| <book> | ||||
| <chapter id=""> | <title></title> | |||
| <formalpara> | <title></title> | |||
| <para></para> | ||||
| </formalpara> | ||||
| <para></para> | ||||
| <programlisting> | <![CDATA[ | |||
| ]]></programlisting> | ||||
| <ulink url=""></ulink> | ||||
|
<mediaobject> <imageobject> <imagedata fileref="" format="PNG"/> </imageobject> <caption><para>blah.</para></caption> </mediaobject> |
||||
| <table><title></title> | <tgroup cols=""><tbody><row><entry> | |||
| </entry></row> | </tbody> </tgroup> </table> | |||
| <itemizedlist><listitem> | <para> | |||
| </para></listitem> | </itemizedlist> | |||
| </chapter> | ||||
| <book> | ||||
I usually write up documentation with a plain text editor in docbook format. This page should serve as a quick reference of the combination of elements that I use most frequently.
The Book becomes the index.html file. Chapters become new html files. The filename uses the chapter id. I usually use formalpara to break up the flow. it is a normal html p element, but the title part is put into a bold b element.
programlisting becomes a pre tag. tables need a colspan attribute with maps to number of entry tags per row.
I also use section as a child of chapter for breaking up long pages.