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
ALIGN="left"
VALIGN="bottom"
><A
-HREF="quickstart.html"
+HREF="cvs.html"
>Prev</A
></TD
><TD
CLASS="SECT1"
><A
NAME="DOCUMENTATION"
->4. Documentation Guidelines</A
+>3. Documentation Guidelines</A
></H1
><P
-> All formal documents are maintained in docbook SGML and located in the
+> All formal documents are maintained in Docbook SGML and located in the
<TT
CLASS="COMPUTEROUTPUT"
>doc/source/*</TT
CLASS="FILENAME"
>INSTALL</TT
>) are maintained as plain text files in the
- toplevel source directory. At least for the time being.
+ top-level source directory. At least for the time being.
</P
><P
> Packagers are encouraged to include this documentation. For those without
</P
><P
> Documentation writers should please make sure documents build
- successfully before committing to CVS.
+ successfully before committing to CVS, if possible.
</P
><P
> How do you update the webserver (i.e. the pages on privoxy.org)?
></OL
>
</P
+><P
+> Finished docs should be occasionally submitted to CVS
+ (<TT
+CLASS="FILENAME"
+>doc/webserver/*/*.html</TT
+>) 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 <I
+CLASS="EMPHASIS"
+>after</I
+> the <TT
+CLASS="LITERAL"
+>$VERSION</TT
+> and
+ other release specific data in <TT
+CLASS="FILENAME"
+>configure.in</TT
+> has been
+ updated (this is done just prior to a new release).
+ </P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="SGML"
->4.1. Quickstart to Docbook and SGML</A
+>3.1. Quickstart to Docbook and SGML</A
></H2
><P
> If you are not familiar with SGML, it is a markup language similar to HTML.
><P
> Some common elements that you likely will use: </P
><P
+> <P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
><para></para></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"
><emphasis></emphasis></I
->, the stylesheets make this
- italics.
- </TD
+>, the stylesheets
+ make this italics.
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
><filename></filename></I
>, files and directories.
- </TD
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
><command></command></I
>, command examples.
- </TD
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
-><literallayout></literllayout></I
+><literallayout></literallayout></I
>, like
- <TT
+ <TT
CLASS="LITERAL"
><pre></TT
>, more or less.
- </TD
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
-><itemizedlist></itemizdelist></I
+><itemizedlist></itemizedlist></I
>, list with bullets.
- </TD
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
><listitem></listitem></I
>, member of the above.
- </TD
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
><screen></screen></I
>, screen output, implies
- <TT
+ <TT
CLASS="LITERAL"
><literallayout></TT
>.
- </TD
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
><ulink url="example.com"></ulink></I
>, like
- HTML <TT
+ HTML <TT
CLASS="LITERAL"
><a></TT
> tag.
- </TD
+ </TD
></TR
><TR
><TD
-> <I
+> <I
CLASS="EMPHASIS"
><quote></quote></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"
CLASS="SECT2"
><A
NAME="DOCSTYLE"
->4.2. <SPAN
+>3.2. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> Documentation Style</A
><LI
><P
> We have an international audience. Refrain from slang, or English
- idiosyncrasies (too many to list :).
+ idiosyncrasies (too many to list :). Humor also does not translate
+ well sometimes.
</P
></LI
><LI
><P
> Try to keep overall line lengths in source files to 80 characters or less
- for obvious reasons. This is not always possible, with lenghty URLs for
+ for obvious reasons. This is not always possible, with lengthy URLs for
instance.
</P
></LI
><H2
CLASS="SECT2"
><A
-NAME="AEN179"
->4.3. Privoxy Custom Entities</A
+NAME="AEN209"
+>3.3. Privoxy Custom Entities</A
></H2
><P
> <SPAN
><UL
><LI
><P
-> Re-cyclable <SPAN
+> Re- <SPAN
CLASS="QUOTE"
>"boilerplate"</SPAN
> text entities are defined like:
>
version string, e.g. <SPAN
CLASS="QUOTE"
->"2.9.13"</SPAN
+>"2.9.15"</SPAN
>.
</TD
></TR
>: the project status, either
<SPAN
CLASS="QUOTE"
->"ALPHA"</SPAN
+>"alpha"</SPAN
>, <SPAN
CLASS="QUOTE"
->"BETA"</SPAN
+>"beta"</SPAN
>, or <SPAN
CLASS="QUOTE"
->"STABLE"</SPAN
+>"stable"</SPAN
>.
</TD
></TR
>"not stable"</SPAN
> releases (e.g. <SPAN
CLASS="QUOTE"
->"BETA"</SPAN
+>"beta"</SPAN
>).
</TD
></TR
ALIGN="left"
VALIGN="top"
><A
-HREF="quickstart.html"
+HREF="cvs.html"
>Prev</A
></TD
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
->Quickstart to Privoxy Development</TD
+>The CVS Repository</TD
><TD
WIDTH="34%"
ALIGN="center"
projects / privoxy.git / blobdiff