-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Documentation Guidelines</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
HREF="coding.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
>, <I
CLASS="CITETITLE"
>AUTHORS</I
->
+>,
+ <I
+CLASS="CITETITLE"
+>INSTALL</I
+>,
<I
CLASS="CITETITLE"
>privoxy.1</I
>DO NOT edit these directly</I
></SPAN
>. Edit the SGML source, or
- contact someone involved in the documentation (at present Hal).
+ contact someone involved in the documentation.
</P
><P
> <TT
> Other, less formal documents (e.g. <TT
CLASS="FILENAME"
>LICENSE</TT
->,
- <TT
-CLASS="FILENAME"
->INSTALL</TT
->) are maintained as plain text files in the
- top-level source directory. At least for the time being.
+>) are
+ maintained as plain text files in the top-level source directory.
</P
><P
> 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. HTML versions are also now being kept in CVS under
+ CVS. HTML versions are also being kept in CVS under
<TT
CLASS="FILENAME"
>doc/webserver/*</TT
+>. And PDF version are kept in
+ <TT
+CLASS="FILENAME"
+>doc/pdf/*</TT
>.
</P
><P
CLASS="EMPHASIS"
>after</I
></SPAN
-> the <VAR
+> the <TT
CLASS="LITERAL"
->$VERSION</VAR
+>$VERSION</TT
> and
other release specific data in <TT
CLASS="FILENAME"
CLASS="QUOTE"
>"closed"</SPAN
>. If not, you
- will likely generate errors. Example: <VAR
+ will likely generate errors. Example: <TT
CLASS="LITERAL"
><title>My
- Title</title></VAR
+ Title</title></TT
>. They are also case-insensitive, but we
strongly suggest using all lower case. This keeps compatibility with
[Docbook] <SPAN
CLASS="QUOTE"
>"sections"</SPAN
> for the most part. Sections
- will be processed into HTML headers (e.g. <VAR
+ will be processed into HTML headers (e.g. <TT
CLASS="LITERAL"
->h1</VAR
+>h1</TT
> for
- <VAR
+ <TT
CLASS="LITERAL"
->sect1</VAR
+>sect1</TT
>). The <SPAN
CLASS="APPLICATION"
>Docbook</SPAN
> stylesheets
will use these to also generate the Table of Contents for each doc. Our
- TOC's are set to a depth of three. Meaning <VAR
+ TOC's are set to a depth of three. Meaning <TT
CLASS="LITERAL"
->sect1</VAR
+>sect1</TT
>,
- <VAR
+ <TT
CLASS="LITERAL"
->sect2</VAR
->, and <VAR
+>sect2</TT
+>, and <TT
CLASS="LITERAL"
->sect3</VAR
+>sect3</TT
> will have TOC
- entries, but <VAR
+ entries, but <TT
CLASS="LITERAL"
->sect4</VAR
+>sect4</TT
> will not. Each section requires
- a <VAR
+ a <TT
CLASS="LITERAL"
-><title></VAR
+><title></TT
> element, and at least one
- <VAR
+ <TT
CLASS="LITERAL"
-><para></VAR
+><para></TT
>. There is a limit of five section
levels in Docbook, but generally three should be sufficient for our
purposes.</P
><literallayout></literallayout></I
></SPAN
>, like
- <VAR
+ <TT
CLASS="LITERAL"
-><pre></VAR
+><pre></TT
>, more or less.
</TD
></TR
><screen></screen></I
></SPAN
>, screen output, implies
- <VAR
+ <TT
CLASS="LITERAL"
-><literallayout></VAR
+><literallayout></TT
>.
</TD
></TR
><ulink url="example.com"></ulink></I
></SPAN
>, like
- HTML <VAR
+ HTML <TT
CLASS="LITERAL"
-><a></VAR
+><a></TT
> tag.
</TD
></TR
> You might also find <SPAN
CLASS="QUOTE"
>"<A
-HREF="http://www.bureau-cornavin.com/opensource/crash-course/"
+HREF="http://opensource.bureau-cornavin.com/crash-course/index.html"
TARGET="_top"
>Writing Documentation
Using DocBook - A Crash Course</A
><LI
><P
> Our documents are available in differing formats. Right now, they
- are just plain text, TML, and PDF, but others are always a
+ are just plain text, HTML, and PDF, but others are always a
future possibility. Be careful with URLs (<ulink>), and avoid
this mistake:
</P
CLASS="APPLICATION"
>aspell</SPAN
> can check SGML with the
- <VAR
+ <TT
CLASS="LITERAL"
->-H</VAR
+>-H</TT
> option. (<SPAN
CLASS="APPLICATION"
>ispell</SPAN
><H2
CLASS="SECT2"
><A
-NAME="AEN233"
+NAME="AEN217"
>3.3. Privoxy Custom Entities</A
></H2
><P
>"internal entities"</SPAN
>. These are like variables in
programming. Well, sort of. For instance, we have the
- <VAR
+ <TT
CLASS="LITERAL"
->p-version</VAR
+>p-version</TT
> entity that contains the current
<SPAN
CLASS="APPLICATION"
> text entities are defined like:
</P
><P
-> <VAR
+> <TT
CLASS="LITERAL"
-><!entity supported SYSTEM "supported.sgml"></VAR
+><!entity supported SYSTEM "supported.sgml"></TT
>
</P
><P
>supported.sgml</TT
> is available for inclusion anywhere
in the doc. To make this happen, just reference the now defined
- entity: <VAR
+ entity: <TT
CLASS="LITERAL"
->&supported;</VAR
+>&supported;</TT
> (starts with an ampersand
and ends with a semi-colon), and the contents will be dumped into
the finished doc at that point.
>
version string, e.g. <SPAN
CLASS="QUOTE"
->"3.0.3"</SPAN
+>"3.0.18"</SPAN
>.
</TD
></TR
></DIV
></BODY
></HTML
->
\ No newline at end of file
+>
projects / privoxy.git / blobdiff