X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fwebserver%2Fdeveloper-manual%2Fdocumentation.html;h=5cb88d7ba616f9ee3a7a2b99d4fa377c44653f50;hb=173d9755c86ab651bdbf5fb17762618b814c31ee;hp=eee065d65902537b5fa91fd0f1a8d23c437615d3;hpb=51dd3416173631d3cdbd51bd35d8cf6a349e13c2;p=privoxy.git diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html index eee065d6..5cb88d7b 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -1,11 +1,11 @@ + Documentation Guidelines3. Documentation Guidelines3. Documentation Guidelines

All formal documents are maintained in Docbook SGML and located in the - doc/source/*doc/source/* directory. You will need

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.

    3.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. Actually, not a mark up language per se, but a language used to define @@ -545,11 +548,11 @@ CLASS="SECT2" CLASS="SECT2" >3.2. Privoxy Documentation Style Documentation Style

    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 @@ -689,8 +692,8 @@ CLASS="SECT2" CLASS="SECT2" >3.3. Privoxy Custom Entities3.3. Privoxy Custom Entities

    version string, e.g. "3.0.6""3.0.13". \ No newline at end of file +>