সুবিধাজনক DocBook ট্যাগ

কোড নথিভুক্ত করার সময় সহায়ক কিছু DocBook ট্যাগ এইখানে উল্লেখ করা হল।

To link to another section in the GTK docs:

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

          
The linkend is the SGML/XML id on the top item of the page you want to link to. For most pages this is currently the part ("gtk", "gdk", "glib") and then the page title ("Hash Tables"). For widgets it is just the class name. Spaces and underscores are converted to '-' to conform to SGML/XML.

To refer to an external function, e.g. a standard C function:

<function>...</function>

          

To include example code:

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

          
or possibly this, for very short code fragments which don't need a title:
<informalexample>
  <programlisting>
  ...
  </programlisting>
</informalexample>

          
For the latter GTK-Doc also supports an abbreviation: |[ ... ]|

বুলেট চিহ্ন সহ তালিকা অন্তর্ভুক্ত করার জন্য ব্যবহার করুন:

<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>

          

কোনো টাইপ উল্লেখ করা জন্য:

<type>unsigned char</type>

          

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

<structname>XFontStruct</structname>

          

কোনো স্ট্রাকচারের ফিল্ড উল্লেখ করার জন্য:

<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).

টেক্সট বিশেষভাবে উল্লেখ করার জন্য:

<emphasis>This is important</emphasis>

          

ফাইলের নামের জন্য ব্যবহার করুন:

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

          

কি উল্লেখ করার জন্য ব্যবহার করুন:

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