Χρήσιμες ετικέτες DocBook

Ακολουθούν ορισμένες ετικέτες DocBook, ιδιαίτερα χρήσιμες για την τεκμηρίωση του κώδικα.

Για να συνδέσετε με μια άλλη ενότητα στην τεκμηρίωση GTK:

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

          
Ο προορισμός είναι το id του SGML/XML στο πρώτο στοιχείο της σελίδας στην οποία παραπέμπει ο σύνδεσμος. Για τις περισσότερες σελίδες είναι το ("gtk", "gdk", glib"), ακολουθούμενο από τον τίτλο της σελίδας («Πίνακες Hash»). Για τα γραφικά συστατικά είναι το όνομα της κλάσης. Τα διαστήματα και τα «_» μετατρέπονται σε «-» για να υπάρχει συμμόρφωση με το SGML/XML.

Αναφορά σε εξωτερική συνάρτηση, π.χ. τυποποιημένη συνάρτηση C:

<function>...</function>

          

Συμπερίληψη παραδειγμάτων κώδικα:

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

          
ή, ενδεχομένως, για πολύ σύντομο κώδικα που δεν χρειάζεται τίτλο:
<informalexample>
  <programlisting>
  ...
  </programlisting>
</informalexample>

          
. Στην τελευταία περίπτωση το GTK-Doc υποστηρίζει επίσης τη σύντμηση: |[ ... ]|

Συμπερίληψη λιστών με κουκίδες:

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

          

Συμπερίληψη σημειώσεων που ξεχωρίζουν από το υπόλοιπο κείμενο:

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

          

Αναφορά σε τύπο:

<type>unsigned char</type>

          

Αναφορά σε εξωτερική δομή (που δεν περιγράφεται στην τεκμηρίωση GTK):

<structname>XFontStruct</structname>

          

Αναφορά σε πεδίο μιας δομής:

<structfield>len</structfield>

          

Αναφορά σε όνομα κλάσης. Μία δυνατότητα είναι το :

<classname>GtkWidget</classname>

          
, αλλά μάλλον θα χρησιμοποιήσετε το #GtkWidget (για αυτόματη δημιουργία συνδέσμου προς τη σελίδα GtkWidget, δείτε τις συντμήσεις).

Χρήση έντονων χαρακτήρων:

<emphasis>This is important</emphasis>

          

Ονόματα αρχείων:

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

          

Για να αναφερθείτε σε κλειδιά χρησιμοποιήστε:

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