Etiquetas DocBook útiles

Aquí están varias etiquetas de DocBook muy útiles al documentar código.

Para enlazar otra sección en GTK docs:

<link linkend="glib-Hash-Tables">Hash Tables</link>

          
. El enlace es el id SGML en el elemento superior de la página a la que quiere enlazar. Para la mayoría de las páginas esta es la parte («gtk», «gdk», «glib») y después el título de página («Tablas hash»). Para los widgets es simplemente el nombre de la clase. Los espacios y guiones bajos se convierten a «-» para ajustarse a SGML/XML.

Para referirse a una función externa, ej. una función de C estándar:

<function>...</function>

          

Para incluir un código de ejemplo:

<example>
  <title>Using a GHashTable.</title>
  <programlisting>
      ...
  </programlisting>
</example>

          
o posiblemente este, para fragmentos de código muy cortos que no necesitan título:
<informalexample>
  <programlisting>
  ...
  </programlisting>
</informalexample>

          
. El último GTK-Doc también soporta abreviación: |[ ... ]|

Para incluir listas de topos:

<itemizedlist>
  <listitem>
    <para>
      ...
    </para>
  </listitem>
  <listitem>
    <para>
      ...
    </para>
  </listitem>
</itemizedlist>

          

Para incluir una nota que sobresale del texto:

<note>
  <para>
    Make sure you free the data after use.
  </para>
</note>

          

Para referirse a un tipo:

<type>unsigned char</type>

          

Para referirse a una estructura externa (no una descrita en la documentación de GTK):

<structname>XFontStruct</structname>

          

Para referirse a un campo o a una estructura:

<structfield>len</structfield>

          

Para referirse a un nombre de clase, se podría usar:

<classname>GtkWidget</classname>

          
pero probablemente estará usando #GtkWidget en su lugar (para crear automaticamenteun enlace a la página GtkWidget; consulte abreviaciones).

Para enfatizar un texto:

<emphasis>This is important</emphasis>

          

Para uso de nombres de archivo:

<filename>/home/user/documents</filename>

          

Para referirse a claves:

<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>