From 94aced1534cfb8424ab8f09fa29871883cdca1c3 Mon Sep 17 00:00:00 2001 From: hal9 Date: Sun, 7 Apr 2002 23:50:08 +0000 Subject: [PATCH] Documentation changes to reflect HTML docs now in CVS, and new generated files list. --- doc/source/developer-manual.sgml | 57 +++++++++++++++++++------------- 1 file changed, 34 insertions(+), 23 deletions(-) diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index a8c8fa2c..a3b87800 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -8,9 +8,9 @@ - - - + + + ]> @@ -21,7 +21,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $ + $Id: developer-manual.sgml,v 1.25 2002/04/06 05:07:28 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -44,7 +44,7 @@ Privoxy Developer Manual - $Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $ + $Id: developer-manual.sgml,v 1.25 2002/04/06 05:07:28 hal9 Exp $ @@ -156,7 +156,7 @@ following guidelines for changing stuff in the code. If it is 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 and the docbook stylesheets (or comparable alternatives), and either jade or openjade @@ -165,31 +165,35 @@ following guidelines for changing stuff in the code. If it is url="../user-manual/index.html">user-manual, FAQ, and, of course this, the developer-manual in this - format. The README, is also now maintained - as SGML. The README in the top-level source - directory is a generated file. DO NOT edit this - directly. Edit the SGML source! + format. The README, AUTHORS + privoxy.1 (man page) + files are also now maintained + as SGML. The finished files are all in the top-level source + directory are generated files! Also, index.html, + the Privoxy home page, is maintained + as sgml. DO NOT edit these + directly. Edit the SGML source, or contact someone + involved in the documentation (at present Stefan and Hal). - Other, less formal documents (e.g. AUTHORS, LICENSE) are maintained as + Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain text files in the toplevel source directory. At least for the time being. 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. Or HTML versions can be downloaded from the www.privoxy.org website, which - should be fairly current. (This is only a temporary solution.) + CVS. HTML versions are also now being kept in CVS under + doc/webserver/*. Formal documents are built with the Makefile targets of make dok, or alternately make redhat-dok. If you have problems, try both. 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. + 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 @@ -321,8 +325,8 @@ following guidelines for changing stuff in the code. If it is - Tags delimiting a block of text should be on their own line. - Like: + Tags delimiting a block of text should be on their + own line. Like: <para> Some text goes here. @@ -336,7 +340,7 @@ following guidelines for changing stuff in the code. If it is - Tags should be nested and step indented like: + Tags should be nested and step indented like (except in-line tags): <para> <itemizedlist> @@ -362,7 +366,8 @@ following guidelines for changing stuff in the code. If it is Do not hesitate to make comments. Comments can either use the <comment> element, or the <!-- --> style comment - familiar from HTML. + familiar from HTML. (Note in Docbook v4.x <comment> is + replaced by <remark>.) @@ -1622,7 +1627,7 @@ static void unload_re_filterfile( void *f ) { ... } Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $"; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.25 2002/04/06 05:07:28 hal9 Exp $"; /********************************************************************* * * File : $Source$ @@ -1682,7 +1687,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.25 2002/04/06 05:07:28 hal9 Exp $" /********************************************************************* * * File : $Source$ @@ -2408,6 +2413,12 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 1.25 2002/04/06 05:07:28 hal9 + -Add privoxy-man-page.sgml, for man page. + -Add authors.sgml for AUTHORS (and p-authors.sgml) + -Reworked various aspects of various docs. + -Added additional comments to sub-docs. + Revision 1.24 2002/04/04 21:33:37 hal9 More on documenting the documents. -- 2.39.2