chunked/index.html


1
2

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AsciiDoc User Guide</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="next" href="pr01.html" title="" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="pr01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div xml:lang="en" class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="idm1"></a>AsciiDoc User Guide</h1></div><div><div class="author"><h3 class="author"><span class="firstname">AsciiDoc.py</span> <span class="surname">Team</span></h3></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="preface"><a href="pr01.html"></a></span></dt><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dt><span class="chapter"><a href="ch02.html">2. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="ch02.html#_installing_asciidoc">2.1. Installing AsciiDoc</a></span></dt><dt><span class="section"><a href="ch02.html#X11">2.2. Example AsciiDoc Documents</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. AsciiDoc Document Types</a></span></dt><dd><dl><dt><span class="section"><a href="ch03.html#_article">3.1. article</a></span></dt><dt><span class="section"><a href="ch03.html#_book">3.2. book</a></span></dt><dt><span class="section"><a href="ch03.html#_manpage">3.3. manpage</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch04.html">4. AsciiDoc Backends</a></span></dt><dd><dl><dt><span class="section"><a href="ch04.html#_backend_aliases">4.1. Backend Aliases</a></span></dt><dt><span class="section"><a href="ch04.html#X100">4.2. Backend Plugins</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch05.html">5. DocBook</a></span></dt><dd><dl><dt><span class="section"><a href="ch05.html#X12">5.1. Converting DocBook to other file formats</a></span></dt><dt><span class="section"><a href="ch05.html#X43">5.2. a2x Toolchain Wrapper</a></span></dt><dt><span class="section"><a href="ch05.html#_html_generation">5.3. HTML generation</a></span></dt><dt><span class="section"><a href="ch05.html#_pdf_generation">5.4. PDF generation</a></span></dt><dt><span class="section"><a href="ch05.html#_html_help_generation">5.5. HTML Help generation</a></span></dt><dt><span class="section"><a href="ch05.html#_toolchain_components_summary">5.6. Toolchain components summary</a></span></dt><dt><span class="section"><a href="ch05.html#_asciidoc_dblatex_configuration_files">5.7. AsciiDoc dblatex configuration files</a></span></dt><dt><span class="section"><a href="ch05.html#_asciidoc_docbook_xsl_stylesheets_drivers">5.8. AsciiDoc DocBook XSL Stylesheets drivers</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch06.html">6. Generating Plain Text Files</a></span></dt><dt><span class="chapter"><a href="ch07.html">7. HTML5 and XHTML 1.1</a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#X99">7.1. Themes</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch08.html">8. Document Structure</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.html#_block_elements">8.1. Block Elements</a></span></dt><dt><span class="section"><a href="ch08.html#X95">8.2. Header</a></span></dt><dt><span class="section"><a href="ch08.html#X86">8.3. Preamble</a></span></dt><dt><span class="section"><a href="ch08.html#_sections">8.4. Sections</a></span></dt><dt><span class="section"><a href="ch08.html#_inline_elements">8.5. Inline Elements</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch09.html">9. Document Processing</a></span></dt><dt><span class="chapter"><a href="ch10.html">10. Text Formatting</a></span></dt><dd><dl><dt><span class="section"><a href="ch10.html#X51">10.1. Quoted Text</a></span></dt><dt><span class="section"><a href="ch10.html#_superscripts_and_subscripts">10.2. Superscripts and Subscripts</a></span></dt><dt><span class="section"><a href="ch10.html#_line_breaks">10.3. Line Breaks</a></span></dt><dt><span class="section"><a href="ch10.html#_page_breaks">10.4. Page Breaks</a></span></dt><dt><span class="section"><a href="ch10.html#_rulers">10.5. Rulers</a></span></dt><dt><span class="section"><a href="ch10.html#_tabs">10.6. Tabs</a></span></dt><dt><span class="section"><a href="ch10.html#_replacements">10.7. Replacements</a></span></dt><dt><span class="section"><a href="ch10.html#_special_words">10.8. Special Words</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch11.html">11. Titles</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#_two_line_titles">11.1. Two line titles</a></span></dt><dt><span class="section"><a href="ch11.html#X46">11.2. One line titles</a></span></dt><dt><span class="section"><a href="ch11.html#_floating_titles">11.3. Floating titles</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch12.html">12. Block Titles</a></span></dt><dt><span class="chapter"><a href="ch13.html">13. BlockId Element</a></span></dt><dt><span class="chapter"><a href="ch14.html">14. AttributeList Element</a></span></dt><dd><dl><dt><span class="section"><a href="ch14.html#_attribute_value_substitution">14.1. Attribute value substitution</a></span></dt><dt><span class="section"><a href="ch14.html#_common_attributes">14.2. Common attributes</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch15.html">15. Paragraphs</a></span></dt><dd><dl><dt><span class="section"><a href="ch15.html#_normal_paragraph_syntax">15.1. normal paragraph syntax</a></span></dt><dt><span class="section"><a href="ch15.html#X85">15.2. literal paragraph syntax</a></span></dt><dt><span class="section"><a href="ch15.html#X94">15.3. quote and verse paragraph styles</a></span></dt><dt><span class="section"><a href="ch15.html#X28">15.4. Admonition Paragraphs</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch16.html">16. Delimited Blocks</a></span></dt><dd><dl><dt><span class="section"><a href="ch16.html#_predefined_delimited_blocks">16.1. Predefined Delimited Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#_listing_blocks">16.2. Listing Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X65">16.3. Literal Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#_sidebar_blocks">16.4. Sidebar Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X26">16.5. Comment Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X76">16.6. Passthrough Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#_quote_blocks">16.7. Quote Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X48">16.8. Example Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X22">16.9. Admonition Blocks</a></span></dt><dt><span class="section"><a href="ch16.html#X29">16.10. Open Blocks</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch17.html">17. Lists</a></span></dt><dd><dl><dt><span class="section"><a href="ch17.html#_bulleted_lists">17.1. Bulleted Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_numbered_lists">17.2. Numbered Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_labeled_lists">17.3. Labeled Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_question_and_answer_lists">17.4. Question and Answer Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_glossary_lists">17.5. Glossary Lists</a></span></dt><dt><span class="section"><a href="ch17.html#_bibliography_lists">17.6. Bibliography Lists</a></span></dt><dt><span class="section"><a href="ch17.html#X15">17.7. List Item Continuation</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch18.html">18. Footnotes</a></span></dt><dt><span class="chapter"><a href="ch19.html">19. Indexes</a></span></dt><dt><span class="chapter"><a href="ch20.html">20. Callouts</a></span></dt><dd><dl><dt><span class="section"><a href="ch20.html#_implementation_notes">20.1. Implementation Notes</a></span></dt><dt><span class="section"><a href="ch20.html#_including_callouts_in_included_code">20.2. Including callouts in included code</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch21.html">21. Macros</a></span></dt><dd><dl><dt><span class="section"><a href="ch21.html#_inline_macros">21.1. Inline Macros</a></span></dt><dt><span class="section"><a href="ch21.html#_block_macros">21.2. Block Macros</a></span></dt><dt><span class="section"><a href="ch21.html#_system_macros">21.3. System Macros</a></span></dt><dt><span class="section"><a href="ch21.html#X77">21.4. Passthrough macros</a></span></dt><dt><span class="section"><a href="ch21.html#_macro_definitions">21.5. Macro Definitions</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch22.html">22. HTML 5 audio and video block macros</a></span></dt><dt><span class="chapter"><a href="ch23.html">23. Tables</a></span></dt><dd><dl><dt><span class="section"><a href="ch23.html#_example_tables">23.1. Example tables</a></span></dt><dt><span class="section"><a href="ch23.html#X68">23.2. Table input data formats</a></span></dt><dt><span class="section"><a href="ch23.html#X69">23.3. Table attributes</a></span></dt><dt><span class="section"><a href="ch23.html#X70">23.4. Column Specifiers</a></span></dt><dt><span class="section"><a href="ch23.html#X84">23.5. Cell Specifiers</a></span></dt><dt><span class="section"><a href="ch23.html#X71">23.6. Table styles</a></span></dt><dt><span class="section"><a href="ch23.html#X72">23.7. Markup attributes</a></span></dt><dt><span class="section"><a href="ch23.html#_nested_tables">23.8. Nested tables</a></span></dt><dt><span class="section"><a href="ch23.html#X83">23.9. DocBook table limitations</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch24.html">24. Manpage Documents</a></span></dt><dd><dl><dt><span class="section"><a href="ch24.html#_document_header">24.1. Document Header</a></span></dt><dt><span class="section"><a href="ch24.html#_the_name_section">24.2. The NAME Section</a></span></dt><dt><span class="section"><a href="ch24.html#_the_synopsis_section">24.3. The SYNOPSIS Section</a></span></dt><dt><span class="section"><a href="ch24.html#_refmiscinfo_attributes">24.4. refmiscinfo attributes</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch25.html">25. Mathematical Formulas</a></span></dt><dd><dl><dt><span class="section"><a href="ch25.html#_latex_math">25.1. LaTeX Math</a></span></dt><dt><span class="section"><a href="ch25.html#_mathjax">25.2. MathJax</a></span></dt><dt><span class="section"><a href="ch25.html#_latexmathml">25.3. LaTeXMathML</a></span></dt><dt><span class="section"><a href="ch25.html#_asciimathml">25.4. ASCIIMathML</a></span></dt><dt><span class="section"><a href="ch25.html#_mathml">25.5. MathML</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch26.html">26. Configuration Files</a></span></dt><dd><dl><dt><span class="section"><a href="ch26.html#_configuration_file_format">26.1. Configuration File Format</a></span></dt><dt><span class="section"><a href="ch26.html#_miscellaneous_section">26.2. Miscellaneous section</a></span></dt><dt><span class="section"><a href="ch26.html#_titles_section">26.3. Titles section</a></span></dt><dt><span class="section"><a href="ch26.html#_tags_section">26.4. Tags section</a></span></dt><dt><span class="section"><a href="ch26.html#_attributes_section">26.5. Attributes section</a></span></dt><dt><span class="section"><a href="ch26.html#_special_characters_section">26.6. Special Characters section</a></span></dt><dt><span class="section"><a href="ch26.html#_quoted_text_section">26.7. Quoted Text section</a></span></dt><dt><span class="section"><a href="ch26.html#_special_words_section">26.8. Special Words section</a></span></dt><dt><span class="section"><a href="ch26.html#X10">26.9. Replacements section</a></span></dt><dt><span class="section"><a href="ch26.html#_markup_template_sections">26.10. Markup Template Sections</a></span></dt><dt><span class="section"><a href="ch26.html#X27">26.11. Configuration file names, precedence and locations</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch27.html">27. Document Attributes</a></span></dt><dt><span class="chapter"><a href="ch28.html">28. Attribute Entries</a></span></dt><dd><dl><dt><span class="section"><a href="ch28.html#_setting_configuration_entries">28.1. Setting configuration entries</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch29.html">29. Attribute Lists</a></span></dt><dd><dl><dt><span class="section"><a href="ch29.html#X75">29.1. Options attribute</a></span></dt><dt><span class="section"><a href="ch29.html#_macro_attribute_lists">29.2. Macro Attribute lists</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch30.html">30. Attribute References</a></span></dt><dd><dl><dt><span class="section"><a href="ch30.html#_simple_attributes_references">30.1. Simple Attributes References</a></span></dt><dt><span class="section"><a href="ch30.html#_conditional_attribute_references">30.2. Conditional Attribute References</a></span></dt><dt><span class="section"><a href="ch30.html#X24">30.3. System Attribute References</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch31.html">31. Intrinsic Attributes</a></span></dt><dt><span class="chapter"><a href="ch32.html">32. Block Element Definitions</a></span></dt><dd><dl><dt><span class="section"><a href="ch32.html#X23">32.1. Styles</a></span></dt><dt><span class="section"><a href="ch32.html#_paragraphs_2">32.2. Paragraphs</a></span></dt><dt><span class="section"><a href="ch32.html#_delimited_blocks">32.3. Delimited Blocks</a></span></dt><dt><span class="section"><a href="ch32.html#_lists">32.4. Lists</a></span></dt><dt><span class="section"><a href="ch32.html#_tables_2">32.5. Tables</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch33.html">33. Filters</a></span></dt><dd><dl><dt><span class="section"><a href="ch33.html#_filter_search_paths">33.1. Filter Search Paths</a></span></dt><dt><span class="section"><a href="ch33.html#_filter_configuration_files">33.2. Filter Configuration Files</a></span></dt><dt><span class="section"><a href="ch33.html#X56">33.3. Example Filter</a></span></dt><dt><span class="section"><a href="ch33.html#_built_in_filters">33.4. Built-in filters</a></span></dt><dt><span class="section"><a href="ch33.html#X58">33.5. Filter plugins</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch34.html">34. Plugins</a></span></dt><dt><span class="chapter"><a href="ch35.html">35. Help Commands</a></span></dt><dd><dl><dt><span class="section"><a href="ch35.html#_customizing_help">35.1. Customizing Help</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch36.html">36. Tips and Tricks</a></span></dt><dd><dl><dt><span class="section"><a href="ch36.html#_know_your_editor">36.1. Know Your Editor</a></span></dt><dt><span class="section"><a href="ch36.html#X20">36.2. Vim Commands for Formatting AsciiDoc</a></span></dt><dt><span class="section"><a href="ch36.html#_troubleshooting">36.3. Troubleshooting</a></span></dt><dt><span class="section"><a href="ch36.html#_gotchas">36.4. Gotchas</a></span></dt><dt><span class="section"><a href="ch36.html#X90">36.5. Combining separate documents</a></span></dt><dt><span class="section"><a href="ch36.html#_processing_document_sections_separately">36.6. Processing document sections separately</a></span></dt><dt><span class="section"><a href="ch36.html#_processing_document_snippets">36.7. Processing document snippets</a></span></dt><dt><span class="section"><a href="ch36.html#_badges_in_html_page_footers">36.8. Badges in HTML page footers</a></span></dt><dt><span class="section"><a href="ch36.html#_pretty_printing_asciidoc_output">36.9. Pretty printing AsciiDoc output</a></span></dt><dt><span class="section"><a href="ch36.html#_supporting_minor_docbook_dtd_variations">36.10. Supporting minor DocBook DTD variations</a></span></dt><dt><span class="section"><a href="ch36.html#_creating_stand_alone_html_documents">36.11. Creating stand-alone HTML documents</a></span></dt><dt><span class="section"><a href="ch36.html#_shipping_stand_alone_asciidoc_source">36.12. Shipping stand-alone AsciiDoc source</a></span></dt><dt><span class="section"><a href="ch36.html#_inserting_blank_space">36.13. Inserting blank space</a></span></dt><dt><span class="section"><a href="ch36.html#_closing_open_sections">36.14. Closing open sections</a></span></dt><dt><span class="section"><a href="ch36.html#_validating_output_files">36.15. Validating output files</a></span></dt></dl></dd><dt><span class="glossary"><a href="go01.html">Glossary</a></span></dt><dt><span class="appendix"><a href="apa.html">A. Migration Notes</a></span></dt><dd><dl><dt><span class="section"><a href="apa.html#X53">A.1. Version 7 to version 8</a></span></dt></dl></dd><dt><span class="appendix"><a href="apb.html">B. Packager Notes</a></span></dt><dt><span class="appendix"><a href="apc.html">C. AsciiDoc Safe Mode</a></span></dt><dt><span class="appendix"><a href="apd.html">D. Using AsciiDoc with non-English Languages</a></span></dt><dt><span class="appendix"><a href="ape.html">E. Vim Syntax Highlighter</a></span></dt><dt><span class="appendix"><a href="apf.html">F. Attribute Options</a></span></dt><dt><span class="appendix"><a href="apg.html">G. Diagnostics</a></span></dt><dt><span class="appendix"><a href="aph.html">H. Backend Attributes</a></span></dt><dt><span class="appendix"><a href="api.html">I. License</a></span></dt></dl></div><div class="list-of-tables"><p><strong>List of Tables</strong></p><dl><dt>7.1. <a href="ch07.html#idm413">Stylesheet file locations</a></dt><dt>7.2. <a href="ch07.html#idm443">JavaScript file locations</a></dt><dt>16.1. <a href="ch16.html#idm1336">Default DelimitedBlock substitutions</a></dt><dt>22.1. <a href="ch22.html#idm2646">Audio macro attributes</a></dt><dt>22.2. <a href="ch22.html#idm2666">Video macro attributes</a></dt><dt>23.1. <a href="ch23.html#idm2727">Simple table</a></dt><dt>23.2. <a href="ch23.html#idm2759">Columns formatted with strong, monospaced and emphasis styles</a></dt><dt>23.3. <a href="ch23.html#idm2825">Horizontal and vertical source data</a></dt><dt>23.4. <a href="ch23.html#idm2871">A table with externally sourced CSV data</a></dt><dt>23.5. <a href="ch23.html#idm2990">Cell spans, alignments and styles</a></dt><dt>33.1. <a href="ch33.html#idm4846">Built-in filters list</a></dt></dl></div><div class="list-of-examples"><p><strong>List of Examples</strong></p><dl><dt>16.1. <a href="ch16.html#idm1569">An example</a></dt></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="pr01.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table></div></body></html>