4 # Asciidoc configuration file.
21 ifdef::asciidoc7compatible[]
23 \^(.+?)\^=<sup>\1</sup>
26 endif::asciidoc7compatible[]
31 [pagebreak-blockmacro]
32 <div style="page-break-after:always"></div>
35 asciimath-style=template="asciimathblock",subs=()
36 latexmath-style=template="latexmathblock",subs=()
39 (?u)^(?P<name>audio|video)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=#
41 # Special characters are escaped in HTML math markup.
42 (?su)[\\]?(?P<name>asciimath|latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[specialcharacters]
43 (?u)^(?P<name>asciimath|latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[specialcharacters]
45 [asciimath-inlinemacro]
48 [asciimath-blockmacro]
49 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
51 <div class="title">{title}</div>
56 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
58 <div class="title">{title}</div>
62 [latexmath-inlinemacro]
65 [latexmath-blockmacro]
66 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
68 <div class="title">{title}</div>
73 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
75 <div class="title">{title}</div>
80 <span class="image{role? {role}}">
81 <a class="image" href="{link}">
82 {data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"}>
83 {data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"}
84 {data-uri#}{sys:"{python}" -u -c "import mimetypes,base64,sys; print 'src=\"data:'+mimetypes.guess_type(r'{target}')[0]+';base64,'; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{imagesdir=}",r"{target}")}"}">
89 <div class="imageblock{style? {style}}{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}{align? style="text-align:{align};"}{float? style="float:{float};"}>
91 <a class="image" href="{link}">
92 {data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}>
93 {data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}
94 {data-uri#}{sys:"{python}" -u -c "import mimetypes,base64,sys; print 'src=\"data:'+mimetypes.guess_type(r'{target}')[0]+';base64,'; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{imagesdir=}",r"{target}")}"}">
97 <div class="title">{caption={figure-caption} {counter:figure-number}. }{title}</div>
101 <div class="audioblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
102 <div class="title">{caption=}{title}</div>
103 <div class="content">
104 <audio src="{imagesdir=}{imagesdir?/}{target}"{autoplay-option? autoplay}{nocontrols-option! controls}{loop-option? loop}>
105 Your browser does not support the audio tag.
110 <div class="videoblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
111 <div class="title">{caption=}{title}</div>
112 <div class="content">
113 <video src="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? height="{height}"}{poster? poster="{poster}"}{autoplay-option? autoplay}{nocontrols-option! controls}{loop-option? loop}>
114 Your browser does not support the video tag.
119 <div style="clear:both;"></div>
124 [indexterm-inlinemacro]
128 [indexterm2-inlinemacro]
130 # Single entry index term that is visible in the primary text flow.
133 [footnote-inlinemacro]
135 <span class="footnote"><br>[{0}]<br></span>
137 [footnoteref-inlinemacro]
138 # footnoteref:[<id>], create reference to footnote.
139 {2%}<span class="footnoteref"><br><a href="#_footnote_{1}">[{1}]</a><br></span>
140 # footnoteref:[<id>,<text>], create footnote with ID.
141 {2#}<span class="footnote" id="_footnote_{1}"><br>[{2}]<br></span>
143 [callout-inlinemacro]
145 <b><{index}></b>
149 <img src="{icon={iconsdir}/callouts/{index}.png}" alt="{index}">
152 <img alt="{index}" src="data:image/png;base64,
153 {sys:"{python}" -u -c "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{icon={iconsdir}/callouts/{index}.png}")}"}">
157 # Comment line macros.
158 [comment-inlinemacro]
159 {showcomments#}<br><span class="comment">{passtext}</span><br>
162 {showcomments#}<p><span class="comment">{passtext}</span></p>
164 [literal-inlinemacro]
166 <span class="monospaced">{passtext}</span>
170 list=<div class="ulist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div>
175 # The start attribute is not valid XHTML 1.1 but all browsers support it.
176 list=<div class="olist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol class="{style}"{start? start="{start}"}>|</ol></div>
181 list=<div class="dlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div>
184 term=<dt class="hdlist1{strong-option? strong}">|</dt>
188 [listtags-horizontal]
189 list=<div class="hdlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>{labelwidth?<col width="{labelwidth}%">}{itemwidth?<col width="{itemwidth}%">}|</table></div>
190 label=<td class="hdlist1{strong-option? strong}">|</td>
193 item=<td class="hdlist2">|</td>
194 text=<p style="margin-top: 0;">|</p>
197 list=<div class="qlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div>
200 term=<p><em>|</em></p>
206 list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div>
211 list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>|</table></div>
213 item=<tr><td><img src="{iconsdir}/callouts/{listindex}.png" alt="{listindex}"></td><td>|</td></tr>
216 item=<tr><td><img alt="{listindex}" src="data:image/png;base64, {sys:"{python}" -u -c "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{icon={iconsdir}/callouts/{listindex}.png}")}"}"></td><td>|</td></tr>
222 list=<div class="dlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div>
229 [listtags-bibliography]
230 list=<div class="ulist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div>
236 emphasis=<em>{1?<span class="{1}">}|{1?</span>}</em>
237 strong=<strong>{1?<span class="{1}">}|{1?</span>}</strong>
238 monospaced=<span class="monospaced{1? {1}}">|</span>
239 singlequoted={lsquo}{1?<span class="{1}">}|{1?</span>}{rsquo}
240 doublequoted={ldquo}{1?<span class="{1}">}|{1?</span>}{rdquo}
241 unquoted={1?<span class="{1}">}|{1?</span>}
242 superscript=<sup>{1?<span class="{1}">}|{1?</span>}</sup>
243 subscript=<sub>{1?<span class="{1}">}|{1?</span>}</sub>
245 ifdef::deprecated-quotes[]
246 # Override with deprecated quote attributes.
247 emphasis={role?<span class="{role}">}<em{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</em>{role?</span>}
248 strong={role?<span class="{role}">}<strong{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</strong>{role?</span>}
249 monospaced=<span class="monospaced{role? {role}}"{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</span>
250 singlequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8216;|{amp}#8217;{1,2,3?</span>}{role?</span>}
251 doublequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8220;|{amp}#8221;{1,2,3?</span>}{role?</span>}
252 unquoted={role?<span class="{role}">}{1,2,3?<span style="{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}">}|{1,2,3?</span>}{role?</span>}
253 superscript={role?<span class="{role}">}<sup{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sup>{role?</span>}
254 subscript={role?<span class="{role}">}<sub{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sub>{role?</span>}
255 endif::deprecated-quotes[]
259 <a href="{name}:{target}">{0={name}:{target}}</a>
261 <a href="{name}:{target}">{0={name}:{target}}</a>
263 <a href="{name}:{target}">{0={name}:{target}}</a>
265 <a href="{name}:{target}">{0={name}:{target}}</a>
267 <a href="{name}:{target}">{0={name}:{target}}</a>
269 <a href="mailto:{target}">{0={target}}</a>
271 <a href="{target}">{0={target}}</a>
273 <a href="{name}:{target}">{0={target}}</a>
276 <a id="{target}"></a>
278 [anchor2-inlinemacro]
281 [anchor3-inlinemacro]
282 <a id="{1}"></a>[{1}]
285 <a href="#{target}">{0=[{target}]}</a>
288 <a href="#{1}">{2=[{1}]}</a>
290 # Special word substitution.
294 <span class="monospaced">{words}</span>
296 <strong>{words}</strong>
298 # Paragraph substitution.
300 <div class="paragraph{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<p>
304 [admonitionparagraph]
305 template::[admonitionblock]
309 <div class="listingblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
310 <div class="title">{caption=}{title}</div>
311 <div class="content monospaced">
318 <div class="literalblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
319 <div class="title">{title}</div>
320 <div class="content monospaced">
327 <div class="sidebarblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
328 <div class="content">
329 <div class="title">{title}</div>
334 <div class="openblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
335 <div class="title">{title}</div>
336 <div class="content">
341 template::[openblock]
344 template::[quoteblock]
347 <div class="quoteblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
348 <div class="title">{title}</div>
349 <div class="content">
352 <div class="attribution">
353 <em>{citetitle}</em>{attribution?<br>}
354 — {attribution}
358 <div class="verseblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
359 <div class="title">{title}</div>
360 <pre class="content">
363 <div class="attribution">
364 <em>{citetitle}</em>{attribution?<br>}
365 — {attribution}
369 <div class="exampleblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
370 <div class="title">{caption={example-caption} {counter:example-number}. }{title}</div>
371 <div class="content">
376 <div class="admonitionblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
379 {data-uri%}{icons#}<img src="{icon={iconsdir}/{name}.png}" alt="{caption}">
380 {data-uri#}{icons#}<img alt="{caption}" src="data:image/png;base64,
381 {data-uri#}{icons#}{sys:"{python}" -u -c "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{icon={iconsdir}/{name}.png}")}"}">
382 {icons%}<div class="title">{caption}</div>
385 <div class="title">{title}</div>
393 colspec=<col{autowidth-option! style="width:{colpcwidth}%;"}>
395 headdata=<th class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }>|</th>
396 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }>|</td>
397 paragraph=<p class="tableblock">|</p>
400 paragraph=<p class="tableblock header">|</p>
403 paragraph=<p class="tableblock"><em>|</em></p>
406 paragraph=<p class="tableblock"><strong>|</strong></p>
408 [tabletags-monospaced]
409 paragraph=<p class="tableblock monospaced">|</p>
412 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }><div class="verse">|</div></td>
416 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }><div class="literal monospaced"><pre>|</pre></div></td>
420 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }><div>|</div></td>
424 <table class="tableblock frame-{frame=all} grid-{grid=all}{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}
426 margin-left:{align@left:0}{align@center|right:auto}; margin-right:{align@left|center:auto}{align@right:0};
428 {autowidth-option%}width:{tablepcwidth}%;
429 {autowidth-option#}{width#style=width:{tablepcwidth}%;}
431 <caption class="title">{caption={table-caption} {counter:table-number}. }{title}</caption>
444 #--------------------------------------------------------------------
445 # Deprecated old table definitions.
449 # Screen width in pixels.
453 [old_tabledef-default]
455 colspec=<col style="width:{colwidth}{pageunits};" />
457 headdata=<th class="tableblock halign-{colalign=left}">|</th>
458 footdata=<td class="tableblock halign-{colalign=left}">|</td>
459 bodydata=<td class="tableblock halign-{colalign=left}">|</td>
462 <table class="tableblock frame-{frame=all} grid-{grid=all}"{id? id="{id}"}>
463 <caption class="title">{caption={table-caption}}{title}</caption>
471 <tbody style="vertical-align:top;">
476 # End of deprecated old table definitions.
477 #--------------------------------------------------------------------
480 <h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}{id? id="{id}"} class="float">{title}</h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}>
483 # Untitled elements between header and first section title.
485 <div class="sectionbody">
492 <h1{id? id="{id}"}>{title}</h1>
496 <div class="sect1{style? {style}}{role? {role}}">
497 <h2{id? id="{id}"}>{numbered?{sectnum} }{title}</h2>
498 <div class="sectionbody">
504 <div class="sect2{style? {style}}{role? {role}}">
505 <h3{id? id="{id}"}>{numbered?{sectnum} }{title}</h3>
510 <div class="sect3{style? {style}}{role? {role}}">
511 <h4{id? id="{id}"}>{numbered?{sectnum} }{title}</h4>
516 <div class="sect4{style? {style}}{role? {role}}">
517 <h5{id? id="{id}"}>{title}</h5>
522 <div class="sect1{style? {style}}{role? {role}}">
523 <h2{id? id="{id}"}>{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}</h2>
524 <div class="sectionbody">
531 <div id="toctitle">{toc-title}</div>
532 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
537 <html lang="{lang=en}">
539 <meta http-equiv="Content-Type" content="text/html; charset={encoding}">
540 <meta name="generator" content="AsciiDoc {asciidoc-version}">
541 <meta name="description" content="{description}">
542 <meta name="keywords" content="{keywords}">
543 <title>{title}</title>
544 {title%}<title>{doctitle=}</title>
546 <link rel="stylesheet" href="{stylesdir=.}/{theme=asciidoc}.css" type="text/css">
547 ifeval::["{source-highlighter}"=="pygments"]
548 <link rel="stylesheet" href="{stylesdir=.}/pygments.css" type="text/css">
551 # DEPRECATED: 'pygments' attribute.
552 ifdef::pygments[<link rel="stylesheet" href="{stylesdir=.}/pygments.css" type="text/css">]
554 ifdef::toc2[<link rel="stylesheet" href="{stylesdir=.}/toc2.css" type="text/css" />]
555 <link rel="stylesheet" href="{stylesdir=.}/{stylesheet}" type="text/css">
558 <style type="text/css">
559 include1::{theme%}{stylesdir=./stylesheets}/asciidoc.css[]
560 include1::{themedir}/{theme}.css[]
561 ifeval::["{source-highlighter}"=="pygments"]
562 include1::{stylesdir=./stylesheets}/pygments.css[]
565 # DEPRECATED: 'pygments' attribute.
567 include1::{stylesdir=./stylesheets}/pygments.css[]
571 include1::{stylesdir=./stylesheets}/toc2.css[]
573 include1::{stylesheet}[]
576 ifndef::disable-javascript[]
578 <script type="text/javascript" src="{scriptsdir=.}/asciidoc.js"></script>
579 <script type="text/javascript" src="{scriptsdir=.}/{theme}.js"></script>
580 <script type="text/javascript">
581 #TODO: Escape not necessary in HTML5?
582 # Escape as CDATA to pass validators.
584 asciidoc.install({toc,toc2?{toclevels}});
589 <script type="text/javascript">
590 # Escape as CDATA to pass validators.
592 include1::{scriptsdir=./javascripts}/asciidoc.js[]
593 include1::{themedir}/{theme}.js[warnings=False]
594 asciidoc.install({toc,toc2?{toclevels}});
598 endif::disable-javascript[]
601 <script type="text/javascript" src="{scriptsdir=.}/ASCIIMathML.js"></script>
604 <script type="text/javascript">
605 # Escape as CDATA to pass validators.
607 include1::{scriptsdir=./javascripts}/ASCIIMathML.js[]
614 <script type="text/javascript" src="{scriptsdir=.}/LaTeXMathML.js"></script>
617 <script type="text/javascript">
618 # Escape as CDATA to pass validators.
620 include1::{scriptsdir=./javascripts}/LaTeXMathML.js[]
625 {docinfo1,docinfo2#}{include:{docdir}/docinfo.html}
626 {docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html}
629 <body class="{doctype}"{max-width? style="max-width:{max-width}"}{css-signature? id="{css-signature}"}>
630 # Article, book header.
631 ifndef::doctype-manpage[]
633 ifndef::notitle[<h1>{doctitle}</h1>]
635 <span id="author">{author}</span><br>
636 <span id="email" class="monospaced"><<a href="mailto:{email}">{email}</a>></span><br>
637 <span id="revnumber">version {revnumber}{revdate?,}</span>
638 <span id="revdate">{revdate}</span>
639 <br><span id="revremark">{revremark}</span>
641 {toc,toc2#}{toc-placement$auto:}{template:toc}
643 endif::doctype-manpage[]
645 ifdef::doctype-manpage[]
648 {doctitle} Manual Page
650 {toc,toc2#}{toc-placement$auto:}{template:toc}
651 <h2>{manname-title}</h2>
652 <div class="sectionbody">
658 endif::doctype-manpage[]
663 {disable-javascript%<div id="footnotes"><hr></div>}
665 # Removing footer date and version if footer-style set to none
666 ifeval::["{footer-style=default}"!="none"]
667 <div id="footer-text">
668 template::[footer-text]
672 <div id="footer-badges">
674 Valid <a href="http://validator.w3.org/check?uri=referer">HTML5</a>
675 and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a>.
678 <a href="http://validator.w3.org/check?uri=referer">
679 <img src="http://www.w3.org/html/logo/badge/html5-badge-h-solo.png"
680 width="30" alt="HTML5 Powered" title="HTML5 Powered">
682 <a href="http://jigsaw.w3.org/css-validator/check/referer">
683 <img style="border:0;width:88px;height:31px"
684 src="http://www.w3.org/Icons/valid-css"
695 # Default footer date is document modification time
696 ifeval::["{footer-style=default}"!="revdate"]
699 # If set to "revdate", it'll be set to the revision date
700 ifeval::["{footer-style=default}"=="revdate"]
704 ifdef::doctype-manpage[]
707 endif::doctype-manpage[]