All formal documents are maintained in Docbook SGML and located in the - doc/source/*doc/source/* directory. You will need , AUTHORS +>, + INSTALL, privoxy.1DO NOT edit these directly. Edit the SGML source, or - contact someone involved in the documentation (at present Hal). + contact someone involved in the documentation.
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/*.
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 (or alternately make - redhat-dok). For PDF docs, do ). For PDF docs, do make - dok-pdf.
Run Run make webservermake webserver which copies all - files from doc/webserverdoc/webserver to the sourceforge webserver via scp.
If you are not familiar with SGML, it is a markup language similar to HTML.
Actually, not a mark up language per se, but a language used to define
@@ -524,7 +535,7 @@ CLASS="EMPHASIS"
> You might also find "Writing Documentation
Using DocBook - A Crash Course It will be easier if everyone follows a similar writing style. This
just makes it easier to read what someone else has written if it
@@ -634,7 +647,7 @@ CLASS="LITERALLAYOUT"
> Our 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:
version string, e.g. "3.1.1""3.0.16".
3.2. 3.2. Privoxy Documentation Style
Documentation Style3.3. Privoxy Custom Entities
3.3. Privoxy Custom Entities