X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fdeveloper-manual%2Fdocumentation.html;h=a4a8311a9257c689888994c910e9210b7d6f7077;hp=60daf5d84d17a3546db810db034459fbc78ed143;hb=61a5d3fc15169d9f6b0c21e3a56d893f4d672eb4;hpb=ba8c8fd40fb5e150e24819471977f46172acbae6 diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html index 60daf5d8..a4a8311a 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -27,13 +27,13 @@

3. Documentation Guidelines

All formal documents are maintained in Docbook SGML and located in the doc/source/* directory. You will need doc/source/* directory. You will need Docbook, the Docbook DTD's and the Docbook modular stylesheets (or comparable alternatives), and either jade or openjade (recommended) installed in order to build docs from source. Currently there is user-manual, FAQ, and, of course this, the developer-manual in this format. The README, - AUTHORS, INSTALL, privoxy.1 (man page), + AUTHORS, INSTALL, privoxy.8 (man page), and config files are also now maintained as Docbook SGML. These files, when built, in the top-level source directory are generated files! Also, the Privoxy index.html (and a variation on this file, privoxy-index.html, meant for @@ -42,9 +42,7 @@

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 config.

+ does not survive so well. Especially some of the examples that are longer than 80 characters.

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, @@ -59,11 +57,11 @@

How do you update the webserver (i.e. the pages on privoxy.org)?

  1. -

    First, build the docs by running make dok.

    +

    First, build the docs by running make dok dok-tidy.

  2. Run make webserver which copies all files from doc/webserver to the sourceforge webserver via scp.

    + "COMPUTEROUTPUT">doc/webserver to the sourceforge webserver via ssh.

Finished docs should be occasionally submitted to Git (doc/webserver/*/*.html) so that @@ -209,7 +207,7 @@

-

3.3. Privoxy Custom Entities

+

3.3. Privoxy Custom Entities

Privoxy documentation is using a number of customized "entities" to facilitate documentation maintenance.

We are using a set of "boilerplate" files with generic text, that is used by @@ -238,7 +236,7 @@ p-version: the Privoxy version string, e.g. "3.0.28". + "APPLICATION">Privoxy version string, e.g. "3.0.34". p-status: the project status, either