Conventions de codage docbook¶
balises de code¶
la balise retenue pour tout le contenu de type "code" mais simple (un mot, une option, un paramètre, une directive) est :
1 <literal>
dès qu'on se trouve en présence d'un morceau de code construit, il faut utiliser
1 <programlisting>
style des liens¶
Il faut éviter les liens de la forme :
1 Plus d'informations sur les contrôles mis en cache sont disponibles <link linkend="advancedtopics-cachedchecks">ici</link>
et favoriser l'utilisation de xref comme par exemple :
1 Plus d'informations sur les contrôles mis en cache sont disponibles au chapitre
2 <xref linkend="advancedtopics-cachedchecks" xrefstyle="select: labelnumber quotedtitle"/>
Ce type de xref génère une référence avec le numéro et le titre du chapitre, tout en maintenant la fonctionnalité d'hyperlien.
Style de codage Docbook/XML¶
- utiliser l'option "soft tabs" de l'éditeur XML (pas de "vrais" tabs dans le code mais des espaces)
- régler l'option "soft tabs" à 4 espaces
Typographie¶
- pour l'expression "et caetera" abrégée, la forme exacte est "etc." (pas de ... derrière)