4 # Asciidoc configuration file.
5 # latex backend, generates LaTeX conformant markup.
7 # Originally created by Benjamin Klum, later modified by Geoff Eddy.
10 subs=quotes,replacements,attributes,macros,specialcharacters,replacements2
13 # The listing block uses a LaTeX verbatim environment where special characters don't need to be escaped.
14 # Hence only "callouts" substitution should be applied.
16 source-style=template="listingblock",subs=("callouts",)
23 latex-table-rowlimit=20
24 latex-use-bibliography-environment!
25 latex-indent-paragraphs!
26 latex-recognize-escaped-unicode!
27 latex-use-custom-list-items!
28 latex-use-colored-tables!
29 latex-use-running-title-headings!
30 latex-use-colored-sidebar-blocks!
34 subsnormal=quotes,specialwords,replacements,attributes,macros,specialcharacters,replacements2
35 #subsnormal=quotes,specialwords,replacements,attributes,macros,passthroughs,specialcharacters,replacements2
36 subsverbatim=callouts,specialcharacters,replacements2
38 # Screen width in pixels.
61 # I needed to rewrite some regular expressions because '<' and '>' have not been escaped to '<' and '>'
64 [\\]?<(?P<index>\d+)>=callout
67 (?su)[\\]?<<(?P<attrlist>[\w"].*?)>>=xref2
72 (?m)^(.*)\s\+$=\1 !..backslash..!newline!..braceleft..!!..braceright..!
74 # -- Spaced em dashes (entity reference —)
75 (^|[^-\\])--($|[^-])=\1--\2
78 # (C) Copyright (entity reference ©)
79 (?<!\\)\(C\)=!..backslash..!textcopyright!..braceleft..!!..braceright..!
82 # (R) registered trade mark (entity reference ®
83 (?<!\\)\(R\)=!..backslash..!textregistered!..braceleft..!!..braceright..!
86 # (TM) Trademark (entity reference ™)
87 (?<!\\)\(TM\)=!..backslash..!texttrademark!..braceleft..!!..braceright..!
90 # ... Ellipsis (entity reference …)
91 (?<!\\)\.\.\.=!..backslash..!dots!..braceleft..!!..braceright..!
94 # Recognize escaped unicode characters
95 # FIXME: these should be uncommented, but then there are encoding
98 #&#([0-9]*);=!..backslash..!unichar!..braceleft..!\1!..braceright..!
99 #&#x([0123456789abcdefABCDEF]*);=!..backslash..!unichar!..braceleft..!{eval:0x\1}!..braceright..!
102 ->=!..backslash..!textrightarrow!..braceleft..!!..braceright..!
103 # => right double arrow (have to enter math mode)
104 =>=!..dollar..!!..backslash..!Rightarrow!..braceleft..!!..braceright..!!..dollar..!
106 <-=!..backslash..!textleftarrow!..braceleft..!!..braceright..!
107 # <= left double arrow (have to enter math mode)
108 <\==!..dollar..!!..backslash..!Leftarrow!..braceleft..!!..braceright..!!..dollar..!
109 # --> long right arrow (have to enter math mode)
110 -->=!..backslash..!textrightarrow!..braceleft..!!..braceright..!
111 # ==> long right double arrow (have to enter math mode)
112 =\=>=!..dollar..!!..backslash..!Rightarrow!..braceleft..!!..braceright..!!..dollar..!
113 # <-- long left arrow (have to enter math mode)
114 <--=!..backslash..!textleftarrow!..braceleft..!!..braceright..!
115 # <== long left double arrow (have to enter math mode)
116 <\=\==!..dollar..!!..backslash..!Leftarrow!..braceleft..!!..braceright..!!..dollar..!
143 # Ruler is interpreted as a page break.
148 !..backslash..!href!..braceleft..!{link}!..braceright..!!..braceleft..!!..percent..!
149 !..backslash..!includegraphics[{scale?scale={scale},}{width?width={width}pt,}{height? height={height}pt}]!..braceleft..!{target}!..braceright..!
150 {link#}!..braceright..!
155 \\hypertarget\{{id}\}\{\}
158 \includegraphics[{scale?scale={scale},}{width?width={width}pt,}{height? height={height}pt}]\{{target}\}%
163 [indexterm-inlinemacro]
165 !..backslash..!index!..braceleft..!{1}{2?!{2}}{3?!{3}}!..braceright..!
167 [indexterm2-inlinemacro]
169 # Single entry index term that is visible in the primary text flow.
170 !..backslash..!index!..braceleft..!{1}!..braceright..!{1}
172 [footnote-inlinemacro]
174 !..backslash..!footnote!..braceleft..!{0}!..braceright..!
176 [footnoteref-inlinemacro]
179 [callout-inlinemacro]
183 [literal-inlinemacro]
186 list={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{itemize\}|\end\{itemize\}
191 list={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\}
196 list=\begin\{description\}|\end\{description\}
199 term=\item[|]\hfill\\*
203 [listtags-horizontal]
204 list={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{description\}|\end\{description\}
212 list={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{description\}|\end\{description\}
215 term=\item[%|]\dotfill
220 list={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\}
225 list={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\}
226 item=\begin\{quotation\}|\end\{quotation\}
233 list={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{enumerate\}|\end\{enumerate\}
240 [listtags-bibliography]
241 list=biblist={title?\minisec\{{title}\}} {id?\label\{{id}\}\\hypertarget\{{id}\}\{\}} \begin\{description\} | \end\{description\}
248 superscript=!..backslash..!textsuperscript!..braceleft..!|!..braceright..!
249 subscript=!..backslash..!textsubscript!..braceleft..!|!..braceright..!
256 emphasis=!..backslash..!emph!..braceleft..!|!..braceright..!
257 strong=!..backslash..!textbf!..braceleft..!|!..braceright..!
258 monospaced=!..backslash..!texttt!..braceleft..!|!..braceright..!
259 doublequoted=!..backslash..!{language!textquotedblleft}{language?{language@.german:glqq}}{language?{language@english:textquotedblleft}}!..braceleft..!!..braceright..!|!..backslash..!{language?{language@.german:grqq}}{language?{language@english:textquotedblright}}{language!textquotedblright}!..braceleft..!!..braceright..!
262 # $$ inline passthrough.
267 !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{1={name}:{target}}!..braceright..!
269 !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{1={name}:{target}}!..braceright..!
271 !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{1={name}:{target}}!..braceright..!
273 !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{1={name}:{target}}!..braceright..!
275 !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{1={target}}!..braceright..!
277 !..backslash..!href!..braceleft..!{name}:{target}!..braceright..!!..braceleft..!{1={target}}!..braceright..!
279 !..backslash..!href!..braceleft..!{target}!..braceright..!!..braceleft..!{1={target}}!..braceright..!
282 !..backslash..!label!..braceleft..!{target}!..braceright..!!..backslash..!hypertarget!..braceleft..!{target}!..braceright..!!..braceleft..!!..braceright..!
284 [anchor2-inlinemacro]
285 !..backslash..!label!..braceleft..!{1}!..braceright..!!..backslash..!hypertarget!..braceleft..!{1}!..braceright..!!..braceleft..!{2={1}}!..braceright..!
287 [anchor3-inlinemacro]
288 {latex-use-bibliography-environment?!..backslash..!bibitem!..braceleft..!{1}!..braceright..!} {latex-use-bibliography-environment!!..backslash..!item[{1}]} !..backslash..!label!..braceleft..!{1}!..braceright..!!..backslash..!hypertarget!..braceleft..!{1}!..braceright..!!..braceleft..!!..braceright..!
291 {style#}{style$page:!..backslash..!pageref!..braceleft..!{target}!..braceright..!}
292 {style#}{style$autoref:!..backslash..!autoref!..braceleft..!{target}!..braceright..!}
293 {style#}{style$ref:!..backslash..!ref!..braceleft..!{target}!..braceright..!}
294 {style#}{latex-use-bibliography-environment#}{style$cite:!..backslash..!cite!..braceleft..!{target}!..braceright..!}
295 {style#}{latex-use-bibliography-environment%}{style$cite:!..backslash..!hyperlink!..braceleft..!{target}!..braceright..!!..braceleft..!{0=[{target}]}!..braceright..!}
296 {style%}!..backslash..!hyperlink!..braceleft..!{target}!..braceright..!!..braceleft..!{0=[{target}]}!..braceright..!!..backslash..!showpagenumber!..braceleft..!{target}!..braceright..!
299 {3#}{3$page:!..backslash..!pageref!..braceleft..!{1}!..braceright..!}
300 {3#}{3$autoref:!..backslash..!autoref!..braceleft..!{1}!..braceright..!}
301 {3#}{3$ref:!..backslash..!ref!..braceleft..!{1}!..braceright..!}
302 {3#}{latex-use-bibliography-environment#}{3$cite:!..backslash..!cite!..braceleft..!{1}!..braceright..!}
303 {3#}{latex-use-bibliography-environment%}{3$cite:!..backslash..!hyperlink!..braceleft..!{1}!..braceright..!!..braceleft..!{2=[{1}]}!..braceright..!}
304 {3%}!..backslash..!hyperlink!..braceleft..!{1}!..braceright..!!..braceleft..!{2=[{1}]}!..braceright..!
307 # Special word substitution.
309 !..backslash..!emph!..braceleft..!{words}!..braceright..!
311 !..backslash..!texttt!..braceleft..!{words}!..braceright..!
313 !..backslash..!textbf!..braceleft..!{words}!..braceright..!
317 # Paragraph substitution.
319 {title%} \par{latex-indent-paragraphs!\noindent\{\}}
320 {title#} \paragraph\{{title}\}
321 \label\{{id}\}\\hypertarget\{{id}\}\{\}
326 # The literal block employs the same markup.
327 template::[literalblock]
330 # The verse block employs the same markup.
331 template::[verseblock]
333 [admonitionparagraph]
334 # The admonition block employs the same markup.
335 template::[admonitionblock]
341 # FIXME: without the FANCYVRBSTOP we would get an unwanted
342 # blank line before \end{Verbatim}.
354 # in the output .tex. This might be a bug/feature in AsciiDoc
355 # when {newline} is thrown at it.
358 \minisec\{{caption=}{title}\}
359 \label\{{id}\}\\hypertarget\{{id}\}\{\}
360 \begin\{Verbatim\}[frame=single]{newline}
362 {newline}FANCYVRBSTOP
369 \label\{{id}\}\\hypertarget\{{id}\}\{\}
378 \label\{{id}\}\\hypertarget\{{id}\}\{\}
387 \label\{{id}\}\\hypertarget\{{id}\}\{\}
389 ifndef::latex-use-colored-sidebar-blocks[]
390 \setlength\{\tabcolsep\}\{0pt\}
391 \rowcolors\{1\}\{\}\{\}
392 \begin\{tabular\}\{l>\{\columncolor[gray]\{.75\}\}rcl\}
396 \begin\{minipage\}\{4in\}
397 endif::latex-use-colored-sidebar-blocks[]
398 ifdef::latex-use-colored-sidebar-blocks[]
399 \fcolorbox\{SidebarBorderColor\}\{SidebarBackgroundColor\}\{\parbox\{\textwidth\}\{
400 endif::latex-use-colored-sidebar-blocks[]
405 ifdef::latex-use-colored-sidebar-blocks[]
408 endif::latex-use-colored-sidebar-blocks[]
409 ifndef::latex-use-colored-sidebar-blocks[]
412 endif::latex-use-colored-sidebar-blocks[]
417 \label\{{id}\}\\hypertarget\{{id}\}\{\}
430 \minisec\{{caption=}{title}\}
431 \label\{{id}\}\\hypertarget\{{id}\}\{\}
439 \begin\{addmargin*\}[0em]\{0em\}
440 \label\{{id}\}\\hypertarget\{{id}\}\{\}
441 \begin\{minipage\}\{\\linewidth\}
442 {icons#} \includegraphics\{{icon={iconsdir}/{name}.png}\}
443 {icons%} \minisec\{{caption}\}
444 \rule\{\\linewidth\}\{2pt\}
445 \par\{\}\\noindent\{\}|\par\{\}\\noindent\{\}%
446 \rule[.25\baselineskip]\{\\linewidth\}\{2pt\}
451 # Same as numbered list.
452 [listdef-bibliography]
458 # Same as labeled list.
467 dotted-style=tags="dotted"
472 [tabletags-monospaced]
488 colspec=>\{{valign@left:\\raggedright}{valign@center:\\centering}{valign@right:\\raggedleft}\}p\{ {colabswidth}pt \}
489 bodyrow=| \tabularnewline
490 headdata=\{\\bfseries\{\}|\} {colnumber@{colcount}::&}
491 footdata=\{\\bfseries\{\}|\} {colnumber@{colcount}::&}
492 bodydata=| {colnumber@{colcount}:%:&}
498 ifdef::latex-use-colored-tables[]
499 \rowcolors\{1\}\{TableEvenColor\}\{TableOddColor\}
500 \setlength\arrayrulewidth\{1.5pt\}
501 \arrayrulecolor\{TableBorderColor\}
502 endif::latex-use-colored-tables[]
503 {eval:{rowcount}{gt}{latex-table-rowlimit}} \begin\{longtable\}\{
504 {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|sides:|}
505 {eval:{rowcount}{gt}{latex-table-rowlimit}} {colspecs}
506 {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|sides:|}
507 {eval:{rowcount}{gt}{latex-table-rowlimit}} \}
508 {eval:{rowcount}{gt}{latex-table-rowlimit}} \hypertarget\{{id}\}\{\}
509 {eval:{rowcount}{gt}{latex-table-rowlimit}} \caption\{{title}\}
510 {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|topbot:\hline}
511 {eval:{rowcount}{gt}{latex-table-rowlimit}} {headrows}
512 {eval:{rowcount}{gt}{latex-table-rowlimit}} {headrows#} \endhead
513 {eval:{rowcount}{gt}{latex-table-rowlimit}} {footrows}
514 {eval:{rowcount}{gt}{latex-table-rowlimit}} {footrows#} \endlastfoot
515 {eval:{rowcount}{gt}{latex-table-rowlimit}}
516 {eval:{rowcount}{gt}{latex-table-rowlimit}} {bodyrows}
517 {eval:{rowcount}{gt}{latex-table-rowlimit}} {frame$all|topbot:\hline}
518 {eval:{rowcount}{gt}{latex-table-rowlimit}} \label\{{id}\}
519 {eval:{rowcount}{gt}{latex-table-rowlimit}} \end\{longtable\}
520 {eval:{rowcount}{lt}={latex-table-rowlimit}} {title%} \par{latex-indent-paragraphs!\noindent}
521 {eval:{rowcount}{lt}={latex-table-rowlimit}} {title#} \begin\{table\}
522 {eval:{rowcount}{lt}={latex-table-rowlimit}} \hypertarget\{{id}\}\{\}
523 {eval:{rowcount}{lt}={latex-table-rowlimit}} \caption\{{title}\}
524 {eval:{rowcount}{lt}={latex-table-rowlimit}} \begin\{minipage\}\{\\textwidth\}
525 {eval:{rowcount}{lt}={latex-table-rowlimit}} \renewcommand\{\\thefootnote\}\{\\thempfootnote\}
526 {eval:{rowcount}{lt}={latex-table-rowlimit}} \centering
527 {eval:{rowcount}{lt}={latex-table-rowlimit}} \begin\{tabular\}\{
528 {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|sides:|}
529 {eval:{rowcount}{lt}={latex-table-rowlimit}} {colspecs}
530 {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|sides:|}
531 {eval:{rowcount}{lt}={latex-table-rowlimit}} \}
532 {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|topbot:\hline}
533 {eval:{rowcount}{lt}={latex-table-rowlimit}} {headrows}
534 {eval:{rowcount}{lt}={latex-table-rowlimit}} {bodyrows}
535 {eval:{rowcount}{lt}={latex-table-rowlimit}} {footrows}
536 {eval:{rowcount}{lt}={latex-table-rowlimit}} {frame$all|topbot:\hline}
537 {eval:{rowcount}{lt}={latex-table-rowlimit}} \end\{tabular\}
538 {eval:{rowcount}{lt}={latex-table-rowlimit}} \renewcommand\{\\footnoterule\}\{\}
539 {eval:{rowcount}{lt}={latex-table-rowlimit}} \end\{minipage\}
540 {eval:{rowcount}{lt}={latex-table-rowlimit}} \label\{{id}\}
541 {eval:{rowcount}{lt}={latex-table-rowlimit}} {title#} \end\{table\}
544 ifdef::doctype-article[]
546 endif::doctype-article[]
548 ifdef::doctype-book[]
549 ^Dedication$=dedication
550 endif::doctype-book[]
552 # we generate our own index, dont make Index special
553 ^Reference Index$=index
555 ifdef::latex-use-bibliography-environment[]
556 ^(Bibliography|References)$=bibliography
557 endif::latex-use-bibliography-environment[]
559 ^Appendix.*$=appendix
562 ^Figures$=list-of-figures
572 \label\{{id}\}\\hypertarget\{{id}\}\{\}
577 #\label\{{id}\}\\hypertarget\{{id}\}\{\}
578 \renewcommand\{\\showpagenumber\}[1]\{, \pageref\{#1\}\}
581 ifdef::latex-use-bibliography-environment[]
583 \label\{{id}\}\\hypertarget\{{id}\}\{\}
584 \begin\{thebibliography\}\{99\}
586 \end\{thebibliography\}
587 endif::latex-use-bibliography-environment[]
591 \label\{{id}\}\\hypertarget\{{id}\}\{\}
595 \label\{{id}\}\\hypertarget\{{id}\}\{\}
604 \label\{{id}\}\\hypertarget\{{id}\}\{\}
610 # Untitled elements between header and first section title.
611 ifdef::doctype-book[]
614 \label\{preamble\}\\hypertarget\{{preamble}\}\{\}
615 endif::doctype-book[]
620 ifdef::doctype-book[]
622 endif::doctype-book[]
626 \hypertarget\{{id}\}\{\}
632 \hypertarget\{{id}\}\{\}
637 \hypertarget\{{id}\}\{\}
638 \subsection\{{title}\}
643 \hypertarget\{{id}\}\{\}
644 \subsubsection\{{title}\}
649 #\hypertarget\{{id}\}\{\}
655 # FIXME: if the "backgroundcolor" entry is present as below, the
656 # background comes out black and is unreadable in PDF, although it is
658 # \lstset\{basicstyle=\footnotesize\ttfamily,showstringspaces=false,breaklines,frame=single, rulecolor=\color\{ListingBorderColor\}, backgroundcolor=\color\{ListingBackgroundColor\}, xleftmargin=0cm, linewidth=0.95\textwidth\}
662 {encoding$UTF-8:}% coding: utf-8
668 ]\{{doctype@article:scrartcl:scrbook}\}
669 \pagestyle\{{latex-use-running-title-headings?headings}{latex-use-running-title-headings!plain}\}
671 \usepackage\{makeidx\}
672 \usepackage[table]\{xcolor\}
674 \definecolor\{LinkColor\}\{rgb\}\{0.95,0.80,0.80\}
675 \definecolor\{UrlColor\}\{rgb\}\{0.80,0.80,0.95\}
676 \definecolor\{TableEvenColor\}\{rgb\}\{0.93,1,0.8\}
677 \definecolor\{TableOddColor\}\{rgb\}\{0.93,1,1\}
678 \definecolor\{TableBorderColor\}\{rgb\}\{0.55,0.67,0.73\}
679 \definecolor\{ListingBorderColor\}\{rgb\}\{0.55,0.55,0.55\}
680 \definecolor\{ListingBackgroundColor\}\{rgb\}\{0.95,0.95,0.95\}
681 \definecolor\{SidebarBorderColor\}\{rgb\}\{0.95,0.95,0.95\}
682 \definecolor\{SidebarBackgroundColor\}\{rgb\}\{1,1,0.93\}
683 \usepackage\{type1ec\}
684 \usepackage[{language=english}]\{babel\}
687 pdftitle=\{{doctitle}\},
688 pdfauthor=\{{author}\},
693 urlbordercolor=UrlColor,
694 linkbordercolor=LinkColor
697 \usepackage\{enumerate\}
698 \usepackage\{graphicx\}
699 \usepackage\{longtable\}
700 \usepackage[T1]\{fontenc\}
702 \usepackage[{encoding@ISO-8859-1:latin1}{encoding@UTF-8:utf8x}{encoding!utf8x}]\{inputenc\}
703 \usepackage\{textcomp\}
705 %\usepackage\{listings\}
706 %\usepackage\{verbatim\}
707 %\usepackage\{moreverb\}
708 \usepackage\{fancyvrb\}
709 \usepackage\{upquote\}
710 \usepackage\{bookman\}
711 \usepackage\{microtype\}
713 \newcommand*\FancyVerbStopString\{FANCYVRBSTOP\}
714 \newcommand\{\\showpagenumber\}[1]\{ (p.\,\pageref\{#1\})\}
716 %\lstset\{basicstyle=\footnotesize\ttfamily,showstringspaces=false,breaklines,frame=single, rulecolor=\color\{ListingBorderColor\}, xleftmargin=0cm, linewidth=0.95\textwidth\}
718 {latex-indent-paragraphs%\setlength\{\\parskip\}\{1ex plus 0.5ex minus 0.2ex\}}
721 \DeclareRobustCommand*\textsubscript[1]\{%
722 \@textsubscript\{\selectfont#1\}\}
723 \def\@textsubscript#1\{%
724 \{\m@th\ensuremath\{_\{\mbox\{\fontsize\sf@size\z@#1\}\}\}\}\}
727 \subject\{{subject}\}
729 \author\{{author}{email?, \href\{mailto:{email}\}\{{email}\}}\}
731 %\publishers\{\begin\{tabular\}\{ll\} {revision?\textbf\{Revision:\} & {revision} \\ } {keywords?\textbf\{Keywords:\} & {keywords} \\ } \end\{tabular\}\}
737 %\newcommand{\texttesh}{\textteshlig\/}
739 \label\{header\}\\hypertarget\{header\}\{\}
740 {doctitle#\maketitle}
743 \label\{footer\}\\hypertarget\{footer\}\{\}