Other, less formal documents (e.g. LICENSE, - INSTALL) are maintained as plain text files in the - top-level source directory. At least for the time being. +>) are + maintained as plain text files in the top-level source directory.
Packagers are encouraged to include this documentation. For those without the ability to build the docs locally, text versions of each are kept in - CVS. HTML versions are also now being kept in CVS under + CVS. HTML versions are also being kept in CVS under doc/webserver/*. And PDF version are kept in + doc/pdf/*.
after the the $VERSION$VERSION and other release specific data in "closed". If not, you - will likely generate errors. Example: <title>My - Title</title>. They are also case-insensitive, but we strongly suggest using all lower case. This keeps compatibility with [Docbook] "sections" for the most part. Sections - will be processed into HTML headers (e.g. h1h1 for - sect1sect1). The Docbook stylesheets will use these to also generate the Table of Contents for each doc. Our - TOC's are set to a depth of three. Meaning sect1sect1, - sect2, and sect2, and sect3sect3 will have TOC - entries, but sect4sect4 will not. Each section requires - a <title><title> element, and at least one - <para><para>. There is a limit of five section levels in Docbook, but generally three should be sufficient for our purposes.
<literallayout></literallayout>, like - <pre><pre>, more or less. <screen></screen>, screen output, implies - <literallayout><literallayout>. <ulink url="example.com"></ulink>, like - HTML <a><a> tag. You might also find "Writing Documentation Using DocBook - A Crash CourseOur documents are available in differing formats. Right now, they - are just plain text, TML, and PDF, but others are always a + are just plain text, HTML, and PDF, but others are always a future possibility. Be careful with URLs (<ulink>), and avoid this mistake:
aspell"internal entities". These are like variables in programming. Well, sort of. For instance, we have the - p-versionp-version entity that contains the current text entities are defined like:
<!entity supported SYSTEM "supported.sgml"><!entity supported SYSTEM "supported.sgml">
supported.sgml is available for inclusion anywhere in the doc. To make this happen, just reference the now defined - entity: &supported;&supported; (starts with an ampersand and ends with a semi-colon), and the contents will be dumped into the finished doc at that point. @@ -795,7 +802,7 @@ CLASS="APPLICATION" > version string, e.g. "3.0.3""3.0.18".