4 # Asciidoc global configuration file.
5 # Contains backend independent configuration settings that are applied to all
15 backend-alias-html=xhtml11
16 backend-alias-docbook=docbook45
19 iconsdir=./images/icons
21 # Uncomment to use xhtml11 quirks mode CSS.
23 # Uncomment to use the Pygments source highlighter instead of GNU highlighter.
25 # Uncomment to use deprecated quote attributes.
28 # Attribute and AttributeList element patterns.
29 attributeentry-pattern=^:(?P<attrname>\w[^.]*?)(\.(?P<attrname2>.*?))?:(\s+(?P<attrvalue>.*))?$
30 attributelist-pattern=(?u)(^\[\[(?P<id>[\w_:][\w_:.-]*)(,(?P<reftext>.*?))?\]\]$)|(^\[(?P<attrlist>.*)\]$)
31 # Substitution attributes for escaping AsciiDoc processing.
43 # DEPRECATED: underscore attribute names.
46 # Left and right single and double quote characters.
47 # See http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
54 subs=specialcharacters,quotes,replacements,macros,attributes,replacements2
55 # Double-line title pattern and underlines.
56 sectiontitle=^(?P<title>.*?)$
57 underlines="==","--","~~","^^","++"
58 # Single-line title patterns.
59 sect0=^= +(?P<title>[\S].*?)( +=)?$
60 sect1=^== +(?P<title>[\S].*?)( +==)?$
61 sect2=^=== +(?P<title>[\S].*?)( +===)?$
62 sect3=^==== +(?P<title>[\S].*?)( +====)?$
63 sect4=^===== +(?P<title>[\S].*?)( +=====)?$
64 blocktitle=^\.(?P<title>([^.\s].*)|(\.[^.\s].*))$
72 # The order is important, quotes are processed in conf file order.
78 ifdef::no-inline-literal[]
80 endif::no-inline-literal[]
81 # +++ and $$ quoting is applied to the +++ and $$ inline passthrough
82 # macros to allow quoted attributes to be used.
83 # This trick only works with inline passthrough macros.
101 # Replacements performed in order of configuration file entry. The first entry
102 # of each replacement pair performs the (non-escaped) replacement, the second
103 # strips the backslash from the escaped replacement.
105 # (C) Copyright (entity reference ©)
109 # (R) registered trade mark (entity reference ®
113 # (TM) Trademark (entity reference ™)
114 (?<!\\)\(TM\)=™
117 # -- Spaced and unspaced em dashes (entity reference —).
118 # Space on both sides is translated to thin space characters.
119 (^-- )=— 
120 (\n-- )|( -- )|( --\n)= — 
121 (\w)--(\w)=\1—\2
124 # Replace vertical typewriter apostrophe with punctuation apostrophe.
125 (\w)'(\w)=\1’\2
128 # ... Ellipsis (entity reference …)
129 (?<!\\)\.\.\.=…
132 # Arrows from the Arrows block of Unicode.
136 # => right double arrow
137 (?<!\\)\=>=⇒
142 # <= left double arrow
143 (?<!\\)<\==⇐
146 # Arbitrary entity references.
147 (?<!\\)&([:_#a-zA-Z][:_.\-\w]*?;)=&\1
148 \\(&[:_#a-zA-Z][:_.\-\w]*?;)=\1
154 delimiter=(?s)(?P<text>\S.*)
157 template::[paragraph-styles]
160 delimiter=(?s)(?P<text>\s+.*)
164 template::[paragraph-styles]
167 delimiter=(?s)^\s*(?P<style>NOTE|TIP|IMPORTANT|WARNING|CAUTION):\s+(?P<text>.+)
168 template::[paragraph-styles]
171 normal-style=template="paragraph"
172 verse-style=template="verseparagraph",posattrs=["style","attribution","citetitle"]
173 quote-style=template="quoteparagraph",posattrs=["style","attribution","citetitle"]
174 literal-style=template="literalparagraph",subs=["verbatim"]
175 listing-style=template="listingparagraph",subs=["verbatim"]
176 NOTE-style=template="admonitionparagraph",name="note",caption="{note-caption}"
177 TIP-style=template="admonitionparagraph",name="tip",caption="{tip-caption}"
178 IMPORTANT-style=template="admonitionparagraph",name="important",caption="{important-caption}"
179 WARNING-style=template="admonitionparagraph",name="warning",caption="{warning-caption}"
180 CAUTION-style=template="admonitionparagraph",name="caution",caption="{caution-caption}"
183 template::[literalblock]
186 template::[verseblock]
189 template::[quoteblock]
192 template::[listingblock]
198 # Backslash prefix required for escape processing.
199 # (?s) re flag for line spanning.
201 # Macros using default syntax.
202 (?su)(?<!\w)[\\]?(?P<name>http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
204 # These URL types don't require any special attribute list formatting.
205 (?su)(?<!\S)[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])=
206 # Allow a leading parenthesis and square bracket.
207 (?su)(?<\=[([])[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])=
209 (?su)[\\]?<(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])>=
211 # Email addresses don't require special attribute list formatting.
212 # The before ">: and after "< character exclusions stop multiple substitution.
213 (?su)(?<![">:\w._/-])[\\]?(?P<target>\w[\w._-]*@[\w._-]*\w)(?!["<\w_-])=mailto
215 # Allow footnote macros hard up against the preceding word so the footnote mark
216 # can be placed against the noted text without an intervening space
217 # (http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5).
218 (?su)[\\]?(?P<name>footnote|footnoteref):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
220 # Anchor: [[[id]]]. Bibliographic anchor.
221 (?su)[\\]?\[\[\[(?P<attrlist>[\w_:][\w_:.-]*?)\]\]\]=anchor3
222 # Anchor: [[id,xreflabel]]
223 (?su)[\\]?\[\[(?P<attrlist>[\w"_:].*?)\]\]=anchor2
225 (?su)[\\]?<<(?P<attrlist>[\w"_:].*?)>>=xref2
227 ifdef::asciidoc7compatible[]
228 # Index term: ++primary,secondary,tertiary++
229 (?su)(?<!\S)[\\]?\+\+(?P<attrlist>[^+].*?)\+\+(?!\+)=indexterm
230 # Index term: +primary+
231 # Follows ++...++ macro otherwise it will match them.
232 (?<!\S)[\\]?\+(?P<attrlist>[^\s\+][^+].*?)\+(?!\+)=indexterm2
233 endif::asciidoc7compatible[]
235 ifndef::asciidoc7compatible[]
236 # Index term: (((primary,secondary,tertiary)))
237 (?su)(?<!\()[\\]?\(\(\((?P<attrlist>[^(].*?)\)\)\)(?!\))=indexterm
238 # Index term: ((primary))
239 # Follows (((...))) macro otherwise it will match them.
240 (?<!\()[\\]?\(\((?P<attrlist>[^\s\(][^(].*?)\)\)(?!\))=indexterm2
241 endif::asciidoc7compatible[]
244 [\\]?<(?P<index>\d+)>=callout
246 # Passthrough macros.
247 (?su)[\\]?(?P<name>pass):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[]
249 # Triple-plus and double-dollar inline passthroughs.
250 (?su)[\\]?\+\+\+(?P<passtext>.*?)\+\+\+=pass[]
251 (?su)[\\]?\$\$(?P<passtext>.*?)\$\$=pass[specialcharacters]
254 ifndef::no-inline-literal[]
255 (?su)(?<![`\w])([\\]?`(?P<passtext>[^`\s]|[^`\s].*?\S)`)(?![`\w])=literal[specialcharacters]
256 endif::no-inline-literal[]
259 (?mu)^[\\]?//(?P<passtext>[^/].*|)$=comment[specialcharacters]
261 # Default (catchall) inline macro is not implemented so there is no ambiguity
262 # with previous definition that could result in double substitution of escaped
264 #(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=
269 # Macros using default syntax.
270 (?u)^(?P<name>image|unfloat)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=#
272 # Passthrough macros.
273 (?u)^(?P<name>pass)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#
277 ^//(?P<passtext>[^/].*|)$=#comment[specialcharacters]
280 # Implemented in HTML backends.
291 template=sidebarblock
294 # DEPRECATED: Use Openblock instead.
295 abstract-style=template="abstractblock"
298 # A block without opening or closing tags.
303 abstract-style=template="abstractblock"
304 partintro-style=template="partintroblock"
309 # Default subs choosen for backward compatibility.
310 subs=attributes,macros
312 pass-style=template="passblock",subs=[]
316 template=listingblock
322 template=literalblock
325 listing-style=template="listingblock"
326 # DEPRECATED: Use verse style on quote blocks instead.
327 verse-style=template="verseblock",subs="normal"
333 posattrs=style,attribution,citetitle
334 quote-style=template="quoteblock",options=("sectionbody",)
335 verse-style=template="verseblock"
339 template=exampleblock
342 NOTE-style=template="admonitionblock",name="note",caption="{note-caption}"
343 TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}"
344 IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}"
345 WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}"
346 CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}"
348 # For use by custom filters.
349 # DEPRECATED: No longer used, a styled listing block (blockdef-listing) is preferable.
352 template=listingblock
361 delimiter=^\s*- +(?P<text>.+)$
365 callout-style=tags="callout"
366 bibliography-style=tags="bibliography"
370 template::[listdef-bulleted]
371 delimiter=^\s*\* +(?P<text>.+)$
375 template::[listdef-bulleted]
376 delimiter=^\s*\*{2} +(?P<text>.+)$
380 template::[listdef-bulleted]
381 delimiter=^\s*\*{3} +(?P<text>.+)$
385 template::[listdef-bulleted]
386 delimiter=^\s*\*{4} +(?P<text>.+)$
390 template::[listdef-bulleted]
391 delimiter=^\s*\*{5} +(?P<text>.+)$
395 delimiter=^\s*(?P<index>\d+\.) +(?P<text>.+)$
402 # Lower alpha numbering.
403 template::[listdef-arabic]
404 delimiter=^\s*(?P<index>[a-z]\.) +(?P<text>.+)$
408 # Upper alpha numbering.
409 template::[listdef-arabic]
410 delimiter=^\s*(?P<index>[A-Z]\.) +(?P<text>.+)$
414 # Lower roman numbering.
415 template::[listdef-arabic]
416 delimiter=^\s*(?P<index>[ivx]+\)) +(?P<text>.+)$
420 # Upper roman numbering.
421 template::[listdef-arabic]
422 delimiter=^\s*(?P<index>[IVX]+\)) +(?P<text>.+)$
427 template::[listdef-arabic]
428 delimiter=^\s*\. +(?P<text>.+)$
432 template::[listdef-loweralpha]
433 delimiter=^\s*\.{2} +(?P<text>.+)$
437 template::[listdef-lowerroman]
438 delimiter=^\s*\.{3} +(?P<text>.+)$
442 template::[listdef-upperalpha]
443 delimiter=^\s*\.{4} +(?P<text>.+)$
447 template::[listdef-upperroman]
448 delimiter=^\s*\.{5} +(?P<text>.+)$
452 delimiter=^\s*(?P<label>.*[^:])::(\s+(?P<text>.+))?$
456 vertical-style=tags="labeled"
457 horizontal-style=tags="horizontal"
458 glossary-style=tags="glossary"
459 qanda-style=tags="qanda"
463 template::[listdef-labeled]
464 delimiter=^\s*(?P<label>.*[^;]);;(\s+(?P<text>.+))?$
468 template::[listdef-labeled]
469 delimiter=^\s*(?P<label>.*[^:]):{3}(\s+(?P<text>.+))?$
473 template::[listdef-labeled]
474 delimiter=^\s*(?P<label>.*[^:]):{4}(\s+(?P<text>.+))?$
478 delimiter=^<?(?P<index>\d*>) +(?P<text>.+)$
483 # DEPRECATED: Old list syntax.
486 delimiter=^\s*(?P<label>.*\S)\?\?$
490 # DEPRECATED: Old list syntax.
491 [listdef-bibliography]
493 delimiter=^\+ +(?P<text>.+)$
497 # DEPRECATED: Old list syntax.
499 delimiter=^(?P<label>.*\S):-$
511 default-style=tags="default"
512 verse-style=tags="verse"
513 literal-style=tags="literal",subs=["specialcharacters"]
514 emphasis-style=tags="emphasis"
515 strong-style=tags="strong"
516 monospaced-style=tags="monospaced"
517 header-style=tags="header"
518 asciidoc-style=tags="asciidoc",subs=[],filter='python "{asciidoc-file}" -b {backend} {asciidoc-args}{lang? -a "lang={lang}@"}{icons? -a icons -a "iconsdir={iconsdir}"}{imagesdir? -a "imagesdir={imagesdir}"}{data-uri? -a data-uri} -a "indir={indir}"{trace? -a "trace={trace}"} -s -'
521 # Same as [tabledef-default] but with different delimiter and separator.
523 separator=((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?!
526 verse-style=tags="verse"
527 literal-style=tags="literal",subs=["specialcharacters"]
528 emphasis-style=tags="emphasis"
529 strong-style=tags="strong"
530 monospaced-style=tags="monospaced"
531 header-style=tags="header"
532 asciidoc-style=tags="asciidoc",subs=[],filter='python "{asciidoc-file}" -b {backend} {asciidoc-args}{lang? -a "lang={lang}@"} -s -'
534 #----------------------------------------
535 # Common block and macro markup templates
536 #----------------------------------------
537 [comment-inlinemacro]
547 template::[pass-blockmacro]
552 [filter-image-blockmacro]
553 # Synthesize missing target attribute for filter generated file names.
554 # The tag split | ensures missing target file names are auto-generated
555 # before the filter is executed, the remainder (the [image-blockmacro])
556 # is excuted after the filter to ensure data URI encoding comes after
557 # the image is created.
558 {target%}{counter2:target-number}
559 {target%}{set2:target:{docname}__{target-number}.png}
561 template::[image-blockmacro]
563 #----------------------------------
564 # Default special section templates
565 #----------------------------------
593 #--------------------------------------------------------------------
594 # Deprecated old table definitions.
597 [old_tabledef-default]
609 # End of deprecated old table definitions.
610 #--------------------------------------------------------------------