-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
-TITLE="The CVS Repository"
-HREF="cvs.html"><LINK
+TITLE="The Git Repository"
+HREF="git.html"><LINK
REL="NEXT"
TITLE="Coding Guidelines"
HREF="coding.html"><LINK
ALIGN="left"
VALIGN="bottom"
><A
-HREF="cvs.html"
+HREF="git.html"
ACCESSKEY="P"
>Prev</A
></TD
>doc/source/*</SAMP
> directory. You will need
<A
-HREF="http://www.docbook.org"
+HREF="https://www.docbook.org/"
TARGET="_top"
>Docbook</A
>, the Docbook
>,
<I
CLASS="CITETITLE"
->privoxy.1</I
+>privoxy.8</I
> (man page), and
<I
CLASS="CITETITLE"
process requires going from SGML to HTML to text to special formatting
required for the embedded comments. Some of this does not survive so
well. Especially some of the examples that are longer than 80 characters.
- The build process for this file outputs to <TT
-CLASS="FILENAME"
->config.new</TT
->,
- which should be reviewed for errors and mis-formatting. Once satisfied
- that it is correct, then it should be hand copied to
- <TT
-CLASS="FILENAME"
->config</TT
->.
</P
><P
> Other, less formal documents (e.g. <TT
><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 being kept in CVS under
+ Git. HTML versions are also being kept in Git under
<TT
CLASS="FILENAME"
>doc/webserver/*</TT
</P
><P
> Documentation writers should please make sure documents build
- successfully before committing to CVS, if possible.
+ successfully before committing to Git, if possible.
</P
><P
> How do you update the webserver (i.e. the pages on privoxy.org)?
> First, build the docs by running <SAMP
CLASS="COMPUTEROUTPUT"
>make
- dok</SAMP
+ dok dok-tidy</SAMP
>.
</P
></LI
CLASS="COMPUTEROUTPUT"
>doc/webserver</SAMP
> to the
- sourceforge webserver via scp.
+ sourceforge webserver via ssh.
</P
></LI
></OL
><P
-> Finished docs should be occasionally submitted to CVS
+> Finished docs should be occasionally submitted to Git
(<TT
CLASS="FILENAME"
>doc/webserver/*/*.html</TT
>. If not, you
will likely generate errors. Example: <TT
CLASS="LITERAL"
-><title>My
- Title</title></TT
+><title>My
+ Title</title></TT
>. They are also case-insensitive, but we
strongly suggest using all lower case. This keeps compatibility with
[Docbook] <SPAN
> will not. Each section requires
a <TT
CLASS="LITERAL"
-><title></TT
+><title></TT
> element, and at least one
<TT
CLASS="LITERAL"
-><para></TT
+><para></TT
>. There is a limit of five section
levels in Docbook, but generally three should be sufficient for our
purposes.</P
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><para></para></I
+><para></para></I
></SPAN
>, paragraph delimiter. Most
text needs to be within paragraph elements (there are some exceptions).
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><emphasis></emphasis></I
+><emphasis></emphasis></I
></SPAN
>, the stylesheets
make this italics.
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><filename></filename></I
+><filename></filename></I
></SPAN
>, files and directories.
</TD
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><command></command></I
+><command></command></I
></SPAN
>, command examples.
</TD
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><literallayout></literallayout></I
+><literallayout></literallayout></I
></SPAN
>, like
<TT
CLASS="LITERAL"
-><pre></TT
+><pre></TT
>, more or less.
</TD
></TR
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><itemizedlist></itemizedlist></I
+><itemizedlist></itemizedlist></I
></SPAN
>, list with bullets.
</TD
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><listitem></listitem></I
+><listitem></listitem></I
></SPAN
>, member of the above.
</TD
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><screen></screen></I
+><screen></screen></I
></SPAN
>, screen output, implies
<TT
CLASS="LITERAL"
-><literallayout></TT
+><literallayout></TT
>.
</TD
></TR
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><ulink url="example.com"></ulink></I
+><ulink url="example.com"></ulink></I
></SPAN
>, like
HTML <TT
CLASS="LITERAL"
-><a></TT
+><a></TT
> tag.
</TD
></TR
CLASS="emphasis"
><I
CLASS="EMPHASIS"
-><quote></quote></I
+><quote></quote></I
></SPAN
>, for, doh, quoting text.
</TD
> Look at any of the existing docs for examples of all these and more.</P
><P
> You might also find
-
+
<SPAN
CLASS="QUOTE"
>"<A
</P
><P
CLASS="LITERALLAYOUT"
-> <para><br>
+> <para><br>
Some text goes here.<br>
- </para><br>
- </P
+ </para></P
><P
> Tags marking individual words, or few words, should be in-line:
</P
><P
CLASS="LITERALLAYOUT"
-> Just to <emphasis>emphasize</emphasis>, some text goes here.<br>
- </P
+> Just to <emphasis>emphasize</emphasis>, some text goes here.</P
></LI
><LI
><P
</P
><P
CLASS="LITERALLAYOUT"
-> <para><br>
- <itemizedlist><br>
- <para><br>
- <listitem><br>
+> <para><br>
+ <itemizedlist><br>
+ <para><br>
+ <listitem><br>
Some text goes here in our list example.<br>
- </listitem><br>
- </para><br>
- </itemizedlist><br>
- </para><br>
- </P
+ </listitem><br>
+ </para><br>
+ </itemizedlist><br>
+ </para></P
><P
> This makes it easier to find the text amongst the tags ;-)
</P
><LI
><P
> Do not hesitate to make comments. Comments can either use the
- <comment> element, or the <!-- --> style comment
- familiar from HTML. (Note in Docbook v4.x <comment> is
- replaced by <remark>.)
+ <comment> element, or the <!-- --> style comment
+ familiar from HTML. (Note in Docbook v4.x <comment> is
+ replaced by <remark>.)
</P
></LI
><LI
><P
> Our documents are available in differing formats. Right now, they
are just plain text and/or HTML, but others are always a
- future possibility. Be careful with URLs (<ulink>), and avoid
+ future possibility. Be careful with URLs (<ulink>), and avoid
this mistake:
</P
><P
-> My favorite site is <ulink url="http://example.com">here</ulink>.
+> My favorite site is <ulink url="http://example.com">here</ulink>.
</P
><P
> This will render as <SPAN
not real helpful in a text doc. Better like this:
</P
><P
-> My favorite site is <ulink url="http://example.com">example.com</ulink>.
+> My favorite site is <ulink url="http://example.com">example.com</ulink>.
</P
></LI
><LI
><H2
CLASS="SECT2"
><A
-NAME="AEN206"
+NAME="CUSTOM-ENTITIES"
>3.3. Privoxy Custom Entities</A
></H2
><P
><P
> <TT
CLASS="LITERAL"
-><!entity supported SYSTEM "supported.sgml"></TT
+><!entity supported SYSTEM "supported.sgml"></TT
>
</P
><P
>
version string, e.g. <SPAN
CLASS="QUOTE"
->"3.0.27"</SPAN
+>"3.0.34"</SPAN
>.
</TD
></TR
ALIGN="left"
VALIGN="top"
><A
-HREF="cvs.html"
+HREF="git.html"
ACCESSKEY="P"
>Prev</A
></TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
->The CVS Repository</TD
+>The Git Repository</TD
><TD
WIDTH="34%"
ALIGN="center"
projects / privoxy.git / blobdiff