Nützliche DocBook-Tags
Nachfolgend finden Sie einige DocBook-Tags, die beim Dokumentieren von Code nützlich sein können.
So erstellen Sie eine Verknüpfung zu einem anderen Abschnitt in den GTK-Docs:
<link linkend="glib-Hash-Tables">Hash Tables</link>
Für einen Bezug zu einer externen Funktion, z.B. einer C-Standardfunktion:
<function>...</function>
So fügen Sie Beispielcode ein: Vielleicht auch so, für sehr kurze Codeschnipsel, die keinen Titel benötigen:
<informalexample> <programlisting> ... </programlisting> </informalexample>
Für eine Liste mit Aufzählungszeichen:
<itemizedlist> <listitem> <para> ... </para> </listitem> <listitem> <para> ... </para> </listitem> </itemizedlist>
Für eine nicht zum eigentlichen Text gehörende Notiz:
<note> <para> Make sure you free the data after use. </para> </note>
Für einen Bezug zu einem Typ:
<type>unsigned char</type>
Für einen Bezug zu einer externen Struktur (die nicht in den GTK-Docs beschrieben wird):
<structname>XFontStruct</structname>
Für einen Bezug zu einem Feld einer Struktur:
<structfield>len</structfield>
Um sich auf einen Klassennamen zu beziehen kann man möglicherweise folgendes verwenden:
<classname>GtkWidget</classname>
Zum Hervorheben von Text:
<emphasis>This is important</emphasis>
Für Dateinamen:
<filename>/home/user/documents</filename>
Für einen Bezug zu einem Schlüssel:
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>