generated
[privoxy.git] / doc / webserver / developer-manual / documentation.html
index bebd35a..343af47 100644 (file)
@@ -10,8 +10,8 @@ REL="HOME"
 TITLE="Privoxy Developer Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
-TITLE="Quickstart to Privoxy Development"
-HREF="quickstart.html"><LINK
+TITLE="The CVS Repository"
+HREF="cvs.html"><LINK
 REL="NEXT"
 TITLE="Coding Guidelines"
 HREF="coding.html"><LINK
@@ -44,7 +44,7 @@ WIDTH="10%"
 ALIGN="left"
 VALIGN="bottom"
 ><A
-HREF="quickstart.html"
+HREF="cvs.html"
 >Prev</A
 ></TD
 ><TD
@@ -71,7 +71,7 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="DOCUMENTATION"
->4. Documentation Guidelines</A
+>5. Documentation Guidelines</A
 ></H1
 ><P
 >    All formal documents are maintained in Docbook SGML and located in the
@@ -251,7 +251,7 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="SGML"
->4.1. Quickstart to Docbook and SGML</A
+>5.1. Quickstart to Docbook and SGML</A
 ></H2
 ><P
 > If you are not familiar with SGML, it is a markup language similar to HTML. 
@@ -344,110 +344,122 @@ CLASS="LITERAL"
 ><P
 > Some common elements that you likely will use: </P
 ><P
+>  <P
 ></P
 ><TABLE
 BORDER="0"
 ><TBODY
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;para&#62;&#60;/para&#62;</I
 >, paragraph delimiter. Most 
-  text needs to be within paragraph elements (there are some exceptions).
- </TD
+      text needs to be within paragraph elements (there are some exceptions).
   </TD
 ></TR
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;emphasis&#62;&#60;/emphasis&#62;</I
->, the stylesheets make this
- italics.
- </TD
+>, the stylesheets
     make this italics.
   </TD
 ></TR
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;filename&#62;&#60;/filename&#62;</I
 >, files and directories.
- </TD
   </TD
 ></TR
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;command&#62;&#60;/command&#62;</I
 >, command examples.
- </TD
   </TD
 ></TR
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;literallayout&#62;&#60;/literallayout&#62;</I
 >, like 
-  <TT
+      <TT
 CLASS="LITERAL"
 >&#60;pre&#62;</TT
 >, more or less.
- </TD
   </TD
 ></TR
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;itemizedlist&#62;&#60;/itemizedlist&#62;</I
 >, list with bullets.
- </TD
   </TD
 ></TR
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;listitem&#62;&#60;/listitem&#62;</I
 >, member of the above.
- </TD
   </TD
 ></TR
 ><TR
 ><TD
->   <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;screen&#62;&#60;/screen&#62;</I
 >, screen output, implies 
-   <TT
+      <TT
 CLASS="LITERAL"
 >&#60;literallayout&#62;</TT
 >.
- </TD
   </TD
 ></TR
 ><TR
 ><TD
->  <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;ulink url="example.com"&#62;&#60;/ulink&#62;</I
 >, like 
-  HTML <TT
+      HTML <TT
 CLASS="LITERAL"
 >&#60;a&#62;</TT
 > tag.
- </TD
   </TD
 ></TR
 ><TR
 ><TD
->   <I
+>      <I
 CLASS="EMPHASIS"
 >&#60;quote&#62;&#60;/quote&#62;</I
 >, for, doh, quoting text. 
- </TD
   </TD
 ></TR
 ></TBODY
 ></TABLE
 ><P
 ></P
+></P
 ><P
 > Look at any of the existing docs for examples of all these and more.</P
+><P
+> You might also find <SPAN
+CLASS="QUOTE"
+>"<A
+HREF="http://www.bureau-cornavin.com/opensource/crash-course/"
+TARGET="_top"
+>Writing Documentation
+ Using DocBook - A Crash Course</A
+>"</SPAN
+> useful.</P
 ></DIV
 ><DIV
 CLASS="SECT2"
@@ -455,7 +467,7 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="DOCSTYLE"
->4.2. <SPAN
+>5.2. <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > Documentation Style</A
@@ -595,8 +607,8 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN186"
->4.3. Privoxy Custom Entities</A
+NAME="AEN214"
+>5.3. Privoxy Custom Entities</A
 ></H2
 ><P
 >  <SPAN
@@ -782,7 +794,7 @@ WIDTH="33%"
 ALIGN="left"
 VALIGN="top"
 ><A
-HREF="quickstart.html"
+HREF="cvs.html"
 >Prev</A
 ></TD
 ><TD
@@ -807,7 +819,7 @@ HREF="coding.html"
 WIDTH="33%"
 ALIGN="left"
 VALIGN="top"
->Quickstart to Privoxy Development</TD
+>The CVS Repository</TD
 ><TD
 WIDTH="34%"
 ALIGN="center"