Home

PDF formatted AsciiDoc User Guide

Contents

1. Tip Use the verbose command line option to view executed toolchain commands 5 3 HTML generation AsciiDoc produces nicely styled HTML directly without requiring a DocBook toolchain but there are also advantages in going the DocBook route e HTML from DocBook can optionally include automatically generated indexes tables of contents footnotes lists of figures and tables e DocBook toolchains can also optionally generate separate chunked linked HTML pages for each document section e Toolchain processing performs link and document validity checks e If the DocBook lang attribute is set then things like table of contents figure and table captions and admonition captions will be output in the specified language setting the AsciiDoc lang attribute sets the DocBook Jang attribute On the other hand HTML output directly from AsciiDoc is much faster is easily customized and can be used in situations where there is no suitable DocBook toolchain for example see the AsciiDoc website 5 4 PDF generation There are two commonly used tools to generate PDFs from DocBook dblatex and FOP DBLATEX OR FOP e dblatex is easier to install there s zero configuration required and no Java VM to install it just works out of the box AsciiDoc User Guide 5 88 e dblatex source code highlighting and numbering is superb e dblatex is easier to use as it converts DocBook directly to PDF whereas before using FOP you have to co
2. I found I was spending more time typing markup tags consulting reference manuals and fixing syntax errors than I was writing the documentation 2 Getting Started 2 1 Installing AsciiDoc See the README and INSTALL files for install prerequisites and procedures Packagers take a look at Packager Notes 2 2 Example AsciiDoc Documents The best way to quickly get a feel for AsciiDoc is to view the AsciiDoc web site and or distributed examples e Take a look at the linked examples on the AsciiDoc web site home page http asciidoc org Press the Page Source sidebar menu item to view corresponding AsciiDoc source e Read the txt source files in the distribution doc directory along with the corresponding HTML and DocBook XML files AsciiDoc User Guide 2 88 3 AsciiDoc Document Types There are three types of AsciiDoc documents article book and manpage All document types share the same AsciiDoc format with some minor variations If you are familiar with DocBook you will have noticed that AsciiDoc document types correspond to the same named DocBook document types Use the asciidoc 1 d doctype option to specify the AsciiDoc document type the default document type is article By convention the t xt file extension is used for AsciiDoc document source files 3 1 article Used for short documents articles and general documentation See the AsciiDoc distribution doc article txt example As
3. 15 4 1 Admonition Icons and Captions Note Admonition customization with icons iconsdir icon and caption attributes does not apply when generating DocBook output If you are going the DocBook route then the a2x 1 no icons and icons dir options can be used to set the appropriate XSL Stylesheets parameters By default the asciidoc 1 HTML backends generate text captions instead of admonition icon image links To generate links to icon images define the icons attribute for example using the a icons command line option The iconsdir attribute sets the location of linked icon images You can override the default icon image using the icon attribute to specify the path of the linked image For example icon images icons wink png NOTE What lovely war Use the caption attribute to customize the admonition captions not applicable to docbook backend The following ex ample suppresses the icon image and customizes the caption of a NOTE admonition undefining the icons attribute with icons None is only necessary if admonition icons have been enabled icons None caption My Special Note NOTE This is my special note This subsection also applies to Admonition Blocks 16 Delimited Blocks Delimited blocks are blocks of text enveloped by leading and trailing delimiter lines normally a series of four or more repeated characters The behavior of Delimited Blocks is specified by entries in configuration file bl
4. Cell alignments are ignored for verse literal or asciidoc table styles 24 Manpage Documents Sooner or later if you program in a UNIX environment you re going to have to write a man page By observing a couple of additional conventions detailed below you can write AsciiDoc files that will generate HTML and PDF man pages plus the native manpage roff format The easiest way to generate roff manpages from AsciiDoc source is to use the a2x 1 command The following example generates a roff formatted manpage file called asciidoc 1 a2x 1 uses asciidoc 1 to convert asciidoc 1 txt to DocBook which it then converts to roff using DocBook XSL Stylesheets a2x doctype manpage format manpage asciidoc 1 txt Viewing and printing manpage files Use the man 1 command to view the manpage file man 1 asciidoc 1 To print a high quality man page to a postscript printer man 1 Tps asciidoc 1 lpr You could also create a PDF version of the man page by converting PostScript to PDF using ps2pdf 1 man 1 Tps asciidoc 1 ps2pdf asciidoc 1 pdf The ps2pdf 1 command is included in the Ghostscript distribution To find out more about man pages view the man 7 manpage man 7 man and man man pages commands AsciiDoc User Guide 53 88 24 1 Document Header A manpage document Header is mandatory The title line contains the man page name followed immediately by the manual section number in br
5. a Fusce euismod commodo velit b Vivamus fringilla mi eu lacus 3 Donec eget arcu bibendum nunc consequat lobortis See also Admonition Icons and Captions AsciiDoc User Guide 26 88 16 10 Open Blocks Open blocks are special e The open block delimiter is line containing two hyphen characters instead of four or more repeated characters e They can be used to group block elements for List item continuation e Open blocks can be styled to behave like any other type of delimited block The following built in styles can be applied to open blocks literal verse quote listing TIP NOTE IMPORTANT WARNING CAUTION abstract partintro comment example sidebar source music latex graphviz For example the following open block and listing block are functionally identical listing Lorum ipsum Lorum ipsum e An unstyled open block groups section elements but otherwise does nothing Open blocks are used to generate document abstracts and book part introductions e Apply the abstract style to generate an abstract for example abstract In this paper we will 1 Apply the partintro style to generate a book part introduction for a multi part book for example partintro Optional part introduction title Optional part introduction goes here 17 Lists LIST TYPES e Bulleted lists Also known as itemized or unordered lists Numbered lists Also called ordered lists Labeled lists Som
6. doctype document type specified by d option email author s email address from document header empty empty string encoding specifies input and output encoding filetype lt fileext gt empty string filetype output file name fil xtension firstname author first name from document header gt greater than gt character entity id running block id generated by BlockId elements indir input file directory name note 2 5 infile input file name note 2 5 lastname author last name from document header ldquo Left double quote character note 7 level title level 1 4 in section titles listindex the list index 1 of the most recent list item localdate the current date localtime the current time lsquo Left single quote character note 7 lt less than lt character entity 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 nbsp non breaking space character entity AsciiDoc User Guide notitle outdir outfile plus python rdquo reftext revdate revnumber rsquo sectnum sp showcomments title two colons two semicolons user dir verbose 69 88 do not display the document title documen
7. docbook role html4 html5 Role contains a string used to classify or subclassify an element and can be applied xhtml11 to AsciiDoc block elements The AsciiDoc role attribute is translated to the role docbook attribute in DocBook outputs and is included in the class attribute in HTML outputs in this respect it behaves like the quoted text role attribute DocBook XSL Stylesheets translate DocBook role attributes to HTML class attributes CSS can then be used to style the generated HTML reftext docbook reftext is used to set the DocBook xreflabel attribute The reftext attribute can an also be set by the BlockId element 15 Paragraphs Paragraphs are blocks of text terminated by a blank line the end of file or the start of a delimited block or a list There are three paragraph syntaxes normal indented literal and admonition which are rendered by default with the corresponding paragraph style Each syntax has a default style but you can explicitly apply any paragraph style to any paragraph syntax You can also apply delimited block styles to single paragraphs The built in paragraph styles are normal literal verse quote listing TIP NOTE IMPORTANT WARNING CAUTION ab stract partintro comment example sidebar source music latex graphviz 15 1 normal paragraph syntax Normal paragraph syntax consists of one or more non blank lines of text The first line must start hard against the left margin no inter
8. target language see the list of captions and titles in the attributes section of the distribution Lang conf files The easiest way is to create a language conf file see the AsciiDoc s lang en conf file Note You still use the NOTE CAUTION TIP WARNING IMPORTANT captions in the AsciiDoc source they get translated in the HTML output file e asciidoc 1 automatically loads configuration files named like Lang lt lang gt conf where lt lang gt is a two letter language code that matches the current AsciiDoc lang attribute See also Configuration File Names and Locations AsciiDoc User Guide E Vim Syntax Highlighter 83 88 Syntax highlighting is incredibly useful in addition to making reading AsciiDoc documents much easier syntax highlighting also helps you catch AsciiDoc syntax errors as you write your documents The AsciiDoc distribution directory contains a Vim syntax highlighter for AsciiDoc vim syntax asciidoc vim you can find the latest version in the online AsciiDoc repository Install the highlighter by copying asciidoc vim to your HOM exist To enable syntax highlighing E vim syntax directory create it if it doesn t already e Put a Vim autocmd in your Vim configuration file see the example vimre file e or execute the Vim command set syntax asciidoc e or add the following line to the end of you AsciiDoc source files vim set syntax asciidoc F Attribute Opt
9. AsciiDoc documents If the attribute name is followed by an exclamation mark the attribute becomes undefined e If lt value gt is omitted the attribute is set to a blank string e lt value gt can contain simple and conditional attribute references e Returns a blank string unless the attribute is undefined in which case the return value is undefined and the enclosing line will be dropped set2 lt attrname gt lt value gt Same as set except that the attribute scope is local to the template sys lt command gt Substitutes the stdout generated by the execution of the shell lt command gt sys2 lt command gt Substitutes the stdout and stderr generated by the execution of the shell lt command gt sys3 lt command gt Passthrough version of sys lt command gt the generated output is written directly to the output without any further substitutions template lt template gt Substitutes the contents of the configuration file section named lt template gt Attribute references contained in the template are substituted SYSTEM REFERENCE BEHAVIOR e System attribute arguments can contain non system attribute references e Closing brace characters inside system attribute arguments must be escaped with a backslash AsciiDoc User Guide 68 88 31 Intrinsic Attributes Intrinsic attributes are simple attributes that are created automatically from AsciiDoc document header parameters asciido
10. string value For example options opt1 opt2 opt3 is equivalent to setting the following three attributes opt 1 optio e If you define a an option attribute globally for example with an attribute entry then it will apply to all elements in the document e AsciiDoc implements a number of predefined options which are listed in the Attribute Options appendix 29 2 Macro Attribute lists Macros calls are suffixed with an attribute list The list may be empty but it cannot be omitted List entries are used to pass attribute values to macro markup templates AsciiDoc User Guide 65 88 30 Attribute References An attribute reference is an attribute name possibly followed by an additional parameters enclosed in curly braces When an attribute reference is encountered it is evaluated and replaced by its corresponding text value If the attribute is undefined the line containing the attribute is dropped There are three types of attribute reference Simple Conditional and System ATTRIBUTE REFERENCE EVALUATION e You can suppress attribute reference expansion by placing a backslash character immediately in front of the opening brace character e By default attribute references are not expanded in LiteralParagraphs ListingBlocks or LiteralBlocks e Attribute substitution proceeds line by line in reverse line order e Attribute reference evaluation is performed in the following order Simple then Conditional and finally System 30 1
11. 44 jbloggs Exp You can override or set header parameters by passing revnumber revremark revdate email author authorinitials firstname and lastname attributes using the asciidoc 1 a attribute command line option For example asciidoc a revdate 2004 07 27 article txt Attribute entries can also be added to the header for substitution in the header template with Attribute Entry elements The title element in HTML outputs is set to the AsciiDoc document title you can set it to a different value by including a title attribute entry in the document header 8 2 1 Additional document header information AsciiDoc has two mechanisms for optionally including additional meta data in the header of the output document docinfo configuration file sections If a configuration file section named docinfo has been loaded then it will be included in the document header Typically the docinfo section name will be prefixed with a character so that it is appended to rather than replace other docinfo sections docinfo files Two docinfo files are recognized one named docinfo and a second named like the AsciiDoc source file with a docinfo suffix For example if the source document is called mydoc t xt then the document information files would bedocinfo xmlandmydoc docinfo xml for DocBook outputs and docinfo html andmydoc docinfo html for HTML outputs The docinfo attributes control which docinfo files are included in the output files
12. Simple Attributes References Simple attribute references take the form lt name gt If the attribute name is defined its text value is substituted otherwise the line containing the reference is dropped from the output 30 2 Conditional Attribute References Additional parameters are used in conjunction with attribute names to calculate a substitution value Conditional attribute refer ences take the following forms lt names gt lt value gt lt value gt is substituted if the attribute lt names gt is undefined otherwise its value is substituted lt value gt can contain simple attribute references lt names gt lt value gt lt value gt is substituted if the attribute lt names gt is defined otherwise an empty string is substituted lt value gt can contain simple attribute references lt names gt lt value gt lt value gt is substituted if the attribute lt names gt is undefined otherwise an empty string is substituted lt value gt can contain simple attribute references lt names gt lt value gt lt value gt is substituted if the attribute lt names gt is defined otherwise the undefined attribute entry causes the containing line to be dropped lt value gt can contain simple attribute references lt names gt lt value gt lt value gt is substituted if the attribute lt names gt is not defined otherwise the containing line is dropped lt value gt can contain simple attribute references lt
13. T IR E Ge E EN 8 Document Structure 8 1 8 2 8 3 8 4 8 5 Blook Elements o o ee dee Gee Sa a hehe de Be Ge be wate ae ede Be de AR TROUT oak bow eet BC A a Re Ge Sa eee ae ae 38 21 Additional document header information s p e spaco sp esap kea we e Rh ee Preamble 2 ege aeda aea ak a eA e e A bee e eoe o A a BOCUONS id eee i aAa E E i ee Se eee E Pe Eee Ee EP A S 4 1 Section markup templates s ccro eR t inpia A ee ee ee ee PE R MIG e Be aaua ea Raced ae GA eds Soe ee E aoe ee Se N eee SS Special Secon TES cw yk eA OR RR A Dek e a Tlie PLE amp 4 Se ow it oa ee eae A ee ee ee ot be eee ee Ge AsciiDoc User Guide 9 Document Processing 10 Text Formatting TOT Spied eRe ek ERA REE A EEA SEE EL AEA OSES GA eee ee eae a o 10 1 1 Quoted text attributes ca s i oe 24066444 bee EEE a EE ES 10 1 2 Constrained and Unconstrained Quotes osp crape HR ee ee ee ee eS CONSI UE a 2 dares EA AA eB SRE Se AAA A Upconstraned GUIES ea he a A A ROR a A eat bed bak 102 Superseripts and SUbscnpis sk ee we RE E a DUES Line Breaks ee eke a CER ERASE GS OEM eRe SESE A ee EES ES Dee Page Beaks gt 000 eS Ree gia SA Se PA Re eee E E ee e e WS RME ek ee Kad Sw we ae Eee ork ARE Bae OS wa BS Gee SG ew 2 Ea Se Ow ae Ea Se os WD a Ghd ae ce Ss Re ee Gok ogee ek ee ae he a hes Ge ea a ed ae 10 7 REPLACEMEMES o ecc ra eb EE Ee ea PRA ee we EGA Ee EO WES Speer WER 2 eb hee ee ek he eh SoG ew EES eh ee ADRESSE SS 11 Titles ILI Two T
14. The function of a tool chain is to read the DocBook markup produced by AsciiDoc and transform it to a presentation format for example HTML PDF HTML Help EPUB DVI PostScript LaTeX A wide range of user output format requirements coupled with a choice of available tools and stylesheets results in many valid tool chain combinations 5 2 a2x Toolchain Wrapper One of the biggest hurdles for new users is installing configuring and using a DocBook XML toolchain a2x 1 can help it s a toolchain wrapper command that will generate XHTML chunked and unchunked PDF EPUB DVI PS LaTeX man page HTML Help and text file outputs from an AsciiDoc text file a2x 1 does all the grunt work associated with generating and sequencing the toolchain commands and managing intermediate and output files a2x 1 also optionally deploys admonition and navigation icons and a CSS stylesheet See the a2x 1 man page for more details In addition to asciidoc 1 you also need xsltproc 1 DocBook XSL Stylesheets and optionally dblatex or FOP to generate PDF w3m 1 or lynx 1 to generate text The following examples generate doc source highlight filter paf from the AsciiDoc doc source highlight fil source file The first example uses dblatex 1 the default PDF generator the second example forces FOP to be used a2x f pdf doc source highlight filter txt a2x f pdf fop doc source highlight filter txt See the a2x 1 man page for details
15. The path names of images icons and scripts are relative path names to the output document not the source document data uri xhtml11 html5 Embed images using the data uri scheme css signature html5 xhtml 1 Set a CSS signature for the document sets the id attribute of the HTML body element CSS signatures provide a mechanism that allows users to personalize the document appearance The term CSS signature was coined by Eric Meyer disable xhtml11 html5 Ifthe disable javascript attribute is defined the asciidoc js Javascript JavaScript is not embedded or linked to the output document By default AsciiDoc automatically embeds or links the asciidoc js JavaScript to the output document The script dynamically generates table of contents and footnotes AsciiDoc User Guide 86 88 Name Backends Description docinfo All backends These three attributes control which document information files will be included in docinfol the the header of the output file docinfo2 g docinfo Include lt filename gt docinfo lt ext gt docinfo1 Include docinfo lt ext gt docinfo2 Include docinfo lt ext gt and lt filename gt docinfo lt ext gt Where lt filename gt is the file name sans extension of the AsciiDoc input file and lt ext gt is htm1 for HTML outputs or xml for DocBook outputs If the input file is the standard input then the output file name is used The following example will inc
16. blockdef listing delimiter 4 template listingblock presubs specialcharacters callouts Configuration file block definition sections are processed incrementally after each configuration file is loaded Block definition section entries are merged into the block definition this allows block parameters to be overridden and extended by later loading configuration files AsciiDoc Paragraph DelimitedBlock List and Table block elements share a common subset of configuration file parameters delimiter A Python regular expression that matches the first line of a block element in the case of DelimitedBlocks and Tables it also matches the last line template The name of the configuration file markup template section that will envelope the block contents The pipe character is substituted for the block contents List elements use a set of list specific tag parameters instead of a single template The template name can contain attribute references allowing dynamic template selection a the time of template substitution options A comma delimited list of element specific option names In addition to being used internally options are available during markup tag and template substitution as attributes with an empty string value named like lt opt ion gt option where lt option gt is the option name See attribute options for a complete list of available options subs presubs postsubs e presubs and postsubs are lists of comma separa
17. ee ee ee eae E 20 2 Miscellaneous SEUA cie A ee EE RE A A ee a 2G MESE eu Seed Coe eh A peel ee See bok dw dae eb eae Oe Se eee oS 204 TABES CHON o bbe ESE Ree OES eS RS ERE EER eae ae Eh ee DOD ADSS ECHA lt lt DA a BOR See ee GS E ee ee 4 SA eee eee 26 6 Special Character section e c 54644 4 05 be 4a be ada es ete a ve eee eee ea ee hea eee 207 Cuotsd Text secon e ke he he oe ie a Re ee a ke eo he eR ae ee eS 209 Special Words section ok Sc gd Ree ae ee awe OS ede Seale ye be Ye See ede amp K 26 9 Repla coments SENOR 0 Soe ears ow ek ARR ee A EAR RS RE A Rabe a 26 10Mark p Template Sections 02 cos e a a A aR ERR ek Pa RAG Ra Ee 26 11 Configuration file names precedence and locations 2 25 coso RE ee Eee ER Ee 27 Document Attributes 28 Attribute Entries 26 1 Setting CONNOUIAION GNIS es ok ba ee A Ee e A ee ee Se AsciiDoc User Guide 29 30 32 33 34 35 36 Attribute Lists Pod CNNSI oe vie A BEERS Rae ARAS Bee ees te Bee ee bh hb oa 29 2 Macro Attribute lists 2 o seese ee ao i arrene eh ee e ee ee ee Attribute References 30 1 Simple Atinbutes References ooo xe GAR RA KR EMA SE RE OR Oe ee EE Re Se ee eS 30 2 Conditional Attribute References a s 6 ses RES REESE ENE RAED VEY OO REEDS e 30 2 1 Condilionalatiribute examples el a RO eS Bk AG GO EO 30 3 System Attribute References ooo A bE EEA A ae ee ee Intrinsic Attributes Block Element Definitions ILL BIG cera eb ee bee a REA
18. following differences e They occur in a block context e The default syntax is lt name gt lt target gt lt attrlist gt two colons not one e Markup template section names end in blockmacro instead of inlinemacro AsciiDoc User Guide 39 88 21 2 1 Block Identifier The Block Identifier macro sets the id attribute and has the same syntax as the anchor inline macro since it performs essentially the same function block templates use the id attribute as a block element ID For example X30 This is equivalent to the id X30 AttributeList element 21 2 2 Images The image block macro is used to display images in a block context The syntax is image lt target gt lt attributes gt The block image macro has the same macro attributes as it s inline image macro counterpart Block images can be titled by preceding the image macro with a BlockTitle DocBook toolchains normally number titled block images and optionally list them in an automatically generated List of Figures backmatter section This example Main circuit board image images layout png J14P main circuit board 1s equivalent to image images layout png J14P main circuit board title Main circuit board A title prefix that can be inserted with the capt ion attribute HTML backends For example Main circuit board caption Figure 2 image images layout png J14P main circuit board Embedding images in XHTML docu
19. labitur dolorum an Est ne magna primis adolescens Fusce euismod commodo velit Ipsum Vivamus fringilla mi eu lacus e Vivamus fringilla mi eu lacus e Donec eget arcu bibendum nunc consequat lobortis Dolor e Vivamus fringilla mi eu lacus e Donec eget arcu bibendum nunc consequat lobortis Note Current PDF toolchains do not make a good job of determining the relative column widths for horizontal labeled lists Nested horizontal labeled lists will generate DocBook validation errors because the DocBook XML V4 2 DTD does not permit nested informal tables although DocBook XSL Stylesheets and dblatex process them correctly The label width can be set as a percentage of the total width by setting the width attribute e g width 10 17 4 Question and Answer Lists AsciiDoc comes pre configured with a ganda style labeled list for generating DocBook question and answer Q amp A lists Ex ample qanda Question one Answer one Question two Answer two AsciiDoc User Guide 31 88 Renders 1 Question one Answer one 2 Question two Answer two 17 5 Glossary Lists AsciiDoc comes pre configured with a glossary style labeled list for generating DocBook glossary lists Example glossary A glossary term The corresponding definition A second glossary term The corresponding definition For working examples see the article txt and book txt documents in the AsciiDoc doc distribution dire
20. simple and conditional attribute references e The counter system attribute will not be executed if the containing line is dropped by the prior evaluation of an undefined attribute counter2 lt attrname gt lt seed gt Same as counter except the it always returns a blank string eval lt expression gt Substitutes the result of the Python lt expression gt AsciiDoc User Guide 67 88 e If lt expression gt evaluates to None or False the reference is deemed undefined and the line containing the reference is dropped from the output e If the expression evaluates to True the attribute evaluates to an empty string e lt expression gt can contain simple and conditional attribute references e The eval system attribute can be nested inside other system attributes eval3 lt command gt Passthrough version of eval lt expression gt the generated output is written directly to the output without any further substitutions finclude lt filename gt Substitutes contents of the file named lt filename gt e The included file is read at the time of attribute substitution e If the file does not exist a warning is emitted and the line containing the reference is dropped from the output file e Tabs are expanded based on the current tabsize attribute value set lt attrname gt lt value gt Sets or unsets document attribute Normally only used in configuration file markup templates use AttributeEntries in
21. super text and some sub text Is rendered like e i41 0 H20 and x Some Pe text and some sub text Superscripts and subscripts are implemented as unconstrained quotes and they can be escaped with a leading backslash and prefixed with with an attribute list AsciiDoc User Guide 16 88 10 3 Line Breaks A plus character preceded by at least one space character at the end of a non blank line forces a line break It generates a line break br tag for HTML outputs and a custom XML asciidoc br processing instruction for DocBook outputs The asciidoc br processing instruction is handled by a2x 1 10 4 Page Breaks A line of three or more less than lt lt lt characters will generate a hard page break in DocBook and printed HTML outputs It uses the CSS page break after property for HTML outputs and a custom XML asciidoc pagebreak processing instruction for DocBook outputs The asciidoc pagebreak processing instruction is handled by a2x 1 Hard page breaks are sometimes handy but as a general rule you should let your page processor generate page breaks for you 10 5 Rulers A line of three or more apostrophe characters will generate a ruler line It generates a ruler hr tag for HTML outputs and a custom XML asciidoc hr processing instruction for DocBook outputs The asciidoc hr processing instruction is handled by a2x 1 10 6 Tabs By default tab characters input files will translated to 8 spaces Tab expansion is set with
22. the filter command does not specify a directory path then asciidoc 1 recursively searches for the executable filter com mand e First it looks in the user s SHOME asciidoc filters directory e Next the global filters directory usually etc asciidoc filters or usr local etc asciidoc directory is searched e Then it looks in the asciidoc 1 filters directory e Finally it relies on the executing shell to search the environment search path PATH Standard practice is to install each filter in it s own sub directory with the same name as the filter s style definition For example the music filter s style name is music so it s configuration and filter files are stored in the filters music directory 33 2 Filter Configuration Files Filters are normally accompanied by a configuration file containing a Paragraph or DelimitedBlock definition along with corre sponding markup templates While it is possible to create new Paragraph or DelimitedBlock definitions the preferred way to implement a filter is to add a style to the existing Paragraph and ListingBlock definitions all filters shipped with AsciiDoc use this technique The filter is applied to the paragraph or delimited block by preceding it with an attribute list the first positional attribute is the style name remaining attributes are normally filter specific parameters asciidoc 1 auto loads all conf files found in the filter search paths unless the container dir
23. the tabsize entry in the configuration file miscellaneous section and can be overridden in included files by setting a tabsize attribute in the include macro s attribute list For example include addendum txt tabsize 2 The tab size can also be set using the attribute command line option for example attribute tabsize 4 10 7 Replacements The following replacements are defined in the default AsciiDoc configuration C copyright TM trademark R registered trademark em dash ellipsis gt right arrow lt left arrow gt right double arrow lt left double arrow Which are rendered as copyright trademark registered trademark em dash ellipsis right arrow left arrow right double arrow lt left double arrow You can also include arbitrary entity references in the AsciiDoc source Examples amp x278a amp 182 renders oq To render a replacement literally escape it with a leading back slash The Configuration Files section explains how to configure your own replacements AsciiDoc User Guide 17 88 10 8 Special Words Words defined in specialwords configuration file sections are automatically marked up without having to be explicitly notated The Configuration Files section explains how to add and replace special words 11 Titles Document and section titles can be in either of two formats 11 1 Two line titles A two line title consists of a t
24. types by editing AsciiDoc configuration files Here is the shipped Default paragraph definition paradef default delimiter P lt text gt 1S x template paragraph The normal paragraph definition has a couple of special properties 1 It must exist and be defined in a configuration file section named paradef default 2 Irrespective of its position in the configuration files default paragraph document matches are attempted only after trying all other paragraph types Paragraph specific block parameter notes delimiter This regular expression must contain the named group text which matches the text on the first line Paragraphs are termi nated by a blank line the end of file or the start of a DelimitedBlock AsciiDoc User Guide 72 88 options The listelement option specifies that paragraphs of this type will automatically be considered part of immediately preceding list items The skip option causes the paragraph to be treated as a comment see CommentBlocks PARAGRAPH PROCESSING PROCEEDS AS FOLLOWS 1 The paragraph text is aligned to the left margin 2 Optional presubs inline substitutions are performed on the paragraph text 3 If a filter command is specified it is executed and the paragraph text piped to its standard input the filter output replaces the paragraph text 4 Optional postsubs inline substitutions are performed on the paragraph text 5 The paragraph text is enveloped by the paragraph s markup tem
25. unique string that conforms to the output markup s anchor syntax The optional lt xreflabel1 gt is the text to be displayed by captionless xref macros that refer to this anchor The optional lt xreflabe1 gt is only really useful when generating DocBook output Example anchor X1 You may have noticed that the syntax of this inline element is the same as that of the BlockId block element this is no coincidence since they are functionally equivalent xref Creates a hypertext link to a document anchor lt lt lt id gt lt caption gt gt gt xref lt id gt lt caption gt The lt id gt refers to an anchor ID The optional lt caption gt is the link s displayed text Example lt lt X21 attribute lists gt gt If lt caption gt is not specified then the displayed text is auto generated e The AsciiDoc xhtml 1 and html5 backends display the lt id gt enclosed in square brackets e If DocBook is produced the DocBook toolchain is responsible for the displayed text which will normally be the referenced figure table or section title number followed by the element s title text Here is an example tiger_image Ly gQer tyger image tiger png This can be seen in lt lt tiger_image gt gt 21 1 3 Linking to Local Documents Hypertext links to files on the local file system are specified using the link inline macro link lt target gt lt caption gt The link macro generates relative URLs The link m
26. 3 5 Filter plugins Filter plugins are a mechanism for distributing AsciiDoc filters A filter plugin is a Zip file containing the files that constitute a filter The asciidoc 1 filter option is used to load and manage filer plugins e Filter plugins take precedence over built in filters with the same name e By default filter plugins are installed in SHOME asciidoc filters lt filter gt where lt filter gt is the filter name 34 Plugins The AsciiDoc plugin architecture is an extension mechanism that allows additional backends filters and themes to be added to AsciiDoc e A plugin is a Zip file containing an AsciiDoc backend filter or theme configuration files stylesheets scripts images e The asciidoc 1 backend filter and theme command line options are used to load and manage plugins Each of these options responds to the plugin management install list remove and build commands e The plugin management command names are reserved and cannot be used for filter backend or theme names e The plugin Zip file name always begins with the backend filter or theme name Plugin commands and conventions are documented in the asciidoc 1 man page You can find lists of plugins on the AsciiDoc website 35 Help Commands The asciidoc 1 command has a help option which prints help topics to stdout The default topic summarizes asciidoc 1 usage asciidoc help To print a help topic specify the topic
27. 60 Ammoniten Blocks lt lt lt car gee eA RES a a Se Se Lee eS Pe lps BIGEKS ooo aa e a Ae BA a A Ree eS ER gee eos ds Lists TRE Bullet Ls cy cies oe See See bo Rae Gy A eas ER OG Bawls Cee SA We Ae ELS See 17 2 Numbered LIS 2 4b ek ek Shee Pew AEE SESE PEARS COREE eR EERE ES Deo Labeled Listi sad on ee ace Ee a OH SYR A Ree a Bee Hed SES Bee Ed De Gs 7 2 1 Elorizontal labeled listsple oo ek p eee eet aed eee Ceres Oe 174 Question and Answer Lists o ss 24 45 pa eee Wed ads a HE ED ROAR Ow Ee ww Era A ASIS oe ke E eGR RE OAS ERE ESE ee EEE OS Dy MOO A I sa ARLE Bee eae A Eee oe A AAA AAA Se ork 17 7 List Ten Continuation ss sacra we ee Ewe eRe Ewe ee BA he hae Sew ee Footnotes Indexes Callouts 20 1 Tnnplememiiion Notes s oe eh ace A AR RE ae A e OR ee 20 2 Including callouts in Included code ocos Re ee ee ee ee ee ee Macros Ph lne MICOS o ea a A a a ee ot eee ee e LI URLE oeo ee etek whe A SESE ee eae be A a a eS liz Titers Cross RIGOR ce bad ee eal A ah ae Soe el hw Ae a GE 21 1 3 Linking to Local D c mients lt e o so eaa ee a Adee Pd e a E ALNA Images a A wa a eh Oe A ee de a a oe JUS COmMent LIES ociosas SGP e AA we oR Ee eS 212 Block Maros o cs foe Oe tw ae A A a OE Ge al Fe 21 2 1 Block Identifier s cew aa eR ER ERR EHR ERR A elk IMAGS dr OWE ao wa A eal bee ae ae Goh a 2123 Comment Limes 04626 44 8b A RA HELGA A ewe eee ee a ld Sye MATOS eo ee Se el a eo Ee a ea ae Pa ee Ee ee ae ee Se we E 23 Delu
28. AsciiDoc User Guide AsciiDoc User Guide POF EY DELATEX AsciiDoc User Guide REVISION HISTORY NUMBER DATE DESCRIPTION NAME 8 6 9 9 November 2013 SJR AsciiDoc User Guide Contents 1 Introduction 2 Getting Started 2 1 wae Installing SCIMOS sso kk ek si E boa eg a ee be Be e a ee a a Example Aseos DOCymentS eose g 2 ek Ae ee EE Rw ee E e Be Ree oe oF Bee eae da 3 AsciiDoc Document Types a 32 33 D E sa ae e stp e E a se es ah Saas ea tbe Paar aa A E e ae ROSE o ceed np coe oe er ke cai fee cero tua Go eee ceca ok da ey eos do ee Se oe aati ra E MAPA ce be DG RS eA we EE ERAS oe bee ee Gee Ae eee eS 4 AsciiDoc Backends At Backend Aliases Ce eee eR ER Ee eee A See R a e Y 42 Backer PUGNE ew RE a ERA bee eee ee EE 5 DocBook 5 1 Converting DocBook to other file formats s c 5 456 Bh wR GE ORR SERRE EE Ee ERE OO 3 2 a22 Toolcham Wrapper og coec essea gr Oe SR EE eee eG ESE RR eee E Oo HTL o o e whee ok Re RS ee hha ee eS BA ERPS SES NEE SESS aon TP Geer i es Re ee Shwe hee BENS Bw Pee Bae tbe BEES SS 39 HTMLHelp generation scott e REE RE MA ee a ee a e SO Teclehain Components SUI cc gk RR RR ORR EEG Re ew AG ER eee OS 5 7 AsotiDos dblatex conliguration files sc ce ere terest te katir heri eee ee eee 56 AsciDoc DocBook XSL Stylesheets drivers oia raa aant e eee ER ee a ewe Eee bees 6 Generating Plain Text Files 7 HTMLS5 and XHTML 1 1 7A
29. BLE DEFINITION BEHAVIOR e The output markup generation is specifically designed to work with the HTML and CALS DocBook table models but should be adaptable to most XML table schema e Table definitions can be mixed in from multiple cascading configuration files e New table definitions inherit the default table and table tags definitions tabledef default and tabletags default so you only need to override those conf file entries that require modification 33 Filters AsciiDoc filters allow external commands to process AsciiDoc Paragraphs DelimitedBlocks and Table content Filters are primarily an extension mechanism for generating specialized outputs Filters are implemented using external commands which are specified in configuration file definitions There s nothing special about the filters they re just standard UNIX filters they read text from the standard input process it and write to the standard output The asciidoc 1 command filter option can be used to install and remove filters The same option is used to uncon ditionally load a filter Attribute substitution is performed on the filter command prior to execution attributes can be used to pass parameters from the AsciiDoc source document to the filter Warning Filters sometimes included executable code Before installing a filter you should verify that it is from a trusted source AsciiDoc User Guide 74 88 33 1 Filter Search Paths If
30. If the data uri attribute is defined then icons are loaded from the theme icons sub directory if it exists i e cons sub directory path 8 88 the iconsdir e Embedded theme files are automatically inserted in the output files but you need to manually copy linked CSS and Javascript files to the location of the output documents Linked CSS and JavaScript theme files are linked to the same linked locations as other CSS and JavaScript files For example the command line option theme foo or attribute theme foo will cause asciidoc 1 to search configuration file locations 1 for a sub directory called themes foo containing the stylesheet foo css and optionally a JavaScript file name foo JS 8 Document Structure An AsciiDoc document consists of a series of block elements starting with an optional document Header followed by an optional Preamble followed by zero or more document Sections Almost any combination of zero or more elements constitutes a valid AsciiDoc document documents can range from a single sentence to a multi part book 8 1 Block Elements Block elements consist of one or more lines of text and may contain other block elements The AsciiDoc block structure can be informally summarized as follows Document Header i AuthorInfo n RevisionInfo Preamble is Section iS SectionBody Block List i BulletedList NumberedList CalloutList z LabeledList t ListEntry ListLabel n L
31. OE aE E HAA ee eee eee eee e bk Peat Bete ea AAN Soo Denne BIQERS cc A PS Bee ee ee he eo oe See Be a E Soe WRB is oe de eR he ea A ede PA EWA Oe eek de ee oe ee A Meee eS Baie E Filters Sa PEF OOO PADRE g od Gh ce a Se a Oe MAS Sree ee OE eee oa GF Be eee 6 ed 332 Filter Configuration Files oe sce ew ae EW ae ea ow Ee ee hee ae ee 333 Example PISE cora sra aa a Ge A Bao MARES ao amp ak 33 4 Bolten DERE oe SA eA bw A wee A eee ee EGA ee ee Jeo Filer PINE 2 oat Babe ea Se es A SE SS ei See a EAS GS Plugins Help Commands ab CURAR RO cobro oia Aa AA Tips and Tricks Al Know YOU EWO e a a ARA A a A a a od e 36 2 Vim Commands for Formatting AscuDoe gt s lt s spesse eR eR RE ERE EEE RS Be 30 21 Vest Wrap Parara phs lt a ee eS Eee eh EEE SE awd Shee Gh S022 Pompad LISIS ss IEA AAA eS E 36 23 Incemt Paragraphs o e e A A e e a a a 30 241 Example F vinre File aii a A a a e 36 9 TIGUBIESHOUDE y nors aea a a A A A Ba Bae AS ACA 2 da ido AA 36 5 Combining separate DOCUS cusco A a a ES Re ee ee e 36 6 Processing document sections separately sos co cesos revedere se iewat ee eee vii 64 64 64 65 65 65 66 66 68 70 71 71 72 72 73 73 74 74 74 74 75 75 75 75 AsciiDoc User Guide 37 36 7 Processing document snippets cos 5684 cen Se 6 ER aS u tgus 36 8 Badges in HTML pape footers lt o o e ek a ee we a 36 9 Pretty printing AsenDoc output io ee eee bs 36 10Supporting minor DocBo
32. TOC generator after the page is loaded If you link to a dynamically generated TOC address the page will load but the browser will ignore the as yet ungenerated section ID The IDs are generated by the following algorithm AsciiDoc User Guide e Repl 12 88 ace all non alphanumeric title characters with underscores e Strip leading or trailing underscores e Convert to lowercase e Prepend the idprefix attribute so there s no possibility of name clashes with existing document IDs Prepend an under score if the idprefix attribute is not defined A numbered suffix _2 _3 is added if a same named auto generated section ID exists e If the ascii ids attribute is defined then non ASCII characters are replaced with ASCII equivalents This attribute may be deprecated in future releases and should be avoided it s sole purpose is to accommodate deficient downstream applications that cannot process non ASCII ID attributes Example the title Jim s House would generate the ID _jim_s_house Section ID synthesis can be disabled by undefining the sect ids attribute 8 4 3 Special Section Titles AsciiDoc has a mechanism for mapping predefined section titles auto magically to specific markup templates For example a title Appendix A Code Reference will automatically use the appendix section markup template The mappings from title to template name are specified in specialsections sections in the Asciidoc language config
33. The contents docinfo templates and files is dependent on the type of output HTML Valid head child elements Typically style and script elements for CSS and JavaScript inclusion DocBook Valid articleinfo or bookinfo child elements DocBook defines numerous elements for document meta data for example copyrights document history and authorship information See the DocBook doc article docinfo xml example that comes with the AsciiDoc distribution The rendering of meta data elements or not is DocBook processor dependent AsciiDoc User Guide 11 88 8 3 Preamble The Preamble is an optional untitled section body between the document Header and the first Section title 8 4 Sections In addition to the document title level 0 AsciiDoc supports four section levels 1 top to 4 bottom Section levels are delimited by section titles Sections are translated using configuration file section markup templates AsciiDoc generates the following intrinsic attributes specifically for use in section markup templates level The level attribute is the section level number it is normally just the title level number 1 4 However if the leveloffset attribute is defined it will be added to the level attribute The leveloffset attribute is useful for combining documents sectnum The n sect ion numbers command line option generates the sect num section number attribute The sectnum attribute is used for section numbers in HTML outputs Do
34. a closing parenthesis The different terminators are necessary to ensure i v and x roman numbers are are distinguishable from x v and x alpha numbers Examples Tx Arabic decimal numbered list item ay Lower case alpha letter numbered list item F Upper case alpha letter numbered list item iii Lower case roman numbered list item IX Upper case roman numbered list item Implicit numbering List items begin one to five period characters followed by some white space then the item text Examples Arabic decimal numbered list item Lower case alpha letter numbered list item Lower case roman numbered list item Upper case alpha letter numbered list item betire Upper case roman numbered list item You can use the style attribute also the first positional attribute to specify an alternative numbering style The numbered list style can be one of the following values arabic loweralpha upperalpha lowerroman upperroman Here are some examples of bulleted and numbered lists Praesent eget purus quis magna eleifend eleifend 1 Fusce euismod commodo velit a Fusce euismod commodo velit b Vivamus fringilla mi eu lacus c Donec eget arcu bibendum nunc consequat lobortis 2 Vivamus fringilla mi eu lacus i Fusce euismod commodo velit 1i Vivamus fringilla mi eu lacus 3 Donec eget arcu bibendum nunc consequat lobortis 4 Nam fermentum mattis ante Lorem ipsum dolor sit amet consec
35. a name and a textual value and is used for textual substitution in AsciiDoc documents and configuration files An attribute reference an attribute name enclosed in braces is replaced by the corresponding attribute value Attribute names are case insensitive and can only contain alphanumeric dash and underscore characters There are four sources of document attributes from highest to lowest precedence Command line attributes AttributeEntry AttributeList Macro and BlockId elements e Configuration file attributes sections Intrinsic attributes Within each of these divisions the last processed entry takes precedence Note If an attribute is not defined then the line containing the attribute reference is dropped This property is used extensively in AsciiDoc configuration files to facilitate conditional markup generation 28 Attribute Entries The AttributeEntry block element allows document attributes to be assigned within an AsciiDoc document Attribute entries are added to the global document attributes dictionary The attribute name value syntax is a single line like lt name gt lt value gt For example AsciiDoc User Guide Author Initials JB 62 88 This will set an attribute reference authorinitials to the value JB in the current document To delete undefine an attribute use the following syntax lt name gt ATTRIBUTEENTRY BEHAVIOR e The attribute entry line begins with co
36. a nested call to itself e In addition to lt name gt lt target gt and lt attrlist gt the lt passtext gt and lt subslist gt named groups are available to passthrough macros A macro is a passthrough macro if the definition includes a lt passtext gt named group 21 1 Inline Macros Inline Macros occur in an inline element context Predefined Inline macros include URLs image and link macros 21 1 1 URLs http https ftp file mailto and callto URLs are rendered using predefined inline macros e If you don t need a custom link caption you can enter the http https ftp file URLs and email addresses without any special macro syntax e If the lt attrlist gt is empty the URL is displayed Here are some examples http www docbook org DocBook org http www docbook org mailto joe bloggs foobar com email Joe Bloggs joe bloggs foobar com Which are rendered DocBook org http www docbook org email Joe Bloggs joe bloggs foobar com If the lt target gt necessitates space characters use 20 for example large 20image png 21 1 2 Internal Cross References Two AsciiDoc inline macros are provided for creating hypertext links within an AsciiDoc document You can use either the standard macro syntax or the preferred alternative AsciiDoc User Guide 37 88 anchor Used to specify hypertext link targets lt id gt lt xreflabel gt anchor lt id gt lt xreflabel gt The lt id gt is a
37. a number inside angle brackets you ll need to escape it with a backslash to prevent it being interpreted as a callout mark Note Define the AsciiDoc icons attribute for example using the a icons command line option to display callout icons AsciiDoc User Guide 35 88 20 1 Implementation Notes Callout marks are generated by the callout inline macro while callout lists are generated using the callout list definition The callout macro and callout list are special in that they work together The callout inline macro is not enabled by the normal macros substitutions option instead it has its own callouts substitution option The following attributes are available during inline callout macro substitution index The callout list item index inside the angle brackets coid An identifier formatted like CO lt 1istnumber gt lt index gt that uniquely identifies the callout mark For example CO2 4 identifies the fourth callout mark in the second set of callout marks The coids attribute can be used during callout list item substitution it is a space delimited list of callout IDs that refer to the explanatory list item 20 2 Including callouts in included code You can annotate working code examples with callouts just remember to put the callouts inside source code comments This example displays the test py source file containing a single callout using the source code highlighter filter AsciiDoc source sou
38. a plain text human readable writable document format that can be translated to DocBook or HTML using the asciidoc 1 command You can then either use asciidoc 1 generated HTML directly or run asciidoc 1 DocBook output through your favorite DocBook toolchain or use the AsciiDoc a2x 1 toolchain wrapper to produce PDF EPUB DVI LaTeX PostScript man page HTML and text formats The AsciiDoc format is a useful presentation format in its own right AsciiDoc markup is simple intuitive and as such is easily proofed and edited AsciiDoc is light weight it consists of a single Python script and a bunch of configuration files Apart from asciidoc 1 and a Python interpreter no other programs are required to convert AsciiDoc text files to DocBook or HTML See Example AsciiDoc Documents below Text markup conventions tend to be a matter of often strong personal preference if the default syntax is not to your liking you can define your own by editing the text based asciidoc 1 configuration files You can also create configuration files to translate AsciiDoc documents to almost any SGML XML markup asciidoc 1 comes with a set of configuration files to translate AsciiDoc articles books and man pages to HTML or DocBook backend formats My AsciiDoc Itch DocBook has emerged as the de facto standard Open Source documentation format But DocBook is a complex language the markup is difficult to read and even more difficult to write directly
39. abeled lists tags The lt name gt of the listtags lt name gt configuration file section containing list markup tag definitions The tag entries list entry label term text map the AsciiDoc list structure to backend markup see the isttags sections in the AsciiDoc distributed backend conf configuration files for examples AsciiDoc User Guide 73 88 32 5 Tables Table behavior and syntax is determined by tabledef x and tabletags x configuration file sections The user can change existing table behavior and add new table types by editing configuration files The following tabledef section entries generate table output markup elements colspec The table colspec tag definition headrow footrow bodyrow Table header footer and body row tag definitions headrow and footrow table definition entries default to bodyrow if they are undefined headdata footdata bodydata Table header footer and body data tag definitions headdata and footdata table definition entries default to bodydata if they are undefined paragraph If the paragraph tag is specified then blank lines in the cell data are treated as paragraph delimiters and marked up using this tag Table behavior is also influenced by the following miscellaneous configuration file entries pagewidth This integer value is the printable width of the output media See table attributes pageunits The units of width in output markup width attribute values TA
40. ackets for example ASCITDOC 1 The title name should not contain white space and the manual section number is a single digit optionally followed by a single character 24 2 The NAME Section The first manpage section is mandatory must be titled NAME and must contain a single paragraph usually a single line consist ing of a list of one or more comma separated command name s separated from the command purpose by a dash character The dash must have at least one white space character on either side For example printf fprintf sprintf print formatted output 24 3 The SYNOPSIS Section The second manpage section is mandatory and must be titled SYNOPSIS 24 4 refmiscinfo attributes In addition to the automatically created man page intrinsic attributes you can assign DocBook refmiscinfo element source version and manual values using AsciiDoc mansource manversion and manmanual attributes respectively This example is from the AsciiDoc header of a man page source file man source AsciiDoc man version revnumber man manual AsciiDoc Manual 25 Mathematical Formulas The asciimath and latexmath passthrough macros along with asciimath and latexmath passthrough blocks provide a backend dependent mechanism for rendering mathematical formulas You can use the following math markups Note The latexmath macro used to include LaTeX Math in DocBook outputs is not the same as the latexmath macro used to include LaTeX MathML
41. ackslash character as you can with other macros e The syntax and tasks performed by system macros is built into asciidoc 1 so they don t appear in configuration files You can however customize the syntax by adding entries to a configuration file macros section 21 3 1 Include Macros The include and includel system macros to include the contents of a named file into the source document The include macro includes a file as if it were part of the parent document tabs are expanded and system macros processed The contents of include1 files are not subject to tab expansion or system macro processing nor are attribute or lower priority substitutions performed The include1 macro s intended use is to include verbatim embedded CSS or scripts into configuration file headers Example include chapterl txt tabsize 4 INCLUDE MACRO BEHAVIOR If the included file name is specified with a relative path then the path is relative to the location of the referring document e Include macros can appear inside configuration files e Files included from within DelimitedBlocks are read to completion to avoid false end of block underline termination e Attribute references are expanded inside the include target if an attribute is undefined then the included file is silently skipped e The tabsize macro attribute sets the number of space characters to be used for tab expansion in the included file not applicable to includel macro e The dep
42. acro lt target gt is the target file name relative to the file system location of the referring document The optional lt caption gt is the link s displayed text If lt caption gt is not specified then lt target gt is displayed Example link downloads foo zip download foo zip You can use the lt filename gt lt id gt syntax to refer to an anchor within a target document but this usually only makes sense when targeting HTML documents AsciiDoc User Guide 38 88 21 1 4 Images Inline images are inserted into the output document using the image macro The inline syntax is image lt target gt lt attributes gt The contents of the image file lt target gt is displayed To display the image its file format must be supported by the target backend application HTML and DocBook applications normally support PNG or JPG files lt target gt file name paths are relative to the location of the referring document IMAGE MACRO ATTRIBUTES e The optional alt attribute is also the first positional attribute it specifies alternative text which is displayed if the output application is unable to display the image file see also Use of ALT texts in IMGs For example image images logo png Company Logo e The optional title attribute provides a title for the image The block image macro renders the title alongside the image The inline image macro displays the title as a popup tooltip in visual browsers AsciiDoc HTML output
43. ame lee A wh eli Ae Bae oes A aa pe ha a TULA Ome netiks oro cari a EeA ee REE ERE SEE HEE ww eRe HES RG S Tio Ore bles ob a ee Oe ERE SERRE BAL SEES eh SEE eee SSS 12 Block Titles 13 BlockId Element 14 AttributeList Element PLT Abie value substitit e ee el Cw ee se eek oe bata a bee eae wae oe 14 2 Common attribiites 2 2 6 sarre ase Se Re Se ek Re ee a ee ee 15 Paragraphs EL moral paragraph synak sk ees a Ae ER OR KS eR eae Ae E eee a 15 2 Metal paragraph SOX lt lt ooo we A ewe ae ee ee ee ae SO 15 3 Guate and Verse paragraph styles coo oca a Ra ARE BD eS Bae Dae A e 154 Admon Paragraphs e spaas ae ee REY ERR RR EES RE ER RES Ee See Lae RG Ee 154 1 Admonthion Icons and Captions lt o soe ee be eee bbe o eS Pee DERE SES 16 Delimited Blocks 16 1 Predefined Delimited Blocks os r Sb ea A ee Rae Maes Ae Sage ok 16 2 isting DIOSES ops tween pee eee Yes hw Ee OR ee A a KE RS 16 5 Literal Blocks coso wR EEE AE SESE E REEL EEA eT La ES VA Sidebar DION e ok Sea we eA RO A MA ee ee A ee oe Bee ee 2 TEN Comment BIGCES o a ke he EERE EE OS ae oe A A 13 14 14 14 15 15 15 15 16 16 16 16 16 17 17 17 17 18 18 18 18 19 19 19 19 19 20 21 21 AsciiDoc User Guide 17 18 19 20 21 16 06 Passthrouem BICES 5 ek ac el ea A ee RR Dee AA Ee de de BR uo BIGGER og noe eo Gm bk ad ed a a Ee ee e eee eb el da Gee ode bo Ss 16 2 Example BIERE 00 Gs ene e SR Bw EA OO e SR eee e de 1
44. amples website newtables t AsciiDoc User Guide 52 88 23 9 DocBook table limitations Fully implementing tables is not trivial some DocBook toolchains do better than others AsciiDoc HTML table outputs are rendered correctly in all the popular browsers if your DocBook generated tables don t look right compare them with the output generated by the AsciiDoc xhtml1 1 backend or try a different DocBook toolchain Here is a list of things to be aware of Although nested tables are not legal in DocBook 4 the FOP and dblatex toolchains will process them correctly If you use a2x 1 you will need to include the no xmllint option to suppress DocBook validation errors Note In theory you can nest DocBook 4 tables one level using the entrytb element but not all toolchains process entrytbl DocBook only allows a subset of block elements inside table cells so not all AsciiDoc elements produce valid DocBook inside table cells If you get validation errors running a2x 1 try the no xmllint option toolchains will often process nested block elements such as sidebar blocks and floating titles correctly even though strictly speaking they are not legal Text formatting in cells using the monospaced table style will raise validation errors because the DocBook literal element was not designed to support formatted text using the literal element is a kludge on the part of AsciiDoc as there is no easy way to set the font style in DocBook
45. an included file When the input is being read from the standard input stdin these attributes are undefined 6 If the input file is the standard input and the output file is not the standard output then docname is the output file name sans file extension 7 See non English usage of quotation marks 8 The blockname attribute identifies the style of the current block It applies to delimited blocks lists and tables Here is a list of blockname values does not include filters or custom block and style names delimited blocks comment sidebar open pass literal verse listing quote example note tip important caution warning abstract partintro lists arabic loweralpha upperalpha lowerroman upperroman labeled labeled3 labeled4 qanda horizontal bibliog raphy glossary tables table Conditional inclusion using ifdef and ifndef macros differs from attribute conditional inclusion in that the former occurs when the file is read while the latter occurs when the contents are written AsciiDoc User Guide 70 88 32 Block Element Definitions The syntax and behavior of Paragraph DelimitedBlock List and Table block elements is determined by block definitions con tained in AsciiDoc configuration file sections Each definition consists of a section title followed by one or more section entries Each entry defines a block parameter controlling some aspect of the block s behavior Here s an example
46. and 3 for lt backend gt conf and lt backend gt lt doctype gt conf backend configuration files e Filter conf files from locations 7 lang lt lang gt conf from locations 1 2 3 asciidoc conf from location 4 e lt backend gt conf and lt backend gt lt doctype gt conf from location 4 e Filter conf files from location 4 e lt docfile gt conf and lt docfile gt lt backend gt conf from location 4 e Configuration files from location 5 Where e lt backend gt and lt doctype gt are values specified by the asciidoc 1 b backena and d doct ype command line options e lt infile gt is the path name of the AsciiDoc input file without the file name extension e lt lang gt is a two letter country code set by the the AsciiDoc lang attribute AsciiDoc User Guide 61 88 Note The backend and language global configuration files are loaded after the header has been parsed This means that you can set most attributes in the document header Here s an example header Life s Mysteries author Hu Nose doctype book SOG icons data uri lang en encoding iso 8859 1 Attributes set in the document header take precedence over configuration file attributes Tip Use the asciidoc 1 v verbose command line option to see which configuration files are loaded and the order in which they are loaded 27 Document Attributes A document attribute is comprised of
47. and line option asciidoc 1 itself has little intrinsic knowledge of backend formats all translation rules are contained in customizable cascading configuration files Backend specific attributes are listed in the Backend Attributes section docbook45 Outputs DocBook XML 4 5 markup AsciiDoc User Guide 3 88 html4 This backend generates plain HTML 4 01 Transitional markup xhtml11 This backend generates XHTML 1 1 markup styled with CSS2 Output files have an html extension html5 This backend generates HTML 5 markup apart from the inclusion of audio and video block macros it is functionally identical to the xhtml11 backend slidy Use this backend to generate self contained Slidy HTML slideshows for your web browser from AsciiDoc documents The Slidy backend is documented in the distribution doc slidy txt file and online wordpress A minor variant of the html4 backend to support blogpost latex Experimental LaTeX backend 4 1 Backend Aliases Backend aliases are alternative names for AsciiDoc backends AsciiDoc comes with two backend aliases html aliased to xhtml11 and docbook aliased to docbook45 You can assign or reassign backend aliases by setting an AsciiDoc attribute named like backend alias lt alias gt to an AsciiDoc backend name For example the following backend alias attribute definitions appear in the attributes section of the global asciidoc conf configuration file backend alias html xhtm111 bac
48. bles are outside the normal document flow tables are for consulting not for reading Tables are designed for and should normally only be used for displaying column oriented tabular data 23 1 Example tables Table 6 Simple table 112 JA 3 14 B 5 6 C AsciiDoc source wadth 155 11 2 JA 13 14 B S 16 Table 7 Columns formatted with strong monospaced and emphasis styles Columns 2 and 3 1 Item 1 Item 1 2 Item 2 Item 2 AsciiDoc User Guide Table 7 continued Columns 2 and 3 3 Item 3 Item 3 4 Item 4 Item 4 footer 1 footer 2 footer 3 AsciiDoc source An example table 2 Columns 2 and 3 iL Item 1 Item 1 2 Item 2 Item 2 3 Item 3 Item 3 4 Item 4 Item 4 footer 1 footer 2 footer 3 width 50 cols gt s m e frame topbot options header footer Table 8 Horizontal and vertical source data Date Duration Avg HR Notes 22 Aug 08 10 24 157 Worked out MSHR max sustainable heart rate by going hard for this interval 22 Aug 08 23 03 152 Back to back with previous interval 24 Aug 08 40 00 145 Moderately hard interspersed with 3x 3min intervals 2min hard 1min really hard taking the HR up to 160 46 88 Short cells can be entered horizontally longer cells vertically The default behavior is to strip leading and trailing blank lines wit
49. breaghe tons set background dark Show tabs and trailing characters set listchars tab trail eol ensuremath lnot set listchars tab trail set list Reformat paragraphs and list nnoremap lt Leader gt r gq Delete trailing white space and Dos returns and to expand tabs to spaces nnoremap lt Leader gt t set et lt CR gt retab lt CR gt s r t lt CR gt autocmd BufRead BufNewFile txt asciidoc README TODO CHANGELOG NOTES ABOUT setlocal autoindent expandtab tabstop 8 softtabstop 2 shiftwidth 2 filetype asciidoc textwidth 70 wrap formatoptions tcgn y orate laser ste ae Nc WS WP A ies Nol ee Vere Vise aa lt oll Who VAS eA OW ee iia Ao WS aE comment s si ex b 5 XCOMM b fb fb fb fb gt 36 3 Troubleshooting AsciiDoc diagnostic features are detailed in the Diagnostics appendix 36 4 Gotchas Incorrect character encoding If you get an error message like UTF 8 codec can t decode then you source file contains invalid UTF 8 characters set the AsciiDoc encoding attribute for the correct character set typically ISO 8859 1 Latin 1 for European languages Invalid output AsciiDoc attempts to validate the input AsciiDoc source but makes no attempt to validate the output markup it leaves that to external tools such as xmllint 1 integrated into a2x 1 Backend validation cannot be hardcoded into AsciiDoc because backends are dynamically configured The fol
50. c 1 command line arguments attributes defined in the default configuration files the execution context Here s the list of predefined intrinsic attributes amp lasciidoc args asciidoc confdir asciidoc dir lasciidoc file ampersand 8 character entity used to pass inherited arguments to asciidoc filters the asciidoc 1 global configuration directory the asciidoc 1 application directory the full path name of the asciidoc 1 script asciidoc version the version of asciidoc 1 author author s full name authored empty string if author or email defined a e e d b authorinitials uthor initials from document header backend lt backend gt mpty string lt backend gt lt doctype gt empty string backend ocument backend specified by b option backend confdir he directory containing the lt backend gt conf file backslash ackslash character basebackend lt base gt mpty string basebackend html or docbook blockname current block name note 8 brvbar broken vertical bar character docdate document last modified date docdir document input directory name note 5 docfile document file name note 5 docname document file name without extension note 6 doctime document last modified time doctitle document title from document header doctype lt doctype gt empty string
51. cBook section numbering are handled automatically by the Doc Book toolchain commands 8 4 1 Section markup templates Section markup templates specify output markup and are defined in AsciiDoc configuration files Section markup template names are derived as follows in order of precedence 1 From the title s first positional attribute or template attribute For example the following three section titles are functionally equivalent terms glossary List of Terms glossary id terms List of Terms template glossary id terms List of Terms 2 When the title text matches a configuration file specialsections entry 3 If neither of the above the default sect lt level gt template is used where lt level gt is a number from to 4 In addition to the normal section template names sect sect2 sect3 sect4 AsciiDoc has the following templates for frontmatter backmatter and other special sections abstract preface colophon dedication glossary bibliography synopsis appendix index These special section templates generate the corresponding Docbook elements for HTML outputs they default to the sect section template 8 4 2 Section IDs If no explicit section ID is specified an ID will be synthesised from the section title The primary purpose of this feature is to ensure persistence of table of contents links permalinks the missing section IDs are generated dynamically by the JavaScript
52. ces are replaced by the corresponding attribute value Inline Macros Inline macros are replaced by the contents of parametrized configuration file sections 9 Document Processing The AsciiDoc source document is read and processed as follows 1 The document Header is parsed header parameter values are substituted into the configuration file header template section which is then written to the output file 2 Each document Section is processed and its constituent elements translated to the output file 3 The configuration file footer template section is substituted and written to the output file When a block element is encountered asciidoc 1 determines the type of block by checking in the following order first to last section Titles BlockMacros Lists DelimitedBlocks Tables AttributeEntrys AttributeLists BlockTitles Paragraphs The default paragraph definition paradef default is last element to be checked Knowing the parsing order will help you devise unambiguous macro list and block syntax rules Inline substitutions within block elements are performed in the following default order 1 Special characters Quotes Special words Replacements Attributes Inline Macros NY Dn A W N Replacements2 The substitutions and substitution order performed on Title Paragraph and DelimitedBlock elements is determined by configu ration file parameters AsciiDoc User Guide 14 88 10 Text Formattin
53. ciiDoc defines standard DocBook article frontmatter and backmatter section markup templates appendix abstract bibliogra phy glossary index 3 2 book Books share the same format as articles with the following differences e The part titles in multi part books are top level titles same level as book title e Some sections are book specific e g preface and colophon Book documents will normally be used to produce DocBook output since DocBook processors can automatically generate foot notes table of contents list of tables list of figures list of examples and indexes AsciiDoc defines standard DocBook book frontmatter and backmatter section markup templates appendix dedication preface bibliography glossary index colophon EXAMPLE BOOK DOCUMENTS Book The doc book txt file in the AsciiDoc distribution Multi part book The doc book multi txt file in the AsciiDoc distribution 3 3 manpage Used to generate roff format UNIX manual pages AsciiDoc manpage documents observe special header title and section naming conventions see the Manpage Documents section for details AsciiDoc defines the synopsis section markup template to generate the DocBook refsynopsisdiv section See also the asciidoc 1 man page source doc asciidoc 1 txt from the AsciiDoc distribution 4 AsciiDoc Backends The asciidoc 1 command translates an AsciiDoc formatted file to the backend format specified by the b backend comm
54. containing the AsciiDoc source file AsciiDoc User Guide 60 88 5 Explicit configuration files specified using e The conf files attribute one or more file names separated by a character These files are loaded in the order they are specified and prior to files specified using the conf file command line option e The asciidoc 1 conf file command line option The conf file option can be specified multiple times in which case configuration files will be processed in the same order they appear on the command line 6 Backend plugin configuration files are loaded from subdirectories named like backends lt backend gt in locations 1 2 and 3 7 Filter configuration files are loaded from subdirectories named like filters lt filter gt in locations 1 2 and 3 Configuration files from the above locations are loaded in the following order e The attributes section only from asciidoc conf in location 3 Files from location 5 This first pass makes locally set attributes available in the global asciidoc conf file e asciidoc conf from locations 1 2 3 e attributes titles and specialcharacters sections from the asciidoc conf in location 4 e The document header is parsed at this point and we can assume the backend and doctype have now been defined e Backend plugin lt backend gt conf and lt backend gt lt doctype gt conf files from locations 6 If a backend plugin is not found then try locations 1 2
55. ctory Note To generate valid DocBook output glossary lists must be located in a section that uses the glossary section markup template 17 6 Bibliography Lists AsciiDoc comes with a predefined bibliography bulleted list style generating DocBook bibliography entries Example bibliography Opteron IES tealicike taoup Eric Steven Raymond The Art of UNIX Programming Addison Wesley ISBN 0 13 142901 9 walsh muellner Norman Walsh Leonard Muellner DocBook The Definitive Guide O Reilly amp Associates LS TSEN AGA ISO The lt reference gt syntax is a bibliography entry anchor it generates an anchor named lt reference gt and addition ally displays lt reference gt at the anchor position For example taoup generates an anchor named t aoup that displays taoup at the anchor position Cite the reference from elsewhere your document using lt lt t aoup gt gt this displays a hyperlink taoup to the corresponding bibliography entry anchor For working examples see the article txt and book txt documents in the AsciiDoc doc distribution directory Note To generate valid DocBook output bibliography lists must be located in a bibliography section 17 7 List Item Continuation Another list or a literal paragraph immediately following a list item is implicitly appended to the list item to append other block elements to a list item you need to explicitly join the
56. cument title e Optional Author and Revision information immediately follows the header title e The document header must be separated from the remainder of the document by one or more blank lines and cannot contain blank lines e The header can include comments e The header can include attribute entries typically doctype lang encoding icons data uri toc numbered e Header attributes are overridden by command line attributes e If the header contains non UTF 8 characters then the encoding must precede the header either in the document or on the command line Here s an example AsciiDoc document header Writing Documentation using AsciiDoc Joe Bloggs lt jbloggs mymail com gt v2 0 February 2003 Rewritten for version 2 release The author information line contains the author s name optionally followed by the author s email address The author s name is formatted like firstname middlename lastname lt email gt i e a first name followed by optional middle and last names followed by an email address in that order Multi word first middle and last names can be entered using the underscore as a word separator The email address comes last and must be enclosed in angle lt gt brackets Here a some examples of author information lines Joe Bloggs lt jbloggs mymail com gt Joe Bloggs Vincent Willem van_Gogh If the author line does not match the above specification then the entire author line is treate
57. d as the first name The optional revision information line follows the author information line The revision information can be one of two formats 1 An optional document revision number followed by an optional revision date followed by an optional revision remark e If the revision number is specified it must be followed by a comma The revision number must contain at least one numeric character e Any non numeric characters preceding the first numeric character will be dropped AsciiDoc User Guide 10 88 e If a revision remark is specified it must be preceded by a colon The revision remark extends from the colon up to the next blank line attribute entry or comment and is subject to normal text substitutions e Ifa revision number or remark has been set but the revision date has not been set then the revision date is set to the value of the docdate attribute Examples v2 0 February 2003 February 2003 v2 0 v2 0 February 2003 Rewritten for version 2 release February 2003 Rewritten for version 2 release v2 0 Rewritten for version 2 release Rewritten for version 2 release 2 The revision information line can also be an RCS CVS SVN Id marker e AsciiDoc extracts the revnumber revdate and author attributes from the Id revision marker and displays them in the document header e If an Id revision marker is used the header author line can be omitted Example Id mydoc txt v 1 5 2009 05 17 17 58
58. data tags pageunits DocBook backend only Specifies table column absolute width units Defaults to pagewidth DocBook backend only The nominal output page width in pageunit units Used to calculate CALS tables absolute column and table widths Defaults to 425 tableabswidth Integer value calculated from width and pagewidth attributes In pageunit units tablepcwidth Table width expressed as a percentage of the available width Integer value 0 100 colabswidth Integer value calculated from cols column width width and pagewidth attributes In pageunit units colpcwidth Column width expressed as a percentage of the table width Integer value 0 100 colcount Total number of table columns rowcount Total number of table rows halign Horizontal cell content alignment left right or center valign Vertical cell content alignment top bottom or middle colnumber colstart The number of the leftmost column occupied by the cell 1 colend The number of the rightmost column occupied by the cell 1 colspan Number of columns the cell should span rowspan Number of rows the cell should span 1 morerows Number of additional rows the cell should span 0 23 8 Nested tables An alternative psv separator character can be used instead of in nested tables This allows a single level of table nesting Columns containing nested tables must use the asciidoc style An example can be found in ex
59. de Mates o o ooko Se eG A Owe Owe eS 2132 Conditional Inclusion Maros ca sc cere ee EEE OR a We we ee 21 3 3 Executable syeieni maces ha A ea EE Ra ee ea eee ee 21 34 Template System Macro o oo ew ee E ew a ee a Se 214 Passtlroush macios o ba ewe A we ee ee ee alo Matto SOMOS 2 ca ose ea baw ee ee ow eee bw ee a btw See we Ge ee 26 27 27 29 30 30 31 31 31 32 33 33 35 35 AsciiDoc User Guide 22 HTML 5 audio and video block macros 23 Tables foul Example DIES ocios ee ES A ee age BAAR ERS oe Re ae ok 232 Table pul data LOMOR S spoiler Oe 23 TABISARTBULES 2er aa a a KR ee eS 234 COMA SOECES s Pe hee EB A a A A 2 A SAI aia adas io a EE CR eee a ii o Beh Oe MARIE SES ud ii a a a di ES GS 23 7 Markup attributes o c c ee ee rr a e 2200 Nested BIES o a e a AR a See el we SG Se ee Se 23 9 DocBook table limitations s cs sisira ce eb eR ew a ee eR ee EES 24 Manpage Documents 2A e CAUSE e bo he a Ra A A A RS Da a SAR RAs ae A Rae ea eS 242 The NAME Seen sc a ede eo ee Re EE EERE e Pde ee ea do a we 24 3 The SYNOPSIS SEGU N coxe EEA eR ERR ew REA a LA TELS A MCIDRLES ia eee Bebe eet hee eee be bh an bbe Bebe eee ead 25 Mathematical Formulas 2 LT Matos a e A a A E A aa e dk 222 ASCTIMIAINVES ooe a da A A A AA ae AA be A Oe ee OE A 233 LaTeX ooo a A e A Ged de ea 25 4 Mall war A RS a Awe BHR RA eS eH A AA OG os 26 Configuration Files 26 1 Contipuration File Format 06 64 he ee Oe ba ee ee ee ba
60. e value of the regular expression match group named name The optional lt subslist is a comma separated list of substitution names enclosed in brackets it sets the default substitutions for passthrough text if omitted then no passthrough substitutions are performed Pattern named groups The following named groups can be used in macro lt pattern gt regular expressions and are available as markup template attributes name The macro name target The macro target attrlist The macro attribute list passtext Contents of this group are passed unmodified to the output subject only to subslist substitutions subslist Processed as a comma separated list of substitution names for passtext substitution overrides the the macro definition subslist HERE S WHAT HAPPENS DURING MACRO SUBSTITUTION e Each contextually relevant macro pattern from the macros section is matched against the input source line e Ifamatch is found the text to be substituted is loaded from a configuration markup template section named like lt name gt inlinemac or lt name gt blockmacro depending on the macro type e Global and macro attribute list attributes are substituted in the macro s markup template The substituted template replaces the macro reference in the output document AsciiDoc User Guide 44 88 22 HTML 5 audio and video block macros The html5 backend audio and video block macros generate the HTML 5 audio and video elemen
61. e no block macro versions of the eval3 and sys3 system attributes 21 3 4 Template System Macro The template block macro allows the inclusion of one configuration file template section within another The following example includes the admonitionblock section in the admonitionparagraph section admonitionparagraph template admonitionblock TEMPLATE MACRO BEHAVIOR e The template macro is useful for factoring configuration file markup e template macros cannot be nested e template macro expansion is applied after all configuration files have been read 21 4 Passthrough macros Passthrough macros are analogous to passthrough blocks and are used to pass text directly to the output The substitution performed on the text is determined by the macro definition but can be overridden by the lt subslist gt The usual syntax is lt name gt lt subslist gt lt passtext gt for inline macros and lt name gt lt subslist gt lt passtext gt for block macros Passthroughs by definition take precedence over all other text substitutions pass Inline and block Passes text unmodified apart from explicitly specified substitutions Examples pass lt q gt To be or not to be lt q gt pass attributes quotes lt u gt the author lt u gt asciimath latexmath Inline and block Passes text unmodified Used for mathematical formulas Inline and block The triple plus passthrough is functi
62. e rendered like include lt stdio h gt ink mer 4 printf Hello World yat y EXT Ol By convention filter blocks use the listing block syntax and are implemented as distinct listing block styles AsciiDoc User Guide 23 88 16 3 Literal Blocks LiteralBlocks are rendered just like literal paragraphs Example Consul necessitatibusx per id consetetur eu pro everti postulant homero verear ea mea qui Renders Consul necessitatibusx per id consetetur eu pro everti postulant homero verear ea mea qui If the listing style is applied to a LiteralBlock it will be rendered as a ListingBlock this is handy if you have a listing containing a ListingBlock 16 4 Sidebar Blocks A sidebar is a short piece of text presented outside the narrative flow of the main text The sidebar is normally presented inside a bordered box to set it apart from the main text The sidebar body is treated like a normal section body Here s an example An Example Sidebar KKK KKK KK KKK KKK KKK KKK KKK KKK KKK KKK KKKKKKKKK KKK KKK Any AsciiDoc SectionBody element apart from SidebarBlocks can be placed inside a sidebar KKK KK KKK KK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KK Which will be rendered like An Example Sidebar Any AsciiDoc SectionBody element apart from SidebarBlocks can be placed inside a sidebar 16 5 Comment Blocks The contents of CommentBlocks are not processed t
63. e style if no attributes are specified the quote style is used The optional attribution and citetitle attributes positional attributes 2 and 3 specify the quote s author and source For example quote Sir Arthur Conan Doyle The Adventures of Sherlock Holmes As he spoke there was the sharp sound of horses hoofs and grating wheels against the curb followed by a sharp pull at the bell Holmes whistled A pair by the sound said he Yes he continued glancing out of the window A nice little brougham and a pair of beauties A hundred and fifty guineas apiece There s money in this case Watson if there is nothing else Which is rendered as As he spoke there was the sharp sound of horses hoofs and grating wheels against the curb followed by a sharp pull at the bell Holmes whistled A pair by the sound said he Yes he continued glancing out of the window A nice little brougham and a pair of beauties A hundred and fifty guineas apiece There s money in this case Watson if there is nothing else Sir Arthur Conan Doyle The Adventures of Sherlock Holmes 16 8 Example Blocks ExampleBlocks encapsulate the DocBook Example element and are used for well examples Example blocks can be titled by preceding them with a BlockTitle DocBook toolchains will normally automatically number examples and generate a List of Examples backmatter section Example blocks are delimited by lines of equals c
64. e sys 2 13 94 Ge 2i 9 349 WINA20 386 C3 lt ol gt Si nee Rony old sm MS OS lt 2 gt System startup code for DOS lt 3 gt Some sort of Windows 3 1 hack Which renders MS DOS directory listing 10 17 97 9 04 lt DIR gt bin 10 16 97 14 11 lt DIR gt DOS O TOLES Aig a lt DIR gt Program Files 10 16 97 14 46 lt DIR gt TEMP 10 11 97 9 04 lt DIR gt tmp 10 18 97 143387 lt DIR gt WINNT 10 16 97 14 25 119 AUTOEXEC BAT 2 2 13 94 6 21 54 619 COMMAND COM 10 16 97 14 25 115 CONFIG SYS o 11 10 37 1717 61 865 984 pagefile sys 2 13 94 6 21 9 349 WINA20 386 O This directory holds MS DOS 0 0 System startup code for DOS Some sort of Windows 3 1 hack EXPLANATION e The callout marks are whole numbers enclosed in angle brackets they refer to the correspondingly numbered item in the following callout list e By default callout marks are confined to LiteralParagraphs LiteralBlocks and ListingBlocks although this is a configuration file option and can be changed e Callout list item numbering is fairly relaxed list items can start with lt n gt n gt or gt where n is the optional list item number in the latter case list items starting with a single gt character are implicitly numbered starting at one e Callout lists should not be nested e Callout lists cannot be used within tables e Callout lists start list items hard against the left margin e If you want to present
65. ectory also contains a file named __noautoload__ see previous section The __noautoload__ feature is used for filters that will be loaded manually using the filter option 33 3 Example Filter AsciiDoc comes with a toy filter for highlighting source code keywords and comments See also the filters code code filte file Note The purpose of this toy filter is to demonstrate how to write a filter it s much to simplistic to be passed off as a code syntax highlighter If you want a full featured multi language highlighter use the source code highlighter filter 33 4 Built in filters The AsciiDoc distribution includes source music latex and graphviz filters details are on the AsciiDoc website Table 11 Built in filters list Filter name Description music A music filter is included in the distribution ilters directory It translates music in LilyPond or ABC notation to standard classical notation source A source code highlight filter is included in the distribution filters directory latex The AsciiDoc LaTeX filter translates LaTeX source to a PNG image that is automatically inserted into the AsciiDoc output documents graphviz Gouichi lisaka has written a Graphviz filter for AsciiDoc Graphviz generates diagrams from a textual specification Gouichi lisaka s Graphviz filter is included in the AsciiDoc distribution Here are some AsciiDoc Graphviz examples AsciiDoc User Guide 75 88 3
66. eo style cursor pointer gt lt source src pics video gizmo mp4 gt lt source src pics video gizmo webm type video webm gt lt source src pics video gizmo ogv type video ogg gt Video not playing lt a href pics video gizmo mp4 gt Download file lt a gt instead lt video gt lt script type text javascript gt var video document getElementBylId video AsciiDoc User Guide 45 88 video addEventListener click function video play false lt script gt 23 Tables The AsciiDoc table syntax looks and behaves like other delimited block types and supports standard block configuration entries Formatting is easy to read and just as importantly easy to enter e Cells and columns can be formatted using built in customizable styles e Horizontal and vertical cell alignment can be set on columns and cell e Horizontal and vertical cell spanning is supported Use tables sparingly When technical users first start creating documents tables complete with column spanning and table nesting are often considered very important The reality is that tables are seldom used even in technical documentation Try this exercise thumb through your library of technical books you ll be surprised just how seldom tables are actually used even less seldom are tables containing block elements such as paragraphs or lists or spanned cells This is no accident like figures ta
67. erse style retains the line breaks for example verse William Blake from Auguries of Innocence To see a world in a grain of sand And a heaven in a wild flower Hold infinity in the palm of your hand And eternity in an hour Which is rendered as To see a world in a grain of sand And a heaven in a wild flower Hold infinity in the palm of your hand And eternity in an hour William Blake from Auguries of Innocence The quote style flows the text at left and right margins for example quote Bertrand Russell The World of Mathematics 1956 A good notation has subtlety and suggestiveness which at times makes it almost seem like a live teacher Which is rendered as A good notation has subtlety and suggestiveness which at times makes it almost seem like a live teacher Bertrand Russell The World of Mathematics 1956 AsciiDoc User Guide 21 88 15 4 Admonition Paragraphs TIP NOTE IMPORTANT WARNING and CAUTION admonishment paragraph styles are generated by placing NOTE TIP IMPORTANT WARNING or CAUTION as the first word of the paragraph For example NOTE This is an example note Alternatively you can specify the paragraph admonition style explicitly using an AttributeList element For example NOTE This is an example note Renders Note This is an example note Tip If your admonition requires more than a single paragraph use an admonition block instead
68. etimes called variable or definition lists Callout lists a list of callout annotations LIST BEHAVIOR e List item indentation is optional and does not determine nesting indentation does however make the source more readable e Another list or a literal paragraph immediately following a list item will be implicitly included in the list item use list item continuation to explicitly append other block elements to a list item e A comment block or a comment line block macro element will terminate a list use inline comment lines to put comments inside lists e The 1ist index intrinsic attribute is the current list item index 1 If this attribute is used outside a list then it s value is the number of items in the most recently closed list Useful for displaying the number of items in a list AsciiDoc User Guide 27 88 17 1 Bulleted Lists Bulleted list items start with a single dash or one to five asterisks followed by some white space then some text Bulleted list syntaxes are List item List item xx List item xxx List item x x List item xxxxx List item 17 2 Numbered Lists List item numbers are explicit or implicit Explicit numbering List items begin with a number followed by some white space then the item text The numbers can be decimal arabic roman upper or lower case or alpha upper or lower case Decimal and alpha numbers are terminated with a period roman numbers are terminated with
69. file It runs on MS Windows platforms and can be downloaded from http www microsoft com 5 7 AsciiDoc dblatex configuration files The AsciiDoc distribution dblatex directory contains asciidoc dblatex xsl customized XSL parameter settings and asciidoc dblatex sty customized LaTeX settings These are examples of optional dblatex output customization and are used by a2x 1 5 8 AsciiDoc DocBook XSL Stylesheets drivers You will have noticed that the distributed HTML and HTML Help documentation files for example doc asciidoc html are not the plain outputs produced using the default DocBook XSL Stylesheets configuration This is because they have been pro cessed using customized DocBook XSL Stylesheets along with in the case of HTML outputs the custom stylesheets docbook CSS stylesheet You ll find the customized DocBook XSL drivers along with additional documentation in the distribution docbook xs1l directory The examples that follow are executed from the distribution documentation doc directory These drivers are also used by a2x 1 AsciiDoc User Guide 6 88 common xsl Shared driver parameters This file is not used directly but is included in all the following drivers chunked xsl Generate chunked XHTML separate HTML pages for each document section in the doc chunked directory For example python asciidoc py b docbook asciidoc txt xsltproc nonet docbook xs1 chunked xsl asciidoc xml e
70. g 10 1 Quoted Text Words and phrases can be formatted by enclosing inline text with quote characters Emphasized text Word phrases enclosed in single quote characters acute accents or _underline characters_ are emphasized Strong text Word phrases enclosed in asterisk characters are rendered in a strong font usually bold Monospaced text Word phrases enclosed in plus characters are rendered in a monospaced font Word phrases enclosed in backtick characters grave accents are also rendered in a monospaced font but in this case the enclosed text is rendered literally and is not subject to further expansion see inline literal passthrough Single quoted text Phrases enclosed with a single grave accent to the left and a single acute accent to the right are rendered in single quotation marks Double quoted text Phrases enclosed with two grave accents to the left and two acute accents to the right are rendered in quotation marks Unquoted text Placing hashes around text does nothing it is a mechanism to allow inline attributes to be applied to otherwise unfor matted text New quote types can be defined by editing asciidoc 1 configuration files See the Configuration Files section for details QUOTED TEXT BEHAVIOR e Quoting cannot be overlapped e Different quoting types can be nested e To suppress quoted text formatting place a backslash character immediately in front of the leading q
71. g definitions Each line of text in these sections is a section entry Section entries share the following syntax name value The entry value is set to value AsciiDoc User Guide 56 88 name The entry value is set to a zero length string name The entry is undefined deleted from the configuration This syntax only applies to attributes and miscellaneous sections SECTION ENTRY BEHAVIOR e All equals characters inside the name must be escaped with a backslash character e name and value are stripped of leading and trailing white space e Attribute names tag entry names and markup template section names consist of one or more alphanumeric underscore or dash characters Names should not begin or end with a dash e A blank configuration file section one without any entries deletes any preceding section with the same name applies to non markup template sections 26 2 Miscellaneous section The optional miscellaneous section specifies the following name va lue options newline Output file line termination characters Can include any valid Python string escape sequences The default value is r n carriage return line feed Should not be quoted or contain explicit spaces use x20 instead For example asciidoc a newline 1n b docbook mydoc txt outfilesuffix The default extension for the output file for example out filesuffix html Defaults to backend name tabsize The number of spaces to expand tab c
72. haracters for example tabsize 4 Defaults to 8 A tabsize of zero suppresses tab expansion useful when piping included files through block filters Included files can override this option using the tabsize attribute pagewidth pageunits These global table related options are documented in the Table Configuration File Definitions sub section Note miscellaneous configuration file entries can be set using the asciidoc 1 a attribute command line option 26 3 Titles section sectiontitle Two line section title pattern The entry value is a Python regular expression containing the named group title underlines A comma separated list of document and section title underline character pairs starting with the section level 0 and ending with section level 4 underline The default setting is und rlin s IL e AsciiDoc User Guide 57 88 sect0 sect4 One line section title patterns The entry value is a Python regular expression containing the named group title blocktitle BlockTitle element pattern The entry value is a Python regular expression containing the named group fitle subs A comma separated list of substitutions that are performed on the document header and section titles Defaults to normal substitution 26 4 Tags section The tags section contains backend tag definitions one per line Tags are used to translate AsciiDoc elements to backend markup An AsciiDoc tag definition is formatted li
73. haracters and can contain any block elements apart from Titles BlockTitles and Sidebars inside an example block For example AsciiDoc User Guide 25 88 An example Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens Renders Example 16 1 An example Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens A title prefix that can be inserted with the caption attribute HTML backends For example caption Example 1 An example with a custom caption Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens 16 9 Admonition Blocks The ExampleBlock definition includes a set of admonition styles VOTE TIP IMPORTANT WARNING CAUTION for gener ating admonition blocks admonitions containing more than a single paragraph Just precede the ExampleBlock with an attribute list specifying the admonition style name For example NOTE A NOTE admonition block Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens Fusce euismod commodo velit Vivamus fringilla mi eu lacus Fusce euismod commodo velit Vivamus fringilla mi eu lacus Donec eget arcu bibendum nunc consequat lobortis Renders A NOTE admonition block Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens 1 Fusce euismod commodo velit 2 Vivamus fringilla mi eu lacus
74. he docbook backend is used To disable table of contents generation undefine the toc attribute by putting a toc attribute entry in the document header or from the command line with an attribute toc option xhtml11 and html5 backends e JavaScript needs to be enabled in your browser e The following example generates a numbered table of contents using a JavaScript embedded in the mydoc htm1 output document asciidoc a toc a numbered mydoc txt toc2 html5 xhtml11 Adds a scrollable table of contents in the left hand margin of an article or book document Use the max width attribute to change the content width In all other respects behaves the same as the foc attribute toc placement html5 xhtml1 1 When set to auto the default value asciidoc 1 will place the table of contents in the document header When toc placement is set to manual the TOC can be positioned anywhere in the document by placing the toc block macro at the point you want the TOC to appear Note If you use toc placement then you also have to define the toc attribute toc title html5 xhtml 1 Sets the table of contents title defaults to Table of Contents AsciiDoc User Guide 88 88 Name Backends Description toclevels html5 xhtml 1 Sets the number of title levels 1 4 reported in the table of contents see the toc attribute above Defaults to 2 and must be used with the toc attribute Example usage asci
75. hey are useful for annotations and for excluding new or outdated content that you don t want displayed CommentBlocks are never written to output files Example HATA MA AAA AAA AAA AA AAA A AAA AAA AA CommentBlock contents are not processed by asciidoc 1 MA EAA AEA CASADA ASAS AAA ATL See also Comment Lines Note System macros are executed inside comment blocks AsciiDoc User Guide 24 88 16 6 Passthrough Blocks By default the block contents is subject only to attributes and macros substitutions use an explicit subs attribute to apply different substitutions PassthroughBlock content will often be backend specific Here s an example subs quotes PARRA A E RR A A A A A lt table border 1 gt lt tr gt lt td gt Cell 1 lt td gt lt td gt Cell 2 lt td gt lt tr gt lt table gt FHF EFHEHEEEFEFE FFF EEE AE HEH HEP H 4 444 The following styles can be applied to passthrough blocks pass No substitutions are performed This is equivalent to subs none asciimath latexmath By default no substitutions are performed the contents are rendered as mathematical formulas 16 7 Quote Blocks QuoteBlocks are used for quoted passages of text There are two styles quote and verse The style behavior is identical to quote and verse paragraphs except that blocks can contain multiple paragraphs and in the case of the quote style other section elements The first positional attribute sets th
76. hin a cell These characteristics aid readability and data entry AsciiDoc source Windtrainer workouts width 80 cols 3 2 2 10 options header Date Dura 22 Aug 08 Worked out EOIS lala 22 Aug 08 Back to bac 124 Aug 08 Moderately hard 1lmin tion Avg HR Notes LOA SHR max sustainable heart rate by going hard terval PESOS 2 k with previous interval 140 00 145 hard interspersed with 3x 3min intervals really hard taking the HR up to 160 2min AsciiDoc User Guide Table 9 A table with externally sourced CSV data 47 88 ID Customer Name Contact Name Customer Address Phone AROUT Around the Horn Thomas Hardy 120 Hanover Sq 171 555 7788 London BERGS Berglunds snabbkop Christina Berglund Berguvsvagen 8 Lulea 0921 12 34 65 BLAUS Blauer See Delikatessen Hanna Moos Forsterstr 57 0621 08460 Mannheim BLONP Blondel pere et fils Frederique Citeaux 24 place Kleber 88 60 15 31 Strasbourg BOLID Bolido Comidas Martin Sommer C Araquil 67 Madrid 91 555 22 82 preparadas BONAP Bon app Laurence Lebihan 12 rue des Bouchers 91 24 45 40 Marseille BOTTM Bottom Dollar Markets Elizabeth Lincoln 23 Tsawassen Blvd 604 555 4729 Tsawassen BSBEV B s Beverages Victoria Ashworth Fauntleroy Circus 171 555 1212 London CACTU Cactus Comidas para Patricio Simpson Cerrito 333 Buenos 1 135 5555 llevar Aires AsciiDoc s
77. idoc a toc a toclevels 3 doc asciidoc txt License AsciiDoc is free software you can redistribute it and or modify it under the terms of the GNU General Public License version 2 GPLv2 as published by the Free Software Foundation AsciiDoc is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License version 2 for more details Copyright 2002 2011 Stuart Rackham
78. im indicates that white space and line breaks in the source document are to be preserved in the output document A Migration Notes A 1 Version 7 to version 8 e A new set of quotes has been introduced which may match inline text in existing documents if they do you ll need to escape the matched text with backslashes e The index entry inline macro syntax has changed if your documents include indexes you may need to edit them e Replaced a2x 1 no icons and no copy options with their negated equivalents icons and copy respec tively The default behavior has also changed the use of icons and copying of icon and CSS files must be specified explicitly with the icons and copy options The rationale for the changes can be found in the AsciiDoc CHANGELOG Note If you want to disable unconstrained quotes the new alternative constrained quotes syntax and the new index entry syntax then you can define the attribute asciidoc7compatible for example by using the a asciidoc7compatible command line option AsciiDoc User Guide 82 88 B Packager Notes Read the README and INSTALL files in the distribution root directory for install prerequisites and procedures The distribution Makefile in used by configure to generate the Makefile is the canonical installation procedure C AsciiDoc Safe Mode AsciiDoc safe mode skips potentially dangerous scripted sections in AsciiDoc source files by i
79. in XHTML outputs LaTeX Math applies to DocBook outputs that are processed by dblatex and is normally used to generate PDF files LaTeXMathML is very much a subset of LaTeX Math and applies to XHTML documents 25 1 LaTeX Math LaTeX math can be included in documents that are processed by dblatex 1 Example inline formula latexmath C alpha beta Y gamma epsilon For more examples see the AsciiDoc website or the distributed doc latexmath txt file AsciiDoc User Guide 54 88 25 2 ASCIlMathML ASCIIMathML formulas can be included in XHTML documents generated using the xhtml11 and html5 backends To enable ASCIIMathML support you must define the asciimath attribute for example using the a asciimath command line option Example inline formula asciimath x x 1f 1 if x 0 text undefined if x 0 For more examples see the AsciiDoc website or the distributed doc asciimathml txt file 25 3 LaTeXMathML LaTeXMathML allows LaTeX Math style formulas to be included in XHTML documents generated using the AsciiDoc xhtmll 1 and html5 backends AsciiDoc uses the original LaTeXMathML by Douglas Woodall LaTeXMathML is derived from ASCI IMathML and is for users who are more familiar with or prefer using LaTeX math formulas it recognizes a subset of LaTeX Math the differences are documented on the LaTeXMathML web page To enable LaTeXMathML support you must define the latexmath attribute for example using the a latexma
80. index terms for the secondary and tertiary entries The index terms appear in the index not the primary text flow indexterm2 lt primary gt lt primary gt This inline macro generates an index term that appears in both the index and the primary text flow The lt primary gt should not be padded to the left or right with white space characters For working examples see the article txt and book txt documents in the AsciiDoc doc distribution directory Note Index entries only really make sense if you are generating DocBook markup DocBook conversion programs automatically generate an index at the point an Index section appears in source document 20 Callouts Callouts are a mechanism for annotating verbatim text for example source code computer output and user input Callout markers are placed inside the annotated text while the actual annotations are presented in a callout list after the annotated text Here s an example MS DOS directory listing 10 17 97 9 04 lt DIR gt bin 10 16 97 Asi lt DIR gt DOS lt 1 gt 10 16 97 Asado lt DIR gt Program Files 10 16 97 14 46 lt DIR gt TEMP 10 17 97 9 04 lt DIR gt tmp 10 16 97 ide shy lt DIR gt WINNT 10 16 97 14725 119 AUTOEXEC BAT lt 2 gt 2 79A 6 21 54 619 COMMAND COM lt 2 gt 10 16 97 14 25 TS ERCON TOMS YS EDS 2 An example footnote 3 Second footnote AsciiDoc User Guide 34 88 11 10 97 17 17 61 865 984 pagefil
81. ions Here is the list of predefined attribute list options Option Backends AsciiDoc Elements Description autowidth xhtml11 html5 table The column widths are determined by the browser html4 not the AsciiDoc cols attribute If there is no width attribute the table width is also left up to the browser unbreakable xhtml11 html5 block elements unbreakable attempts to keep the block element together on a single printed page c f the breakable and unbreakable docbook XSL FO options below breakable docbook XSL FO table example The breakable options allows block elements to unbreakable block image break across page boundaries unbreakable attempts to keep the block element together on a single page If neither option is specified the default XSL stylesheet behavior prevails compact docbook xhtml11 bulleted list Minimizes vertical space in the list html5 numbered list footer docbook xhtml11 table The last row of the table is rendered as a footer html5 html4 header docbook xhtml11 table The first row of the table is rendered as a header html5 html4 pgwide docbook XSL FO table block image Specifies that the element should be rendered horizontal labeled across the full text width of the page irrespective of list the current indentation strong xhtml11 html5 labeled lists Emboldens label text html4 G Diagnostics The asciidoc 1 verbose command line option prints additional i
82. istItem iS Where Header Preamble Sectionx Title A ros Reais 7 FirstName MiddleName LastName EmailAddress RevisionNumber RevisionDate RevisionRemark SectionBody Title SectionBody Section x BlockTitle Block BlockMacro Paragraph DelimitedBlock List Table BulletedList NumberedList LabeledList CalloutList ListItem ListItem ListItem istEntry istLabel ListItem ListTerm ItemText List ListParagraph ListContinuation e implies zero or one occurrence implies one or more occurrences implies zero or more occurrences e All block elements are separated by line boundaries e BlockId Attribute This is a rough structural guide not a rigorous syntax definition Entry and AttributeList block elements not shown can occur almost anywhere AsciiDoc User Guide 9 88 e There are a number of document type and backend specific restrictions imposed on the block syntax The following elements cannot contain blank lines Header Title Paragraph ItemText e A ListParagraph is a Paragraph with its listelement option set e A ListContinuation is a list continuation element 8 2 Header The Header contains document meta data typically title plus optional authorship and revision information e The Header is optional but if it is used it must start with a do
83. itle line starting hard against the left margin and an underline Section underlines consist a repeated character pairs spanning the width of the preceding title give or take up to two characters The default title underlines for each of the document levels are Level Level O top level 13 Level 2 2 2 2 RRR RR RR RRR nnn 3 4 Level Level bottom level 4 4 4 4 Examples Level One Section Title Level 2 Subsection Title 11 2 One line titles One line titles consist of a single line delimited on either side by one or more equals characters the number of equals characters corresponds to the section level minus one Here are some examples Document Titl level 0 Section tit level 1 Section titl level 2 Section titl level 3 Section title level 4 Note One or more spaces must fall between the title and the delimiters e The trailing title delimiter is optional The one line title syntax can be changed by editing the configuration file titles section sect 0 sect 4 entries AsciiDoc User Guide 18 88 11 3 Floating titles Setting the title s first positional attribute or style attribute to float generates a free floating title A free floating title is rendered just like a normal section title but is not formally associated with a text body and is not part of the regular sectio
84. itutions are suppressed and block indents are retained This option is useful when dealing with large amounts of imported plain text quirks xhtml11 Include the xhtm111 quirks conf configuration file and xhtml111 quirks css stylesheet to work around IE6 browser incompatibilities This feature is deprecated and its use is discouraged documents are still viewable in IE6 without it revremark docbook A short summary of changes in this document revision Must be defined prior to the first document section The document also needs to be dated to output this attribute scriptsdir html5 xhtml11 The name of the directory containing linked JavaScripts See HTML stylesheets and JavaScript locations sgml docbook45 The backend docbook45 command line option produces DocBook 4 5 XML You can produce the older DocBook SGML format using the attribute sgml command line option stylesdir html5 xhtml11 The name of the directory containing linked or embedded stylesheets See HTML stylesheets and JavaScript locations stylesheet html5 xhtml11 The file name of an optional additional CSS stylesheet theme html5 xhtml11 Use alternative stylesheet see Stylesheets toc html5 xhtml11 Adds a table of contents to the start of an article or book document The toc docbook XSL attribute can be specified using the attribute toc command line option or Stylesheets a toc attribute entry in the document header The toc attribute is defined by default when t
85. ive to the AsciiDoc configuration directory the directory containing the backend conf file Table 2 JavaScript file locations scriptsdir attribute Linked location linkcss attribute defined Embedded location linkcss attribute undefined Undefined default Same directory as the output document javascripts subdirectory in the AsciiDoc configuration directory the directory containing the backend conf file Absolute or relative directory name Absolute or relative to the output document Absolute or relative to the AsciiDoc configuration directory the directory containing the backend conf file 7 1 Themes The AsciiDoc theme attribute is used to select an alternative CSS stylesheet and to optionally include additional JavaScript code e Theme files reside in an AsciiDoc configuration directory named themes lt theme gt where lt theme gt is the the theme name set by the theme attribute asciidoc 1 sets the themedir attribute to the theme directory path name e The theme attribute can also be set using the asciidoc 1 theme option the theme option can also be used to manage theme plugins AsciiDoc User Guide e AsciiDoc ships with two themes flask and volnitsky e The lt theme gt css file replaces the default asciidoc css CSS file e The lt theme gt js file is included in addition to the default asciidoc 4s JavaScript file attribute is set to theme i
86. ke lt tagname gt lt starttag gt lt endtag gt For example emphasis lt em gt lt em gt In this example asciidoc 1 replaces the character with the emphasized text from the AsciiDoc input file and writes the result to the output file Use the brvbar attribute reference if you need to include a pipe character inside tag text 26 5 Attributes section The optional attributes section contains predefined attributes If the attribute value requires leading or trailing spaces then the text text should be enclosed in quotation mark characters To delete a attribute insert a name entry in a downstream configuration file or use the asciidoc 1 attribute name command line option an attribute name suffixed with a character deletes the attribute 26 6 Special Characters section The specialcharacters section specifies how to escape characters reserved by the backend markup Each translation is specified on a single line formatted like lt special_character gt lt translated_characters gt Special characters are normally confined to those that resolve markup ambiguity in the case of HTML and XML markups the ampersand less than and greater than characters The following example causes all occurrences of the lt character to be replaced by amp 1t lt 61t 26 7 Quoted Text section Quoting is used primarily for text formatting The quotes section defines AsciiDoc quoting characters and their correspond i
87. kend alias docbook docbook45 4 2 Backend Plugins The asciidoc 1 backena option is also used to install and manage backend plugins e A backend plugin is used just like the built in backends e Backend plugins take precedence over built in backends with the same name e You can use the asciidoc confdir intrinsic attribute to refer to the built in backend configuration file location from backend plugin configuration files e You can use the backend confdir intrinsic attribute to refer to the backend plugin configuration file location e By default backends plugins are installed in SHOME asciidoc backends lt backend gt where lt backend gt is the backend name 5 DocBook AsciiDoc generates article book and refentry DocBook documents corresponding to the AsciiDoc article book and manpage document types Most Linux distributions come with conversion tools collectively called a toolchain for converting DocBook files to presenta tion formats such as Postscript HTML PDF EPUB DVI PostScript LaTeX roff the native man page format HTMLHelp JavaHelp and text There are also programs that allow you to view DocBook files directly for example Yelp the GNOME help viewer AsciiDoc User Guide 4 88 5 1 Converting DocBook to other file formats DocBook files are validated parsed and translated various presentation file formats using a combination of applications collec tively called a DocBook tool chain
88. le style name For example the following psv formatted cell will span two columns and the text will be centered and emphasized 2 e Cell text 23 6 Table styles Table styles can be applied to the entire table by setting the style attribute in the table s attribute list or on a per column basis by specifying the style in the table s cols attribute Table data can be formatted using the following predefined styles default The default style AsciiDoc inline text formatting blank lines are treated as paragraph breaks emphasis Like default but all text is emphasised monospaced Like default but all text is in a monospaced font strong Like default but all text is bold header Apply the same style as the table header Normally used to create a vertical header in the first column asciidoc With this style table cells can contain any of the AsciiDoc elements that are allowed inside document sections This style runs asciidoc 1 as a filter to process cell contents See also Docbook table limitations literal No text formatting monospaced font all line breaks are retained the same as the AsciiDoc LiteralBlock element verse All line breaks are retained just like the AsciiDoc verse paragraph style AsciiDoc User Guide 51 88 23 7 Markup attributes AsciiDoc makes a number of attributes available to table markup templates and tags Column specific attributes are available when substituting the colspec cell
89. les specifies that any occurrence of NOTE or IMPORTANT should appear in a bold font if Gl Words and word phrases are treated as Python regular expressions for example the word NOTE would only match NOT appeared at the start of a line AsciiDoc comes with three built in Special Word types emphasizedwords monospacedwords and strongwords each has a corresponding backend specific markup template section Edit the configuration files to customize existing Special Words and to add new ones SPECIAL WORD BEHAVIOR e Word list entries must be separated by space characters e Word list entries with embedded spaces should be enclosed in quotation characters e A specialwords section entry of the form name wordl word2 adds words to existing name entries e A specialwords section entry of the form name undefines deletes all existing name words e Since word list entries are processed as Python regular expressions you need to be careful to escape regular expression special characters e By default Special Words are substituted before Inline Macros this may lead to undesirable consequences For example the special word foobar would be expanded inside the macro call http www foobar com A possible solution is to emphasize whole words only by defining the word using regular expression characters for example bfoobar b e If the first matched character of a special word is a backslash then the remaining characters are o
90. lon no white space allowed in left margin e AsciiDoc converts the lt name gt to a legal attribute name lower case alphanumeric dash and underscore characters only all other characters deleted This allows more human friendly text to be used e Leading and trailing white space is stripped from the lt value gt e Lines ending in a space followed by a plus character are continued to the next line for example description AsciiDoc is a text document format for writing notes documentation articles books slideshows web pages and man pages e If the lt value gt is blank then the corresponding attribute value is set to an empty string e Attribute references contained in the entry lt value gt will be expanded e By default AttributeEntry values are substituted for specialcharacters and attributes see above if you want to change or disable AttributeEntry substitution use the inline macro syntax e Attribute entries in the document Header are available for header markup template substitution e Attribute elements override configuration file and intrinsic attributes but do not override command line attributes Here are some more attribute entry examples AsciiDoc User Manual author Stuart Rackham email srackham gmail com revdate Apsley 2002 revnumber 5 1 1 Which creates these attributes author firstname lastname authorinitials revdate revnumber The previou
91. lowing example generates valid HTML but invalid DocBook the DocBook literal element cannot contain an emphasis element monospaced text with an _emphasized_ wordt Misinterpreted text formatting You can suppress markup expansion by placing a backslash character immediately in front of the element The following example suppresses inline monospaced formatting 1 for C Overlapping text formatting Overlapping text formatting will generate illegal overlapping markup tags which will result in downstream XML parsing errors Here s an example Some strong markup _that overlaps emphasized markup_ AsciiDoc User Guide 78 88 Ambiguous underlines A DelimitedBlock can immediately follow a paragraph without an intervening blank line but be careful a single line paragraph underline may be misinterpreted as a section title underline resulting in a closing block delimiter expected error Ambiguous ordered list items Lines beginning with numbers at the end of sentences will be interpreted as ordered list items The following example incorrectly begins a new list with item number 1999 He was last sighted in 1999 Since then things have moved on The list item out of sequence warning makes it unlikely that this problem will go unnoticed Special characters in attribute values Special character substitution precedes attribute substitution so if attribute values contain special characters you may depending on the substitutio
92. lude the mydoc docinfo xml docinfo file in the DocBook mydoc xml output file asciidoc a docinfo b docbook mydoc txt This next example will include docinfo html and mydoc docinfo html docinfo files in the HTML output file asciidoc a docinfo2 b html4 mydoc txt encoding html4 html5 Set the input and output document character set encoding For example the xhtml11 attribute encoding ISO 8859 1 command line option will set the docbook character set encoding to ISO 8859 1 e The default encoding is UTF 8 e This attribute specifies the character set in the output document e The encoding name must correspond to a Python codec name or alias e The encoding attribute can be set using an AttributeEntry inside the document header For example encoding ISO 8859 1 hr html4 Defines the html4 inter section horizontal ruler element By default htm 4 top level sections are separated by a horizontal ruler element undefine this attribute or set it to an empty string if you do not want them The default html4 backend value for the hr attribute is lt hr gt icons xhtml11 html5 Link admonition paragraph and admonition block icon images and badge images By default icons is undefined and text is used in place of icon images iconsdir html4 html5 The name of the directory containing linked admonition icons navigation icons xhtml11 and the callouts sub directory the callouts sub directory contains callout docbook number images iconsdir defaults t
93. m to the list item with a list continuation a separator line containing a single plus character Multiple block elements can be appended to a list item using list continuations provided they are legal list item children in the backend markup Here are some examples of list item continuations list item one contains multiple continuations list item two is continued with an OpenBlock containing multiple elements AsciiDoc User Guide List item one List item one continued with a second paragraph followed by an Indented block SS S mv sh tmp List item continued with a third paragraph 2 List item two continued with an open block This paragraph is part of the preceding list item This paragraph is part of the preceding list item los dale eS Is This paragraph belongs to item two of the outer list Renders 1 List item one List item one continued with a second paragraph followed by an Indented block ls x sh mv sh tmp List item continued with a third paragraph 2 List item two continued with an open block This paragraph is part of the preceding list item a This list is nested and does not require explicit item continuation This paragraph is part of the preceding list item b List item b This paragraph belongs to item two of the outer list 18 Footnotes The shipped AsciiDoc configuration includes three footnote inline macros footnote lt text gt Generates a footn
94. ments If you define the data uri attribute then images will be embedded in XHTML outputs using the data URI scheme You can use the data uri attribute with the xhtml11 and html5 backends to produce single file XHTML documents with embedded images and CSS for example asciidoc a data uri mydocument txt Note All current popular browsers support data URIs although versions of Internet Explorer prior to version 8 do not Some browsers limit the size of data URIs AsciiDoc User Guide 40 88 21 2 3 Comment Lines Single lines starting with two forward slashes hard up against the left margin are treated as comments Comment lines do not appear in the output unless the showcomments attribute is defined Comment lines have been implemented as both block and inline macros so a comment line can appear as a stand alone block or within block elements that support inline macro expansion Example comment line This is a comment If the showcomments attribute is defined comment lines are written to the output e In DocBook the comment lines are enclosed by the remark element which may or may not be rendered by your toolchain e The showcomments attribute does not expose Comment Blocks Comment Blocks are never passed to the output 21 3 System Macros System macros are block macros that perform a predefined task and are hardwired into the asciidoc 1 program e You can escape system macros with a leading b
95. n context need to escape the special characters yourself For example asciidoc a orgname Bill samp Ben Inc mydoc txt Attribute lists If any named attribute entries are present then all string attribute values must be quoted For example Desktop screenshot width 32 36 5 Combining separate documents You have a number of stand alone AsciiDoc documents that you want to process as a single document Simply processing them with a series of include macros won t work because the documents contain level 0 document titles The solution is to create a top level wrapper document and use the leveloffset attribute to push them all down one level For example Combined Document Title Push titles down one level leveloffset 1 include document1 txt Return to normal title levels leveloffset 0 A Top Level Section Lorum ipsum Push titles down one level leveloffset 1 include document2 txt include document3 txt The document titles in the included documents will now be processed as level 1 section titles level 1 sections as level 2 sections and so on e Put a blank line between the include macro lines to ensure the title of the included document is not seen as part of the last paragraph of the previous document e You won t want non title document header lines for example Author and Revision lines in the included files conditionally exclude them if they are necessary f
96. n each of the lang x conf files Specifying special section template names explicitly does add more noise to the source document the template attribute declaration but the intention is obvious and the syntax is consistent with other AsciiDoc elements c f bibliographic Q amp A and glossary lists Special section titles have been deprecated but are retained for backward compatibility AsciiDoc User Guide 13 88 8 5 Inline Elements Inline document elements are used to format text and to perform various types of text substitution Inline elements and inline element syntax is defined in the asciidoc 1 configuration files Here is a list of AsciiDoc inline elements in the default order in which they are processed Special characters These character sequences escape special characters used by the backend markup typically lt gt and amp characters See specialcharacters configuration file sections Quotes Elements that markup words and phrases usually for character formatting See quotes configuration file sections Special Words Word or word phrase patterns singled out for markup without the need for further annotation See specialwords configuration file sections Replacements Each replacement defines a word or word phrase pattern to search for along with corresponding replacement text See replacements configuration file sections Attribute references Document attribute names enclosed in bra
97. n hierarchy so the normal ordering rules do not apply Floating titles can also be used in contexts where section titles are illegal for example sidebar and admonition blocks Example float The second day Floating titles do not appear in a document s table of contents 12 Block Titles A BlockTitle element is a single line beginning with a period followed by the title text A BlockTitle is applied to the immediately following Paragraph DelimitedBlock List Table or BlockMacro For example Notes Note 1 Note 2 is rendered as NOTES e Note 1 e Note 2 13 Blockld Element A Blockld is a single line block element containing a unique identifier enclosed in double square brackets It is used to assign an identifier to the ensuing block element For example chapter titles Chapter titles can be The preceding example identifies the ensuing paragraph so it can be referenced from other locations for example with lt lt chapter tit titles gt gt BlockId elements can be applied to Title Paragraph List DelimitedBlock Table and BlockMacro elements The BlockId element sets the id attribute for substitution in the subsequent block s markup template If a second positional argument is supplied it sets the reftext attribute which is used to set the DocBook xreflabel attribute The BlockId element has the same syntax and serves the same function to the anchor inline macro 14 AttributeList Element An A
98. name as a command argument Help topic names can be shortened so long as they are not ambiguous Examples asciidoc help manpage asciidoc h m Short version of previous example asciidoc help syntax asciidoc h s Short version of previous example 35 1 Customizing Help To change delete or add your own help topics edit a help configuration file The help file name help lt lang gt conf is based on the setting of the lang attribute it defaults to help conf English The help file location will depend on whether you want the topics to apply to all users or just the current user The help topic files have the same named section format as other configuration files The help conf files are stored in the same locations and loaded in the same order as other configuration files When the help command line option is specified AsciiDoc loads the appropriate help files and then prints the contents of the section whose name matches the help topic name If a topic name is not specified default is used You don t need to specify the whole help topic name on the command line just enough letters to ensure it s not ambiguous If a matching help file section is not found a list of available topics is printed AsciiDoc User Guide 76 88 36 Tips and Tricks 36 1 Know Your Editor Writing AsciiDoc documents will be a whole lot more pleasant if you know your favorite text editor Learn how to indent and reformat tex
99. names gt lt regexp gt lt valuel gt lt value2 gt lt valuel gt is substituted if the value of attribute lt names gt matches the regular expression lt regexp gt otherwise lt value2 gt is substituted If attribute lt names gt is not defined the containing line is dropped If lt value2 gt is omitted an empty string is assumed The values and the regular expression can contain simple attribute references To embed colons in the values or the regular expression escape them with backslashes lt names gt lt regexp gt lt valuel gt lt value2 gt Same behavior as the previous ternary attribute except for the following cases AsciiDoc User Guide 66 88 lt names gt lt regexp gt lt value gt Substitutes lt value gt if lt names gt matches lt regexp gt otherwise the result is undefined and the containing line is dropped lt names gt lt regexp gt lt value gt Substitutes lt value gt if lt names gt does not match lt regexp gt otherwise the result is undefined and the containing line is dropped The attribute lt names gt parameter normally consists of a single attribute name but it can be any one of the following e A single attribute name which evaluates to the attributes value e Multiple separated attribute names which evaluates to an empty string if one or more of the attributes is defined otherwise it s value is undefined e Multiple separated attribute names which evaluate
100. ne overline text and blue line through bold blue and line through is rendered as Obvious and very obvious Underline text overline text and bold blue and line through Note Color and text decorator attributes are rendered for XHTML and HTML 5 outputs using CSS stylesheets The mechanism to implement color and text decorator attributes is provided for DocBook toolchains via the DocBook phrase element role attribute but the actual rendering is toolchain specific and is not part of the AsciiDoc distribution 10 1 2 Constrained and Unconstrained Quotes There are actually two types of quotes Constrained quotes Quoted must be bounded by white space or commonly adjoining punctuation characters These are the most commonly used type of quote Unconstrained quotes Unconstrained quotes have no boundary constraints and can be placed anywhere within inline text For consistency and to make them easier to remember unconstrained quotes are double ups of the _ x and constrained quotes __ unconstrained emphasized text__ unconstrained strong textx x unconstrained monospaced text unconstrained unquoted text The following example emboldens the letter F xxFxxile Open 10 2 Superscripts and Subscripts Put carets on either side of the text to be superscripted put tildes on either side of text to be subscripted For example the following line e amp 960 i 1 0 H 2 0 and x 10 Some
101. nec eget arcu bibendum nunc consequat lobortis A predefined compact option is available to bulleted and numbered lists this translates to the DocBook spacing compact lists attribute which may or may not be processed by the DocBook toolchain Example options compact Compact list item Another compact list item Tip To apply the compact option globally define a document wide compact option attribute e g using the a compact option command line option You can set the list start number using the start attribute works for HTML outputs and DocBook outputs processed by DocBook XSL Stylesheets Example start 7 List item 7 List item 8 AsciiDoc User Guide 29 88 17 3 Labeled Lists Labeled list items consist of one or more text labels followed by the text of the list item An item label begins a line with an alphanumeric character hard against the left margin and ends with two three or four colons or two semi colons A list item can have multiple labels one per line The list item text consists of one or more lines of text starting after the last label either on the same line or a new line and can be followed by nested List or ListParagraph elements Item text can be optionally indented Here are some examples aliases Lorem Fusce euismod commodo velit Fusce euismod commodo velit Ipsum Vivamus fringilla mi eu lacus Vivamus fringilla mi eu lacus Donec eget arcu bibendum nunc con
102. nformation to stderr files processed filters processed warnings system attribute evaluation AsciiDoc User Guide 84 88 A special attribute named trace enables the output of element by element diagnostic messages detailing output markup generation to stderr The trace attribute can be set on the command line or from within the document using Attribute Entries the latter allows tracing to be confined to specific portions of the document e Trace messages print the source file name and line number and the trace name followed by related markup trace names are normally the names of AsciiDoc elements see the list below e The trace message is only printed if the trace attribute value matches the start of a trace name The trace attribute value can be any Python regular expression If a trace value is not specified all trace messages will be printed this can result in large amounts of output if applied to the whole document e In the case of inline substitutions The text before and after the substitution is printed the before text is preceded by a line containing lt lt lt and the after text by a line containing gt gt gt The subs trace value is an alias for all inline substitutions Trace names lt blockname gt block close lt blockname gt block open lt subs gt dropped line a line containing an undefined attribute reference floating title footer header list close list entry close list entry
103. ng backend markup tags Each section entry value is the name of a of a tags section entry The entry name is the character or characters that quote the text The following examples are taken from AsciiDoc configuration files quotes _ emphasis AsciiDoc User Guide 58 88 tags emphasis lt em gt lt em gt You can specify the left and right quote strings separately by separating them with a character for example vv quoted Omitting the tag will disable quoting for example if you don t want superscripts or subscripts put the following in a custom configuration file or edit the global asciidoc conf configuration file quotes n Unconstrained quotes are differentiated from constrained quotes by prefixing the tag name with a hash character for example __ emphasis QUOTED TEXT BEHAVIOR e Quote characters must be non alphanumeric e To minimize quoting ambiguity try not to use the same quote characters in different quote types 26 8 Special Words section The specialwords section is used to single out words and phrases that you want to consistently format in some way throughout your document without having to repeatedly specify the markup The name of each entry corresponds to a markup template section and the entry value consists of a list of words and phrases to be marked up For example specialwords strongwords NOTE IMPORTANT strongwords lt strong gt words lt strong gt The examp
104. nhibiting the execution of arbitrary code or the inclusion of arbitrary files The safe mode is disabled by default it can be enabled with the asciidoc 1 safe command line option SAFE MODE CONSTRAINTS e eval sys and sys2 executable attributes and block macros are not executed e include lt filename gt and includel lt filename gt block macro files must reside inside the parent file s directory e include lt filename gt executable attribute files must reside inside the source document directory e Passthrough Blocks are dropped Warning T The safe mode is not designed to protect against unsafe AsciiDoc configuration files Be especially careful when 1 Implementing filters 2 Implementing elements that don t escape special characters 3 Accepting configuration files from untrusted sources D Using AsciiDoc with non English Languages AsciiDoc can process UTF 8 character sets but there are some things you need to be aware of e If you are generating output documents using a DocBook toolchain then you should set the AsciiDoc lang attribute to the appropriate language it defaults to en English This will ensure things like table of contents figure and table captions and admonition captions are output in the specified language For example a2x a lang es doc article txt e If you are outputting HTML directly from asciidoc 1 you ll need to set the various _caption attributes to match your
105. nside the square brackets and the endif macro omitted for example ifdef revnumber Version number 42 Is equivalent to ifdef revnumber Version number 42 endif revnumber ifdef and ifndef macros also accept multiple attribute names e Multiple separated attribute names evaluate to defined if one or more of the attributes is defined otherwise it s value is undefined e Multiple separated attribute names evaluate to defined if all of the attributes is defined otherwise it s value is undefined Document text between the ifeval and endif macros is included if the Python expression inside the square brackets is true Example ifeval rs458 2 endif e Document attribute references are expanded before the expression is evaluated e If an attribute reference is undefined then the expression is considered false Take a look at the x conf configuration files in the AsciiDoc distribution for examples of conditional inclusion macro usage AsciiDoc User Guide 42 88 21 3 3 Executable system macros The eval sys and sys2 block macros exhibit the same behavior as their same named system attribute references The difference is that system macros occur in a block macro context whereas system attributes are confined to inline contexts where attribute substitution is enabled The following example displays a long directory listing inside a literal block sys i Is 1 txt Note There ar
106. nvert DocBook to XML FO using DocBook XSL Stylesheets e FOP is more feature complete for example callouts are processed inside literal layouts and arguably produces nicer looking output 5 5 HTML Help generation 1 Convert DocBook XML documents to HTML Help compiler source files using DocBook XSL Stylesheets and xsltproc 1 2 Convert the HTML Help source hhp and html files to HTML Help chm files using the Microsoft HTML Help Compiler 5 6 Toolchain components summary AsciiDoc Converts AsciiDoc t xt files to DocBook XML xm1 files DocBook XSL Stylesheets These are a set of XSL stylesheets containing rules for converting DocBook XML documents to HTML XSL FO manpage and HTML Help files The stylesheets are used in conjunction with an XML parser such as xsltproc 1 xsltproc An XML parser for applying XSLT stylesheets in our case the DocBook XSL Stylesheets to XML documents dblatex Generates PDF DVI PostScript and LaTeX formats directly from DocBook source via the intermediate LaTeX typesetting language uses DocBook XSL Stylesheets xsltproc 1 and latex 1 FOP The Apache Formatting Objects Processor converts XSL FO fo files to PDF files The XSL FO files are generated from DocBook source files using DocBook XSL Stylesheets and xsltproc 1 Microsoft Help Compiler The Microsoft HTML Help Compiler hhc exe is a command line tool that converts HTML Help source files to a single HTML Help chm
107. o images icons If admonition icons are embedded using the data uri scheme then the iconsdir attribute defaults to the location of the icons installed in the AsciiDoc configuration directory imagesdir html4 html5 If this attribute is defined it is prepended to the target image file name paths in xhtml11 inline and block image macros docbook keywords html4 html5 The keywords and description attributes set the correspondingly named HTML description title xhtml11 meta tag contents the title attribute sets the HTML title tag contents Their principle use is for SEO Search Engine Optimisation All three are optional but if they are used they must appear in the document header or on the command line If title is not specified the AsciiDoc document title is used AsciiDoc User Guide 87 88 Name Backends Description linkcss html5 xhtml1 1 Link CSS stylesheets and JavaScripts By default linkcss is undefined in which case stylesheets and scripts are automatically embedded in the output document max width html5 xhtml1 1 Set the document maximum display width sets the body element CSS max width property numbered html4 html5 Adds section numbers to section titles The docbook backend ignores numbered xhtml11 attribute entries after the document header docbook XSL Stylesheets plaintext All backends If this global attribute is defined all inline subst
108. oc a2x 1 toolchain wrapper utility AsciiDoc User Guide 7 HTML5 and XHTML 1 1 7 88 The xhtml 1 and html5 backends embed or link CSS and JavaScript files in their outputs there is also a themes plugin framework e If the AsciiDoc linkcss attribute is defined then CSS and JavaScript files are linked to the output document otherwise they are embedded the default behavior e The default locations for CSS and JavaScript files can be changed by setting the AsciiDoc stylesdir and scriptsdir attributes respectively e The default locations for embedded and linked files differ and are calculated at different times embedded files are loaded when asciidoc 1 generates the output document linked files are loaded by the browser when the user views the output document e Embedded files are automatically inserted in the output files but you need to manually copy linked CSS and Javascript files from AsciiDoc configuration directories to the correct location relative to the output document Table 1 Stylesheet file locations stylesdir attribute Linked location linkcss attribute Embedded location linkcss defined attribute undefined Undefined default Same directory as the output stylesheets subdirectory in the document AsciiDoc configuration directory the directory containing the backend conf file Absolute or relative directory name Absolute or relative to the output document Absolute or relat
109. ockdef x sections AsciiDoc User Guide 22 88 16 1 Predefined Delimited Blocks AsciiDoc ships with a number of predefined DelimitedBlocks see the asciidoc conf configuration file in the asciidoc 1 program directory Predefined delimited block underlines CommentBlock III NINA III 1 PassthroughBlock 4 4 4 4 4 4 4 4 4 4 4 4 44 ListingBlock LiAtESTAIBLOCIES sewecaidedecwdidenu ia e SidebarBlock RKKARAKKKKK KK KK ARA KK KK AA QuoteBlock ExampleBlock OpenBlock Table 3 Default DelimitedBlock substitutions Attributes Callouts Macros Quotes Replacements Special Special chars words PassthroughBlock Yes No Yes No No No No ListingBlock No Yes No No No Yes No LiteralBlock No Yes No No No Yes No SidebarBlock Yes No Yes Yes Yes Yes Yes QuoteBlock Yes No Yes Yes Yes Yes Yes ExampleBlock Yes No Yes Yes Yes Yes Yes OpenBlock Yes No Yes Yes Yes Yes Yes 16 2 Listing Blocks ListingBlocks are rendered verbatim in a monospaced font they retain line and whitespace formatting and are often distinguished by a background or border There is no text formatting or substitutions within Listing blocks apart from Special Characters and Callouts Listing blocks are often used for computer output and file listings Here s an example include lt stdio h gt int main printf Hello World n exit 0 Which will b
110. ok DTD variations 36 11Creating stand alone HTML documents 36 12Shipping stand alone AsciiDoc source 2 oo o ee 36 ISMinsertina Diank spate ios eA Re Ra Pe Rw Ss oe ee 36 AC lasing GpenSechions o ke A A eS Be E 36 15 Validating output files ee ee ee ewe ee Pee be Glossary Migration Notes AL Version Ft tO VERSIONS eaa Se ew Re a RO ee SO Packager Notes AsciiDoc Safe Mode Using AsciiDoc with non English Languages Vim Syntax Highlighter Attribute Options Diagnostics Backend Attributes License viii 79 79 79 79 80 80 80 80 81 81 81 81 82 82 82 83 83 83 85 88 AsciiDoc User Guide 1 88 AsciiDoc is a text document format for writing notes documentation articles books ebooks slideshows web pages blogs and UNIX man pages AsciiDoc files can be translated to many formats including HTML PDF EPUB man page AsciiDoc is highly configurable both the AsciiDoc source file syntax and the backend output markups which can be almost any type of SGML XML markup can be customized and extended by the user This document This is an overly large document it probably needs to be refactored into a Tutorial Quick Reference and Formal Reference If you re new to AsciiDoc read this section and the Getting Started section and take a look at the example AsciiDoc txt source files in the distribution doc directory 1 Introduction AsciiDoc is
111. onally identical to the pass macro but you don t have to escape characters and you can prefix with quoted attributes in the inline version Example Red red sum_ i 1 n i n n 1 2 S AsciiMathML formula AsciiDoc User Guide 43 88 Inline and block The double dollar passthrough is functionally identical to the triple plus passthrough with one exception special characters are escaped Example 5 a b c d n k Text quoted with single backtick characters constitutes an inline literal passthrough The enclosed text is rendered in a monospaced font and is only subject to special character substitution This makes sense since monospace text is usually intended to be rendered literally and often contains characters that would otherwise have to be escaped If you need monospaced text containing inline substitutions use a plus character instead of a backtick 21 5 Macro Definitions Each entry in the configuration macros section is a macro definition which can take one of the following forms lt pattern gt lt name gt lt subslist Inline macro definition lt pattern gt lt name gt lt subslist Block macro definition lt pattern gt lt name gt lt subslist System macro definition lt pattern gt Delete the existing macro with this lt pattern gt lt pattern gt is a Python regular expression and lt name gt is the name of a markup template If lt name gt is omitted then it is th
112. open list item close list item open list label close list label open list open macro block a block macro name man page NAME section paragraph preamble close preamble open push blockname pop blockname section close section open level lt level gt subs all inline substitutions table Where e lt level gt is section level number 0 4 e lt blockname gt is a delimited block name comment sidebar open pass listing literal quote example e lt subs gt is an inline substitution type specialcharacters quotes specialwords replacements attributes macros callouts re placements2 replacements3 Command line examples AsciiDoc User Guide 85 88 1 Trace the entire document asciidoc a trace mydoc txt 2 Trace messages whose names start with quotes or macros asciidoc a trace quotes macros mydoc txt 3 Print the first line of each trace message asciidoc a trace mydoc txt 2 gt amp 1 grep TRACE Attribute Entry examples 1 Begin printing all trace messages trace 2 Print only matched trace messages trace quotes macros 3 Turn trace messages off trace H Backend Attributes This table contains a list of optional attributes that influence the generated outputs Name Backends Description badges xhtml11 html5 Link badges XHTML 1 1 and CSS in document footers By default badges are omitted badges is undefined Note
113. or stand alone processing AsciiDoc User Guide 79 88 36 6 Processing document sections separately You have divided your AsciiDoc document into separate files one per top level section which are combined and processed with the following top level document Combined Document Title Joe Bloggs vi 0 12241503 include sectionl txt include section2 txt include section3 txt You also want to process the section files as separate documents This is easy because asciidoc 1 will quite happily process sectionl txt section2 txt and section3 txt separately the resulting output documents contain the section but have no document title 36 7 Processing document snippets Use the s no header footer command line option to suppress header and footer output this is useful if the processed output is to be included in another file For example asciidoc sb docbook sectionl txt asciidoc 1 can be used as a filter so you can pipe chunks of text through it For example echo Hello World x x asciidoc s lt div class paragraph gt lt p gt Hello lt strong gt World lt strong gt lt p gt lt div gt 36 8 Badges in HTML page footers See the footer section in the AsciiDoc distribution xhtm111 conf configuration file 36 9 Pretty printing AsciiDoc output If the indentation and layout of the asciidoc 1 output is not to your liking you can 1 Change the indentation and layout of configu
114. ose sections and section entries that need to be overridden Tip When creating custom configuration files you only need to include the sections and entries that differ from the default configu ration AsciiDoc User Guide 55 88 Tip The best way to learn about configuration files is to read the default configuration files in the AsciiDoc distribution in conjunc tion with asciidoc 1 output files You can view configuration file load sequence by turning on the asciidoc 1 v verbose command line option AsciiDoc reserves the following section names for specific purposes miscellaneous Configuration options that don t belong anywhere else attributes Attribute name value entries specialcharacters Special characters reserved by the backend markup tags Backend markup tags quotes Definitions for quoted inline character formatting specialwords Lists of words and phrases singled out for special markup replacements replacements2 replacements3 Find and replace substitution definitions specialsections Used to single out special section names for specific markup macros Macro syntax definitions titles Heading section and block title definitions paradef Paragraph element definitions blockdef DelimitedBlock element definitions listdef List element definitions listtags List element tag definitions tabledef Table element definitions tabletags Table element ta
115. ote with text lt text gt footnoteref lt id gt lt text gt Generates a footnote with a reference ID lt id gt and text lt text gt footnoteref lt id gt Generates a reference to the footnote with ID lt id gt a This list is nested and does not require explicit item continuation 32 88 AsciiDoc User Guide 33 88 The footnote text can span multiple lines The xhtml 1 and html5 backends render footnotes dynamically using JavaScript html4 outputs do not use JavaScript and leave the footnotes inline docbook footnotes are processed by the downstream DocBook toolchain Example footnotes A footnote footnote An example footnote a second footnote with a reference ID footnoteref note2 Second footnote finally a reference to the second footnote footnoteref note2 Renders A footnote 2 a second footnote with a reference ID 3 finally a reference to the second footnote 2 19 Indexes The shipped AsciiDoc configuration includes the inline macros for generating DocBook index entries indexterm lt primary gt lt secondary gt lt tertiary gt lt primary gt lt secondary gt lt tertiary gt This inline macro generates an index term the lt secondary gt and lt tertiary gt positional attributes are optional Example indexterm Tigers Big cats or using the alternative syntax Tigers Big cats Index terms that have secondary and tertiary entries also generate separate
116. ource format csv cols 1 4x2 options header ID Customer Name Contact Name Customer Address Phone include customers csv AsciiDoc source cols e m gt s widtn 25 L gt si S 4 MID sta MO SAY 218 9 2 gt L10 23 2 Table input data formats Table 10 Cell spans alignments and styles 1 2 3 4 5 8 9 10 AsciiDoc table data can be psv dsv or csv formatted The default table format is psv AsciiDoc psv Prefix Separated Values and dsv Delimiter Separated Values formats are cell oriented the table is treated as a sequence of cells there are no explicit row separators AsciiDoc User Guide 48 88 e psv prefixes each cell with a separator whereas dsv delimits cells with a separator e psv and dsv separators are Python regular expressions e The default psv separator contains cell specifier related named regular expression groups e The default dsv separator is n a colon or a new line character e psv and dsv cell separators can be escaped by preceding them with a backslash character Here are four psv cells the second item spans two columns the last contains an escaped separator One 2 Two and three A separator character csv is the quasi standard row oriented Comma Separated Values CSV format commonly used to import and export spreadsheet and database data 23 3 Table attributes Tables can be cu
117. plate and written to the output file 32 3 Delimited Blocks DelimitedBlock options values are sectionbody The block contents are processed as a SectionBody skip The block is treated as a comment see CommentBlocks Preceding attribute lists and block titles are not consumed presubs postsubs and filter entries are ignored when sectionbody or skip options are set DelimitedBlock processing proceeds as follows 1 Optional presubs substitutions are performed on the block contents 2 If a filter is specified it is executed and the block s contents piped to its standard input The filter output replaces the block contents 3 Optional postsubs substitutions are performed on the block contents 4 The block contents is enveloped by the block s markup template and written to the output file Tip Attribute expansion is performed on the block filter command before it is executed this is useful for passing arguments to the filter 32 4 Lists List behavior and syntax is determined by 1istdef x configuration file sections The user can change existing list behavior and add new list types by editing configuration files List specific block definition notes type This is either bulleted numbered labeled or callout delimiter A Python regular expression that matches the first line of a list element entry This expression can contain the named groups text bulleted groups index and text numbered lists label and text l
118. pub xsl Used by a2x 1 to generate EPUB formatted documents fo xsl Generate XSL Formatting Object fo files for subsequent PDF file generation using FOP For example python asciidoc py b docbook article txt xsltproc nonet docbook xsl fo xsl article xml gt article fo S fop article fo article pdf htmlhelp xsl Generate Microsoft HTML Help source files for the MS HTML Help Compiler in the doc htmlhelp directory This example is run on MS Windows from a Cygwin shell prompt python asciidoc py b docbook asciidoc txt xsltproc nonet docbook xsl htmlhelp xsl asciidoc xml c Program Files HTML Help Workshop hhc exe htmlhelp hhp manpage xsl Generate a roff 1 format UNIX man page from a DocBook XML refentry document This example generates an asciidoc 1 man page file python asciidoc py d manpage b docbook asciidoc 1 txt xsltproc nonet docbook xsl manpage xsl asciidoc 1 xml xhtml xsl Convert a DocBook XML file to a single XHTML file For example python asciidoc py b docbook asciidoc txt xsltproc nonet docbook xs1 xhtml xsl asciidoc xml gt asciidoc html If you want to see how the complete documentation set is processed take a look at the A A P script doc main aap 6 Generating Plain Text Files AsciiDoc does not have a text backend for most purposes AsciiDoc source text is fine however you can convert AsciiDoc text files to formatted text using the AsciiD
119. ration file markup template sections The empty attribute is useful for outputting trailing blank lines in markup templates 2 Use Dave Raggett s HTML Tidy program to tidy asciidoc 1 output Example asciidoc b docbook o mydoc txt tidy indent xml gt mydoc xml 3 Use the xmllint 1 format option Example xmllint format mydoc xml 36 10 Supporting minor DocBook DTD variations The conditional inclusion of DocBook SGML markup at the end of the distribution docbook45 conf file illustrates how to support minor DTD variations The included sections override corresponding entries from preceding sections AsciiDoc User Guide 80 88 36 11 Creating stand alone HTML documents If you ve ever tried to send someone an HTML document that includes stylesheets and images you ll know that it s not as straight forward as exchanging a single file AsciiDoc has options to create stand alone documents containing embedded images stylesheets and scripts The following AsciiDoc command creates a single file containing embedded images CSS stylesheets and JavaScript for table of contents and footnotes asciidoc a data uri a icons a toc a max width 55em article txt You can view the HTML file here http asciidoc org article standalone html 36 12 Shipping stand alone AsciiDoc source Reproducing presentation documents from someone else s source has one major problem unless your configuration files are the same a
120. rce python include test py lt 1 gt Print statement Included test py source print Hello World lt 1 gt 21 Macros Macros are a mechanism for substituting parametrized text into output documents Macros have a name a single target argument and an attribute list The usual syntax is lt name gt lt target gt lt attrlist gt for inline macros and lt name gt lt target gt lt attrlist gt for block macros Here are some examples http www docbook org DocBook org include chapt1 txt tabsize 2 mailto srackhamtgmail com MACRO BEHAVIOR e lt name gt is the macro name It can only contain letters digits or dash characters and cannot start with a dash e The optional lt target gt cannot contain white space characters e lt attrlist gt is a list of attributes enclosed in square brackets e characters inside attribute lists must be escaped with a backslash AsciiDoc User Guide 36 88 e Expansion of macro references can normally be escaped by prefixing a backslash character see the AsciiDoc FAQ for examples of exceptions to this rule e Attribute references in block macros are expanded e The substitutions performed prior to Inline macro macro expansion are determined by the inline context e Macros are processed in the order they appear in the configuration file s e Calls to inline macros can be nested inside different inline macros an inline macro call cannot contain
121. ros are often quite long they break paragraph flow and readability suffers The problem is compounded by redundancy if the same name is used repeatedly Attribute entries can be used to make your documents easier to read and write here are some examples vis http freshmeat net projects asciidoc homepage http asciidoc org AsciiDoc home page new image images smallnew pngl footnotel footnote A meaningless latin term Using previously defined attributes See the 1 Freshmeat summary or the homepage for something new new Lorem ispum footnotel NOTE The attribute entry definition must precede it s usage e You are not limited to URLs or file names entire macro calls or arbitrary lines of text can be abbreviated e Shared attributes entries could be grouped into a separate file and included in multiple documents AsciiDoc User Guide 64 88 29 Attribute Lists e An attribute list is a comma separated list of attribute values e The entire list is enclosed in square brackets e Attribute lists are used to pass parameters to macros blocks using the AttributeList element and inline quotes The list consists of zero or more positional attribute values followed by zero or more named attribute values Here are three examples a single unquoted positional attribute three unquoted positional attribute values one positional attribute followed by two named attributes the unquoted attribu
122. s example is equivalent to this document header AsciiDoc User Manual Stuart Rackham lt srackham gmail com gt Boi Meret 23 2004 email AsciiDoc User Guide 63 88 28 1 Setting configuration entries A variant of the Attribute Entry syntax allows configuration file section entries and markup template sections to be set from within an AsciiDoc document lt section_name gt lt entry_name gt lt entry_value gt Where lt section_name gt is the configuration section name lt ent ry_name gt is the name of the entry and lt entry_value gt is the optional entry value This example sets the default labeled list style to horizontal listdef labeled style horizontal It is exactly equivalent to a configuration file containing listdef labeled style horizontal e If the lt entry_name gt is omitted then the entire section is substituted with the lt ent ry_value gt This feature should only be used to set markup template sections The following example sets the xref2 inline macro markup template xref2 inlinemacro lt a href 1 gt 22 2 lt a gt e No substitution is performed on configuration file attribute entries and they cannot be undefined e This feature can only be used in attribute entries configuration attributes cannot be set using the asciidoc 1 command attribute option Attribute entries promote clarity and eliminate repetition URLs and file names in AsciiDoc mac
123. s not media independent because different presentation media have different physical dimensions To get round this limitation both DocBook XSL Stylesheets and dblatex have implemented table width processing instructions for setting the table width as a percentage of the available width AsciiDoc emits these processing instructions if the width attribute is set along with proportional column widths the AsciiDoc docbook backend pageunits attribute defaults to To generate DocBook tables with absolute column widths set the pageunits attribute to a CALS absolute unit such as pt and set the pagewidth attribute to match the width of the presentation media 23 4 Column Specifiers Column specifiers define how columns are rendered and appear in the table cols attribute A column specifier consists of an optional column multiplier followed by optional alignment width and style values and is formatted like lt multiplier gt x lt align gt lt width gt lt style gt All components are optional The multiplier must be first and the style last The order of lt align gt or lt width gt is not important Column lt width gt can be either an integer proportional value 1 or a percentage 1 100 The default value is 1 To ensure portability across different backends there is no provision for absolute column widths not to be confused with output column width markup attributes which are available in both percentage and ab
124. s only e The optional width and height attributes scale the image size and can be used in any combination The units are pixels The following example scales the previous example to a height of 32 pixels image images logo png Company Logo height 32 e The optional link attribute is used to link the image to an external document The following example links a screenshot thumbnail to a full size version image screen thumbnail png height 32 link screen png e The optional scaledwidth attribute is only used in DocBook block images specifically for PDF documents The following example scales the images to 75 of the available print width image images logo png scaledwidth 75 alt Company Logo e The image scale attribute sets the DocBook imagedata element scale attribute e The optional align attribute aligns block macro images horizontally Allowed values are center left and right For example image images tiger png Tiger image align left e The optional float attribute floats the image left or right on the page works with HTML outputs only has no effect on DocBook outputs float and align attributes are mutually exclusive Use the unfloat block macro to stop floating 21 1 5 Comment Lines See comment block macro 21 2 Block Macros A Block macro reference must be contained in a single line separated either side by a blank line or a block delimiter Block macros behave just like Inline macros with the
125. s the creator s you won t get the same output The solution is to create a single backend specific configuration file using the asciidoc 1 c dump conf command line option You then ship this file along with the AsciiDoc source document plus the asciidoc py script The only end user requirement is that they have Python installed and that they consider you a trusted source This example creates a composite HTML configuration file for mydoc txt asciidoc cb xhtml111 mydoc txt gt mydoc xhtmlll conf Ship mydoc t xt mydoc html conf and asciidoc py With these three files and a Python interpreter the recipient can regenerate the HMTL output asciidoc py eb xhtml111 mydoc txt The e no conf option excludes the use of implicit configuration files ensuring that only entries from the mydoc html conf configuration are used 36 13 Inserting blank space Adjust your style sheets to add the correct separation between block elements Inserting blank paragraphs containing a single non breaking space character nbsp works but is an ad hoc solution compared to using style sheets 36 14 Closing open sections You can close off section tags up to level N by calling the eval Section setlevel N system macro This is useful 1f you want to include a section composed of raw markup The following example includes a DocBook glossary division at the top section level level 0 ifdef basebackend docbook eval Section se
126. s the first and section positional attributes posattrs attribution citetitle style This optional parameter specifies the default style name lt stylename gt style Optional style definition see Styles below The following block parameters behave like document attributes and can be set in block attribute lists and style definitions template options subs presubs postsubs filter 32 1 Styles A style is a set of block parameter bundled as a single named parameter The following example defines a style named verbatim verbatim style template literalblock subs verbatim If a block s attribute list contains a style attribute then the corresponding style parameters are be merged into the default block definition parameters e All style parameter names must be suffixed with style and the style parameter value is in the form of a list of named attributes e The template style parameter is mandatory other parameters can be omitted in which case they inherit their values from the default block definition parameters e Multi item style parameters subs presubs postsubs posattrs must be specified using Python tuple syntax rather than a simple list of values as they in separate entries e g postsubs callouts not postsubs callouts 32 2 Paragraphs Paragraph translation is controlled by paradef configuration file section entries Users can define new types of paragraphs and modify the behavior of existing
127. s to an empty string if all of the attributes are defined otherwise it s value is undefined Conditional attributes with single attribute names are evaluated first so they can be used inside the multi attribute conditional lt value gt 30 2 1 Conditional attribute examples Conditional attributes are mainly used in AsciiDoc configuration files see the distribution conf files for examples Attribute equality test If backend is docbook43 or xhtmlI 1 the example evaluates to DocBook 4 5 or XHTML 1 1 backend otherwise it evaluates to some other backend backend docbook45 xhtmll11 DocBook 4 5 or XHTML 1 1 backend some other backend Attribute value map This example maps the frame attribute values topbot all none sides to hsides border void vsides frame topbot hsides frame all border frame none void frame sides vsides 30 3 System Attribute References System attribute references generate the attribute text value by executing a predefined action that is parametrized by one or more arguments The syntax is lt action gt lt arguments gt counter lt attrname gt lt seed gt Increments the document attribute if the attribute is undefined it is set to 1 Returns the new attribute value e Counters generate global document wide attributes e The optional lt seed gt specifies the counter s initial value it can be a number or a single letter defaults to e lt seed gt can contain
128. sequat lobortis Dolores Donec eget arcu bibendum nunc consequat lobortis Suspendisse A massa id sem aliquam auctor Morbi Pretium nulla vel lorem LA Diieruminatt i Sens Una VAR ans ca Huser gaita mic acuse Donec Eget arcu bibendum nunc consequat lobortis Which render as In Lorem Fusce euismod commodo velit Fusce euismod commodo velit Ipsum Vivamus fringilla mi eu lacus e Vivamus fringilla mi eu lacus e Donec eget arcu bibendum nunc consequat lobortis Dolor Donec eget arcu bibendum nunc consequat lobortis Suspendisse A massa id sem aliquam auctor Morbi Pretium nulla vel lorem In Dictum mauris in urna Vivamus Fringilla mi eu lacus Donec Eget arcu bibendum nunc consequat lobortis AsciiDoc User Guide 30 88 17 3 1 Horizontal labeled list style The horizontal labeled list style also the first positional attribute places the list text side by side with the label instead of under the label Here is an example horizontal Lorem Fusce euismod commodo velit Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens Fusce euismod commodo velit Ipsum Vivamus fringilla mi eu lacus Vivamus fringilla mi eu lacus Donec eget arcu bibendum nunc consequat lobortis Dolorx Vivamus fringilla mi eu lacus Donec eget arcu bibendum nunc consequat lobortis Which render as Lorem Fusce euismod commodo velit Qui in magna commodo est
129. solute units The lt align gt column alignment specifier is formatted like lt horizontal gt lt vertical gt Where lt horizontal gt and lt vertical gt are one of the following characters lt or gt which represent left center and right horizontal alignment or top middle and bottom vertical alignment respectively A lt multiplier gt can be used to specify repeated columns e g cols 4 lt specifies four left justified columns The default multiplier value is 1 The lt style gt name specifies a table style to used to markup column cells you can use the full style names if you wish but the first letter is normally sufficient Column specific styles are not applied to header rows AsciiDoc User Guide 50 88 23 5 Cell Specifiers Cell specifiers allow individual cells in psv formatted tables to be spanned multiplied aligned and styled Cell specifiers prefix psv delimiters and are formatted like lt span gt x lt align gt lt style gt lt span gt specifies horizontal and vertical cell spans operator or the number of times the cell is replicated operator lt span gt is formatted like lt colspan gt lt rowspan gt Where lt colspan gt and lt rowspan gt are integers specifying the number of columns and rows to span e lt align gt specifies horizontal and vertical cell alignment an is the same as in column specifiers e A lt style gt value is the first letter of tab
130. stomized by the following attributes format psv default dsv or csv See Table Data Formats separator The cell separator A Python regular expression psv and dsv formats or a single character csv format frame Defines the table border and can take the following values topbot top and bottom all all sides none and sides left and right sides The default value is all grid Defines which ruler lines are drawn between table rows and columns The grid attribute value can be any of the following values none cols rows and all The default value is all align Use the align attribute to horizontally align the table on the page works with HTML outputs only has no effect on DocBook outputs The following values are valid left right and center float Use the float attribute to float the table left or right on the page works with HTML outputs only has no effect on DocBook outputs Floating only makes sense in conjunction with a table width attribute value of less than 100 otherwise the table will take up all the available space float and align attributes are mutually exclusive Use the unfloat block macro to stop floating halign Use the halign attribute to horizontally align all cells in a table The following values are valid left right and center defaults to left Overridden by Column specifiers and Cell specifiers valign Use the valign attribute to vertically align all cells in a table The following
131. t blocks paragraphs lists and sentences Tips for vim users follow 36 2 Vim Commands for Formatting AsciiDoc 36 2 1 Text Wrap Paragraphs Use the vim gq command to reformat paragraphs Setting the textwidth sets the right text wrap margin for example set textwidth 70 To reformat a paragraph 1 Position the cursor at the start of the paragraph 2 Type gq Execute help gq command to read about the vim gq command Tip Assign the gq command to the Q key with the nnoremap Q gq command or put it in your vimrc file to so it s always available see the Example vimrc file Put set commands in your vimrc file so you don t have to enter them manually The Vim website http www vim org has a wealth of resources including scripts for automated spell checking and ASCII Art drawing 36 2 2 Format Lists The gq command can also be used to format bulleted numbered and callout lists First you need to set the comments formatoptions and formatlistpat see the Example vimre file Now you can format simple lists that use dash asterisk period and plus bullets along with numbered ordered lists 1 Position the cursor at the start of the list 2 Type gq 36 2 3 Indent Paragraphs Indent whole paragraphs by indenting the fist line with the desired indent and then executing the gq command AsciiDoc User Guide 77 88 36 2 4 Example vimrc File Use bold
132. t output directory name output file name note 2 plus character note 2 the full path name of the Python interpreter executable right double quote character note 7 running block xreflabel generat document revision date document revision number right single quote character formatted section number space character send comment lines to the output section title in titled elemen two colon characters two semicolon characters the asciidoc directory defined as if i d by BlockId elements from document header from document header note 7 in section titles ts t exists if verbose command option specified wj word joiner zwsp zero width space character entity Note 1 Intrinsic attributes are global so avoid defining custom attributes with the same names 2 outfile outdir infile indir attributes are effectively read only you can set them but it won t affect the input or output file paths 3 See also the Backend Attributes section for attributes that relate to AsciiDoc XHTML file generation 4 The entries that translate to blank strings are designed to be used for conditional text inclusion You can also use the ifdef ifndef and endif System macros for conditional inclusion 5 docfile and docdir refer to root document specified on the asciidoc 1 command line infile and indir refer to the current input file which may be the root document or
133. te value in the final example contains comma amp 44 and double quote amp 34 character entities Hello quote Bertrand Russell The World of Mathematics 1956 22 times backcolor 0e0e0e options noborders wide A footnote amp 44 amp 34 with an image amp 34 image smallnew png ATTRIBUTE LIST BEHAVIOR e If one or more attribute values contains a comma the all string values must be quoted enclosed in double quotation mark characters e If the list contains any named or quoted attributes then all string attribute values must be quoted e To include a double quotation mark character in a quoted attribute value the the quotation mark must be escaped with a backslash e List attributes take precedence over existing attributes List attributes can only be referenced in configuration file markup templates and tags they are not available elsewhere in the document Setting a named attribute to None undefines the attribute Positional attributes are referred to as 1 2 3 Attribute 0 refers to the entire list excluding the enclosing square brackets Named attribute names cannot contain dash characters 29 1 Options attribute If the attribute list contains an attribute named options it is processed as a comma separated list of option names e Each name generates an attribute named like lt option gt option where lt option gt is the option name with an empty
134. ted substitutions that are performed on the block contents presubs is applied first postsubs if specified second e subs is an alias for presubs e Ifa filter is allowed Paragraphs DelimitedBlocks and Tables and has been specified then presubs and postsubs substi tutions are performed before and after the filter is run respectively e Allowed values specialcharacters quotes specialwords replacements macros attributes callouts e The following composite values are also allowed none No substitutions normal The following substitutions in the following order specialcharacters quotes attributes specialwords replace ments macros replacements2 verbatim The following substitutions in the following order specialcharacters and callouts e normal and verbatim substitutions can be redefined by with subsnormal and subsverbat im entries in a configu ration file miscellaneous section e The substitutions are processed in the order in which they are listed and can appear more than once filter This optional entry specifies an executable shell command for processing block content Paragraphs DelimitedBlocks and Tables The filter command can contain attribute references AsciiDoc User Guide 71 88 posattrs Optional comma separated list of positional attribute names This list maps positional attributes in the block s attribute list to named block attributes The following example from the QuoteBlock definition map
135. tetuer adipiscing elit Fusce euismod commodo velit Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens Sit munere ponderum dignissim et Minim luptatum et vel Vivamus fringilla mi eu lacus Donec eget arcu bibendum nunc consequat lobortis Nulla porttitor vulputate libero AsciiDoc User Guide 28 88 Fusce euismod commodo velit Vivamus fringilla mi eu lacus upperroman Fusce euismod commodo velit Vivamus fringilla mi eu lacus Donec eget arcu bibendum nunc consequat lobortis Which render as e Praesent eget purus quis magna eleifend eleifend 1 Fusce euismod commodo velit a Fusce euismod commodo velit b Vivamus fringilla mi eu lacus c Donec eget arcu bibendum nunc consequat lobortis 2 Vivamus fringilla mi eu lacus i Fusce euismod commodo velit 11 Vivamus fringilla mi eu lacus 3 Donec eget arcu bibendum nunc consequat lobortis 4 Nam fermentum mattis ante e Lorem ipsum dolor sit amet consectetuer adipiscing elit Fusce euismod commodo velit Qui in magna commodo est labitur dolorum an Est ne magna primis adolescens Sit munere ponderum dignissim et Minim luptatum et vel x Vivamus fringilla mi eu lacus Donec eget arcu bibendum nunc consequat lobortis e Nulla porttitor vulputate libero 1 Fusce euismod commodo velit 2 Vivamus fringilla mi eu lacus I Fusce euismod commodo velit II Vivamus fringilla mi eu lacus 3 Do
136. th command line option Example inline formula latexmath sum_ n 1 infty frac 1 2 n For more examples see the AsciiDoc website or the distributed doc latexmathm1 txt file 25 4 MathML MathML is a low level XML markup for mathematics AsciiDoc has no macros for MathML but users familiar with this markup could use passthrough macros and passthrough blocks to include MathML in output documents 26 Configuration Files AsciiDoc source file syntax and output file markup is largely controlled by a set of cascading text based configuration files At runtime The AsciiDoc default configuration files are combined with optional user and document specific configuration files 26 1 Configuration File Format Configuration files contain named sections Each section begins with a section name in square brackets The section body consists of the lines of text between adjacent section headings Section names consist of one or more alphanumeric underscore or dash characters and cannot begin or end with a dash Lines starting with a character are treated as comments and ignored If the section name is prefixed with a character then the section contents is appended to the contents of an already existing same named section Otherwise same named sections and section entries override previously loaded sections and section entries this is sometimes referred to as cascading Consequently downstream configuration files need only contain th
137. th macro attribute sets the maximum permitted number of subsequent nested includes not applicable to includel macro which does not process nested includes Setting depth to 1 disables nesting inside the included file By default nesting is limited to a depth of ten e If the he warnings attribute is set to False or any other Python literal that evaluates to boolean false then no warning message is printed if the included file does not exist By default warnings are enabled e Internally the includel macro is translated to the includel system attribute which means it must be evaluated in a region where attribute substitution is enabled To inhibit nested substitution in included files it is preferable to use the include macro and set the attribute depth 1 AsciiDoc User Guide 41 88 21 3 2 Conditional Inclusion Macros Lines of text in the source document can be selectively included or excluded from processing based on the existence or not of a document attribute Document text between the ifdef and endif macros is included if a document attribute is defined ifdef lt attribute gt endif lt attribute gt Document text between the ifndef and endif macros is not included if a document attribute is defined ifndef lt attribute gt endif lt attribute gt lt attribute gt is an attribute name which is optional in the trailing endif macro If you only want to process a single line of text then the text can be put i
138. the configuration file replacements section 26 10 Markup Template Sections Markup template sections supply backend markup for translating AsciiDoc elements Since the text is normally backend depen dent you find these sections in the backend specific configuration files Template sections differ from other sections in that they contain a single block of text instead of per line name value entries A markup template section body can contain e Attribute references e System macro calls e A document content placeholder The document content placeholder is a single character and is replaced by text from the source element Use the brvbar attribute reference if you need a literal character in the template 26 11 Configuration file names precedence and locations Configuration files have a conf file name extension they are loaded from the following locations 1 The directory containing the asciidoc executable 2 If there is no asciidoc conf file in the directory containing the asciidoc executable then load from the global con figuration directory normally etc asciidoc or usr local etc asciidoc Le the global configuration files directory is skipped if AsciiDoc configuration files are installed in the same directory as the asciidoc executable This allows both a system wide copy and multiple local copies of AsciiDoc to coexist on the same host PC 3 The user s SHOME asciidoc directory if it exists 4 The directory
139. tlevel 0 A EE EE lt glossary gt lt title gt Glossary lt title gt lt glossdiv gt lt glossdiv gt lt glossary gt FHA E AFH EHH AFE HHH HEH H 4444 4444 endif basebackend docbook AsciiDoc User Guide 81 88 36 15 Validating output files Use xmllint 1 to check the AsciiDoc generated markup is both well formed and valid Here are some examples xmllint nonet noout valid docbook file xml xmllint nonet noout valid xhtml11 file html xmllint nonet noout valid html html4 file html The valid option checks the file is valid against the document type s DTD if the DTD is not installed in your system s catalog then it will be fetched from its Internet location If you omit the valid option the document will only be checked that it is well formed The online W3C Markup Validation Service is the defacto standard when it comes to validating HTML it validates all HTML standards including HTMLS5S 37 Glossary Block element An AsciiDoc block element is a document entity composed of one or more whole lines of text Inline element AsciiDoc inline elements occur within block element textual content they perform formatting and substitution tasks Formal element An AsciiDoc block element that has a BlockTitle Formal elements are normally listed in front or back matter for example lists of tables examples and figures Verbatim element The word verbat
140. ts respectively They follow the usual AsciiDoc block macro syntax lt name gt lt target gt lt attrlist gt where lt name gt audio or video lt target gt The URL or file name of the video or audio file lt attrlist gt A list of named attributes see below Table 4 Audio macro attributes Name Value options A comma separated list of one or more of the following items autoplay loop which correspond to the same named HTML 5 audio element boolean attributes By default the player controls are enabled include the nocontrols option value to hide them Table 5 Video macro attributes Name Value height The height of the player in pixels width The width of the player in pixels poster The URL or file name of an image representing the video options A comma separated list of one or more of the following items autoplay loop and nocontrols The autoplay and loop options correspond to the same named HTML 5 video element boolean attributes By default the player controls are enabled include the nocontrols option value to hide them Examples audio images example oggl video gizmo ogv width 200 options nocontrols autoplay Example video video gizmo ogv video http www 808 dk pics video gizmo ogv If your needs are more complex put raw HTML 5 in a markup block for example from http www 808 dk code html 5 video lt video poster pics video gizmo jpg id vid
141. ttributeList block element is an attribute list on a line by itself e AttributeList attributes are only applied to the immediately following block element the attributes are made available to the block s markup template e Multiple contiguous AttributeList elements are additively combined in the order they appear e The first positional attribute in the list is often used to specify the ensuing element s style AsciiDoc User Guide 19 88 14 1 Attribute value substitution By default only substitutions that take place inside attribute list values are attribute references this is because not all attributes are destined to be marked up and rendered as text for example the table cols attribute To perform normal inline text substitutions special characters quotes macros replacements on an attribute value you need to enclose it in single quotes In the following quote block the second attribute value in the AttributeList is quoted to ensure the http macro is expanded to a hyperlink quote http en wikipedia org wiki Samuel_Johnson Samuel Johnson Sir a woman s preaching is like a dog s walking on his hind legs It is not done well but you are surprised to find it done at all 14 2 Common attributes Most block elements support the following attributes Name Backends Description id html4 html5 Unique identifier typically serve as link targets Can also be set by the BlockId xhtml11 element
142. uote character s In the case of ambiguity between escaped and non escaped text you will need to escape both leading and trailing quotes in the case of multi character quotes you may even need to escape individual characters 10 1 1 Quoted text attributes Quoted text can be prefixed with an attribute list The first positional attribute role attribute is translated by AsciiDoc to an HTML span element class attribute or a DocBook phrase element role attribute DocBook XSL Stylesheets translate DocBook phrase elements with role attributes to corresponding HTML span elements with the same class attributes CSS can then be used to style the generated HTML Thus CSS styling can be applied to both DocBook and AsciiDoc generated HTML outputs You can also specify multiple class names separated by spaces CSS rules for text color text background color text size and text decorators are included in the distributed AsciiDoc CSS files and are used in conjunction with AsciiDoc xhtml11 html5 and docbook outputs The CSS class names are e lt color gt text foreground color e lt color gt background text background color e big and small text size e underline overline and line through strike through text decorators AsciiDoc User Guide 15 88 Where lt color gt can be any of the sixteen HTML color names Examples red Obvious and big red yellow background very obvious underline Underline text overli
143. uration files lang conf Section entries lt titl lt titil lt titl templa are formatted like le gt lt template gt Le gt is a Python regular expression and lt template gt is the name of a configuration file markup template section If the Le gt matches an AsciiDoc document section title then the backend output is marked up using the lt template gt markup te instead of the default sect lt level gt section template The title attribute value is set to the value of the matched regular expression group named title if there is no title group title defaults to the whole of the AsciiDoc section title If lt template gt is blank then any existing entry with the same lt title gt will be deleted Special section titles vs explicit template names AsciiDoc has two mechanisms for specifying non default section markup templates you can specify the template name explicitly using the template attribute or indirectly using special section titles Specifying a section template attribute explicitly is preferred Auto magical special section titles have the following drawbacks e They are non obvious you have to know the exact matching title for each special section on a language by language basis e Section titles are predefined and can only be customised with a configuration change e The implementation is complicated by multiple languages every special section title has to be defined for each language i
144. utput without markup i e the backslash can be used to escape special word markup For example the special word b Tt en b will mark up the words Ten and ten only if they are not preceded by a backslash AsciiDoc User Guide 59 88 26 9 Replacements section replacements replacements2 and replacements3 configuration file entries specify find and replace text and are formatted like lt find_pattern gt lt replacement_text gt The find text can be a Python regular expression the replace text can contain Python regular expression group references Use Replacement shortcuts for often used macro references for example the second replacement allows us to backslash escape the macro name NEW image images smallnew png New NEW NEW The only difference between the three replacement types is how they are applied By default replacements and replacements2 are applied in normal substitution contexts whereas replacements3 needs to be configured explicitly and should only be used in backend configuration files REPLACEMENT BEHAVIOR e The built in replacements can be escaped with a backslash If the find or replace text has leading or trailing spaces then the text should be enclosed in quotation characters e Since the find text is processed as a regular expression you need to be careful to escape regular expression special characters e Replacements are performed in the same order they appear in
145. values are valid top bottom and middle defaults to top Overridden by Column specifiers and Cell specifiers options The options attribute can contain comma separated values for example header footer By default header and footer rows are omitted See attribute options for a complete list of available table options cols The cols attribute is a comma separated list of column specifiers For example cols 2 lt p 2 4p gt AsciiDoc User Guide 49 88 e If cols is present it must specify all columns e If the cols attribute is not specified the number of columns is calculated as the number of data items in the first line of the table e The degenerate form for the cols attribute is an integer specifying the number of columns e g cols 4 width The width attribute is expressed as a percentage value 1 99 The width specifies the table width relative to the available width HTML backends use this value to set the table width attribute It s a bit more complicated with DocBook see the DocBook table widths sidebar filter The filter attribute defines an external shell command that is invoked for each cell The built in asciidoc table style is implemented using a filter DocBook table widths The AsciiDoc docbook backend generates CALS tables CALS tables do not support a table width attribute table width can only be controlled by specifying absolute column widths Specifying absolute column widths i
146. vening white space The default processing expectation is that of a normal paragraph of text 15 2 literal paragraph syntax Literal paragraphs are rendered verbatim in a monospaced font without any distinguishing background or border By default there is no text formatting or substitutions within Literal paragraphs apart from Special Characters and Callouts The literal style is applied implicitly to indented paragraphs i e where the first line of the paragraph is indented by one or more space or tab characters For example AsciiDoc User Guide 20 88 Consul necessitatibus per id consetetur u pro everti postulant homero verear ea mea qui Renders Consul necessitatibusx per id consetetur eu pro everti postulant homero verear ea mea qui Note Because lists can be indented it s possible for your indented paragraph to be misinterpreted as a list in situations like this apply the literal style to a normal paragraph Instead of using a paragraph indent you could apply the literal style explicitly for example literal Consul necessitatibusx per id consetetur u pro everti postulant homero verear ea mea qui Renders Consul necessitatibusx per id consetetur eu pro everti postulant homero verear ea mea qui 15 3 quote and verse paragraph styles The optional attribution and citetitle attributes positional attributes 2 and 3 specify the author and source respectively The v

Download Pdf Manuals

Related Search

Related Contents

  LZH-70W (Manuale Utente)  Rotel RP900 User's Manual  Divar - Digital Versatile Recorder  02-CD-16-C-167 - Ventanilla Única de Transparencia del Gobierno  Manuel d`utilisation    

Copyright © All rights reserved. Failed to retrieve file