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