1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
5 >Documentation Guidelines</TITLE
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
10 TITLE="Privoxy Developer Manual"
11 HREF="index.html"><LINK
13 TITLE="The CVS Repository"
16 TITLE="Coding Guidelines"
17 HREF="coding.html"><LINK
20 HREF="../p_doc.css"><META
21 HTTP-EQUIV="Content-Type"
23 charset=ISO-8859-1"></HEAD
34 SUMMARY="Header navigation table"
43 >Privoxy Developer Manual</TH
80 >3. Documentation Guidelines</A
83 > All formal documents are maintained in Docbook SGML and located in the
85 CLASS="COMPUTEROUTPUT"
87 > directory. You will need
89 HREF="http://www.docbook.org"
93 DTD's and the Docbook modular stylesheets (or comparable alternatives),
101 > (recommended) installed in order to
102 build docs from source. Currently there is <A
103 HREF="../user-manual/index.html"
111 HREF="../faq/index.html"
140 > files are also now maintained as Docbook
141 SGML. These files, when built, in the top-level source directory are
142 generated files! Also, the <SPAN
149 variation on this file, <TT
151 >privoxy-index.html</TT
153 meant for inclusion with doc packages), are maintained as SGML as well.
158 >DO NOT edit these directly</I
160 >. Edit the SGML source, or
161 contact someone involved in the documentation.
167 > requires some special handling. The reason it
168 is maintained this way is so that the extensive comments in the file
172 >. But the conversion
173 process requires going from SGML to HTML to text to special formatting
174 required for the embedded comments. Some of this does not survive so
175 well. Especially some of the examples that are longer than 80 characters.
176 The build process for this file outputs to <TT
180 which should be reviewed for errors and mis-formatting. Once satisfied
181 that it is correct, then it should be hand copied to
188 > Other, less formal documents (e.g. <TT
192 maintained as plain text files in the top-level source directory.
195 > Packagers are encouraged to include this documentation. For those without
196 the ability to build the docs locally, text versions of each are kept in
197 CVS. HTML versions are also being kept in CVS under
204 > Formal documents are built with the Makefile targets of
206 CLASS="COMPUTEROUTPUT"
209 The build process uses the document SGML sources in
211 CLASS="COMPUTEROUTPUT"
212 >doc/source/*/*</SAMP
213 > to update all text files in
215 CLASS="COMPUTEROUTPUT"
217 > and to update all HTML
219 CLASS="COMPUTEROUTPUT"
220 >doc/webserver/</SAMP
224 > Documentation writers should please make sure documents build
225 successfully before committing to CVS, if possible.
228 > How do you update the webserver (i.e. the pages on privoxy.org)?
236 > First, build the docs by running <SAMP
237 CLASS="COMPUTEROUTPUT"
246 CLASS="COMPUTEROUTPUT"
247 >make webserver</SAMP
250 CLASS="COMPUTEROUTPUT"
253 sourceforge webserver via scp.
258 > Finished docs should be occasionally submitted to CVS
261 >doc/webserver/*/*.html</TT
262 >) so that those without
263 the ability to build them locally, have access to them if needed.
264 This is especially important just prior to a new release! Please
275 other release specific data in <TT
279 updated (this is done just prior to a new release).
287 >3.1. Quickstart to Docbook and SGML</A
290 > If you are not familiar with SGML, it is a markup language similar to HTML.
291 Actually, not a mark up language per se, but a language used to define
292 markup languages. In fact, HTML is an SGML application. Both will use
296 > to format text and other content. SGML tags can be much
297 more varied, and flexible, but do much of the same kinds of things. The tags,
301 >, are definable in SGML. There is no set
305 >. Since we are using
309 >, our tags are those that are defined by
313 >. Much of how the finish document is
314 rendered is determined by the <SPAN
318 The stylesheets determine how each tag gets translated to HTML, or other
321 > Tags in Docbook SGML need to be always <SPAN
325 will likely generate errors. Example: <TT
328 Title</title></TT
329 >. They are also case-insensitive, but we
330 strongly suggest using all lower case. This keeps compatibility with
336 > Our documents use <SPAN
339 > for the most part. Sections
340 will be processed into HTML headers (e.g. <TT
351 will use these to also generate the Table of Contents for each doc. Our
352 TOC's are set to a depth of three. Meaning <TT
366 > will not. Each section requires
370 > element, and at least one
374 >. There is a limit of five section
375 levels in Docbook, but generally three should be sufficient for our
378 > Some common elements that you likely will use:</P
390 ><para></para></I
392 >, paragraph delimiter. Most
393 text needs to be within paragraph elements (there are some exceptions).
402 ><emphasis></emphasis></I
414 ><filename></filename></I
416 >, files and directories.
425 ><command></command></I
436 ><literallayout></literallayout></I
451 ><itemizedlist></itemizedlist></I
453 >, list with bullets.
462 ><listitem></listitem></I
464 >, member of the above.
473 ><screen></screen></I
475 >, screen output, implies
478 ><literallayout></TT
488 ><ulink url="example.com"></ulink></I
503 ><quote></quote></I
505 >, for, doh, quoting text.
513 > Look at any of the existing docs for examples of all these and more.</P
515 > You might also find
520 HREF="https://web.archive.org/web/20160315230758/http://opensource.bureau-cornavin.com/crash-course/index.html"
522 > Writing Documentation Using DocBook - A Crash Course</A
535 > Documentation Style</A
538 > It will be easier if everyone follows a similar writing style. This
539 just makes it easier to read what someone else has written if it
540 is all done in a similar fashion.
550 > All tags should be lower case.
555 > Tags delimiting a <SPAN
561 > of text (even small
562 blocks) should be on their own line. Like:
565 CLASS="LITERALLAYOUT"
566 > <para><br>
567 Some text goes here.<br>
568 </para><br>
569 </P
571 > Tags marking individual words, or few words, should be in-line:
574 CLASS="LITERALLAYOUT"
575 > Just to <emphasis>emphasize</emphasis>, some text goes here.<br>
576 </P
580 > Tags should be nested and step indented for block text like: (except
584 CLASS="LITERALLAYOUT"
585 > <para><br>
586 <itemizedlist><br>
587 <para><br>
588 <listitem><br>
589 Some text goes here in our list example.<br>
590 </listitem><br>
591 </para><br>
592 </itemizedlist><br>
593 </para><br>
594 </P
596 > This makes it easier to find the text amongst the tags ;-)
601 > Use white space to separate logical divisions within a document,
602 like between sections. Running everything together consistently
603 makes it harder to read and work on.
608 > Do not hesitate to make comments. Comments can either use the
609 <comment> element, or the <!-- --> style comment
610 familiar from HTML. (Note in Docbook v4.x <comment> is
611 replaced by <remark>.)
616 > We have an international audience. Refrain from slang, or English
617 idiosyncrasies (too many to list :). Humor also does not translate
623 > Try to keep overall line lengths in source files to 80 characters or less
624 for obvious reasons. This is not always possible, with lengthy URLs for
630 > Our documents are available in differing formats. Right now, they
631 are just plain text and/or HTML, but others are always a
632 future possibility. Be careful with URLs (<ulink>), and avoid
636 > My favorite site is <ulink url="http://example.com">here</ulink>.
639 > This will render as <SPAN
641 >"My favorite site is here"</SPAN
643 not real helpful in a text doc. Better like this:
646 > My favorite site is <ulink url="http://example.com">example.com</ulink>.
651 > All documents should be spell checked occasionally.
655 > can check SGML with the
674 >3.3. Privoxy Custom Entities</A
680 > documentation is using
681 a number of customized <SPAN
685 documentation maintenance.
688 > We are using a set of <SPAN
691 > files with generic text,
692 that is used by multiple docs. This way we can write something once, and use
693 it repeatedly without having to re-write the same content over and over again.
694 If editing such a file, keep in mind that it should be
701 >. That is the purpose; so it can be used in varying
702 contexts without additional modifications.
705 > We are also using what <SPAN
711 >"internal entities"</SPAN
712 >. These are like variables in
713 programming. Well, sort of. For instance, we have the
717 > entity that contains the current
721 > version string. You are strongly
722 encouraged to use these where possible. Some of these obviously
723 require re-setting with each release (done by the Makefile). A sampling of
724 custom entities are listed below. See any of the main docs for examples.
734 > text entities are defined like:
739 ><!entity supported SYSTEM "supported.sgml"></TT
743 > In this example, the contents of the file,
747 > is available for inclusion anywhere
748 in the doc. To make this happen, just reference the now defined
752 > (starts with an ampersand
753 and ends with a semi-colon), and the contents will be dumped into
754 the finished doc at that point.
759 > Commonly used <SPAN
761 >"internal entities"</SPAN
781 version string, e.g. <SPAN
795 >: the project status, either
816 >: use to conditionally include
820 > releases (e.g. <SPAN
834 >: just the opposite.
845 >: this doc is only generated as text.
855 > There are others in various places that are defined for a specific
856 purpose. Read the source!
865 SUMMARY="Footer navigation table"
904 >The CVS Repository</TD
914 >Coding Guidelines</TD
projects / privoxy.git / blob