4
# Asciidoc configuration file.
5
# Default docbook backend.
10
# Printable page width and units.
11
# Used to calculate DocBook CALS tables absolute column and table widths.
18
# toc and numbered are set to maintain original default behavior.
23
# Line break markup. Custom processing instruction in fo.xsl.
24
(?m)^(.*)\s\+$=\1<?asciidoc-br?>
27
ifdef::asciidoc7compatible[]
29
\^(.+?)\^=<superscript>\1</superscript>
31
~(.+?)~=<subscript>\1</subscript>
32
endif::asciidoc7compatible[]
35
# Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl.
36
<simpara><?asciidoc-hr?></simpara>
38
[pagebreak-blockmacro]
39
# Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl.
40
<simpara><?asciidoc-pagebreak?></simpara>
43
latexmath-style=template="latexmathblock",subs=[]
47
(?su)[\\]?(?P<name>latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[]
48
(?u)^(?P<name>latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[]
50
[latexmath-inlinemacro]
52
<alt><![CDATA[{passtext}]]></alt>
53
<inlinemediaobject><textobject><phrase></phrase></textobject></inlinemediaobject>
56
[latexmath-blockmacro]
58
<alt><![CDATA[{passtext}]]></alt>
59
<mediaobject><textobject><phrase></phrase></textobject></mediaobject>
63
<equation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title>
64
{title%}<informalequation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
65
<alt><![CDATA[|]]></alt>
66
<mediaobject><textobject><phrase></phrase></textobject></mediaobject>
68
{title%}</informalequation>
73
<imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}/>
75
<textobject><phrase>{alt={target}}</phrase></textobject>
79
<figure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"}><title>{title}</title>
80
{title%}<informalfigure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{pgwide-option?<?dbfo pgwide="1"?>}
81
# DocBook XSL Stylesheets custom processing instructions.
82
<?dbfo keep-together="{breakable-option#auto}"?>
83
<?dbfo keep-together="{unbreakable-option#always}"?>
86
<imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scaledwidth? width="{scaledwidth}" scalefit="1"}{align? align="{align}"}/>
88
<textobject><phrase>{alt={target}}</phrase></textobject>
91
{title%}</informalfigure>
93
[indexterm-inlinemacro]
95
# Generate separate index entries for primary, secondary and tertiary
99
{2%} <primary>{1}</primary>
101
# Primary and secondary.
103
{2#}{3%} <primary>{1}</primary><secondary>{2}</secondary>
106
{2#}{3%} <primary>{2}</primary>
108
# Primary, secondary and tertiary.
110
<primary>{1}</primary><secondary>{2}</secondary><tertiary>{3}</tertiary>
113
<primary>{2}</primary><secondary>{3}</secondary>
116
<primary>{3}</primary>
119
[indexterm2-inlinemacro]
121
# Single entry index term that is visible in the primary text flow.
122
<indexterm><primary>{1}</primary></indexterm>{1}
124
[footnote-inlinemacro]
126
<footnote><simpara>{0}</simpara></footnote>
128
[footnoteref-inlinemacro]
129
# Footnote reference.
130
{2#}<footnote id="{1}"><simpara>{2}</simpara></footnote>
131
{2%}<footnoteref linkend="{1}" />
133
[callout-inlinemacro]
139
list=<itemizedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{compact-option? spacing="compact"}>{title?<title>{title}</title>}|</itemizedlist>
140
item=<listitem>|</listitem>
141
text=<simpara>|</simpara>
144
list=<orderedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} numeration="{style}"{compact-option? spacing="compact"}>{title?<title>{title}</title>}|</orderedlist>
145
item=<listitem>|</listitem>
146
text=<simpara>|</simpara>
149
list=<variablelist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</variablelist>
150
entry=<varlistentry>|</varlistentry>
153
item=<listitem>|</listitem>
154
text=<simpara>|</simpara>
156
[listtags-horizontal]
157
# Horizontal labeled list (implemented with two column table).
158
# Hardwired column widths to 30%,70% because the current crop of PDF
159
# generators do not auto calculate column widths.
160
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}>
162
label=<entry>|</entry>
163
term=<simpara>|</simpara>
164
item=<entry>|</entry>
165
text=<simpara>|</simpara>
168
list=<calloutlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</calloutlist>
169
item=<callout arearefs="{coids}">|</callout>
170
text=<simpara>|</simpara>
173
list=<qandaset{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</qandaset>
174
entry=<qandaentry>|</qandaentry>
175
label=<question>|</question>
176
term=<simpara>|</simpara>
177
item=<answer>|</answer>
178
text=<simpara>|</simpara>
180
[listtags-bibliography]
182
item=<bibliomixed>|</bibliomixed>
183
text=<bibliomisc>|</bibliomisc>
187
entry=<glossentry>|</glossentry>
189
term=<glossterm>|</glossterm>
190
item=<glossdef>|</glossdef>
191
text=<simpara>|</simpara>
195
emphasis={role?<phrase role="{role}">}<emphasis>|</emphasis>{role?</phrase>}
196
strong={role?<phrase role="{role}">}<emphasis role="strong">|</emphasis>{role?</phrase>}
197
monospaced={role?<phrase role="{role}">}<literal>|</literal>{role?</phrase>}
198
singlequoted={role?<phrase role="{role}">}{amp}#8216;|{amp}#8217;{role?</phrase>}
199
doublequoted={role?<phrase role="{role}">}{amp}#8220;|{amp}#8221;{role?</phrase>}
200
unquoted={role?<phrase role="{role}">}|{role?</phrase>}
201
subscript={role?<phrase role="{role}">}<subscript>|</subscript>{role?</phrase>}
202
superscript={role?<phrase role="{role}">}<superscript>|</superscript>{role?</phrase>}
206
<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
208
<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
210
<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
212
<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
214
<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
216
<ulink url="mailto:{target}">{0={target}}</ulink>
218
<ulink url="{name}:{target}">{0={target}}</ulink>
220
<ulink url="{target}">{0={target}}</ulink>
223
<anchor id="{target}" xreflabel="{0=[{target}]}"/>
225
[anchor2-inlinemacro]
226
<anchor id="{1}" xreflabel="{2=[{1}]}"/>
228
[anchor3-inlinemacro]
229
<anchor id="{1}" xreflabel="[{1}]"/>[{1}]
232
<link linkend="{target}">{0}</link>
233
{2%}<xref linkend="{target}"/>
236
<link linkend="{1}">{2}</link>
237
{2%}<xref linkend="{1}"/>
239
[comment-inlinemacro]
240
{showcomments#}<remark>{passtext}</remark>
243
template::[comment-inlinemacro]
245
[literal-inlinemacro]
247
<literal>{passtext}</literal>
249
# Special word macros
251
<emphasis>{words}</emphasis>
253
<literal>{words}</literal>
255
<emphasis role="strong">{words}</emphasis>
257
# Paragraph substitution.
259
<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
260
{title%}<simpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
263
{title#}</para></formalpara>
266
[admonitionparagraph]
267
<{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><simpara>|</simpara></{name}>
270
# The literal block employs the same markup.
271
template::[literalblock]
274
template::[verseblock]
278
<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
279
{title#}<literallayout class="monospaced">
280
{title%}<literallayout{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} class="monospaced">
283
{title#}</para></formalpara>
286
<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
288
{title%}<screen{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
291
{title#}</para></formalpara>
294
<sidebar{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
295
<title>{title}</title>
300
<abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
301
<title>{title}</title>
306
<blockquote{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
307
<title>{title}</title>
308
# Include attribution only if either {attribution} or {citetitle} is defined.
309
{attribution#}<attribution>
310
{attribution%}{citetitle#}<attribution>
312
<citetitle>{citetitle}</citetitle>
313
{attribution#}</attribution>
314
{attribution%}{citetitle#}</attribution>
319
<blockquote{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
320
<title>{title}</title>
321
# Include attribution only if either {attribution} or {citetitle} is defined.
322
{attribution#}<attribution>
323
{attribution%}{citetitle#}<attribution>
325
<citetitle>{citetitle}</citetitle>
326
{attribution#}</attribution>
327
{attribution%}{citetitle#}</attribution>
334
<{title?example}{title!informalexample}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
335
# DocBook XSL Stylesheets custom processing instructions.
336
<?dbfo keep-together="{breakable-option#auto}"?>
337
<?dbfo keep-together="{unbreakable-option#always}"?>
338
<title>{title}</title>
340
</{title?example}{title!informalexample}>
343
<{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
344
<title>{title}</title>
350
colspec=<colspec colname="col_{colnumber}" colwidth="{width!{colpcwidth}*}{width?{colabswidth}{pageunits}}"/>
352
headdata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry>
353
bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry>
354
paragraph=<simpara>|</simpara>
357
paragraph=<simpara><emphasis>|</emphasis></simpara>
360
paragraph=<simpara><emphasis role="strong">|</emphasis></simpara>
363
paragraph=<simpara><emphasis role="strong">|</emphasis></simpara>
365
[tabletags-monospaced]
366
paragraph=<simpara><literal>|</literal></simpara>
369
bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout>|</literallayout></entry>
373
bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout class="monospaced">|</literallayout></entry>
380
<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"}
382
{grid%rowsep="1" colsep="1"}
383
rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}"
385
<title>{title}</title>
386
# DocBook XSL Stylesheets custom processing instructions.
387
<?dbhtml table-width="{width}"?>
388
<?dbfo table-width="{width}"?>
389
<?dbfo keep-together="{breakable-option#auto}"?>
390
<?dbfo keep-together="{unbreakable-option#always}"?>
391
<tgroup cols="{colcount}">
403
</{title?table}{title!informaltable}>
405
#--------------------------------------------------------------------
406
# Deprecated old table definitions.
409
[old_tabledef-default]
411
colspec=<colspec colwidth="{colwidth}{pageunits}" align="{colalign}"/>
413
bodydata=<entry>|</entry>
416
<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} pgwide="0"
417
frame="{frame=topbot}"
418
{grid%rowsep="0" colsep="0"}
419
rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}"
421
<title>{title}</title>
422
<tgroup cols="{cols}">
434
</{title?table}{title!informaltable}>
436
# End of deprecated old table definitions.
437
#--------------------------------------------------------------------
441
<preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
442
<title>{title}</title>
447
<index{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
448
<title>{title}</title>
453
<bibliography{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
454
<title>{title}</title>
459
<glossary{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
460
<title>{title}</title>
465
<appendix{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
466
<title>{title}</title>
471
<bridgehead{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} renderas="sect{level}">{title}</bridgehead>
474
[header-declarations]
475
<?xml version="1.0" encoding="{encoding}"?>
476
<!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">
477
{toc#}<?asciidoc-toc?>
478
{numbered#}<?asciidoc-numbered?>
481
<title>{doctitle}</title>
482
<date>{revdate}</date>
483
# To ensure valid articleinfo/bookinfo when there is no AsciiDoc header.
484
{doctitle%}{revdate%}<date>{docdate}</date>
486
<firstname>{firstname}</firstname>
487
<othername>{middlename}</othername>
488
<surname>{lastname}</surname>
489
<affiliation><orgname>{orgname}</orgname></affiliation>
490
<email>{email}</email>
492
<authorinitials>{authorinitials}</authorinitials>
493
<revhistory><revision>{revnumber?<revnumber>{revnumber}</revnumber>}<date>{revdate}</date>{authorinitials?<authorinitials>{authorinitials}</authorinitials>}{revremark?<revremark>{revremark}</revremark>}</revision></revhistory>
494
# Include file named like source document with -docinfo.xml suffix
495
# if it exists and if the docinfo attribute is defined.
496
# include it as the document history.
497
{docinfo#}{include:{docdir}/{docname}-docinfo.xml}
498
# DEPRECTED: Use docinfo.
499
{revisionhistory#}{include:{docdir}/{docname}-revhistory.xml}
500
# DEPRECTED: Use corpname in preference to companyname.
501
<corpname>{companyname}</corpname>
502
<corpname>{corpname}</corpname>
504
#-------------------------
505
# article document type
506
#-------------------------
507
ifdef::doctype-article[]
510
template::[header-declarations]
512
<article lang="{lang=en}">
521
# Untitled elements between header and first section title.
525
<abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
530
<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
531
<title>{title}</title>
536
<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
537
<title>{title}</title>
542
<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
543
<title>{title}</title>
548
<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
549
<title>{title}</title>
553
endif::doctype-article[]
555
#-------------------------
556
# manpage document type
557
#-------------------------
558
ifdef::doctype-manpage[]
561
# The roff format does not substitute special characters so just print them as
567
template::[header-declarations]
568
<refentry lang="{lang=en}">
570
<refentrytitle>{mantitle}</refentrytitle>
571
<manvolnum>{manvolnum}</manvolnum>
572
# Default source and manual to suppress DocBook XSL warnings.
573
<refmiscinfo class="source">{mansource= }</refmiscinfo>
574
<refmiscinfo class="manual">{manmanual= }</refmiscinfo>
575
<refmiscinfo class="version">{manversion={revnumber}}</refmiscinfo>
578
<refname>{manname1}</refname>
579
<refname>{manname2}</refname>
580
<refname>{manname3}</refname>
581
<refname>{manname4}</refname>
582
<refname>{manname5}</refname>
583
<refname>{manname6}</refname>
584
<refname>{manname7}</refname>
585
<refname>{manname8}</refname>
586
<refname>{manname9}</refname>
587
<refpurpose>{manpurpose}</refpurpose>
595
<refsynopsisdiv{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
600
<refsect1{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
601
<title>{title}</title>
606
<refsect2{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
607
<title>{title}</title>
612
<refsect3{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
613
<title>{title}</title>
617
endif::doctype-manpage[]
619
#-------------------------
621
#-------------------------
622
ifdef::doctype-book[]
625
template::[header-declarations]
627
<book lang="{lang=en}">
636
# Preamble is not allowed in DocBook book so wrap it in a preface.
637
<preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
643
<dedication{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
648
<colophon{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
653
<part{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
654
<title>{title}</title>
659
<chapter{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
660
<title>{title}</title>
665
<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
666
<title>{title}</title>
671
<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
672
<title>{title}</title>
677
<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
678
<title>{title}</title>
682
endif::doctype-book[]
686
# Optional DocBook SGML.
688
# Most of the differences between DocBook XML and DocBook SGML boils
689
# down to the empty element syntax: SGML does not like the XML empty
690
# element <.../> syntax, use <...> instead.
695
[header-declarations]
696
<!DOCTYPE {doctype-article?article}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
699
colspec=<colspec colwidth="{colabswidth}{pageunits}" align="{colalign}">
704
<imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}>
706
<textobject><phrase>{alt={target}}</phrase></textobject>
710
<figure><title>{title}</title>
711
{title%}<informalfigure>
714
<imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}>
716
<textobject><phrase>{alt={target}}</phrase></textobject>
719
{title%}</informalfigure>
723
<link linkend="{target}">{0}</link>
724
{2%}<xref linkend="{target}">
727
<link linkend="{1}">{2}</link>
728
{2%}<xref linkend="{1}">
730
<anchor id="{target}" xreflabel="{0=[{target}]}">
731
[anchor2-inlinemacro]
733
<anchor id="{1}" xreflabel="{2=[{1}]}">
added
removed
docbook.conf
