X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fdeveloper-manual%2Fdocumentation.html;h=6e67c91d8aa34228eba7c86d7162a3eecffdf5f3;hp=0db87befeb4c2901a80ec450dee870fe8f773d6d;hb=ae6beecce49ef10b169c4b843580985430bc698b;hpb=a5b1999794b4b0faa68812c0b8b2861316ae8341 diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html index 0db87bef..6e67c91d 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -73,7 +73,9 @@ CLASS="SECT1" >

3. Documentation Guidelines

3. Documentation Guidelines

All formal documents are maintained in Docbook SGML and located in the , 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/*.

3.1. Quickstart to Docbook and SGML

3.1. Quickstart to Docbook and SGML

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 @@ -536,7 +544,9 @@ CLASS="SECT2" >

3.2. 3.2. Privoxy Documentation Style

  • 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:

    3.3. Privoxy Custom Entities

    3.3. Privoxy Custom Entities

    version string, e.g. "3.1.1""3.0.5".