# # asciidoc.conf # # Asciidoc global configuration file. # Contains backend independent configuration settings that are applied to all # AsciiDoc documents. # [miscellaneous] tabsize=8 textwidth=70 newline=\r\n [attributes] backend-alias-html=xhtml11 backend-alias-docbook=docbook45 toclevels=2 toc-placement=auto sectids= iconsdir=./images/icons encoding=UTF-8 # Uncomment to use xhtml11 quirks mode CSS. #quirks= # HTML source code highlighter (source-highlight, pygments or highlight). source-highlighter=source-highlight # Uncomment to use deprecated quote attributes. #deprecated-quotes= empty= sp=" " # Attribute and AttributeList element patterns. attributeentry-pattern=^:(?P\w[^.]*?)(\.(?P.*?))?:(\s+(?P.*))?$ attributelist-pattern=(?u)(^\[\[(?P[\w_:][\w_:.-]*)(,(?P.*?))?\]\]$)|(^\[(?P.*)\]$) # Substitution attributes for escaping AsciiDoc processing. amp=& lt=< gt=> brvbar=| nbsp=  zwsp=​ wj=⁠ deg=° backslash=\ two-colons=:: two-semicolons=;; # DEPRECATED: underscore attribute names. two_colons=:: two_semicolons=;; # Left and right single and double quote characters. # See http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks lsquo=‘ rsquo=’ ldquo=“ rdquo=” [titles] subs=specialcharacters,quotes,replacements,macros,attributes,replacements2 # Double-line title pattern and underlines. sectiontitle=^(?P.*?)$ underlines="==","--","~~","^^","++" # Single-line title patterns. sect0=^= +(?P<title>[\S].*?)( +=)?$ sect1=^== +(?P<title>[\S].*?)( +==)?$ sect2=^=== +(?P<title>[\S].*?)( +===)?$ sect3=^==== +(?P<title>[\S].*?)( +====)?$ sect4=^===== +(?P<title>[\S].*?)( +=====)?$ blocktitle=^\.(?P<title>([^.\s].*)|(\.[^.\s].*))$ [specialcharacters] &=& <=< >=> [quotes] # The order is important, quotes are processed in conf file order. **=#strong *=strong ``|''=doublequoted '=emphasis `|'=singlequoted ifdef::no-inline-literal[] `=monospaced endif::no-inline-literal[] # +++ and $$ quoting is applied to the +++ and $$ inline passthrough # macros to allow quoted attributes to be used. # This trick only works with inline passthrough macros. +++=#unquoted $$=#unquoted ++=#monospaced +=monospaced __=#emphasis _=emphasis \##=#unquoted \#=unquoted ^=#superscript ~=#subscript [specialwords] emphasizedwords= strongwords= monospacedwords= [replacements] # Replacements performed in order of configuration file entry. The first entry # of each replacement pair performs the (non-escaped) replacement, the second # strips the backslash from the escaped replacement. # (C) Copyright (entity reference ©) (?<!\\)\(C\)=© \\\(C\)=(C) # (R) registered trade mark (entity reference ® (?<!\\)\(R\)=® \\\(R\)=(R) # (TM) Trademark (entity reference ™) (?<!\\)\(TM\)=™ \\\(TM\)=(TM) # -- Spaced and unspaced em dashes (entity reference —). # Space on both sides is translated to thin space characters. (^-- )=—  (\n-- )|( -- )|( --\n)= —  (\w)--(\w)=\1—\2 \\--(?!-)=-- # Replace vertical typewriter apostrophe with punctuation apostrophe. (\w)'(\w)=\1’\2 (\w)\\'(\w)=\1'\2 # ... Ellipsis (entity reference …) (?<!\\)\.\.\.=… \\\.\.\.=... # Arrows from the Arrows block of Unicode. # -> right arrow (?<!\\)->=→ \\->=-> # => right double arrow (?<!\\)\=>=⇒ \\\=>==> # <- left arrow (?<!\\)<-=← \\<-=<- # <= left double arrow (?<!\\)<\==⇐ \\<\==<= # Arbitrary entity references. (?<!\\)&([:_#a-zA-Z][:_.\-\w]*?;)=&\1 \\(&[:_#a-zA-Z][:_.\-\w]*?;)=\1 #----------- # Paragraphs #----------- [paradef-default] delimiter=(?s)(?P<text>\S.*) posattrs=style style=normal template::[paragraph-styles] [paradef-literal] delimiter=(?s)(?P<text>\s+.*) options=listelement posattrs=style style=literal template::[paragraph-styles] [paradef-admonition] delimiter=(?s)^\s*(?P<style>NOTE|TIP|IMPORTANT|WARNING|CAUTION):\s+(?P<text>.+) template::[paragraph-styles] [paragraph-styles] normal-style=template="paragraph" comment-style=template="paragraph",options=('skip',) verse-style=template="verseparagraph",posattrs=("style","attribution","citetitle") quote-style=template="quoteparagraph",posattrs=("style","attribution","citetitle") literal-style=template="literalparagraph",subs=("verbatim",) listing-style=template="listingparagraph",subs=("verbatim",) example-style=template="exampleparagraph" sidebar-style=template="sidebarparagraph" abstract-style=template="abstractparagraph" partintro-style=template="partintroparagraph" NOTE-style=template="admonitionparagraph",name="note",caption="{note-caption}" TIP-style=template="admonitionparagraph",name="tip",caption="{tip-caption}" IMPORTANT-style=template="admonitionparagraph",name="important",caption="{important-caption}" WARNING-style=template="admonitionparagraph",name="warning",caption="{warning-caption}" CAUTION-style=template="admonitionparagraph",name="caution",caption="{caution-caption}" [literalparagraph] template::[literalblock] [verseparagraph] template::[verseblock] [quoteparagraph] template::[quoteblock] [listingparagraph] template::[listingblock] [exampleparagraph] template::[exampleblock] [sidebarparagraph] template::[sidebarblock] [abstractparagraph] template::[abstractblock] [partintroparagraph] template::[partintroblock] [macros] #-------------- # Inline macros #-------------- # Backslash prefix required for escape processing. # (?s) re flag for line spanning. # Macros using default syntax. (?su)(?<!\w)[\\]?(?P<name>http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm):(?P<target>\S*?)\[(?P<attrlist>.*?)(?<!\\)\]= # These URL types don't require any special attribute list formatting. (?su)(?<!\S)[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])= # Allow a leading parenthesis and square bracket. (?su)(?<\=[([])[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])= # Allow <> brackets. (?su)[\\]?<(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])>= # Email addresses don't require special attribute list formatting. # The before ">: and after "< character exclusions stop multiple substitution. (?su)(?<![">:\w._/-])[\\]?(?P<target>\w[\w._-]*@[\w._-]*\w)(?!["<\w_-])=mailto # Allow footnote macros hard up against the preceding word so the footnote mark # can be placed against the noted text without an intervening space # (http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5). (?su)[\\]?(?P<name>footnote|footnoteref):(?P<target>\S*?)\[(?P<attrlist>.*?)(?<!\\)\]= # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P<attrlist>[\w_:][\w_:.-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] (?su)[\\]?\[\[(?P<attrlist>[\w"_:].*?)\]\]=anchor2 # Link: <<id,text>> (?su)[\\]?<<(?P<attrlist>[\w"_:].*?)>>=xref2 ifdef::asciidoc7compatible[] # Index term: ++primary,secondary,tertiary++ (?su)(?<!\S)[\\]?\+\+(?P<attrlist>[^+].*?)\+\+(?!\+)=indexterm # Index term: +primary+ # Follows ++...++ macro otherwise it will match them. (?<!\S)[\\]?\+(?P<attrlist>[^\s\+][^+].*?)\+(?!\+)=indexterm2 endif::asciidoc7compatible[] ifndef::asciidoc7compatible[] # Index term: (((primary,secondary,tertiary))) (?su)(?<!\()[\\]?\(\(\((?P<attrlist>[^(].*?)\)\)\)(?!\))=indexterm # Index term: ((primary)) # Follows (((...))) macro otherwise it will match them. (?<!\()[\\]?\(\((?P<attrlist>[^\s\(][^(].*?)\)\)(?!\))=indexterm2 endif::asciidoc7compatible[] # Callout [\\]?<(?P<index>\d+)>=callout # Passthrough macros. (?su)[\\]?(?P<name>pass):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[] # Triple-plus and double-dollar inline passthroughs. (?su)[\\]?\+\+\+(?P<passtext>.*?)\+\+\+=pass[] (?su)[\\]?\$\$(?P<passtext>.*?)\$\$=pass[specialcharacters] # Inline literal. ifndef::no-inline-literal[] (?su)(?<![`\w])([\\]?`(?P<passtext>[^`\s]|[^`\s].*?\S)`)(?![`\w])=literal[specialcharacters] endif::no-inline-literal[] # Inline comment. (?mu)^[\\]?//(?P<passtext>[^/].*|)$=comment[specialcharacters] # Default (catchall) inline macro is not implemented so there is no ambiguity # with previous definition that could result in double substitution of escaped # references. #(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)\[(?P<passtext>.*?)(?<!\\)\]= #------------- # Block macros #------------- # Macros using default syntax. (?u)^(?P<name>image|unfloat|toc)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=# # Passthrough macros. (?u)^(?P<name>pass)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=# ^'{3,}$=#ruler ^<{3,}$=#pagebreak ^//(?P<passtext>[^/].*|)$=#comment[specialcharacters] # Implemented in HTML backends. [unfloat-blockmacro] [toc-blockmacro] #----------------- # Delimited blocks #----------------- [blockdef-comment] delimiter=^/{4,}$ options=skip posattrs=style [blockdef-sidebar] delimiter=^\*{4,}$ template=sidebarblock options=sectionbody posattrs=style # DEPRECATED: Use Openblock instead. abstract-style=template="abstractblock" [blockdef-open] # A block without opening or closing tags. delimiter=^--$ posattrs=style style=default default-style=template="openblock",options=("sectionbody",) comment-style=template="openblock",options=("skip",) abstract-style=template="abstractblock",options=("sectionbody",) partintro-style=template="partintroblock",options=("sectionbody",) example-style=template="exampleblock",options=("sectionbody",) sidebar-style=template="sidebarblock",options=("sectionbody",) verse-style=template="verseblock",posattrs=("style","attribution","citetitle") quote-style=template="quoteblock",posattrs=("style","attribution","citetitle"),options=("sectionbody",) literal-style=template="literalparagraph",subs=("verbatim",) listing-style=template="listingparagraph",subs=("verbatim",) NOTE-style=template="admonitionblock",name="note",caption="{note-caption}",options=("sectionbody",) TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}",options=("sectionbody",) IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}",options=("sectionbody",) WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}",options=("sectionbody",) CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}",options=("sectionbody",) [blockdef-pass] delimiter=^\+{4,}$ template=passblock # Default subs choosen for backward compatibility. subs=attributes,macros posattrs=style pass-style=template="passblock",subs=() [blockdef-listing] delimiter=^-{4,}$ template=listingblock subs=verbatim posattrs=style [blockdef-literal] delimiter=^\.{4,}$ template=literalblock subs=verbatim posattrs=style listing-style=template="listingblock" # DEPRECATED: Use verse style on quote blocks instead. verse-style=template="verseblock",subs="normal" [blockdef-quote] delimiter=^_{4,}$ subs=normal style=quote posattrs=style,attribution,citetitle quote-style=template="quoteblock",options=("sectionbody",) verse-style=template="verseblock" [blockdef-example] delimiter=^={4,}$ template=exampleblock options=sectionbody posattrs=style NOTE-style=template="admonitionblock",name="note",caption="{note-caption}" TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}" IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}" WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}" CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}" # For use by custom filters. # DEPRECATED: No longer used, a styled listing block (blockdef-listing) is preferable. [blockdef-filter] delimiter=^~{4,}$ template=listingblock subs=none posattrs=style #------- # Lists #------- [listdef-bulleted] # - bullets. delimiter=^\s*- +(?P<text>.+)$ posattrs=style type=bulleted tags=bulleted callout-style=tags="callout" bibliography-style=tags="bibliography" [listdef-bulleted1] # * bullets. template::[listdef-bulleted] delimiter=^\s*\* +(?P<text>.+)$ [listdef-bulleted2] # ** bullets. template::[listdef-bulleted] delimiter=^\s*\*{2} +(?P<text>.+)$ [listdef-bulleted3] # *** bullets. template::[listdef-bulleted] delimiter=^\s*\*{3} +(?P<text>.+)$ [listdef-bulleted4] # **** bullets. template::[listdef-bulleted] delimiter=^\s*\*{4} +(?P<text>.+)$ [listdef-bulleted5] # ***** bullets. template::[listdef-bulleted] delimiter=^\s*\*{5} +(?P<text>.+)$ [listdef-arabic] # Arabic numbering. delimiter=^\s*(?P<index>\d+\.) +(?P<text>.+)$ posattrs=style type=numbered tags=numbered style=arabic [listdef-loweralpha] # Lower alpha numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[a-z]\.) +(?P<text>.+)$ style=loweralpha [listdef-upperalpha] # Upper alpha numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[A-Z]\.) +(?P<text>.+)$ style=upperalpha [listdef-lowerroman] # Lower roman numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[ivx]+\)) +(?P<text>.+)$ style=lowerroman [listdef-upperroman] # Upper roman numbering. template::[listdef-arabic] delimiter=^\s*(?P<index>[IVX]+\)) +(?P<text>.+)$ style=upperroman [listdef-numbered1] # . numbering. template::[listdef-arabic] delimiter=^\s*\. +(?P<text>.+)$ [listdef-numbered2] # .. numbering. template::[listdef-loweralpha] delimiter=^\s*\.{2} +(?P<text>.+)$ [listdef-numbered3] # ... numbering. template::[listdef-lowerroman] delimiter=^\s*\.{3} +(?P<text>.+)$ [listdef-numbered4] # .... numbering. template::[listdef-upperalpha] delimiter=^\s*\.{4} +(?P<text>.+)$ [listdef-numbered5] # ..... numbering. template::[listdef-upperroman] delimiter=^\s*\.{5} +(?P<text>.+)$ [listdef-labeled] # label:: item. delimiter=^\s*(?P<label>.*[^:])::(\s+(?P<text>.+))?$ posattrs=style type=labeled tags=labeled vertical-style=tags="labeled" horizontal-style=tags="horizontal" glossary-style=tags="glossary" qanda-style=tags="qanda" [listdef-labeled2] # label;; item. template::[listdef-labeled] delimiter=^\s*(?P<label>.*[^;]);;(\s+(?P<text>.+))?$ [listdef-labeled3] # label::: item. template::[listdef-labeled] delimiter=^\s*(?P<label>.*[^:]):{3}(\s+(?P<text>.+))?$ [listdef-labeled4] # label:::: item. template::[listdef-labeled] delimiter=^\s*(?P<label>.*[^:]):{4}(\s+(?P<text>.+))?$ [listdef-callout] posattrs=style delimiter=^<?(?P<index>\d*>) +(?P<text>.+)$ type=callout tags=callout style=arabic # DEPRECATED: Old list syntax. [listdef-qanda] posattrs=style delimiter=^\s*(?P<label>.*\S)\?\?$ type=labeled tags=qanda # DEPRECATED: Old list syntax. [listdef-bibliography] posattrs=style delimiter=^\+ +(?P<text>.+)$ type=bulleted tags=bibliography # DEPRECATED: Old list syntax. [listdef-glossary] delimiter=^(?P<label>.*\S):-$ posattrs=style type=labeled tags=glossary #------- # Tables #------- [tabledef-default] delimiter=^\|={3,}$ posattrs=style template=table default-style=tags="default" verse-style=tags="verse" literal-style=tags="literal",subs=("specialcharacters",) emphasis-style=tags="emphasis" strong-style=tags="strong" monospaced-style=tags="monospaced" header-style=tags="header" 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}"}{blockname? -a "blockname={blockname}"} -s -' [tabledef-nested] # Same as [tabledef-default] but with different delimiter and separator. delimiter=^!={3,}$ separator=((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?! posattrs=style template=table verse-style=tags="verse" literal-style=tags="literal",subs=("specialcharacters",) emphasis-style=tags="emphasis" strong-style=tags="strong" monospaced-style=tags="monospaced" header-style=tags="header" 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}"}{blockname? -a "blockname={blockname}"} -s -' #---------------------------------------- # Common block and macro markup templates #---------------------------------------- [comment-inlinemacro] # Outputs nothing. [comment-blockmacro] # Outputs nothing. [pass-blockmacro] {passtext} [pass-inlinemacro] template::[pass-blockmacro] [passblock] | [filter-image-blockmacro] # Synthesize missing target attribute for filter generated file names. # The tag split | ensures missing target file names are auto-generated # before the filter is executed, the remainder (the [image-blockmacro]) # is excuted after the filter to ensure data URI encoding comes after # the image is created. {target%}{counter2:target-number} {target%}{set2:target:{docname}__{target-number}.png} | template::[image-blockmacro] [+docinfo] # Blank section to suppress missing template warning. #---------------------------------- # Default special section templates #---------------------------------- [abstract] template::[sect1] [colophon] template::[sect1] [dedication] template::[sect1] [preface] template::[sect1] [appendix] template::[sect1] [glossary] template::[sect1] [bibliography] template::[sect1] [index] template::[sect1] [synopsis] template::[sect1] #-------------------------------------------------------------------- # Deprecated old table definitions. # [old_tabledef-default] fillchar=- format=fixed [old_tabledef-csv] fillchar=~ format=csv [old_tabledef-dsv] fillchar=_ format=dsv # End of deprecated old table definitions. #--------------------------------------------------------------------