Conventions d’écriture
On y pense moins souvent, elles ont pourtant leur importance, les conventions d’écriture sont les choix que nous faisons :
- sur le fond dans l’écriture et les représentations et
- sur la forme de présentation.
De même que pour les autres conventions, nous devons connaître les possibilités et les limites de l’outil que nous utilisons (ici, mdBook et le langage Markdown).
Le fond
Parmi les conventions d’écriture, nous pouvons définir ce dont nous traitons, la manière dont nous le traitons, et le ton même (qui, dans mon approche ici, fait partie intégrante du « fond ».)
La manière d’écrire certains éléments
Nous devons choisir d’écrire des mots-clefs d’une manière ou d’une autre.
Je vais plus loin : nous devrions, comme je l’ai fait ici (voir Conventions d’écriture dans ce livre), choisir un mot et un seul, une expression et une seule, pour définir un concept.
Ce afin de structurer la pensée et de simplifier bien des choses (comme la recherche par mot-clef par exemple).
Codes sources
La manière d’écrire le fond (qui est visible du·de la lecteur·trice) peut inclure des conventions d’écriture des codes informatiques, des commentaires dans ces codes informatiques, etc.
La forme
La forme signifie ici la manière dont nous utilisons les outils à notre disposition.
Il est important, pour que le document soit homogène et le reste dans le temps ou avec les différent·e·s intervenant·e·s, que nous ayons défini les manières d’utiliser ces outils.
L’organisation des chapitres de page mdBook
Les composants mdBook
Nous pouvons décider :
Tip
Si nous utilisons les avertissements (admonitions) comme celui-ci ou non.
Comment utiliser les blocs de citations comme celui-ci.
Ou encore les blocs extensibles
pour développer une idée plus approfondie comme je le fais dans mes livres mdBook.
Une fois que nous avons fait ces choix, nous pouvons affiner encore les règles que nous choisissons d’appliquer.
Les règles externes
Nous évoluons dans un monde qui nous dicte certaines conventions que nous devrions respecter : l’orthographe, la grammaire, mais aussi la typographie.
Typographie française
Parmi les règles que nous utilisons figurent celles de la typographie française.
Je ne parle ici que d’un élément, mais bien d’autres nécessitent une réflexion et des choix.
Nous utilisons le caractère espace insécable qui est très important en typographie française.
C’est lui qui évite qu’un guillemet fermant ou qu’un signe de ponctuation soit écrit en début de ligne suivante par exemple.
L'espace insécable dans le texte
L’espace insécable existe nativement en UTF-8 et donc dans les fichiers Markdown et les pages HTML générées par la plupart des parseurs.
On la réalise avec la combinaison de touches AltGr + Espace dans Linux.
Il convient d’y faire très attention, surtout si nous n’avons pas pris soin de paramétrer notre éditeur pour qu’il surligne les caractères « spéciaux » dont cette espace insécable. Je ne peux que vous recommander de le faire au plus vite.
Il est encore plus dangereux dans les commentaires des codes sources dans la mesure où nombre d’EDI n’interprètent et ne surlignent donc pas ces caractères.
Il arrive très fréquemment, lorsque nous saisissons vite, que nous insérions une espace insécable après les croisillons des titres dans des fichiers Markdown par exemple, car nous ne relâchons pas la touche AltGr suffisamment rapidement. C’est alors catastrophique car la plupart des parseurs Markdown considèrent alors, ne reconnaissant pas la séquence {croisillons}{espace}{texte}, qu’il ne s’agit pas d’un titre.
Si vous observiez ce qu’il se produit dans cet affichage de code, c’est sans doute que vous avez saisi une espace insécable au lieu d’une espace :
fn main() {
println("Prénom : Marc");
// Exemple d'espaces insécables à la place d'espaces.
}L’art du compromis
Lorsque nous connaissons et maîtrisons bien les règles de la typographie, nous sommes habitué·e·s à composer avec les outils et leurs contraintes. Par exemple, les petites capitales, qui existent pourtant bel et bien en CSS (et donc en HTML) ne sont pas proposées dans la plupart des outils Markdown dont mbBook.
Plus encore…
En CSS, on écrit :
font-variant: small-caps;
Ou dans une version plus moderne et plus précise :
font-variant-caps: small-caps;
Le navigateur web cherche les vraies petites capitales de la police si elles existent. Si la police ne les intègre pas, le navigateur triche en réduisant la taille des lettres capitales. Le résultat n’est pas toujours excellent.
Pour mémoire, il a existé une balise non standard <acronym> dans de précédentes versions de HTML qui appliquait parfois les lettres petites capitales sur certains navigateurs. 1