Spent some time trying to find out how to write definition lists in DocBook. DocBook is the markup language used by gtk-doc and consequently the tool I am using for writing documentation for GtkImageView.
... And I am very, VERY sick of it. It turns out it was fairly simple (heh), all you have to do to create a list of directories and paragraphs is this:
<variablelist><title>Font Filename Extensions</title>
<varlistentry><term><filename>TTF</filename></term>
<listitem>
<para>
TrueType fonts.
</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>PFA</filename></term>
<term><filename>PFB</filename></term>
<listitem>
<para>
PostScript fonts. <filename>PFA</filename> files are common on
<acronym>UNIX</acronym> systems, <filename>PFB</filename> files
are more common on Windows systems.
</para>
</listitem>
</varlistentry>
</variablelist>
The result is almost exactly what you could have accomplised using this HTML:
<dl>
<lh>Font Filename Extension</lh>
<dt><tt>TTF</tt></dt>
<dd>TrueType fonts.</dd>
<dt><tt>PFA, PFB</tt></dt>
<dd>PostScript fonts. <tt>PFA</tt> files are common on UNIX
systems, <tt>PFB</tt> files are more common on Windows systems.</dd>
</dl>
And of course, even less markup is needed if you use reStructuredText.
My search for a decent documentation writing system continues.
Inga kommentarer:
Skicka en kommentar