Tags úteis do DocBook
Aqui estão algumas tags de DocBook que são muito úteis quando se está documentado o código.
Para vincular a outra seção nas documentações do GTK:
<link linkend="glib-Hash-Tables">Tabela de hashes</link>
Para se referir a uma função externa, como, por exemplo, uma função padrão do C:
<function>...</function>
Para incluir um código de exemplo:
<example> <title>Usando uma GHashTable.</title> <programlisting> ... </programlisting> </example>
<informalexample> <programlisting> ... </programlisting> </informalexample>
Para incluir listas com marcadores:
<itemizedlist> <listitem> <para> ... </para> </listitem> <listitem> <para> ... </para> </listitem> </itemizedlist>
Para incluir uma nota que fique fora do texto:
<note> <para> Certifique-se de que você liberou os dados após usá-los. </para> </note>
Para se referir a um tipo:
<type>unsigned char</type>
Para se referir a uma estrutura externa (não uma descrita nos documentos do GTK):
<structname>XFontStruct</structname>
Para se referir a um campo de uma estrutura:
<structfield>len</structfield>
Para se referir a um nome de classe, nós possivelmente poderíamos usar:
<classname>GtkWidget</classname>
Para enfatizar um texto:
<emphasis>Isso é importante</emphasis>
Para nome de arquivos use:
<filename>/home/usuario/documentos</filename>
Para se referir a chaves use:
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>