
- •AsciiDoc User Guide
- •Table of Contents
- •Introduction
- •Getting Started
- •Installing the AsciiDoc tarball distribution
- •Example AsciiDoc Documents
- •AsciiDoc Document Types
- •article
- •book
- •manpage
- •AsciiDoc Backends
- •docbook
- •xhtml11
- •Stylesheets
- •html4
- •linuxdoc
- •Document Structure
- •Block Elements
- •Header
- •Preamble
- •Sections
- •Special Sections
- •Inline Elements
- •Document Processing
- •Text Formatting
- •Quoted Text
- •Inline Passthroughs
- •Superscripts and Subscripts
- •Line Breaks (HTML/XHTML)
- •Rulers (HTML/XHTML)
- •Tabs
- •Replacements
- •Special Words
- •Titles
- •Two line titles
- •One line titles
- •BlockTitles
- •BlockId Element
- •Paragraphs
- •Default Paragraph
- •Literal Paragraph
- •Admonition Paragraphs
- •Admonition Icons and Captions
- •Delimited Blocks
- •Predefined Delimited Blocks
- •Listing Blocks
- •Literal Blocks
- •SidebarBlocks
- •Comment Blocks
- •Passthrough Blocks
- •Quote Blocks
- •Example Blocks
- •Admonition Blocks
- •Lists
- •Bulleted and Numbered Lists
- •Vertical Labeled Lists
- •Horizontal Labeled Lists
- •Question and Answer Lists
- •Glossary Lists
- •Bibliography Lists
- •List Item Continuation
- •List Block
- •Footnotes
- •Indexes
- •Callouts
- •Implementation Notes
- •Macros
- •Inline Macros
- •URLs
- •Internal Cross References
- •anchor
- •xref
- •Linking to Local Documents
- •Images
- •Block Macros
- •Block Identifier
- •Images
- •Comment Lines
- •System Macros
- •Include Macros
- •Conditional Inclusion Macros
- •eval, sys and sys2 System Macros
- •Template System Macro
- •Macro Definitions
- •Tables
- •Example Tables
- •AsciiDoc Table Block Elements
- •Ruler
- •Row and Data Elements
- •Underline
- •Attribute List
- •Markup Attributes
- •Manpage Documents
- •Document Header
- •The NAME Section
- •The SYNOPSIS Section
- •Configuration Files
- •Configuration File Format
- •Markup Template Sections
- •Special Sections
- •Miscellaneous
- •Titles
- •Tags
- •Attributes Section
- •Special Characters
- •Quoted Text
- •Special Words
- •Replacements
- •Configuration File Names and Locations
- •Document Attributes
- •Attribute Entries
- •Attribute Lists
- •Macro Attribute lists
- •AttributeList Element
- •Attribute References
- •Simple Attributes References
- •Conditional Attribute References
- •Conditional attribute examples
- •System Attribute References
- •Intrinsic Attributes
- •Block Element Definitions
- •Styles
- •Paragraphs
- •Delimited Blocks
- •Lists
- •Tables
- •Filters
- •Filter Search Paths
- •Filter Configuration Files
- •Code Filter
- •Converting DocBook to other file formats
- •a2x Toolchain Wrapper
- •Toolchain Components
- •AsciiDoc DocBook XSL Drivers
- •Generating Plain Text Files
- •XML and Character Sets
- •PDF Fonts
- •Help Commands
- •Customizing Help
- •Tips and Tricks
- •Know Your Editor
- •Vim Commands for Formatting AsciiDoc
- •Text Wrap Paragraphs
- •Format Lists
- •Indent Paragraphs
- •Troubleshooting
- •Gotchas
- •Combining Separate Documents
- •Processing Document Sections Separately
- •Processing Document Chunks
- •Badges in HTML Page Footers
- •Pretty Printing AsciiDoc Output
- •Supporting Minor DocBook DTD Variations
- •Shipping Stand-alone AsciiDoc Source
- •Inserting Blank Space
- •Closing Open Sections
- •Validating Output Files
- •Glossary
- •A. Migration Notes
- •Version 6 to version 7
- •B. Packager Notes
- •C. AsciiDoc Safe Mode
- •E. Installing FOP on Linux
- •F. Installing Java on Windows
- •G. Installing Java on Linux

AsciiDoc User Guide
reference is deemed undefined and the line containing the reference is dropped from the output. If the expression evaluates to True the attribute evaluates to an empty string. In all remaining cases the attribute evaluates to a string representation of the <expression> result.
{include:<filename>}
Substitutes contents of the file named <filename>.
•The included file is read at the time of attribute substitution.
•If the file does not exist a warning is emitted and the line containing the reference is dropped from the output file.
•Tabs are expanded based on the current tabsize.
{sys:<command>}
Substitutes the stdout generated by the execution of the shell <command>.
{sys2:<command>}
Substitutes the stdout and stderr generated by the execution of the shell <command>.
System reference behavior
•System attribute arguments can contain non-system attribute references.
•Closing brace characters inside system attribute arguments must be escaped them with a backslash.
Intrinsic Attributes
Intrinsic attributes are simple attributes that are created automatically from document header parameters, asciidoc(1) command-line arguments, environment parameters along with attributes defined in the default configuration files. Here's the list of predefined intrinsic attributes:
{asciidoc-version} |
the version of asciidoc(1) |
{asciidoc-dir} |
the asciidoc(1) application directory |
{user-dir} |
the ~/.asciidoc directory (if it exists) |
{authorinitials} |
author initials (from document header) |
{author} |
author's full name ({firstname} {middlename} |
|
{lastname}) |
{authored} |
empty string '' if {author} or {email} defined, |
|
otherwise undefined. |
{date} |
document date (from document header) |
{doctitle} |
document title (from document header) |
{email} |
author's email address (from document header) |
{firstname} |
author first name (from document header) |
{lastname} |
author last name (from document header) |
{localdate} |
the current date |
{localtime} |
the current time |
{manname} |
manpage name (defined in NAME section) |
{manpurpose} |
manpage (defined in NAME section) |
{mantitle} |
document title minus the manpage volume number |
{manvolnum} |
manpage volume number (1..8) (from document header) |
{middlename} |
author middle name (from document header) |
{revision} |
document revision number (from document header) |
{title} |
section title (defined titled element substitution |
|
sections) |
{sectnum} |
section number (defined in section titles |
59