AsciiDoc User Guide Stuart Rackham <[email protected]> Revision History Revision 8.2.5 18 November 2007 SJR Table of Contents Introduction ..........................................................................................................................................4 Getting Started .....................................................................................................................................4 Installing AsciiDoc ......................................................................................................................5 Example AsciiDoc Documents ....................................................................................................5 AsciiDoc Document Types ..................................................................................................................5 article ............................................................................................................................................5 book ..............................................................................................................................................5 manpage .......................................................................................................................................6 AsciiDoc Backends ..............................................................................................................................6 docbook ........................................................................................................................................6 xhtml11 ........................................................................................................................................6 html4 ............................................................................................................................................9 linuxdoc ........................................................................................................................................9 latex ..............................................................................................................................................9 Document Structure .............................................................................................................................9 Block Elements ..........................................................................................................................10 Header ........................................................................................................................................10 Preamble ....................................................................................................................................11 Sections ......................................................................................................................................11 Inline Elements ..........................................................................................................................12 Document Processing .........................................................................................................................13 Text Formatting .................................................................................................................................14 Quoted Text ...............................................................................................................................14 Inline Passthroughs ....................................................................................................................15 Superscripts and Subscripts .......................................................................................................16 Line Breaks (HTML/XHTML) ..................................................................................................16 Rulers (HTML/XHTML) ...........................................................................................................16 Tabs ............................................................................................................................................16 Replacements .............................................................................................................................16 Special Words ............................................................................................................................17 Titles ..................................................................................................................................................17 Two line titles ............................................................................................................................17 One line titles .............................................................................................................................17 BlockTitles .........................................................................................................................................18 BlockId Element ................................................................................................................................18 Paragraphs ..........................................................................................................................................18 Default Paragraph ......................................................................................................................19 Literal Paragraph ........................................................................................................................19 Admonition Paragraphs .............................................................................................................19 Delimited Blocks ...............................................................................................................................20 Predefined Delimited Blocks .....................................................................................................20 1 AsciiDoc User Guide Listing Blocks ............................................................................................................................21 Literal Blocks .............................................................................................................................21 SidebarBlocks ............................................................................................................................22 Comment Blocks ........................................................................................................................23 Passthrough Blocks ....................................................................................................................23 Quote Blocks ..............................................................................................................................23 Example Blocks .........................................................................................................................24 Admonition Blocks ....................................................................................................................25 Lists ....................................................................................................................................................25 Bulleted and Numbered Lists .....................................................................................................26 Vertical Labeled Lists ................................................................................................................27 Horizontal Labeled Lists ............................................................................................................28 Question and Answer Lists ........................................................................................................29 Glossary Lists .............................................................................................................................30 Bibliography Lists ......................................................................................................................30 List Item Continuation ...............................................................................................................31 List Block ...................................................................................................................................32 Footnotes ............................................................................................................................................33 Indexes ...............................................................................................................................................33 Callouts ..............................................................................................................................................34 Implementation Notes ................................................................................................................35 Including callouts in included code ...........................................................................................35 Macros ................................................................................................................................................36 Inline Macros .............................................................................................................................36 Block Macros .............................................................................................................................39 System Macros ...........................................................................................................................40