X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fdeveloper-manual%2Fdocumentation.html;h=83a505307ce6edc795f8162bf38efa243c52e2b9;hp=ba6f74146ec855895e4c42f07bc523f2dbbe040a;hb=659cbbc13f413ed0c5dacd4d03060f48eb500011;hpb=3c890b0540031fa87cc28514b3e4d0e23124fbcd diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html index ba6f7414..83a50530 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -1,4 +1,4 @@ - +
Other, less formal documents (e.g.
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 doc/webserver/*
Documentation writers should please make sure documents build - successfully before committing to CVS, if possible. + successfully before committing to Git, if possible.
How do you update the webserver (i.e. the pages on privoxy.org)? @@ -236,7 +226,7 @@ TYPE="1" > First, build the docs by running make - dok.
doc/webserver to the - sourceforge webserver via scp. + sourceforge webserver via ssh.Finished docs should be occasionally submitted to CVS +> Finished docs should be occasionally submitted to Git (doc/webserver/*/*.html. If not, you will likely generate errors. Example: <title>My - Title</title><title>My + Title</title>. They are also case-insensitive, but we strongly suggest using all lower case. This keeps compatibility with [Docbook] will not. Each section requires a <title><title> element, and at least one <para><para>. There is a limit of five section levels in Docbook, but generally three should be sufficient for our purposes.
<para></para><para></para>, paragraph delimiter. Most text needs to be within paragraph elements (there are some exceptions). @@ -399,7 +389,7 @@ CLASS="EMPHASIS" CLASS="emphasis" ><emphasis></emphasis><emphasis></emphasis>, the stylesheets make this italics. @@ -411,7 +401,7 @@ CLASS="EMPHASIS" CLASS="emphasis" ><filename></filename><filename></filename>, files and directories. <command></command><command></command>, command examples. <literallayout></literallayout><literallayout></literallayout>, like <pre><pre>, more or less. <itemizedlist></itemizedlist><itemizedlist></itemizedlist>, list with bullets. <listitem></listitem><listitem></listitem>, member of the above. <screen></screen><screen></screen>, screen output, implies <literallayout><literallayout>. <ulink url="example.com"></ulink><ulink url="example.com"></ulink>, like HTML <a><a> tag. <quote></quote><quote></quote>, for, doh, quoting text. Look at any of the existing docs for examples of all these and more. <para>
- <itemizedlist>
- <para>
- <listitem>
+> <para>
+ <itemizedlist>
+ <para>
+ <listitem>
Some text goes here in our list example.
- </listitem>
- </para>
- </itemizedlist>
- </para>
-
This makes it easier to find the text amongst the tags ;-)
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>.)
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:
My favorite site is <ulink url="http://example.com">here</ulink>. +> My favorite site is <ulink url="http://example.com">here</ulink>.
This will render as My favorite site is <ulink url="http://example.com">example.com</ulink>.
+> My favorite site is <ulink url="http://example.com">example.com</ulink>.
<!entity supported SYSTEM "supported.sgml"><!entity supported SYSTEM "supported.sgml">
version string, e.g. "3.0.27""3.0.34". PrevThe CVS RepositoryThe Git Repository