1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Documentation Guidelines</title>
<meta name="GENERATOR" content=
"Modular DocBook HTML Stylesheet Version 1.79">
<link rel="HOME" title="Privoxy Developer Manual" href="index.html">
<link rel="PREVIOUS" title="The CVS Repository" href="cvs.html">
<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">
</head>
<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">
<tr>
<th colspan="3" align="center">Privoxy Developer Manual</th>
</tr>
<tr>
<td width="10%" align="left" valign="bottom"><a href="cvs.html"
accesskey="P">Prev</a></td>
<td width="80%" align="center" valign="bottom"></td>
<td width="10%" align="right" valign="bottom"><a href="coding.html"
accesskey="N">Next</a></td>
</tr>
</table>
<hr align="left" width="100%">
</div>
<div class="SECT1">
<h1 class="SECT1"><a name="DOCUMENTATION" id="DOCUMENTATION">3.
Documentation Guidelines</a></h1>
<p>All formal documents are maintained in Docbook SGML and located in the
<samp class="COMPUTEROUTPUT">doc/source/*</samp> directory. You will need
<a href="http://www.docbook.org" target="_top">Docbook</a>, the Docbook
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 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>
files are also now maintained as Docbook SGML. These files, when built,
in the top-level source directory are generated files! Also, the
<span class="APPLICATION">Privoxy</span> <tt class=
"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"><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
file mirror those in <i class="CITETITLE">user-manual</i>. But the
conversion 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 class="FILENAME">LICENSE</tt>)
are maintained as plain text files in the top-level source directory.</p>
<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 <tt class=
"FILENAME">doc/webserver/*</tt>.</p>
<p>Formal documents are built with the Makefile targets of <samp class=
"COMPUTEROUTPUT">make dok</samp>. The build process uses the document
SGML sources in <samp class="COMPUTEROUTPUT">doc/source/*/*</samp> to
update all text files in <samp class="COMPUTEROUTPUT">doc/text/</samp>
and to update all HTML documents in <samp class=
"COMPUTEROUTPUT">doc/webserver/</samp>.</p>
<p>Documentation writers should please make sure documents build
successfully before committing to CVS, if possible.</p>
<p>How do you update the webserver (i.e. the pages on privoxy.org)?</p>
<ol type="1">
<li>
<p>First, build the docs by running <samp class="COMPUTEROUTPUT">make
dok</samp>.</p>
</li>
<li>
<p>Run <samp class="COMPUTEROUTPUT">make webserver</samp> which
copies all files from <samp class=
"COMPUTEROUTPUT">doc/webserver</samp> to the sourceforge webserver
via scp.</p>
</li>
</ol>
<p>Finished docs should be occasionally submitted to CVS (<tt class=
"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"><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
and SGML</a></h2>
<p>If you are not familiar with SGML, it is a markup language similar
to HTML. Actually, not a mark up language per se, but a language used
to define markup languages. In fact, HTML is an SGML application. Both
will use <span class="QUOTE">"tags"</span> to format text and other
content. SGML tags can be much more varied, and flexible, but do much
of the same kinds of things. The tags, or <span class=
"QUOTE">"elements"</span>, are definable in SGML. There is no set
<span class="QUOTE">"standards"</span>. Since we are using <span class=
"APPLICATION">Docbook</span>, our tags are those that are defined by
<span class="APPLICATION">Docbook</span>. Much of how the finish
document is rendered is determined by the <span class=
"QUOTE">"stylesheets"</span>. The stylesheets determine how each tag
gets translated to HTML, or other formats.</p>
<p>Tags in Docbook SGML need to be always <span class=
"QUOTE">"closed"</span>. If not, you will likely generate errors.
Example: <tt class="LITERAL"><title>My Title</title></tt>.
They are also case-insensitive, but we strongly suggest using all lower
case. This keeps compatibility with [Docbook] <span class=
"APPLICATION">XML</span>.</p>
<p>Our documents use <span class="QUOTE">"sections"</span> for the most
part. Sections will be processed into HTML headers (e.g. <tt class=
"LITERAL">h1</tt> for <tt class="LITERAL">sect1</tt>). The <span class=
"APPLICATION">Docbook</span> stylesheets will use these to also
generate the Table of Contents for each doc. Our TOC's are set to a
depth of three. Meaning <tt class="LITERAL">sect1</tt>, <tt class=
"LITERAL">sect2</tt>, and <tt class="LITERAL">sect3</tt> will have TOC
entries, but <tt class="LITERAL">sect4</tt> will not. Each section
requires a <tt class="LITERAL"><title></tt> element, and at least
one <tt class="LITERAL"><para></tt>. There is a limit of five
section levels in Docbook, but generally three should be sufficient for
our purposes.</p>
<p>Some common elements that you likely will use:</p>
<table border="0">
<tbody>
<tr>
<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"><i class=
"EMPHASIS"><emphasis></emphasis></i></span>, the
stylesheets make this italics.</td>
</tr>
<tr>
<td><span class="emphasis"><i class=
"EMPHASIS"><filename></filename></i></span>, files
and directories.</td>
</tr>
<tr>
<td><span class="emphasis"><i class=
"EMPHASIS"><command></command></i></span>, command
examples.</td>
</tr>
<tr>
<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"><i class=
"EMPHASIS"><itemizedlist></itemizedlist></i></span>,
list with bullets.</td>
</tr>
<tr>
<td><span class="emphasis"><i class=
"EMPHASIS"><listitem></listitem></i></span>, member
of the above.</td>
</tr>
<tr>
<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"><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"><i class=
"EMPHASIS"><quote></quote></i></span>, for, doh,
quoting text.</td>
</tr>
</tbody>
</table>
<p>Look at any of the existing docs for examples of all these and
more.</p>
<p>You might also find <span class="QUOTE">"<a href=
"http://opensource.bureau-cornavin.com/crash-course/index.html" target=
"_top">Writing Documentation Using DocBook - A Crash Course</a>"</span>
useful.</p>
</div>
<div class="SECT2">
<h2 class="SECT2"><a name="DOCSTYLE" id="DOCSTYLE">3.2. <span class=
"APPLICATION">Privoxy</span> Documentation Style</a></h2>
<p>It will be easier if everyone follows a similar writing style. This
just makes it easier to read what someone else has written if it is all
done in a similar fashion.</p>
<p>Here it is:</p>
<ul>
<li>
<p>All tags should be lower case.</p>
</li>
<li>
<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>
</para><br>
</p>Tags marking
individual words, or few words, should be in-line:
<p class="LITERALLAYOUT">
Just to <emphasis>emphasize</emphasis>, some text goes here.<br>
</p>
</li>
<li>
<p>Tags should be nested and step indented for block text like:
(except in-line tags)</p>
<p class="LITERALLAYOUT"> <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>This makes it easier
to find the text amongst the tags ;-)
</li>
<li>
<p>Use white space to separate logical divisions within a document,
like between sections. Running everything together consistently
makes it harder to read and work on.</p>
</li>
<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>.)</p>
</li>
<li>
<p>We have an international audience. Refrain from slang, or
English idiosyncrasies (too many to list :). Humor also does not
translate well sometimes.</p>
</li>
<li>
<p>Try to keep overall line lengths in source files to 80
characters or less for obvious reasons. This is not always
possible, with lengthy URLs for instance.</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
this mistake:</p>
<p>My favorite site is <ulink
url="http://example.com">here</ulink>.</p>
<p>This will render as <span class="QUOTE">"My favorite site is
here"</span>, which is not real helpful in a text doc. Better like
this:</p>
<p>My favorite site is <ulink
url="http://example.com">example.com</ulink>.</p>
</li>
<li>
<p>All documents should be spell checked occasionally. <span class=
"APPLICATION">aspell</span> can check SGML with the <tt class=
"LITERAL">-H</tt> option. (<span class="APPLICATION">ispell</span>
I think too.)</p>
</li>
</ul>
</div>
<div class="SECT2">
<h2 class="SECT2"><a name="AEN208" id="AEN208">3.3. Privoxy Custom
Entities</a></h2>
<p><span class="APPLICATION">Privoxy</span> documentation is using a
number of customized <span class="QUOTE">"entities"</span> to
facilitate documentation maintenance.</p>
<p>We are using a set of <span class="QUOTE">"boilerplate"</span> files
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"><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
variables in programming. Well, sort of. For instance, we have the
<tt class="LITERAL">p-version</tt> entity that contains the current
<span class="APPLICATION">Privoxy</span> version string. You are
strongly encouraged to use these where possible. Some of these
obviously require re-setting with each release (done by the Makefile).
A sampling of custom entities are listed below. See any of the main
docs for examples.</p>
<ul>
<li>
<p>Re- <span class="QUOTE">"boilerplate"</span> text entities are
defined like:</p>
<p><tt class="LITERAL"><!entity supported SYSTEM
"supported.sgml"></tt></p>
<p>In this example, the contents of the file, <tt class=
"FILENAME">supported.sgml</tt> is available for inclusion anywhere
in the doc. To make this happen, just reference the now defined
entity: <tt class="LITERAL">&supported;</tt> (starts with an
ampersand and ends with a semi-colon), and the contents will be
dumped into the finished doc at that point.</p>
</li>
<li>
<p>Commonly used <span class="QUOTE">"internal
entities"</span>:</p>
<table border="0">
<tbody>
<tr>
<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.21"</span>.</td>
</tr>
<tr>
<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"><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"><i class=
"EMPHASIS">p-stable</i></span>: just the opposite.</td>
</tr>
<tr>
<td><span class="emphasis"><i class=
"EMPHASIS">p-text</i></span>: this doc is only generated as
text.</td>
</tr>
</tbody>
</table>
</li>
</ul>
<p>There are others in various places that are defined for a specific
purpose. Read the source!</p>
</div>
</div>
<div class="NAVFOOTER">
<hr align="left" width="100%">
<table summary="Footer navigation table" width="100%" border="0"
cellpadding="0" cellspacing="0">
<tr>
<td width="33%" align="left" valign="top"><a href="cvs.html"
accesskey="P">Prev</a></td>
<td width="34%" align="center" valign="top"><a href="index.html"
accesskey="H">Home</a></td>
<td width="33%" align="right" valign="top"><a href="coding.html"
accesskey="N">Next</a></td>
</tr>
<tr>
<td width="33%" align="left" valign="top">The CVS Repository</td>
<td width="34%" align="center" valign="top"> </td>
<td width="33%" align="right" valign="top">Coding Guidelines</td>
</tr>
</table>
</div>
</body>
</html>
|
