Other, less formal documents (e.g. LICENSE,
+>config requires some special handling. The reason it
+ is maintained this way is so that the extensive comments in the file
+ mirror those in user-manual. But the conversion
+ process requires going from SGML to HTML to text to special formatting
+ required for the embedded comments. Some of this does not survive so
+ well. Especially some of the examples that are longer than 80 characters.
+ The build process for this file outputs to config.new,
+ which should be reviewed for errors and mis-formatting. Once satisfied
+ that it is correct, then it should be hand copied to
INSTALL) are maintained as plain text files in the
- top-level source directory. At least for the time being.
+>config.
+
Other, less formal documents (e.g. LICENSE) 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/*.
Formal documents are built with the Makefile targets of
- make dokmake dok, or alternately
- make redhat-dokmake redhat-dok. If you have problems,
try both. The build process uses the document SGML sources in
- doc/source/*/*doc/source/*/* to update all text files in
- doc/text/doc/text/ and to update all HTML
- documents in doc/webserver/doc/webserver/.
First, build the docs by running First, build the docs by running make
+ dok (or alternately make
- dok (or alternately ). For PDF docs, do make
- redhat-dok).
+ dok-pdf.
Run Run make webservermake webserver which copies all
- files from doc/webserverdoc/webserver to the
sourceforge webserver via scp.
) so that those without
the ability to build them locally, have access to them if needed.
This is especially important just prior to a new release! Please
- do this after the $VERSION5.1. Quickstart to Docbook and SGML3.1. Quickstart to Docbook and SGML
If you are not familiar with SGML, it is a markup language similar to HTML.
@@ -351,43 +402,58 @@ BORDER="0"
>
<para></para>, paragraph delimiter. Most
text needs to be within paragraph elements (there are some exceptions).
<emphasis></emphasis>, the stylesheets
make this italics.
Tags delimiting a Tags delimiting a block of text (even small
blocks) should be on their own line. Like:
Our documents are available in differing formats. Right now, they
- are just plain text, and HTML, but PDF, and others is 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: