Balises DocBook utiles
Voici quelques balises DocBook très utiles pendant la conception de la documentation d'un code.
Pour créer un lien vers une autre section dans la documentation GTK :
<link linkend="glib-Hash-Tables">Hash Tables</link>
Pour faire référence à une fonction externe comme, par exemple, à une fonction C standard :
<function>...</function>
Pour inclure des extraits de code :
<example> <title>Using a GHashTable.</title> <programlisting> ... </programlisting> </example>
<informalexample> <programlisting> ... </programlisting> </informalexample>
Pour ajouter une liste à puces :
<itemizedlist> <listitem> <para> ... </para> </listitem> <listitem> <para> ... </para> </listitem> </itemizedlist>
Pour ajouter une note de bas de page :
<note> <para> Make sure you free the data after use. </para> </note>
Pour se référer à un type :
<type>unsigned char</type>
Pour se référer à une structure externe (non décrite dans la documentation GTK) :
<structname>XFontStruct</structname>
Pour se référer à un champ d'une structure :
<structfield>len</structfield>
Pour se référer au nom d'une classe, il est possible d'utiliser :
<classname>GtkWidget</classname>
Pour mettre en évidence un texte :
<emphasis>This is important</emphasis>
Pour les noms de fichiers :
<filename>/home/user/documents</filename>
Pour se référer à des touches :
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>