File: custom.html

package info (click to toggle)
docbook-dsssl-doc 1.79-7
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 3,724 kB
  • sloc: makefile: 2
file content (641 lines) | stat: -rw-r--r-- 11,806 bytes parent folder | download | duplicates (5)
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Customizing the Stylesheets</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Modular DocBook Stylesheets"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Installation and Setup"
HREF="install.html"><LINK
REL="NEXT"
TITLE="The Print Stylesheet"
HREF="print.html"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
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"
>The Modular DocBook Stylesheets</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="install.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="print.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="CUSTOMIZE"
></A
>Chapter 3. Customizing the Stylesheets</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="custom.html#AEN175"
>Deriving Your Own Stylesheet</A
></DT
><DT
><A
HREF="custom.html#AEN191"
>A Single Stylesheet for Both Print and HTML</A
></DT
><DT
><A
HREF="custom.html#AEN205"
>Customizing the Title Page</A
></DT
><DT
><A
HREF="custom.html#AEN297"
>Using the Stylesheets with XML</A
></DT
></DL
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN175"
>Deriving Your Own Stylesheet</A
></H1
><P
>The best way to customize the stylesheets is to write your own &ldquo;driver&rdquo;
file; this is a document which contains your local modifications to the stylesheet
and then includes the stylesheet from the standard distribution by reference.
This allows you to make local changes and extensions without modifying the
distributed files, which makes upgrading to the next release much, much simpler.</P
><P
>The basic driver file looks like this:<PRE
CLASS="SCREEN"
>&lt;!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
&lt;!ENTITY dbstyle SYSTEM "docbook.dsl" CDATA DSSSL&#62;
]&#62;

&lt;style-sheet&#62;
&lt;style-specification use="docbook"&#62;
&lt;style-specification-body&#62;

;; your stuff goes here...

&lt;/style-specification-body&#62;
&lt;/style-specification&#62;
&lt;external-specification id="docbook" document="dbstyle"&#62;
&lt;/style-sheet&#62;&#13;</PRE
></P
><P
>Make sure that you specify, in the system identifier, the full path
to the <TT
CLASS="FILENAME"
>docbook.dsl</TT
> file that you want to customize; for
example, <TT
CLASS="FILENAME"
>\docbook\print\docbook.dsl</TT
>.</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>The next stylesheet release will probably use public identifiers
to locate the stylesheets, which will simplify this problem a bit (at the
cost, naturally, of a little more complexity elsewhere; sigh).</P
></BLOCKQUOTE
></DIV
><P
>You can add your own definitions, or redefinitions, of stylesheet rules
and parameters where<PRE
CLASS="SCREEN"
>;; your stuff goes here...</PRE
> occurs in
the example above.</P
><P
>The <TT
CLASS="FILENAME"
>plain.dsl</TT
> stylesheet in the <TT
CLASS="FILENAME"
>docbook/print</TT
> directory is a customization of the <TT
CLASS="FILENAME"
>docbook.dsl</TT
>
print stylesheet. It turns off title page and TOC generation.</P
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN191"
>A Single Stylesheet for Both Print and HTML</A
></H1
><P
>A DSSSL <CODE
CLASS="SGMLTAG"
>style-sheet</CODE
> consists of one or more <CODE
CLASS="SGMLTAG"
>style-specification</CODE
>s. This allows one to build a single stylesheet
that can format with either the print or HTML backends.</P
><P
>All you need is a customization skeleton that looks like this:</P
><PRE
CLASS="SCREEN"
>&lt;!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
&lt;!ENTITY % html "IGNORE"&#62;
&lt;![%html;[
&lt;!ENTITY % print "IGNORE"&#62;
&lt;!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" CDATA dsssl&#62;
]]&#62;
&lt;!ENTITY % print "INCLUDE"&#62;
&lt;![%print;[
&lt;!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook Print Stylesheet//EN" CDATA dsssl&#62;
]]&#62;
]&#62;
&lt;style-sheet&#62;
&lt;style-specification id="print" use="docbook"&#62;
&lt;style-specification-body&#62; 

;; customize the print stylesheet

&lt;/style-specification-body&#62;
&lt;/style-specification&#62;
&lt;style-specification id="html" use="docbook"&#62;
&lt;style-specification-body&#62; 

;; customize the html stylesheet

&lt;/style-specification-body&#62;
&lt;/style-specification&#62;
&lt;external-specification id="docbook" document="docbook.dsl"&#62;
&lt;/style-sheet&#62;</PRE
><P
>If this is <TT
CLASS="FILENAME"
>both.dsl</TT
>, I can format my document using
the print stylesheet by running<PRE
CLASS="SCREEN"
>jade -t rtf -d both.dsl#print file.sgm</PRE
>and using the HTML stylesheet by running<PRE
CLASS="SCREEN"
>jade -t sgml -i html -d both.dsl#html file.sgm</PRE
>which is kindof neat. (I've built some additional machinery on top
of this to make the selection automatic from within <A
HREF="http://www.arbortext.com/"
TARGET="_top"
>ADEPT</A
> and a shell script that I use.)</P
><P
>An alternative method for doing this is simply to use marked sections
in the stylesheet, like this:
<PRE
CLASS="SCREEN"
>&lt;!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
&lt;!ENTITY % html "IGNORE"&#62;
&lt;![%html;[
&lt;!ENTITY % print "IGNORE"&#62;
&lt;!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" CDATA dsssl&#62;
]]&#62;
&lt;!ENTITY % print "INCLUDE"&#62;
&lt;![%print;[
&lt;!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook Print Stylesheet//EN" CDATA dsssl&#62;
]]&#62;
]&#62;
&lt;style-sheet&#62;
&lt;style-specification use="docbook"&#62;
&lt;style-specification-body&#62; 

;; common customization can go here

&lt;![%print;[

;; customize the print stylesheet here

]]&gt;

&lt;![%html;[

;; customize the html stylesheet here

]]&gt;

&lt;/style-specification-body&#62;
&lt;/style-specification&#62;
&lt;external-specification id="docbook" document="docbook.dsl"&#62;
&lt;/style-sheet&#62;</PRE
></P
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN205"
>Customizing the Title Page</A
></H1
><P
>Titlepages are controlled by several variables:<P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>%generate-<TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage%</TT
></DT
><DD
><P
>Controls whether or not a titlepage is generated. If, for
example, <TT
CLASS="LITERAL"
>%generate-book-titlepage%</TT
> is true, a titlepage
will be generated for <CODE
CLASS="SGMLTAG"
>Book</CODE
>s.</P
></DD
><DT
><TT
CLASS="LITERAL"
><TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage-recto-elements</TT
></DT
><DD
><P
>Specifies the elements which should occur
on the titlepage recto. This variable is a list of GIs. For example, if <TT
CLASS="LITERAL"
>book-titlepage-recto-elements</TT
> is <TT
CLASS="LITERAL"
>'("TITLE" "SUBTITLE" "AUTHOR")</TT
>, then the <CODE
CLASS="SGMLTAG"
>Title</CODE
>, <CODE
CLASS="SGMLTAG"
>SubTitle</CODE
>,
and <CODE
CLASS="SGMLTAG"
>Author</CODE
> elements in the division or component's <CODE
CLASS="SGMLTAG"
>*Info</CODE
> element will appear on the <CODE
CLASS="SGMLTAG"
>Book</CODE
>'s titlepage
recto.</P
></DD
><DT
><TT
CLASS="LITERAL"
><TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage-verso-elements</TT
></DT
><DD
><P
>Specifies the elements which should occur
on the titlepage verso.</P
></DD
><DT
><TT
CLASS="LITERAL"
>%titlepage-in-info-order%</TT
></DT
><DD
><P
>The content of the titlepage is drawn from the <CODE
CLASS="SGMLTAG"
>*Info</CODE
> element
at the beginning of a division or component. If <TT
CLASS="LITERAL"
>%titlepage-in-info-order%</TT
> is true, the elements on the titlepage will occur in the order
in which they appear in the <CODE
CLASS="SGMLTAG"
>*Info</CODE
> element. Otherwise, the
elements occur in a fixed order given by the <TT
CLASS="LITERAL"
><TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage-<TT
CLASS="REPLACEABLE"
><I
>side</I
></TT
>-elemnts</TT
>.</P
></DD
><DT
><TT
CLASS="LITERAL"
>%generate-<TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-toc-on-titlepage%</TT
></DT
><DD
><P
>For some elements, such as <CODE
CLASS="SGMLTAG"
>Part</CODE
>s, it may make sense to place the TOC for that element (if it is
generated) on the same page sequence as the titlepage. If <TT
CLASS="LITERAL"
>%generate-<TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-toc-on-titlepage%</TT
> is true, that's what will
be done.</P
></DD
><DT
><TT
CLASS="LITERAL"
>%generate-partintro-on-titlepage%</TT
></DT
><DD
><P
><CODE
CLASS="SGMLTAG"
>Part</CODE
>s and <CODE
CLASS="SGMLTAG"
>Reference</CODE
>s can begin
with a <CODE
CLASS="SGMLTAG"
>PartIntro</CODE
>. If <TT
CLASS="LITERAL"
>%generate-partintro-on-titlepage%</TT
> is true, the content of the <CODE
CLASS="SGMLTAG"
>PartIntro</CODE
> will occur
on the same page sequence as the titlepage.</P
></DD
></DL
></DIV
></P
><P
>The most common customization is probably setting <TT
CLASS="LITERAL"
>%generate-<TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage%</TT
> to true and changing the list of
elements in <TT
CLASS="LITERAL"
><TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage-recto-elements</TT
> and <TT
CLASS="LITERAL"
><TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage-verso-elements</TT
></P
><P
>There are a few other functions that you may wish to change:<P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>(<TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage-before node side)</TT
></DT
><DD
><P
>This function is called before each new type
of element on the titlepage (before the first <CODE
CLASS="SGMLTAG"
>Title</CODE
>, before
the first <CODE
CLASS="SGMLTAG"
>SubTitle</CODE
>, etc.). The <TT
CLASS="LITERAL"
>node</TT
>
will contain the element that will appear on the titlepage next and <TT
CLASS="LITERAL"
>side</TT
> will be either <TT
CLASS="LITERAL"
>'recto</TT
> or <TT
CLASS="LITERAL"
>'verso</TT
>.</P
></DD
><DT
><TT
CLASS="LITERAL"
>(<TT
CLASS="REPLACEABLE"
><I
>element</I
></TT
>-titlepage-<TT
CLASS="REPLACEABLE"
><I
>component</I
></TT
> node side)</TT
></DT
><DD
><P
>This function
is called for each element on the titlepage. For example, the <CODE
CLASS="SGMLTAG"
>Abstract</CODE
> on a <CODE
CLASS="SGMLTAG"
>Book</CODE
> titlepage is printed by the <TT
CLASS="LITERAL"
>book-titlepage-abstract</TT
> function.</P
></DD
></DL
></DIV
></P
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN297"
>Using the Stylesheets with XML</A
></H1
><P
>This is just a placeholder. This needs to be written. Basically, you
just need to use <TT
CLASS="FILENAME"
>catalog</TT
> files to make sure that the
XML instances and the stylesheets get parsed with the correct declarations.</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="install.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="print.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Installation and Setup</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>The Print Stylesheet</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>