make dinstall: skip mediawiki deb for now
[pve-docs.git] / asciidoc / pve-docbook.conf
1 #
2 # docbook45.conf
3 #
4 # Asciidoc DocBook 4.5 configuration file.
5 #
6 # modified for Proxmox VE docs
7 # - add thumbnail attribute
8
9 [miscellaneous]
10 outfilesuffix=.xml
11 # Printable page width and units.
12 # Used to calculate DocBook CALS tables absolute column and table widths.
13 pagewidth=425
14 pageunits=*
15
16 [attributes]
17 basebackend=docbook
18 basebackend-docbook=
19 basebackend-docbook45=
20 # For backward compatibility (docbook backend was renamed to docbook45 at 8.6.2)
21 backend-docbook=
22 # toc and numbered are set to maintain original default behavior.
23 toc=
24 numbered=
25
26 [replacements2]
27 # Line break markup. Custom processing instruction in fo.xsl.
28 (?m)^(.*)\s\+$=\1<?asciidoc-br?>
29
30 [replacements]
31 ifdef::asciidoc7compatible[]
32 # Superscripts.
33 \^(.+?)\^=<superscript>\1</superscript>
34 # Subscripts.
35 ~(.+?)~=<subscript>\1</subscript>
36 endif::asciidoc7compatible[]
37
38 [ruler-blockmacro]
39 # Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl.
40 <simpara><?asciidoc-hr?></simpara>
41
42 [pagebreak-blockmacro]
43 # Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl.
44 <simpara><?asciidoc-pagebreak?></simpara>
45
46 [blockdef-pass]
47 latexmath-style=template="latexmathblock",subs=()
48
49 [macros]
50 # math macros.
51 (?su)[\\]?(?P<name>latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[]
52 (?u)^(?P<name>latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[]
53
54 [latexmath-inlinemacro]
55 <inlineequation>
56 <alt><![CDATA[{passtext}]]></alt>
57 <inlinemediaobject><textobject><phrase></phrase></textobject></inlinemediaobject>
58 </inlineequation>
59
60 [latexmath-blockmacro]
61 <informalequation>
62 <alt><![CDATA[{passtext}]]></alt>
63 <mediaobject><textobject><phrase></phrase></textobject></mediaobject>
64 </informalequation>
65
66 [latexmathblock]
67 <equation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title>
68 {title%}<informalequation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
69 <alt><![CDATA[|]]></alt>
70 <mediaobject><textobject><phrase></phrase></textobject></mediaobject>
71 {title#}</equation>
72 {title%}</informalequation>
73
74 [image-inlinemacro]
75 <inlinemediaobject>
76   <imageobject>
77   <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}/>
78   </imageobject>
79   <textobject><phrase>{alt={target}}</phrase></textobject>
80 </inlinemediaobject>
81
82 [image-blockmacro]
83 <figure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"}><title>{title}</title>
84 {title%}<informalfigure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{pgwide-option?<?dbfo pgwide="1"?>}
85 # DocBook XSL Stylesheets custom processing instructions.
86 <?dbfo keep-together="{breakable-option#auto}"?>
87 <?dbfo keep-together="{unbreakable-option#always}"?>
88 <mediaobject>
89   <imageobject>
90   <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}{scaledwidth? width="{scaledwidth}" scalefit="1"}{align? align="{align}"}/>
91   </imageobject>
92   <textobject><phrase>{alt={target}}</phrase></textobject>
93 </mediaobject>
94 {title#}</figure>
95 {title%}</informalfigure>
96
97 [indexterm-inlinemacro]
98 # Index term.
99 # Generate separate index entries for primary, secondary and tertiary
100 # descriptions.
101 # Primary only.
102 {2%}<indexterm>
103 {2%}  <primary>{1}</primary>
104 {2%}</indexterm>
105 # Primary and secondary.
106 {2#}{3%}<indexterm>
107 {2#}{3%}  <primary>{1}</primary><secondary>{2}</secondary>
108 {2#}{3%}</indexterm>
109 {2#}{3%}<indexterm>
110 {2#}{3%}  <primary>{2}</primary>
111 {2#}{3%}</indexterm>
112 # Primary, secondary and tertiary.
113 {3#}<indexterm>
114   <primary>{1}</primary><secondary>{2}</secondary><tertiary>{3}</tertiary>
115 {3#}</indexterm>
116 {3#}<indexterm>
117   <primary>{2}</primary><secondary>{3}</secondary>
118 {3#}</indexterm>
119 {3#}<indexterm>
120   <primary>{3}</primary>
121 {3#}</indexterm>
122
123 [indexterm2-inlinemacro]
124 # Index term.
125 # Single entry index term that is visible in the primary text flow.
126 <indexterm><primary>{1}</primary></indexterm>{1}
127
128 [footnote-inlinemacro]
129 # Footnote.
130 <footnote><simpara>{0}</simpara></footnote>
131
132 [footnoteref-inlinemacro]
133 # Footnote reference.
134 {2#}<footnote id="{1}"><simpara>{2}</simpara></footnote>
135 {2%}<footnoteref linkend="{1}" />
136
137 [callout-inlinemacro]
138 # Callout.
139 <co id="{coid}"/>
140
141 # List tags.
142 [listtags-bulleted]
143 list=<itemizedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{compact-option? spacing="compact"}>{unbreakable-option? <?dbfo keep-together="always"?>}{title?<title>{title}</title>}|</itemizedlist>
144 item=<listitem>|</listitem>
145 text=<simpara>|</simpara>
146
147 [listtags-numbered]
148 list=<orderedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} numeration="{style}"{compact-option? spacing="compact"}>{unbreakable-option? <?dbfo keep-together="always"?>}{title?<title>{title}</title>}{start?<?dbfo start="{start}"?><?dbhtml start="{start}"?>}|</orderedlist>
149 item=<listitem>|</listitem>
150 text=<simpara>|</simpara>
151
152 [listtags-labeled]
153 list=<variablelist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</variablelist>
154 entry=<varlistentry>|</varlistentry>
155 label=
156 term=<term>|</term>
157 item=<listitem>|</listitem>
158 text=<simpara>|</simpara>
159
160 [listtags-horizontal]
161 # Horizontal labeled list (implemented with two column table).
162 # Hardwired column widths to 30%,70% because the current crop of PDF
163 # generators do not auto calculate column widths.
164  list=<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{style? tabstyle="{style}"}{pgwide-option? pgwide="1"} frame="none" colsep="0" rowsep="0">{title?<title>{title}</title>}<tgroup cols="2"><colspec colwidth="{labelwidth=15}*"/><colspec colwidth="{itemwidth=85}*"/><tbody valign="top">|</tbody></tgroup><{title?/table}{title!/informaltable}>
165 entry=<row>|</row>
166 label=<entry>|</entry>
167 term=<simpara>|</simpara>
168 item=<entry>|</entry>
169 text=<simpara>|</simpara>
170
171 [listtags-callout]
172 list=<calloutlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</calloutlist>
173 item=<callout arearefs="{coids}">|</callout>
174 text=<para>|</para>
175
176 [listtags-qanda]
177 list=<qandaset{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</qandaset>
178 entry=<qandaentry>|</qandaentry>
179 label=<question>|</question>
180 term=<simpara>|</simpara>
181 item=<answer>|</answer>
182 text=<simpara>|</simpara>
183
184 [listtags-bibliography]
185 list=<bibliodiv{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</bibliodiv>
186 item=<bibliomixed>|</bibliomixed>
187 text=<bibliomisc>|</bibliomisc>
188
189 [listtags-glossary]
190 list=
191 entry=<glossentry>|</glossentry>
192 label=
193 term=<glossterm>|</glossterm>
194 item=<glossdef>|</glossdef>
195 text=<simpara>|</simpara>
196
197 [tags]
198 # Quoted text
199 emphasis=<emphasis>{1?<phrase role="{1}">}|{1?</phrase>}</emphasis>
200 strong=<emphasis role="strong">{1?<phrase role="{1}">}|{1?</phrase>}</emphasis>
201 monospaced=<literal>{1?<phrase role="{1}">}|{1?</phrase>}</literal>
202 singlequoted={lsquo}{1?<phrase role="{1}">}|{1?</phrase>}{rsquo}
203 doublequoted={ldquo}{1?<phrase role="{1}">}|{1?</phrase>}{rdquo}
204 unquoted={1?<phrase role="{1}">}|{1?</phrase>}
205 subscript=<subscript>{1?<phrase role="{1}">}|{1?</phrase>}</subscript>
206 superscript=<superscript>{1?<phrase role="{1}">}|{1?</phrase>}</superscript>
207
208 ifdef::deprecated-quotes[]
209 # Override with deprecated quote attributes.
210 emphasis={role?<phrase role="{role}">}<emphasis>|</emphasis>{role?</phrase>}
211 strong={role?<phrase role="{role}">}<emphasis role="strong">|</emphasis>{role?</phrase>}
212 monospaced={role?<phrase role="{role}">}<literal>|</literal>{role?</phrase>}
213 singlequoted={role?<phrase role="{role}">}{amp}#8216;|{amp}#8217;{role?</phrase>}
214 doublequoted={role?<phrase role="{role}">}{amp}#8220;|{amp}#8221;{role?</phrase>}
215 unquoted={role?<phrase role="{role}">}|{role?</phrase>}
216 subscript={role?<phrase role="{role}">}<subscript>|</subscript>{role?</phrase>}
217 superscript={role?<phrase role="{role}">}<superscript>|</superscript>{role?</phrase>}
218 endif::deprecated-quotes[]
219
220 # Inline macros
221 [http-inlinemacro]
222 <ulink url="{name}:{target}">{0={name}:{target}}</ulink>
223 [https-inlinemacro]
224 <ulink url="{name}:{target}">{0={name}:{target}}</ulink>
225 [ftp-inlinemacro]
226 <ulink url="{name}:{target}">{0={name}:{target}}</ulink>
227 [file-inlinemacro]
228 <ulink url="{name}:{target}">{0={name}:{target}}</ulink>
229 [irc-inlinemacro]
230 <ulink url="{name}:{target}">{0={name}:{target}}</ulink>
231 [mailto-inlinemacro]
232 <ulink url="mailto:{target}">{0={target}}</ulink>
233 [callto-inlinemacro]
234 <ulink url="{name}:{target}">{0={target}}</ulink>
235 [link-inlinemacro]
236 <ulink url="{target}">{0={target}}</ulink>
237 # anchor:id[text]
238 [anchor-inlinemacro]
239 <anchor id="{target}" xreflabel="{0=[{target}]}"/>
240 # [[id,text]]
241 [anchor2-inlinemacro]
242 <anchor id="{1}" xreflabel="{2=[{1}]}"/>
243 # [[[id]]]
244 [anchor3-inlinemacro]
245 <anchor id="{1}" xreflabel="[{1}]"/>[{1}]
246 # xref:id[text]
247 [xref-inlinemacro]
248 <link linkend="{target}">{0}</link>
249 {2%}<xref linkend="{target}"/>
250 # <<id,text>>
251 [xref2-inlinemacro]
252 <link linkend="{1}">{2}</link>
253 {2%}<xref linkend="{1}"/>
254 # // comment line
255 [comment-inlinemacro]
256 {showcomments#}<remark>{passtext}</remark>
257
258 [comment-blockmacro]
259 {showcomments#}<remark>{passtext}</remark>
260
261 [literal-inlinemacro]
262 # Inline literal.
263 <literal>{passtext}</literal>
264
265 # Special word macros
266 [emphasizedwords]
267 <emphasis>{words}</emphasis>
268 [monospacedwords]
269 <literal>{words}</literal>
270 [strongwords]
271 <emphasis role="strong">{words}</emphasis>
272
273 # Paragraph substitution.
274 [paragraph]
275 <formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
276 {thumbnail#}<mediaobject>
277 {thumbnail#}  <imageobject>
278 {thumbnail#}  <imagedata fileref="images/{thumbnail}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}{scaledwidth? width="{scaledwidth}" scalefit="1"}{align? align="{align}"}/>
279 {thumbnail#}  </imageobject>
280 {thumbnail#}  <textobject><phrase>{alt={thumbnail}}</phrase></textobject>
281 {thumbnail#}</mediaobject>
282 {title%}<simpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
283 |
284 {title%}</simpara>
285 {title#}</para></formalpara>
286 {empty}
287
288 [admonitionparagraph]
289 <{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><simpara>|</simpara></{name}>
290
291 # Delimited blocks.
292 [literalblock]
293 <formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
294 {title#}<literallayout class="monospaced">
295 {title%}<literallayout{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} class="monospaced">
296 |
297 </literallayout>
298 {title#}</para></formalpara>
299
300 [listingblock]
301 <formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
302 {title#}<screen>
303 {title%}<screen{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
304 |
305 </screen>
306 {title#}</para></formalpara>
307
308 [sidebarblock-open]
309 <sidebar{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
310 <title>{title}</title>
311
312 [sidebarblock-close]
313 </sidebar>
314
315 [sidebarblock]
316 template::[sidebarblock-open]
317 |
318 template::[sidebarblock-close]
319
320 [sidebarparagraph]
321 template::[sidebarblock-open]
322 <simpara>|</simpara>
323 template::[sidebarblock-close]
324
325 [abstractblock-open]
326 <abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
327 <title>{title}</title>
328
329 [abstractblock-close]
330 </abstract>
331
332 [abstractblock]
333 template::[abstractblock-open]
334 |
335 template::[abstractblock-close]
336
337 [abstractparagraph]
338 template::[abstractblock-open]
339 <simpara>|</simpara>
340 template::[abstractblock-close]
341
342 [openblock]
343 |
344
345 [partintroblock-open]
346 <partintro{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
347 <title>{title}</title>
348
349 [partintroblock-close]
350 </partintro>
351
352 [partintroblock]
353 template::[partintroblock-open]
354 |
355 template::[partintroblock-close]
356
357 [partintroparagraph]
358 template::[partintroblock-open]
359 <simpara>|</simpara>
360 template::[partintroblock-close]
361
362 [quote-open]
363 # Common quote and verse element template.
364 <blockquote{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
365 <title>{title}</title>
366 # Include attribution only if either {attribution} or {citetitle} is defined.
367 {attribution#}<attribution>
368 {attribution%}{citetitle#}<attribution>
369 {attribution}
370 <citetitle>{citetitle}</citetitle>
371 {attribution#}</attribution>
372 {attribution%}{citetitle#}</attribution>
373
374 [quote-close]
375 </blockquote>
376
377 [quoteblock]
378 template::[quote-open]
379 |
380 template::[quote-close]
381
382 [verseblock]
383 template::[quote-open]
384 <literallayout>|</literallayout>
385 template::[quote-close]
386
387 [quoteparagraph]
388 template::[quote-open]
389 <simpara>|</simpara>
390 template::[quote-close]
391
392 [exampleblock-open]
393 <{title?example}{title!informalexample}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
394 # DocBook XSL Stylesheets custom processing instructions.
395 <?dbfo keep-together="{breakable-option#auto}"?>
396 <?dbfo keep-together="{unbreakable-option#always}"?>
397 <title>{title}</title>
398
399 [exampleblock-close]
400 </{title?example}{title!informalexample}>
401
402 [exampleblock]
403 template::[exampleblock-open]
404 |
405 template::[exampleblock-close]
406
407 [exampleparagraph]
408 template::[exampleblock-open]
409 <simpara>|</simpara>
410 template::[exampleblock-close]
411
412 [admonitionblock]
413 <{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
414 <title>{title}</title>
415 |
416 </{name}>
417
418 # Tables.
419 [tabletags-default]
420 colspec=<colspec colname="col_{colnumber}" colwidth="{width!{colpcwidth}*}{width?{colabswidth}{pageunits}}"/>
421 bodyrow=<row>|</row>
422 headdata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry>
423 bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry>
424 paragraph=<simpara>|</simpara>
425
426 [tabletags-emphasis]
427 paragraph=<simpara><emphasis>|</emphasis></simpara>
428
429 [tabletags-header]
430 paragraph=<simpara><emphasis role="strong">|</emphasis></simpara>
431
432 [tabletags-strong]
433 paragraph=<simpara><emphasis role="strong">|</emphasis></simpara>
434
435 [tabletags-monospaced]
436 paragraph=<simpara><literal>|</literal></simpara>
437
438 [tabletags-verse]
439 bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout>|</literallayout></entry>
440 paragraph=
441
442 [tabletags-literal]
443 bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout class="monospaced">|</literallayout></entry>
444 paragraph=
445
446 [tabletags-asciidoc]
447 paragraph=
448
449 [table]
450 <{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"}
451 frame="{frame=all}"
452 {grid%rowsep="1" colsep="1"}
453 rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}"
454 >
455 <title>{title}</title>
456 # DocBook XSL Stylesheets custom processing instructions.
457 <?dbhtml table-width="{width}"?>
458 <?dbfo table-width="{width}"?>
459 <?dblatex table-width="{width}"?>
460 <?dbfo keep-together="{breakable-option#auto}"?>
461 <?dbfo keep-together="{unbreakable-option#always}"?>
462 <tgroup cols="{colcount}">
463 {colspecs}
464 {headrows#}<thead>
465 {headrows}
466 {headrows#}</thead>
467 {footrows#}<tfoot>
468 {footrows}
469 {footrows#}</tfoot>
470 <tbody>
471 {bodyrows}
472 </tbody>
473 </tgroup>
474 </{title?table}{title!informaltable}>
475
476 #--------------------------------------------------------------------
477 # Deprecated old table definitions.
478 #
479
480 [old_tabledef-default]
481 template=old_table
482 colspec=<colspec colwidth="{colwidth}{pageunits}" align="{colalign}"/>
483 bodyrow=<row>|</row>
484 bodydata=<entry>|</entry>
485
486 [old_table]
487 <{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} pgwide="0"
488 frame="{frame=topbot}"
489 {grid%rowsep="0" colsep="0"}
490 rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}"
491 >
492 <title>{title}</title>
493 <tgroup cols="{cols}">
494 {colspecs}
495 {headrows#}<thead>
496 {headrows}
497 {headrows#}</thead>
498 {footrows#}<tfoot>
499 {footrows}
500 {footrows#}</tfoot>
501 <tbody>
502 {bodyrows}
503 </tbody>
504 </tgroup>
505 </{title?table}{title!informaltable}>
506
507 # End of deprecated old table definitions.
508 #--------------------------------------------------------------------
509
510 # Special sections.
511 [preface]
512 <preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
513 <title>{title=}</title>
514 |
515 </preface>
516
517 [index]
518 <index{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
519 <title>{title}</title>
520 |
521 </index>
522
523 [bibliography]
524 <bibliography{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
525 <title>{title}</title>
526 |
527 </bibliography>
528
529 [glossary]
530 <glossary{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
531 <title>{title}</title>
532 |
533 </glossary>
534
535 [appendix]
536 <appendix{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
537 <title>{title}</title>
538 |
539 </appendix>
540
541 [floatingtitle]
542 <bridgehead{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} renderas="sect{level}">{title}</bridgehead>
543
544
545 [header-declarations]
546 <?xml version="1.0" encoding="{encoding}"?>
547 <!DOCTYPE {doctype-article?article}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
548 {toc#}<?asciidoc-toc?>
549 {numbered#}<?asciidoc-numbered?>
550
551 [+docinfo]
552 {notitle%}    <title>{doctitle}</title>
553     <date>{revdate}</date>
554 # To ensure valid articleinfo/bookinfo when there is no AsciiDoc header.
555     {doctitle%}{revdate%}<date>{docdate}</date>
556     {authored#}<author>
557         <firstname>{firstname}</firstname>
558         <othername>{middlename}</othername>
559         <surname>{lastname}</surname>
560         <email>{email}</email>
561     {authored#}</author>
562     <authorinitials>{authorinitials}</authorinitials>
563 <revhistory><revision>{revnumber?<revnumber>{revnumber}</revnumber>}<date>{revdate}</date>{authorinitials?<authorinitials>{authorinitials}</authorinitials>}{revremark?<revremark>{revremark}</revremark>}</revision></revhistory>
564 {docinfo1,docinfo2#}{include:{docdir}/docinfo.xml}
565 {docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.xml}
566 # DEPRECATED: Use docinfo.
567 {revisionhistory#}{include:{docdir}/{docname}-revhistory.xml}
568 # DEPRECATED: Use orgname in preference to companyname.
569 <orgname>{companyname}</orgname>
570 # DEPRECATED: Use orgname in preference to corpname.
571 <orgname>{corpname}</orgname>
572 <orgname>{orgname}</orgname>
573
574 #-------------------------
575 # article document type
576 #-------------------------
577 ifdef::doctype-article[]
578
579 [header]
580 template::[header-declarations]
581
582 <article lang="{lang=en}">
583 <articleinfo>
584 template::[docinfo]
585 </articleinfo>
586
587 [footer]
588 </article>
589
590 [preamble]
591 # Untitled elements between header and first section title.
592 |
593
594 [abstract]
595 <abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
596 |
597 </abstract>
598
599 [sect1]
600 <section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
601 <title>{title}</title>
602 |
603 </section>
604
605 [sect2]
606 <section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
607 <title>{title}</title>
608 |
609 </section>
610
611 [sect3]
612 <section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
613 <title>{title}</title>
614 |
615 </section>
616
617 [sect4]
618 <section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
619 <title>{title}</title>
620 |
621 </section>
622
623 endif::doctype-article[]
624
625 #-------------------------
626 # manpage document type
627 #-------------------------
628 ifdef::doctype-manpage[]
629
630 [replacements]
631 # The roff format does not substitute special characters so just print them as
632 # text.
633 \(C\)=(C)
634 \(TM\)=(TM)
635
636 [header]
637 template::[header-declarations]
638 <refentry lang="{lang=en}">
639 <refentryinfo>
640 template::[docinfo]
641 </refentryinfo>
642 <refmeta>
643 <refentrytitle>{mantitle}</refentrytitle>
644 <manvolnum>{manvolnum}</manvolnum>
645 # Default source and manual to suppress DocBook XSL warnings.
646 <refmiscinfo class="source">{mansource=&#160;}</refmiscinfo>
647 <refmiscinfo class="manual">{manmanual=&#160;}</refmiscinfo>
648 <refmiscinfo class="version">{manversion={revnumber}}</refmiscinfo>
649 </refmeta>
650 <refnamediv>
651     <refname>{manname1}</refname>
652     <refname>{manname2}</refname>
653     <refname>{manname3}</refname>
654     <refname>{manname4}</refname>
655     <refname>{manname5}</refname>
656     <refname>{manname6}</refname>
657     <refname>{manname7}</refname>
658     <refname>{manname8}</refname>
659     <refname>{manname9}</refname>
660     <refpurpose>{manpurpose}</refpurpose>
661 </refnamediv>
662
663 [footer]
664 </refentry>
665
666 # Section macros
667 [synopsis]
668 <refsynopsisdiv{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
669 |
670 </refsynopsisdiv>
671
672 [sect1]
673 <refsect1{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
674 <title>{title}</title>
675 |
676 </refsect1>
677
678 [sect2]
679 <refsect2{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
680 <title>{title}</title>
681 |
682 </refsect2>
683
684 [sect3]
685 <refsect3{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
686 <title>{title}</title>
687 |
688 </refsect3>
689
690 endif::doctype-manpage[]
691
692 #-------------------------
693 # book document type
694 #-------------------------
695 ifdef::doctype-book[]
696
697 [header]
698 template::[header-declarations]
699
700 <book lang="{lang=en}">
701 <bookinfo>
702 template::[docinfo]
703 </bookinfo>
704
705 [footer]
706 </book>
707
708 [preamble]
709 # Preamble is not allowed in DocBook book so wrap it in a preface.
710 <preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
711 <title>{title=}</title>
712 |
713 </preface>
714
715 [dedication]
716 <dedication{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
717 <title>{title}</title>
718 |
719 </dedication>
720
721 [colophon]
722 <colophon{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
723 <title>{title}</title>
724 |
725 </colophon>
726
727 [sect0]
728 <part{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
729 <title>{title}</title>
730 |
731 </part>
732
733 [sect1]
734 <chapter{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
735 <title>{title}</title>
736 |
737 </chapter>
738
739 [sect2]
740 <section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
741 <title>{title}</title>
742 |
743 </section>
744
745 [sect3]
746 <section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
747 <title>{title}</title>
748 |
749 </section>
750
751 [sect4]
752 <section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
753 <title>{title}</title>
754 |
755 </section>
756
757 endif::doctype-book[]
758
759 ifdef::sgml[]
760 #
761 # Optional DocBook SGML.
762 #
763 # Most of the differences between DocBook XML and DocBook SGML boils
764 # down to the empty element syntax: SGML does not like the XML empty
765 # element <.../> syntax, use <...> instead.
766 #
767 [miscellaneous]
768 outfilesuffix=.sgml
769
770 [header-declarations]
771 <!DOCTYPE {doctype-article?article}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
772
773 [tabledef-default]
774 colspec=<colspec colwidth="{colabswidth}{pageunits}" align="{colalign}">
775
776 [image-inlinemacro]
777 <inlinemediaobject>
778   <imageobject>
779   <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}>
780   </imageobject>
781   <textobject><phrase>{alt={target}}</phrase></textobject>
782 </inlinemediaobject>
783
784 [image-blockmacro]
785 <figure><title>{title}</title>
786 {title%}<informalfigure>
787 <mediaobject>
788   <imageobject>
789   <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}>
790   </imageobject>
791   <textobject><phrase>{alt={target}}</phrase></textobject>
792 </mediaobject>
793 {title#}</figure>
794 {title%}</informalfigure>
795
796 # Inline macros
797 [xref-inlinemacro]
798 <link linkend="{target}">{0}</link>
799 {2%}<xref linkend="{target}">
800 [xref2-inlinemacro]
801 # <<id,text>>
802 <link linkend="{1}">{2}</link>
803 {2%}<xref linkend="{1}">
804 [anchor-inlinemacro]
805 <anchor id="{target}" xreflabel="{0=[{target}]}">
806 [anchor2-inlinemacro]
807 # [[id,text]]
808 <anchor id="{1}" xreflabel="{2=[{1}]}">
809
810 endif::sgml[]