From: hal9 Date: Mon, 8 Apr 2002 15:57:28 +0000 (+0000) Subject: Minor mod to doc section. X-Git-Tag: v_2_9_14~151 X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=commitdiff_plain;h=281c503f6d2799387e2dfac7fccdd3d885c6312e Minor mod to doc section. --- diff --git a/doc/webserver/developer-manual/coding.html b/doc/webserver/developer-manual/coding.html index 5b3c4883..d136ce6a 100644 --- a/doc/webserver/developer-manual/coding.html +++ b/doc/webserver/developer-manual/coding.html @@ -4,7 +4,8 @@ >Coding Guidelines
const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.25 2002/04/06 05:07:28 hal9 Exp $";
+>const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $";
 /*********************************************************************
  *
  * File        :  $Source$
@@ -2096,7 +2097,7 @@ WIDTH="100%"
 CLASS="PROGRAMLISTING"
 >#ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.25 2002/04/06 05:07:28 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $"
 /*********************************************************************
  *
  * File        :  $Source$
diff --git a/doc/webserver/developer-manual/contact.html b/doc/webserver/developer-manual/contact.html
index 2e312f5e..aed71ffd 100644
--- a/doc/webserver/developer-manual/contact.html
+++ b/doc/webserver/developer-manual/contact.html
@@ -4,7 +4,8 @@
 >Contacting the developers, Bug Reporting and Feature RequestsCopyright and History
10.1. Copyright
10.2. History
Version Control GuidelinesDocumentation Guidelines    All formal documents are maintained in docbook SGML and located in the
     doc/sourcedoc/source/* directory. You will need
     docbook and the docbook
-    stylesheets (or comparable alternatives), and either
-    Docbook, the Docbook 
+    DTD's and the Docbook modular stylesheets (or comparable alternatives),
+    and either jade or  or
+    openjade
-    (recommended) installed in order to build docs from source. Currently
-    there is  (recommended) installed in order to
+    build docs from source. Currently there is FAQ, and,
-    of course this, the , and, of
+    course this, the developer-manual in this
-    format. The  in this format.
+    The README, is also now maintained 
-    as SGML. The , README in the top-level source 
-    directory is a generated file. AUTHORS
+    privoxy.1 (man page) files are also now maintained
+    as Docbook 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 this
-    directly. Edit the SGML source!
+>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
-     plain text files in the toplevel source directory. At least for the 
-     time being.
+>     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
@@ -154,15 +173,15 @@ CLASS="COMPUTEROUTPUT"
      try both. The build process uses the document SGML sources in
      doc/sourcedoc/source/*/* to update all text files in
      doc/textdoc/text/ and to update all HTML
      documents in doc/webserverdoc/webserver/.
     
 If you are not familiar with SGML, it is a markup language similar to HTML. 
- In fact, HTML is an SGML application. Both use "tags"
- to format text and other content. SGML tags are much more varied, 
- and flexible, but do much of the same kinds of things. The tags, 
+> to format text and other content. SGML tags can be much
+ more varied, and flexible, but do much of the same kinds of things. The tags,
  or "elements", are definable in SGML. There is no 
- set , are definable in SGML. There is no set
+ "standards". Since we are using
  Docbook, our tags are those that are 
- defined by , our tags are those that are defined by 
+ Docbook. Much of how the 
- finish document is rendered is determined by the . Much of how the finish document is
+ rendered is determined by the "stylesheets".
- The stylesheets determine how each tag gets translated to HTML, or 
- other formats.
 Tags in SGML need to be always  Tags in Docbook SGML need to be always "closed". If not, you 
- will likely generate errors. Example: 
- . If not, you
+ will likely generate errors. Example: <title>My Title</title>. They are 
- also case-insensitive, but we strongly suggest using all lower 
- case. This keeps compatibility with [Docbook] <title>My
+ Title</title>. They are also case-insensitive, but we
+ strongly suggest using all lower case. This keeps compatibility with
+ [Docbook] XML.
<para></para>, paragraph delimiter. Most 
-  text needs to be within paragraph elements.
+  text needs to be within paragraph elements (there are some exceptions).
    <emphasis></emphasis>, stylesheets make this
+>, the stylesheets make this
  italics.
  
  •        Tags delimiting a block of text should be on their own line. 
-       Like:
+>       Tags delimiting a block of text (even small
+       blocks) should be on their own line. Like:
        
     <para>
    
@@ -457,8 +480,9 @@ CLASS="LITERALLAYOUT"
 >
  •       Tags should be nested and step indented like:
-       
          Tags should be nested and step indented for block text like: (except
+      in-line tags) 
+     
     <para>
    
   <itemizedlist>
    
@@ -485,7 +509,8 @@ CLASS="LITERALLAYOUT"
 >
         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>.)
     
  • 4.3. Privoxy Custom Entities
    Privoxy version string. You are strongly 
   encouraged to use these where possible. Some of these obviously 
-  require re-setting with each release. A sampling of custom entities are
-  listed below. See any of the main docs for examples.
+  require re-setting with each release (done by the Makefile). A sampling of
+  custom entities are listed below. See any of the main docs for examples.
  
      
    Privoxy Developer Manual
    $Id: developer-manual.sgml,v 1.25 2002/04/06 05:07:28 hal9 Exp $
    $Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $
    Quickstart to Docbook and SGML
    1
    4.2. 
    4.3. Privoxy Custom Entities
    10.1. Copyright
    10.2. History
    IntroductionReleasing a new versionQuickstart to Privoxy DevelopmentSee alsoTesting Guidelines