Source

asciidoc / linuxdoc.conf

# linuxdoc.conf
#
# Asciidoc configuration file.
# linuxdoc backend, article document type.
#
# NOTE:
# - The Linuxdoc format only supports article documents.
# - Linuxdoc does not support a number of AsciiDoc elements, for
#   example table.
# - The AsciiDoc linuxdoc backend is no longer being actively
#   developed or tested with new AsciiDoc releases.
#

[attributes]
basebackend=linuxdoc
basebackend-linuxdoc=

[miscellaneous]
outfilesuffix=.sgml

[replacements]
(?m)^(.*)\s\+$=\1<newline>

# To allow the AsciiDoc User Guide to be processed.
{amp}\#960;=pi

# Small 'NEW' image.
(?<!\\)#NEW#=New!
\\#NEW#=#NEW#

# (C) Copyright (entity reference &copy;)
(?<!\\)\(C\)=&#169;
\\\(C\)=(C)

# (R) registered trade mark (entity reference &reg;
(?<!\\)\(R\)=&reg;
\\\(R\)=(R)

# (TM) Trademark (entity reference &trade;)
(?<!\\)\(TM\)=&trade;
\\\(TM\)=(TM)

# -- Spaced and unspaced em dashes (entity reference &mdash;)
(^|[^-\\])--($|[^-])=\1&mdash;\2
\\--(?!-)=--

# ... Ellipsis (entity reference &hellip;)
(?<!\\)\.\.\.=&hellip;
\\\.\.\.=...

[header]
<!doctype linuxdoc system>
<article>
<title>{doctitle}</title>
<author>
    by {author}
    <tt>&lt;<url url="mailto:{email}" name="{email}">&gt;</tt>
</author>
{date#}<date>
{date#}    v{revision}{date?,}
{date#}    {date}
{date#}</date>

[footer]
</article>

[indexterm-inlinemacro]
# Inline index term.
{2%}<nidx>{1}</nidx>
{2#}{3%}<nidx>{2}</nidx>
<nidx>{3}</nidx>

[indexterm2-inlinemacro]
# Inline index term.
# Single entry index term that is visible in the primary text flow.
<nidx>{1}</nidx>
{1}

[footnote-inlinemacro]
# Inline footnote.
<newline>[{0}]<newline>

[tags]
# Bulleted, numbered and labeled list tags.
ilist={title?<p><bf>{title}</bf>}<itemize>|</itemize>
ilistitem=<item>|</item>
ilisttext=|
olist={title?<p><bf>{title}</bf>}<enum>|</enum>
olist2=<enum>|</enum>
olistitem=<item>|</item>
olisttext=|
vlist={title?<p><bf>{title}</bf>}<descrip>|</descrip>
vlistitem=|
vlisttext=|
vlistentry=|
vlistterm=<tag>|</tag>
# Same as vertical labeled list.
hlist={title?<p><bf>{title}</bf>}<descrip>|</descrip>
hlistitem=|
hlisttext=|
hlistentry=|
hlistterm=<tag>|</tag>
# Question and Answer list.
qlist=<enum>|</enum>
qlistentry=<item>|</item>
qlistterm=|
qlistitem=|
qlisttext=<p>|
# Callout list (same as numbered list).
colist={title?<p><bf>{title}</bf>}<enum>|</enum>
colistitem=<item>|</item>
colisttext=|

# Quoted text
emphasis=<em>|</em>
strong=<bf>|</bf>
monospaced=<tt>|</tt>
quoted=``|''

[specialsections]
^Abstract$=sect-abstract

[sect-abstract]
<abstract>
|
</abstract>
<toc>

[preamble]
<abstract>
|
</abstract>
<toc>

[sect1]
<sect>{title}
<p>
|

[sect2]
<sect1>{title}
<p>
|

[sect3]
<sect2>{title}
<p>
|

[sect4]
<p><bf>{title}</bf>
<p>
|

# Inline macros
[http-inlinemacro]
<url url="{name}:{target}" name="{0={name}:{target}}">
[https-inlinemacro]
<url url="{name}:{target}" name="{0={name}:{target}}">
[ftp-inlinemacro]
<url url="{name}:{target}" name="{0={name}:{target}}">
[file-inlinemacro]
<url url="{name}:{target}" name="{0={name}:{target}}">
[mailto-inlinemacro]
<url url="{name}:{target}" name="{0={target}}">
[link-inlinemacro]
<url url="{target}" name="{0={target}}">
# LinuxDoc does not have anchors or anchor reference elements but we include
# the macros so the anchor is hidden and the reference text displayed.
# Anchor: [[id,xreflabel]]
[anchor-inlinemacro]
#&lsqb;{target}&rsqb;
[anchor2-inlinemacro]
# [[id,text]]
#&lsqb;{1}&rsqb;
[xref-inlinemacro]
#{1} &lsqb;{target}&rsqb;
{1={target}}
[xref2-inlinemacro]
# <<id,text>>
#{2} &lsqb;{1}&rsqb;
{2=1}

# Special word macros
[emphasizedwords]
<em>{words}</em>
[monospacedwords]
<tt>{words}</tt>
[strongwords]
<bf>{words}</bf>

# Paragraph substitution.
[paragraph]
<p><bf>{title}</bf><newline>
|
{empty}
{empty}
 
[literalparagraph]
<p><bf>Example:</bf> {title}
<verb>|</verb>
{empty}

[admonitionparagraph]
<p><bf>{style}:</bf> |
{empty}
{empty}

[verseparagraph]
template::[paragraph]

[image-inlinemacro]
{1={target}}

[ruler-blockmacro]
# Only applies to HTML so don't output anything.

[image-blockmacro]
<p><bf>Figure:</bf> {title}
<p>{1}
{1%}<p>Image file: {target}

[literalblock]
<p><bf>Example:</bf> {title}
<verb>
|
</verb>
{empty}

[listingblock]
<p><bf>Example:</bf> {title}
<tscreen><verb>
|
</verb></tscreen>
{empty}

[sidebarblock]
<p><bf>{title}</bf>
|
{empty}
{empty}

[exampleblock]
<p><bf>{title}</bf>
|
{empty}
{empty}

[admonitionblock]
<p><bf>{style}</bf>
|
{empty}
{empty}

[passthroughblock]
|

[quoteblock]
<p><bf>{title}</bf>
|
<p>
&mdash; {1={attribution}}
<em>{2={citetitle}}</em>
{empty}

[verseblock]
|
{empty}
{empty}

# Bibliography list.
# Same as numbered list.
[listdef-bibliography]
listtag=olist
itemtag=olistitem
texttag=olisttext

# Glossary list.
# Same as variable list.
[listdef-glossary]
listtag=vlist
itemtag=vlistitem
texttag=vlisttext
entrytag=vlistentry
labeltag=vlistterm