don't convert "&code;" strings in docbook generated html
[privoxy.git] / doc / source / ldp.dsl.in
1 <!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
2 <!ENTITY % html "IGNORE">
3 <![%html;[
4 <!ENTITY % print "IGNORE">
5 <!ENTITY docbook.dsl SYSTEM "@DKPREFIX@/html/docbook.dsl" CDATA dsssl>
6 ]]>
7 <!ENTITY % print "INCLUDE">
8 <![%print;[
9 <!ENTITY docbook.dsl SYSTEM "@DKPREFIX@/print/docbook.dsl" CDATA dsssl>
10 ]]>
11 ]>
12
13 <!--
14
15 ;; borrowed from the LDP stylesheet, with modifications, HB.
16 ;; Added support for css 03/20/02, and other mods.
17
18 -->
19
20 <style-sheet>
21
22 <style-specification id="print" use="docbook">
23 <style-specification-body>
24
25 ;; ==============================
26 ;; customize the print stylesheet
27 ;; ==============================
28 ;;
29 ;; see http://docbook.sourceforge.net/projects/dsssl/doc/print.html
30 ;;
31
32 (define %indent-screen-lines%
33   ;; Indent lines in a 'Screen'?
34   #t)
35
36 (define %callout-fancy-bug%
37   ;; Use fancy callout bugs?
38   #t)
39
40 (define %chap-app-running-heads%
41   ;; Generate running headers and footers on chapter-level elements?
42   #t)
43
44 (define %chap-app-running-head-autolabel%
45   ;; Put chapter labels in running heads?
46   #t)
47
48 ;; this is necessary because right now jadetex does not understand
49 ;; symbolic entities, whereas things work well with numeric entities.
50 (declare-characteristic preserve-sdata?
51   "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
52   #f)
53
54 ;; put the legal notice in a separate file
55 (define %generate-legalnotice-link%
56   #t)
57
58 ;; use graphics in admonitions, and have their path be "stylesheet-images"
59 ;; NO: they do not yet look very good
60 (define %admon-graphics-path%
61   "./stylesheet-images/")
62
63 (define %admon-graphics%
64   #f)
65
66 (define %funcsynopsis-decoration%
67   ;; make funcsynopsis look pretty
68   #t)
69
70 ;;(define %shade-verbatim%
71 ;;  #t)
72
73 (define %section-autolabel% #t)
74   ;; For enumerated sections (1.1, 1.1.1, 1.2, etc.)
75
76 ;; HB changed TOC depth to 3 levels.
77 (define (toc-depth nd)
78   3)
79
80 ;; HB added 03/20/02, see dbparam.dsl ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
81
82 (define %body-attr%
83   ;; REFENTRY body-attr
84   ;; PURP What attributes should be hung off of BODY?
85   ;; DESC
86   ;; A list of the BODY attributes that should be generated.
87   ;; The format is a list of lists, each interior list contains the
88   ;; name and value of a BODY attribute.
89   ;; /DESC
90   ;; AUTHOR N/A
91   ;; /REFENTRY
92   (list
93    (list "BGCOLOR" "#EEEEEE")
94    (list "TEXT" "#000000")
95    (list "LINK" "#0000FF")
96    (list "VLINK" "#840084")
97    (list "ALINK" "#0000FF")))
98
99 (define %stylesheet%
100   ;; REFENTRY stylesheet
101   ;; PURP Name of the stylesheet to use
102   ;; DESC
103   ;; The name of the stylesheet to place in the HTML LINK TAG, or '#f' to
104   ;; suppress the stylesheet LINK.
105   ;; /DESC
106   ;; AUTHOR N/A
107   ;; /REFENTRY
108   "../p_doc.css")
109
110 (define %stylesheet-type%
111   ;; REFENTRY stylesheet-type
112   ;; PURP The type of the stylesheet to use
113   ;; DESC
114   ;; The type of the stylesheet to place in the HTML LINK TAG.
115   ;; /DESC
116   ;; AUTHOR N/A
117   ;; /REFENTRY
118   "text/css")
119
120 (define %css-liststyle-alist%
121   ;; REFENTRY css-liststyle-alist
122   ;; PURP Map DocBook OVERRIDE and MARK attributes to CSS
123   ;; DESC
124   ;; If '%css-decoration%' is turned on then the list-style-type property of
125   ;; list items will be set to reflect the list item style selected in the
126   ;; DocBook instance.  This associative list maps the style type names used
127   ;; in your instance to the appropriate CSS names.  If no mapping exists,
128   ;; the name from the instance will be used.
129   ;; /DESC
130   ;; AUTHOR N/A
131   ;; /REFENTRY
132   '(("bullet" "disc")
133     ("box" "square")))
134
135 (define %css-decoration%
136   ;; REFENTRY css-decoration
137   ;; PURP Enable CSS decoration of elements
138   ;; DESC
139   ;; If '%css-decoration%' is turned on then HTML elements produced by the
140   ;; stylesheet may be decorated with STYLE attributes.  For example, the
141   ;; LI tags produced for list items may include a fragment of CSS in the
142   ;; STYLE attribute which sets the CSS property "list-style-type".
143   ;; /DESC
144   ;; AUTHOR N/A
145   ;; /REFENTRY
146   #t)
147
148 ;; swa1
149
150 (define %generate-part-toc%
151   #f)
152
153 (define %generate-article-toc%
154   ;; Should a Table of Contents be produced for Articles?
155   ;; If true, a Table of Contents will be generated for each 'Article'.
156   #t)
157
158 (define %generate-part-toc-on-titlepage%
159   ;; Should the Part TOC appear on the Part title page?
160   #f)
161
162 ;;Do you want a separate page for the title?
163 (define %generate-article-titlepage-on-separate-page%
164  #t)
165
166 ;;Do you want the article toc on the titlepage or separate?
167 (define %generate-article-toc-on-titlepage%
168  #f)
169
170 ;;Titlepage Separate?
171 ;; This is the one that makes TOC only on first page!! hal.
172 (define (chunk-skip-first-element-list)
173  '())
174
175 (define %body-start-indent%
176   ;; Default indent of body text
177   2pi)
178
179 (define %para-indent-firstpara%
180   ;; First line start-indent for the first paragraph
181   0pt)
182
183 ;; swa2
184
185 (define %para-indent%
186   ;; First line start-indent for paragraphs (other than the first)
187   0pt)
188
189 (define %block-start-indent%
190   ;; Extra start-indent for block-elements
191   2pt)
192
193 ;;Define distance between paragraphs
194 (define %para-sep%
195  (/ %bf-size% 2.0))
196
197 ;; with swa2 no effects
198
199 ;; swa3
200
201 ;;Define distance between block elements (figures, tables, etc.).
202 (define %block-sep%
203  (* %para-sep% 1.0))
204 ;; (* %para-sep% 2.0))
205
206 (define %hyphenation%
207   ;; Allow automatic hyphenation?
208   #t)
209
210 (define %left-margin% 5pi)
211 (define %right-margin% 5pi)
212 (define %top-margin% 5pi)
213 (define %bottom-margin% 5pi)
214 (define %footer-margin% 2pi)
215 (define %header-margin% 2pi)
216
217 (define %line-spacing-factor% 1.3)
218   ;; Factor used to calculate leading
219   ;; The leading is calculated by multiplying the current font size by the
220   ;; '%line-spacing-factor%'. For example, if the font size is 10pt and
221   ;; the '%line-spacing-factor%' is 1.1, then the text will be
222   ;; printed "10-on-11".
223
224 (define %head-before-factor%
225   ;; Factor used to calculate space above a title
226   ;; The space before a title is calculated by multiplying the font size
227   ;; used in the title by the '%head-before-factor%'.
228 ;;  0.75)
229   0.5)
230
231 (define %head-after-factor%
232   ;; Factor used to calculate space below a title
233   ;; The space after a title is calculated by multiplying the font size used
234   ;; in the title by the '%head-after-factor%'.
235   0.5)
236
237 (define %input-whitespace-treatment% 'collapse)
238
239 (define ($generate-article-lot-list$)
240   ;; Which Lists of Titles should be produced for Articles?
241   (list ))
242
243
244 </style-specification-body>
245 </style-specification>
246
247
248 <!--
249 ;; ===================================================
250 ;; customize the html stylesheet; borrowed from Cygnus
251 ;; at http://sourceware.cygnus.com/ (cygnus-both.dsl)
252 ;; ===================================================
253 -->
254
255 <style-specification id="html" use="docbook">
256 <style-specification-body>
257
258 ;; this is the 'html' portion of the stylesheet so we want to keep the
259 ;; ampersand-code strings and let the browser convert them to characters
260 (declare-characteristic preserve-sdata?
261   "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
262   #t)
263
264 ;; put the legal notice in a separate file
265 (define %generate-legalnotice-link%
266   #t)
267
268 ;; use graphics in admonitions, and have their path be "stylesheet-images"
269 ;; NO: they do not yet look very good
270 (define %admon-graphics-path%
271   "./stylesheet-images/")
272
273 (define %admon-graphics%
274   #f)
275
276 (define %funcsynopsis-decoration%
277   ;; make funcsynopsis look pretty
278   #t)
279
280 (define %html-ext%
281   ".html")
282
283 (define %generate-article-toc%
284   ;; Should a Table of Contents be produced for Articles?
285   ;; If true, a Table of Contents will be generated for each 'Article'.
286   #t)
287
288 ;; HB added next three statements 05/03/02.
289 ;;Do you want a separate page for the title?
290 (define %generate-article-titlepage-on-separate-page%
291  #t)
292
293 ;;Do you want the article toc on the titlepage or separate?
294 (define %generate-article-toc-on-titlepage%
295  #t)
296
297 ;;Titlepage Separate?
298 ;; This is the one that makes TOC only on first page!! hal.
299 (define (chunk-skip-first-element-list)
300  '())
301
302 (define %root-filename%
303   ;; The filename of the root HTML document (e.g, "index").
304   "index")
305
306 (define %generate-part-toc%
307   #t)
308
309 (define %shade-verbatim%
310   #t)
311
312 (define %use-id-as-filename%
313   ;; Use ID attributes as name for component HTML files?
314   #t)
315
316 (define %graphic-default-extension%
317   "gif")
318
319 (define %section-autolabel% #t)
320   ;; For enumerated sections (1.1, 1.1.1, 1.2, etc.)
321
322 ;; HB changed TOC depth to 3 levels.
323 (define (toc-depth nd)
324   3)
325
326 ;; HB added 03/20/02, see dbparam.dsl ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
327
328 (define %body-attr%
329   ;; REFENTRY body-attr
330   ;; PURP What attributes should be hung off of BODY?
331   ;; DESC
332   ;; A list of the the BODY attributes that should be generated.
333   ;; The format is a list of lists, each interior list contains the
334   ;; name and value of a BODY attribute.
335   ;; /DESC
336   ;; AUTHOR N/A
337   ;; /REFENTRY
338   (list
339    (list "BGCOLOR" "#EEEEEE")
340    (list "TEXT" "#000000")
341    (list "LINK" "#0000FF")
342    (list "VLINK" "#840084")
343    (list "ALINK" "#0000FF")))
344
345 (define %stylesheet%
346   ;; REFENTRY stylesheet
347   ;; PURP Name of the stylesheet to use
348   ;; DESC
349   ;; The name of the stylesheet to place in the HTML LINK TAG, or '#f' to
350   ;; suppress the stylesheet LINK.
351   ;; /DESC
352   ;; AUTHOR N/A
353   ;; /REFENTRY
354   "../p_doc.css")
355
356 (define %stylesheet-type%
357   ;; REFENTRY stylesheet-type
358   ;; PURP The type of the stylesheet to use
359   ;; DESC
360   ;; The type of the stylesheet to place in the HTML LINK TAG.
361   ;; /DESC
362   ;; AUTHOR N/A
363   ;; /REFENTRY
364   "text/css")
365
366 (define %css-liststyle-alist%
367   ;; REFENTRY css-liststyle-alist
368   ;; PURP Map DocBook OVERRIDE and MARK attributes to CSS
369   ;; DESC
370   ;; If '%css-decoration%' is turned on then the list-style-type property of
371   ;; list items will be set to reflect the list item style selected in the
372   ;; DocBook instance.  This associative list maps the style type names used
373   ;; in your instance to the appropriate CSS names.  If no mapping exists,
374   ;; the name from the instance will be used.
375   ;; /DESC
376   ;; AUTHOR N/A
377   ;; /REFENTRY
378   '(("bullet" "disc")
379     ("box" "square")))
380
381 (define %css-decoration%
382   ;; REFENTRY css-decoration
383   ;; PURP Enable CSS decoration of elements
384   ;; DESC
385   ;; If '%css-decoration%' is turned on then HTML elements produced by the
386   ;; stylesheet may be decorated with STYLE attributes.  For example, the
387   ;; LI tags produced for list items may include a fragment of CSS in the
388   ;; STYLE attribute which sets the CSS property "list-style-type".
389   ;; /DESC
390   ;; AUTHOR N/A
391   ;; /REFENTRY
392   #t)
393
394 ;; HB added 2008-01-19
395 (define %html-header-tags%
396   '(("META" ("HTTP-EQUIV" "Content-Type") ("CONTENT" "text/html;
397 charset=ISO-8859-1"))))
398
399 </style-specification-body>
400 </style-specification>
401
402
403 <style-specification id="html-notoc" use="html">
404 <style-specification-body>
405
406 ;; ===================================================
407 ;; Vairant without TOC for the Homepage --oes 24/05/02
408 ;; ===================================================
409
410 (define %generate-article-toc%
411   ;; Should a Table of Contents be produced for Articles?
412   ;; If true, a Table of Contents will be generated for each 'Article'.
413   #f)
414
415 </style-specification-body>
416 </style-specification>
417
418 <external-specification id="docbook" document="docbook.dsl">
419
420 </style-sheet>