<link rel="NEXT" title="Coding Guidelines" href="coding.html">
<link rel="STYLESHEET" type="text/css" href="../p_doc.css">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
- <style type="text/css">
-body {
- background-color: #EEEEEE;
- color: #000000;
- }
- :link { color: #0000FF }
- :visited { color: #840084 }
- :active { color: #0000FF }
- span.c3 {font-style: italic}
- a.c2 {font-style: italic}
- hr.c1 {text-align: left}
- </style>
</head>
-<body class="SECT1">
+<body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
+"#840084" alink="#0000FF">
<div class="NAVHEADER">
<table summary="Header navigation table" width="100%" border="0"
cellpadding="0" cellspacing="0">
accesskey="N">Next</a></td>
</tr>
</table>
- <hr class="c1" width="100%">
+ <hr align="left" width="100%">
</div>
<div class="SECT1">
DTD's and the Docbook modular stylesheets (or comparable alternatives),
and either <span class="APPLICATION">jade</span> or <span class=
"APPLICATION">openjade</span> (recommended) installed in order to build
- docs from source. Currently there is <a class="CITETITLE c2" href=
- "../user-manual/index.html" target="_top">user-manual</a>, <a class=
- "CITETITLE c2" href="../faq/index.html" target="_top">FAQ</a>, and, of
- course this, the <i class="CITETITLE">developer-manual</i> in this
+ docs from source. Currently there is <a href="../user-manual/index.html"
+ target="_top"><i class="CITETITLE">user-manual</i></a>, <a href=
+ "../faq/index.html" target="_top"><i class="CITETITLE">FAQ</i></a>, and,
+ of course this, the <i class="CITETITLE">developer-manual</i> in this
format. The <i class="CITETITLE">README</i>, <i class=
"CITETITLE">AUTHORS</i>, <i class="CITETITLE">INSTALL</i>, <i class=
"CITETITLE">privoxy.1</i> (man page), and <i class="CITETITLE">config</i>
"FILENAME">index.html</tt> (and a variation on this file, <tt class=
"FILENAME">privoxy-index.html</tt>, meant for inclusion with doc
packages), are maintained as SGML as well. <span class=
- "emphasis EMPHASIS c3">DO NOT edit these directly</span>. Edit the SGML
- source, or contact someone involved in the documentation.</p>
+ "emphasis"><i class="EMPHASIS">DO NOT edit these directly</i></span>.
+ Edit the SGML source, or contact someone involved in the
+ documentation.</p>
<p><tt class="FILENAME">config</tt> requires some special handling. The
reason it is maintained this way is so that the extensive comments in the
"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 <span class=
- "emphasis EMPHASIS c3">after</span> 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>
+ "emphasis"><i class="EMPHASIS">after</i></span> 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" id="SGML">3.1. Quickstart to Docbook
<table border="0">
<tbody>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><para></para></span>,
- paragraph delimiter. Most text needs to be within paragraph
- elements (there are some exceptions).</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><para></para></i></span>, paragraph
+ delimiter. Most text needs to be within paragraph elements (there
+ are some exceptions).</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><emphasis></emphasis></span>,
- the stylesheets make this italics.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><emphasis></emphasis></i></span>, the
+ stylesheets make this italics.</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><filename></filename></span>,
- files and directories.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><filename></filename></i></span>, files
+ and directories.</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><command></command></span>,
- command examples.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><command></command></i></span>, command
+ examples.</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><literallayout></literallayout></span>,
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><literallayout></literallayout></i></span>,
like <tt class="LITERAL"><pre></tt>, more or less.</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><itemizedlist></itemizedlist></span>,
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><itemizedlist></itemizedlist></i></span>,
list with bullets.</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><listitem></listitem></span>,
- member of the above.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><listitem></listitem></i></span>, member
+ of the above.</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><screen></screen></span>,
- screen output, implies <tt class=
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><screen></screen></i></span>, screen
+ output, implies <tt class=
"LITERAL"><literallayout></tt>.</td>
</tr>
<tr>
- <td><span class="emphasis EMPHASIS c3"><ulink
- url="example.com"></ulink></span>, like HTML <tt class=
- "LITERAL"><a></tt> tag.</td>
+ <td><span class="emphasis"><i class="EMPHASIS"><ulink
+ url="example.com"></ulink></i></span>, like HTML
+ <tt class="LITERAL"><a></tt> tag.</td>
</tr>
<tr>
- <td><span class=
- "emphasis EMPHASIS c3"><quote></quote></span>, for,
- doh, quoting text.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS"><quote></quote></i></span>, for, doh,
+ quoting text.</td>
</tr>
</tbody>
</table>
</li>
<li>
- <p>Tags delimiting a <span class=
- "emphasis EMPHASIS c3">block</span> of text (even small blocks)
- should be on their own line. Like:</p>
+ <p>Tags delimiting a <span class="emphasis"><i class=
+ "EMPHASIS">block</i></span> of text (even small blocks) should be
+ on their own line. Like:</p>
<p class="LITERALLAYOUT"> <para><br>
Some text goes here.<br>
with generic text, that is used by multiple docs. This way we can write
something once, and use it repeatedly without having to re-write the
same content over and over again. If editing such a file, keep in mind
- that it should be <span class="emphasis EMPHASIS c3">generic</span>.
- That is the purpose; so it can be used in varying contexts without
- additional modifications.</p>
+ that it should be <span class="emphasis"><i class=
+ "EMPHASIS">generic</i></span>. That is the purpose; so it can be used
+ in varying contexts without additional modifications.</p>
<p>We are also using what <span class="APPLICATION">Docbook</span>
calls <span class="QUOTE">"internal entities"</span>. These are like
<table border="0">
<tbody>
<tr>
- <td><span class="emphasis EMPHASIS c3">p-version</span>: the
- <span class="APPLICATION">Privoxy</span> version string, e.g.
- <span class="QUOTE">"3.0.20"</span>.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS">p-version</i></span>: the <span class=
+ "APPLICATION">Privoxy</span> version string, e.g.
+ <span class="QUOTE">"3.0.19"</span>.</td>
</tr>
<tr>
- <td><span class="emphasis EMPHASIS c3">p-status</span>: the
- project status, either <span class="QUOTE">"alpha"</span>,
- <span class="QUOTE">"beta"</span>, or <span class=
+ <td><span class="emphasis"><i class=
+ "EMPHASIS">p-status</i></span>: the project status, either
+ <span class="QUOTE">"alpha"</span>, <span class=
+ "QUOTE">"beta"</span>, or <span class=
"QUOTE">"stable"</span>.</td>
</tr>
<tr>
- <td><span class="emphasis EMPHASIS c3">p-not-stable</span>:
- use to conditionally include text in <span class="QUOTE">"not
- stable"</span> releases (e.g. <span class=
- "QUOTE">"beta"</span>).</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS">p-not-stable</i></span>: use to conditionally
+ include text in <span class="QUOTE">"not stable"</span>
+ releases (e.g. <span class="QUOTE">"beta"</span>).</td>
</tr>
<tr>
- <td><span class="emphasis EMPHASIS c3">p-stable</span>: just
- the opposite.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS">p-stable</i></span>: just the opposite.</td>
</tr>
<tr>
- <td><span class="emphasis EMPHASIS c3">p-text</span>: this
- doc is only generated as text.</td>
+ <td><span class="emphasis"><i class=
+ "EMPHASIS">p-text</i></span>: this doc is only generated as
+ text.</td>
</tr>
</tbody>
</table>
</div>
<div class="NAVFOOTER">
- <hr class="c1" width="100%">
+ <hr align="left" width="100%">
<table summary="Footer navigation table" width="100%" border="0"
cellpadding="0" cellspacing="0">
projects / privoxy.git / blobdiff