doc/www/asciidoc.conf

   1 #
   2 # asciidoc.conf
   3 #
   4 # Asciidoc global configuration file.
   5 # Contains backend independent configuration settings that are applied to all
   6 # AsciiDoc documents.
   7 #
   8
   9 [miscellaneous]
  10 tabsize=8
  11 textwidth=70
  12 newline=\r\n
  13
  14 [attributes]
  15 backend-alias-html=xhtml11
  16 backend-alias-docbook=docbook45
  17 toclevels=2
  18 sectids=
  19 iconsdir=./images/icons
  20 encoding=UTF-8
  21 # Uncomment to use xhtml11 quirks mode CSS.
  22 #quirks=
  23 # Uncomment to use the Pygments source highlighter instead of GNU highlighter.
  24 #pygments=
  25 # Uncomment to use deprecated quote attributes.
  26 #deprecated-quotes=
  27 empty=
  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.
  32 amp=&
  33 lt=<
  34 gt=>
  35 brvbar=|
  36 nbsp=&#160;
  37 zwsp=&#8203;
  38 wj=&#8288;
  39 deg=&#176;
  40 backslash=\
  41 two-colons=::
  42 two-semicolons=;;
  43 # DEPRECATED: underscore attribute names.
  44 two_colons=::
  45 two_semicolons=;;
  46 # Left and right single and double quote characters.
  47 # See http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
  48 lsquo=&#8216;
  49 rsquo=&#8217;
  50 ldquo=&#8220;
  51 rdquo=&#8221;
  52
  53 [titles]
  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].*))$
  65
  66 [specialcharacters]
  67 &=&amp;
  68 <=&lt;
  69 >=&gt;
  70
  71 [quotes]
  72 # The order is important, quotes are processed in conf file order.
  73 **=#strong
  74 *=strong
  75 ``|''=doublequoted
  76 '=emphasis
  77 `|'=singlequoted
  78 ifdef::no-inline-literal[]
  79 `=monospaced
  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.
  84 +++=#unquoted
  85 $$=#unquoted
  86 ++=#monospaced
  87 +=monospaced
  88 __=#emphasis
  89 _=emphasis
  90 \##=#unquoted
  91 \#=unquoted
  92 ^=#superscript
  93 ~=#subscript
  94
  95 [specialwords]
  96 emphasizedwords=
  97 strongwords=
  98 monospacedwords=
  99
 100 [replacements]
 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.
 104
 105 # (C) Copyright (entity reference &copy;)
 106 (?<!\\)\(C\)=&#169;
 107 \\\(C\)=(C)
 108
 109 # (R) registered trade mark (entity reference &reg;
 110 (?<!\\)\(R\)=&#174;
 111 \\\(R\)=(R)
 112
 113 # (TM) Trademark (entity reference &trade;)
 114 (?<!\\)\(TM\)=&#8482;
 115 \\\(TM\)=(TM)
 116
 117 # -- Spaced and unspaced em dashes (entity reference &mdash;).
 118 # Space on both sides is translated to thin space characters.
 119 (^-- )=&#8212;&#8201;
 120 (\n-- )|( -- )|( --\n)=&#8201;&#8212;&#8201;
 121 (\w)--(\w)=\1&#8212;\2
 122 \\--(?!-)=--
 123
 124 # Replace vertical typewriter apostrophe with punctuation apostrophe.
 125 (\w)'(\w)=\1&#8217;\2
 126 (\w)\\'(\w)=\1'\2
 127
 128 # ... Ellipsis (entity reference &hellip;)
 129 (?<!\\)\.\.\.=&#8230;
 130 \\\.\.\.=...
 131
 132 # Arrows from the Arrows block of Unicode.
 133 # -> right arrow
 134 (?<!\\)-&gt;=&#8594;
 135 \\-&gt;=-&gt;
 136 # => right double arrow
 137 (?<!\\)\=&gt;=&#8658;
 138 \\\=&gt;==&gt;
 139 # <- left arrow
 140 (?<!\\)&lt;-=&#8592;
 141 \\&lt;-=&lt;-
 142 # <= left double arrow
 143 (?<!\\)&lt;\==&#8656;
 144 \\&lt;\==&lt;=
 145
 146 # Arbitrary entity references.
 147 (?<!\\)&amp;([:_#a-zA-Z][:_.\-\w]*?;)=&\1
 148 \\(&amp;[:_#a-zA-Z][:_.\-\w]*?;)=\1
 149
 150 #-----------
 151 # Paragraphs
 152 #-----------
 153 [paradef-default]
 154 delimiter=(?s)(?P<text>\S.*)
 155 posattrs=style
 156 style=normal
 157 template::[paragraph-styles]
 158
 159 [paradef-literal]
 160 delimiter=(?s)(?P<text>\s+.*)
 161 options=listelement
 162 posattrs=style
 163 style=literal
 164 template::[paragraph-styles]
 165
 166 [paradef-admonition]
 167 delimiter=(?s)^\s*(?P<style>NOTE|TIP|IMPORTANT|WARNING|CAUTION):\s+(?P<text>.+)
 168 template::[paragraph-styles]
 169
 170 [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}"
 181
 182 [literalparagraph]
 183 template::[literalblock]
 184
 185 [verseparagraph]
 186 template::[verseblock]
 187
 188 [quoteparagraph]
 189 template::[quoteblock]
 190
 191 [listingparagraph]
 192 template::[listingblock]
 193
 194 [macros]
 195 #--------------
 196 # Inline macros
 197 #--------------
 198 # Backslash prefix required for escape processing.
 199 # (?s) re flag for line spanning.
 200
 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>.*?)\]=
 203
 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/])=
 208 # Allow <> brackets.
 209 (?su)[\\]?&lt;(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])&gt;=
 210
 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
 214
 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>.*?)\]=
 219
 220 # Anchor: [[[id]]]. Bibliographic anchor.
 221 (?su)[\\]?\[\[\[(?P<attrlist>[\w_:][\w_:.-]*?)\]\]\]=anchor3
 222 # Anchor: [[id,xreflabel]]
 223 (?su)[\\]?\[\[(?P<attrlist>[\w"_:].*?)\]\]=anchor2
 224 # Link: <<id,text>>
 225 (?su)[\\]?&lt;&lt;(?P<attrlist>[\w"_:].*?)&gt;&gt;=xref2
 226
 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[]
 234
 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[]
 242
 243 # Callout
 244 [\\]?&lt;(?P<index>\d+)&gt;=callout
 245
 246 # Passthrough macros.
 247 (?su)[\\]?(?P<name>pass):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[]
 248
 249 # Triple-plus and double-dollar inline passthroughs.
 250 (?su)[\\]?\+\+\+(?P<passtext>.*?)\+\+\+=pass[]
 251 (?su)[\\]?\$\$(?P<passtext>.*?)\$\$=pass[specialcharacters]
 252
 253 # Inline literal.
 254 ifndef::no-inline-literal[]
 255 (?su)(?<![`\w])([\\]?`(?P<passtext>[^`\s]|[^`\s].*?\S)`)(?![`\w])=literal[specialcharacters]
 256 endif::no-inline-literal[]
 257
 258 # Inline comment.
 259 (?mu)^[\\]?//(?P<passtext>[^/].*|)$=comment[specialcharacters]
 260
 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
 263 # references.
 264 #(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=
 265
 266 #-------------
 267 # Block macros
 268 #-------------
 269 # Macros using default syntax.
 270 (?u)^(?P<name>image|unfloat)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=#
 271
 272 # Passthrough macros.
 273 (?u)^(?P<name>pass)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#
 274
 275 ^'{3,}$=#ruler
 276 ^<{3,}$=#pagebreak
 277 ^//(?P<passtext>[^/].*|)$=#comment[specialcharacters]
 278
 279 [unfloat-blockmacro]
 280 # Implemented in HTML backends.
 281
 282 #-----------------
 283 # Delimited blocks
 284 #-----------------
 285 [blockdef-comment]
 286 delimiter=^/{4,}$
 287 options=skip
 288
 289 [blockdef-sidebar]
 290 delimiter=^\*{4,}$
 291 template=sidebarblock
 292 options=sectionbody
 293 posattrs=style
 294 # DEPRECATED: Use Openblock instead.
 295 abstract-style=template="abstractblock"
 296
 297 [blockdef-open]
 298 # A block without opening or closing tags.
 299 delimiter=^--$
 300 template=openblock
 301 options=sectionbody
 302 posattrs=style
 303 abstract-style=template="abstractblock"
 304 partintro-style=template="partintroblock"
 305
 306 [blockdef-pass]
 307 delimiter=^\+{4,}$
 308 template=passblock
 309 # Default subs choosen for backward compatibility.
 310 subs=attributes,macros
 311 posattrs=style
 312 pass-style=template="passblock",subs=[]
 313
 314 [blockdef-listing]
 315 delimiter=^-{4,}$
 316 template=listingblock
 317 subs=verbatim
 318 posattrs=style
 319
 320 [blockdef-literal]
 321 delimiter=^\.{4,}$
 322 template=literalblock
 323 subs=verbatim
 324 posattrs=style
 325 listing-style=template="listingblock"
 326 # DEPRECATED: Use verse style on quote blocks instead.
 327 verse-style=template="verseblock",subs="normal"
 328
 329 [blockdef-quote]
 330 delimiter=^_{4,}$
 331 subs=normal
 332 style=quote
 333 posattrs=style,attribution,citetitle
 334 quote-style=template="quoteblock",options=("sectionbody",)
 335 verse-style=template="verseblock"
 336
 337 [blockdef-example]
 338 delimiter=^={4,}$
 339 template=exampleblock
 340 options=sectionbody
 341 posattrs=style
 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}"
 347
 348 # For use by custom filters.
 349 # DEPRECATED: No longer used, a styled listing block (blockdef-listing) is preferable.
 350 [blockdef-filter]
 351 delimiter=^~{4,}$
 352 template=listingblock
 353 subs=none
 354 posattrs=style
 355
 356 #-------
 357 # Lists
 358 #-------
 359 [listdef-bulleted]
 360 # - bullets.
 361 delimiter=^\s*- +(?P<text>.+)$
 362 posattrs=style
 363 type=bulleted
 364 tags=bulleted
 365 callout-style=tags="callout"
 366 bibliography-style=tags="bibliography"
 367
 368 [listdef-bulleted1]
 369 # * bullets.
 370 template::[listdef-bulleted]
 371 delimiter=^\s*\* +(?P<text>.+)$
 372
 373 [listdef-bulleted2]
 374 # ** bullets.
 375 template::[listdef-bulleted]
 376 delimiter=^\s*\*{2} +(?P<text>.+)$
 377
 378 [listdef-bulleted3]
 379 # *** bullets.
 380 template::[listdef-bulleted]
 381 delimiter=^\s*\*{3} +(?P<text>.+)$
 382
 383 [listdef-bulleted4]
 384 # **** bullets.
 385 template::[listdef-bulleted]
 386 delimiter=^\s*\*{4} +(?P<text>.+)$
 387
 388 [listdef-bulleted5]
 389 # ***** bullets.
 390 template::[listdef-bulleted]
 391 delimiter=^\s*\*{5} +(?P<text>.+)$
 392
 393 [listdef-arabic]
 394 # Arabic numbering.
 395 delimiter=^\s*(?P<index>\d+\.) +(?P<text>.+)$
 396 posattrs=style
 397 type=numbered
 398 tags=numbered
 399 style=arabic
 400
 401 [listdef-loweralpha]
 402 # Lower alpha numbering.
 403 template::[listdef-arabic]
 404 delimiter=^\s*(?P<index>[a-z]\.) +(?P<text>.+)$
 405 style=loweralpha
 406
 407 [listdef-upperalpha]
 408 # Upper alpha numbering.
 409 template::[listdef-arabic]
 410 delimiter=^\s*(?P<index>[A-Z]\.) +(?P<text>.+)$
 411 style=upperalpha
 412
 413 [listdef-lowerroman]
 414 # Lower roman numbering.
 415 template::[listdef-arabic]
 416 delimiter=^\s*(?P<index>[ivx]+\)) +(?P<text>.+)$
 417 style=lowerroman
 418
 419 [listdef-upperroman]
 420 # Upper roman numbering.
 421 template::[listdef-arabic]
 422 delimiter=^\s*(?P<index>[IVX]+\)) +(?P<text>.+)$
 423 style=upperroman
 424
 425 [listdef-numbered1]
 426 # . numbering.
 427 template::[listdef-arabic]
 428 delimiter=^\s*\. +(?P<text>.+)$
 429
 430 [listdef-numbered2]
 431 # .. numbering.
 432 template::[listdef-loweralpha]
 433 delimiter=^\s*\.{2} +(?P<text>.+)$
 434
 435 [listdef-numbered3]
 436 # ... numbering.
 437 template::[listdef-lowerroman]
 438 delimiter=^\s*\.{3} +(?P<text>.+)$
 439
 440 [listdef-numbered4]
 441 # .... numbering.
 442 template::[listdef-upperalpha]
 443 delimiter=^\s*\.{4} +(?P<text>.+)$
 444
 445 [listdef-numbered5]
 446 # ..... numbering.
 447 template::[listdef-upperroman]
 448 delimiter=^\s*\.{5} +(?P<text>.+)$
 449
 450 [listdef-labeled]
 451 # label:: item.
 452 delimiter=^\s*(?P<label>.*[^:])::(\s+(?P<text>.+))?$
 453 posattrs=style
 454 type=labeled
 455 tags=labeled
 456 vertical-style=tags="labeled"
 457 horizontal-style=tags="horizontal"
 458 glossary-style=tags="glossary"
 459 qanda-style=tags="qanda"
 460
 461 [listdef-labeled2]
 462 # label;; item.
 463 template::[listdef-labeled]
 464 delimiter=^\s*(?P<label>.*[^;]);;(\s+(?P<text>.+))?$
 465
 466 [listdef-labeled3]
 467 # label::: item.
 468 template::[listdef-labeled]
 469 delimiter=^\s*(?P<label>.*[^:]):{3}(\s+(?P<text>.+))?$
 470
 471 [listdef-labeled4]
 472 # label:::: item.
 473 template::[listdef-labeled]
 474 delimiter=^\s*(?P<label>.*[^:]):{4}(\s+(?P<text>.+))?$
 475
 476 [listdef-callout]
 477 posattrs=style
 478 delimiter=^<?(?P<index>\d*>) +(?P<text>.+)$
 479 type=callout
 480 tags=callout
 481 style=arabic
 482
 483 # DEPRECATED: Old list syntax.
 484 [listdef-qanda]
 485 posattrs=style
 486 delimiter=^\s*(?P<label>.*\S)\?\?$
 487 type=labeled
 488 tags=qanda
 489
 490 # DEPRECATED: Old list syntax.
 491 [listdef-bibliography]
 492 posattrs=style
 493 delimiter=^\+ +(?P<text>.+)$
 494 type=bulleted
 495 tags=bibliography
 496
 497 # DEPRECATED: Old list syntax.
 498 [listdef-glossary]
 499 delimiter=^(?P<label>.*\S):-$
 500 posattrs=style
 501 type=labeled
 502 tags=glossary
 503
 504 #-------
 505 # Tables
 506 #-------
 507 [tabledef-default]
 508 delimiter=^\|={3,}$
 509 posattrs=style
 510 template=table
 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 -'
 519
 520 [tabledef-nested]
 521 # Same as [tabledef-default] but with different delimiter and separator.
 522 delimiter=^!={3,}$
 523 separator=((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?!
 524 posattrs=style
 525 template=table
 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 -'
 533
 534 #----------------------------------------
 535 # Common block and macro markup templates
 536 #----------------------------------------
 537 [comment-inlinemacro]
 538 # Outputs nothing.
 539
 540 [comment-blockmacro]
 541 # Outputs nothing.
 542
 543 [pass-blockmacro]
 544 {passtext}
 545
 546 [pass-inlinemacro]
 547 template::[pass-blockmacro]
 548
 549 [passblock]
 550 |
 551
 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}
 560 |
 561 template::[image-blockmacro]
 562
 563 #----------------------------------
 564 # Default special section templates
 565 #----------------------------------
 566 [abstract]
 567 template::[sect1]
 568
 569 [colophon]
 570 template::[sect1]
 571
 572 [dedication]
 573 template::[sect1]
 574
 575 [preface]
 576 template::[sect1]
 577
 578 [appendix]
 579 template::[sect1]
 580
 581 [glossary]
 582 template::[sect1]
 583
 584 [bibliography]
 585 template::[sect1]
 586
 587 [index]
 588 template::[sect1]
 589
 590 [synopsis]
 591 template::[sect1]
 592
 593 #--------------------------------------------------------------------
 594 # Deprecated old table definitions.
 595 #
 596
 597 [old_tabledef-default]
 598 fillchar=-
 599 format=fixed
 600
 601 [old_tabledef-csv]
 602 fillchar=~
 603 format=csv
 604
 605 [old_tabledef-dsv]
 606 fillchar=_
 607 format=dsv
 608
 609 # End of deprecated old table definitions.
 610 #--------------------------------------------------------------------