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 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, - text versions of each are kept in CVS. HTML versions are also being kept in CVS under doc/webserver/*.
Formal documents are built with the Makefile targets of make dok. The build process uses the document SGML sources in doc/source/*/* to update all text files in doc/text/ and to update all HTML documents in doc/webserver/.
-Documentation writers should please make sure documents build successfully before committing to CVS, if +
Documentation writers should please make sure documents build successfully before committing to Git, if possible.
How do you update the webserver (i.e. the pages on privoxy.org)?
First, build the docs by running make dok.
+First, build the docs by running make dok dok-tidy.
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 CVS (doc/webserver/*/*.html) so that +
Finished docs should be occasionally submitted to Git (doc/webserver/*/*.html) 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 $VERSION and other release specific data in configure.in has been updated @@ -139,9 +137,9 @@
Look at any of the existing docs for examples of all these and more.
-You might also find "Writing Documentation Using DocBook - - A Crash Course" useful.
+You might also find " Writing Documentation Using DocBook - A Crash Course" useful.
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 @@ -231,7 +227,7 @@
<!entity supported SYSTEM "supported.sgml">
In this example, the contents of the file, supported.sgml is available for inclusion anywhere in the doc. To make this happen, just reference the now defined entity: &supported; (starts with an ampersand and ends with a semi-colon), and the contents will + "LITERAL">&supported; (starts with an ampersand and ends with a semi-colon), and the contents will be dumped into the finished doc at that point.
| Prev | +Prev | Home | Next |
| The CVS Repository | +The Git Repository | Coding Guidelines |