ఉపయోగకర DocBook టాగ్స్

కోడ్‌ను పత్రికీకరణ చేయునప్పుడు యెక్కువ వుపయోగకరంగా వుండే మరికొన్ని DocBook టాగ్స్ యిక్కడ వున్నాయి.

GTK docs నందు వేరొక విభాగమునకు లింకు చేయుటకు:

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

          
మీరు లింకు యేర్పరచాలని కొరుకొనుచున్న పేజీ యొక్క పై అంశముపై SGML/XML idయే linkend. చాలా పేజీలకు ప్రస్తుతం యిదే పార్ట్ ("gtk", "gdk", "glib") మరియు పేజీ శీర్షిక ("Hash Tables"). విడ్జట్లకు యిది క్లాస్ నామము మాత్రమే. SGML/XML నిర్ధారించుటకు ఖాళీలు మరియు అండర్‌స్కోర్లు '-'గా మార్చబడినవి.

బాహ్య ఫంక్షన్‌ను సూచించుటకు, ఉ.దా. ప్రామాణిక C ఫంక్షన్:

<function>...</function>

          

ఉదాహరణ కోడ్‌ను చేర్చుటకు:

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

          
లేదా, శీర్షిక అవసరములేని చాలా చిన్న కోడ్ ముక్కల కొరకు:
<informalexample>
  <programlisting>
  ...
  </programlisting>
</informalexample>

          
తరువాతి GTK-Doc కూడా అబ్రివేషన్‌ను మద్దతించును: |[ ... ]|

To include bulleted lists:

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

          

To include a note which stands out from the text:

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

          

To refer to a type:

<type>unsigned char</type>

          

To refer to an external structure (not one described in the GTK docs):

<structname>XFontStruct</structname>

          

To refer to a field of a structure:

<structfield>len</structfield>

          

To refer to a class name, we could possibly use:

<classname>GtkWidget</classname>

          
but you'll probably be using #GtkWidget instead (to automatically create a link to the GtkWidget page - see the abbreviations).

To emphasize text:

<emphasis>This is important</emphasis>

          

For filenames use:

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

          

To refer to keys use:

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