This is all about the new style DOSEmu documentation. When I was discussing this with Hans he was concerned (as I am) about the fact that we are all programmers - and generally programmers are poor at documentation. Of course, I'd love you all to prove me (us ?) wrong!
However, every programmer can handle the few basic linuxdoc-sgml commands that are need to make some really good documents! Much of linuxdoc-sgml is like HTML, which is hardly surprising as they are both SGMLs. The source to this document may make useful reading (This is the file './src/doc/README/doc')
There are 5 section levels you can use. They are all automatically numbered. Your choices are:
I think there are lots of ways of doing this, but I've only been using 2:
There is a useful shorthand here. These (and many other tags) can be written either as:
This second form can be very useful.
Here we have 3 useful types:
For the ``itemize'' and ``enum'' lists the items are marked with <item>. eg:
For the ``descrip'' lists the items are marked with either <tag>...</tag> or it's short form (<tag/.../). eg:
If you want to quote a small amount use <tt>. eg:
To quote a large section, such as part of a file or an example use <tscreen> and <verb>. eg:
Note that the order of closing the tags is the reverse of opening! You also still need to ``quote'' any < or > characters although most other characters should be OK.
Obviously some characters are going to need to be quoted. In general these are
the same ones as HTML (eg < is written as
One of the extra feature that this lets us do is include URLs and cross-references.
These have 2 parts: a label, and a reference.
The label is
The reference is
This looks slightly horrible, but is very flexible. It looks quite similar to
the reference above. It is
Which will appear as <firstname.lastname@example.org>
Next Previous Contents
|The DOSEMU team|