Page-mémo : recommandations pour Framabook

Voici quelques remarques pour corriger des choses récurrentes.

Titres de parties

Il faudrait donner un titre aux parties : je les ai recopiées sur la page du livre (note : avant propos, introduction et annexes ne sont pas des parties).

Là où il y a des listes descriptives (notamment le glossaire), merci d'utiliser la syntaxe markdown qui coinvient, ici : http://pandoc.org/MANUAL.html#definition-lists

(et de manière générale, c'est la syntaxe pandoc-markdown qu'il convient d'utiliser.

Astuce pour sauter une ligne
mot
<ligne> (presser deux fois Enter)
: definition
<ligne> (presser deux fois Enter)
mot
<etc.>
Notes de bas de page

La typo (majuscules, ponctuations, etc) et la mise en forme. Ne pas oublier que nous faisons un livre et qu'il s'agisse de epub ou de papier, de simples liens ne suffisent pas. Il faut donner le maximum de description des sources. Voir ci dessous des modèles de corrections pour les notes de bas de page.

Modèles de corrections pour les notes de bas de page :

Pour des renvois à une page web, voir correction de la note 3 du chapitre 3

Pour des liens renvoyant à Wikipédia, donner le titre de la page. Voir correction de la note 1 chapitre 5

Pour des liens renvoyant à une source qui correspond à une entrée bibliographique, voir correction de la note 18 du chapitre 8.

Concernant les liens entre des sections du livre : il faut les revoir en citant explicitement le titre de la section à laquelle ils renvoient.

Par exemple dans le chapitre 7, nous lisons « (comme dans l’exemple de Arash Payan et Appirater4)». Le 4 renvoie à une note de bas de page : « lien vers partie2 chapitre1 - ligne 133 ».

Il faut plutôt écrire comme suit : « (comme dans l’exemple de Arash Payan et Appirater, voir le Chapitre -titre du chapitre-, -titre de section-)». Ainsi aussi bien en HTML qu'en LaTeX, on utilise des labels pour renvoyer au bon endroit.

De manière générale, le vocabulaire est le suivant : un partie est divisée en chapitres, eux mêmes divisés en sections et sous-sections.

Revoir tous les éléments entre guillemets. Soit on utilise de l'italique, soit des guillemets mais pas les deux en même temps

Choisissez bien ce qui doit apparaître entre guillemet et ce qui doit être en italique. Par exemple, dans la première phrase du chapitre 2, il faut utiliser les guillemets. Par contre dans le second paragraphe du chapitre 2, l’occurrence App Academy n'a pas à être en italique (ni entre guillemets), les majuscules suffisent, c'est le nom d'une organisation, mee si il est en anglais. Toujours dans le chapitre 2, dans la phrase « Pour comparer, l’utilisation de frameworks et de langages non open source impliquaient : de payer pour y avoir accès, », les occurrences frameworks et open source doivent effectivement être en italique (et surveiller que c'est toujours le cas).

A part les titres, rien ne doit être en gras. On peut éventuellement faire des titres de paragraphe, mais en général c'est pas vraiment frenchy et puis ce qui est en gras peut très bien être en italique.

Concernant les titres, j'ai été surpris de les voir si longs ! Un long titre n'est pas un titre, c'est un paragraphe à développer Si vous avez une solution, par exemple pour réinventer des titres et placer les titres longs en italique en dessous, je pense qu'il ne faut pas hésiter. A vous de voir.