X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fdeveloper-manual%2Fdocumentation.html;h=f1bfe610969b1b7ac9f4b2ae1e81e9850b84f62a;hp=9eeab323abcc7eef1987876c4d5b00e9d856a934;hb=5700aead3098beb0cc5a02bc0034a0d4194774a6;hpb=93a7bf2ca37f91d1ba013c7d5ba2a2da9fbd0191 diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html index 9eeab323..f1bfe610 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -1,23 +1,26 @@ +
Next | 4. Documentation Guidelines3. Documentation Guidelines
<para></para>, paragraph delimiter. Most - text needs to be within paragraph elements (there are some exceptions). - |
<emphasis></emphasis>, the stylesheets make this - italics. - | , the stylesheets + make this italics. +
<filename></filename>, files and directories. - |
<command></command>, command examples. - |
<literallayout></literllayout><literallayout></literallayout>, like - <pre>, more or less. - |
<itemizedlist></itemizedlist>, list with bullets. - |
<listitem></listitem>, member of the above. - |
<screen></screen>, screen output, implies - <literallayout>. - |
<ulink url="example.com"></ulink>, like - HTML <a> tag. - |
<quote></quote>, for, doh, quoting text. - |
Look at any of the existing docs for examples of all these and more.
You might also find "Writing Documentation + Using DocBook - A Crash Course" useful.
Tags delimiting a Tags delimiting a block of text (even small blocks) should be on their own line. Like:
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.
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.
Our documents are available in differing formats. Right now, they - are just plain text, and HTML, but PDF, and others is 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:
generic. That is the purpose; so it can be used in varying contexts without additional modifications.
Re-cyclable Re- "boilerplate" text entities are defined like:
@@ -669,24 +790,30 @@ BORDER="0"
> p-version: the Privoxy
version string, e.g. "2.9.14""3.0.18".
p-status: the project status, either
p-not-stable: use to conditionally include
text in p-stable: just the opposite.
p-text: this doc is only generated as text.
Prev
Home Next Quickstart to Privoxy DevelopmentThe CVS Repository