diff options
| author | rrt <unknown> | 2000-10-09 16:53:49 +0000 |
|---|---|---|
| committer | rrt <unknown> | 2000-10-09 16:53:49 +0000 |
| commit | c54e397f8b1b0f1277e6785b7c4f894f28dbc745 (patch) | |
| tree | 8b518233ec83b38c4de6e60bddbe2ab3b6df71aa /docs | |
| parent | 9cd3ca368ac5342202ad286885b1ac9c196ecd7c (diff) | |
| download | haskell-c54e397f8b1b0f1277e6785b7c4f894f28dbc745.tar.gz | |
[project @ 2000-10-09 16:53:49 by rrt]
Added a tip about using <Para> inside <ListItem>s.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docbook-cheat-sheet.sgml | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/docs/docbook-cheat-sheet.sgml b/docs/docbook-cheat-sheet.sgml index ae7957977c..4a4a8a5a38 100644 --- a/docs/docbook-cheat-sheet.sgml +++ b/docs/docbook-cheat-sheet.sgml @@ -31,13 +31,28 @@ The GHC documentation is written using DocBook 3.1, so the DTD line should be: <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> </Screen> -<Para> -This guide is <Emphasis>not</Emphasis> meant to teach you how to write DocBook; read the <ULink URL="http://www.docbook.org/">DocBook book</ULink> for that. It is more of a reference than a tutorial, so see the <ULink URL="http://www.oasis-open.org/docbook/">DocBook home page</ULink> for other links. -</Para> +<Para> This guide is <Emphasis>not</Emphasis> meant to teach you how to +write DocBook; read the <ULink URL="http://www.docbook.org/">DocBook +book</ULink> for that. It is more of a reference than a tutorial, so see the +<ULink URL="http://www.oasis-open.org/docbook/">DocBook home page</ULink> +for other links. </Para> -<Para> -The rest of this section outlines the use of several tags which may not be obvious (DocBook is rather scholastic in style: it has tags for many things from C function prototypes to keyboard bindings; at the same time it has many omissions and oddities). The current scheme has many infelicities, partly because it was dreamt up in a hurry while the author was learning DocBook and converting the documentation thereto, and partly because DocBook is rather C-centric. -</Para> +<Para> However, by popular demand, here are some useful points: </Para> + +<ItemizedList> +<ListItem> +<Para>Remember to use <SGMLTag class="StartTag">Para</SGMLTag> inside +<SGMLTag class="StartTag">ListItem</SGMLTag>s. +</ListItem> +</ItemizedList> + +<Para> The rest of this section outlines the use of several tags which may +not be obvious (DocBook is rather scholastic in style: it has tags for many +things from C function prototypes to keyboard bindings; at the same time it +has many omissions and oddities). The current scheme has many infelicities, +partly because it was dreamt up in a hurry while the author was learning +DocBook and converting the documentation thereto, and partly because DocBook +is rather C-centric. </Para> <VariableList> |