devexpress pdf viewer control asp.net : Convert selected pages of pdf to word Library SDK component asp.net .net wpf mvc asciidoc0-part983

AsciiDoc User Guide
i
AsciiDoc User Guide
Convert selected pages of pdf to word - Library SDK component:C# PDF Page Extract Library: copy, paste, cut PDF pages in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Easy to Use C# Code to Extract PDF Pages, Copy Pages from One PDF File and Paste into Others
www.rasteredge.com
Convert selected pages of pdf to word - Library SDK component:VB.NET PDF Page Extract Library: copy, paste, cut PDF pages in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Detailed VB.NET Guide for Extracting Pages from Microsoft PDF Doc
www.rasteredge.com
AsciiDoc User Guide
ii
REVISION HISTORY
NUMBER
DATE
DESCRIPTION
NAME
8.6.9
9November 2013
SJR
Library SDK component:C# PDF Page Insert Library: insert pages into PDF file in C#.net
page2 }; // Specify a position for inserting the selected pages. doc2.InsertPages( pages, pageIndex); // Output the new document Insert Blank Page to PDF File in
www.rasteredge.com
Library SDK component:VB.NET PDF Page Insert Library: insert pages into PDF file in vb.
As String = Program.RootPath + "\\" Output.pdf" Dim doc1 As doc1.GetPage(2) Dim pages = New PDFPage Specify a position for inserting the selected pages.
www.rasteredge.com
AsciiDoc User Guide
iii
Contents
1 Introduction
1
2 Getting Started
1
2.1 Installing AsciiDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2.2 Example AsciiDoc Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
3 AsciiDoc Document Types
2
3.1 article . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3.2 book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3.3 manpage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
4 AsciiDoc Backends
2
4.1 Backend Aliases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
4.2 Backend Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
5 DocBook
3
5.1 Converting DocBook to other file formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
5.2 a2x Toolchain Wrapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
5.3 HTML generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
5.4 PDF generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
5.5 HTML Help generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
5.6 Toolchain components summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
5.7 AsciiDoc dblatex configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
5.8 AsciiDoc DocBook XSL Stylesheets drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
6 Generating Plain Text Files
6
7 HTML5 and XHTML 1.1
7
7.1 Themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
8 Document Structure
8
8.1 Block Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
8.2 Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
8.2.1 Additional document header information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
8.3 Preamble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
8.4 Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
8.4.1 Section markup templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
8.4.2 Section IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
8.4.3 Special Section Titles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
8.5 Inline Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Library SDK component:C# Word - Insert Blank Word Page in C#.NET
doc1 = new DOCXDocument(inputFilePath1); // Specify a position for inserting the selected page. Add and Insert Multiple Word Pages to Word Document Using C#.
www.rasteredge.com
Library SDK component:C# PDF Page Rotate Library: rotate PDF page permanently in C#.net
270; // Rotate the selected page. PDFDocument.RotatePage(inputFilePath, pageIndex, rotateInDegree); How to Use C#.NET Demo Code to Rotate All PDF Pages in C#
www.rasteredge.com
AsciiDoc User Guide
iv
9 Document Processing
13
10 Text Formatting
14
10.1 QuotedText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
10.1.1 Quoted text attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
10.1.2 Constrained and Unconstrained Quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Constrained quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Unconstrained quotes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
10.2 Superscripts and Subscripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
10.3 Line Breaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.4 Page Breaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.5 Rulers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.6 Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.7 Replacements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.8 Special Words. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
11 Titles
17
11.1 Two line titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
11.2 One line titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
11.3 Floating titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12 Block Titles
18
13 BlockId Element
18
14 AttributeList Element
18
14.1 Attribute value substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
14.2 Common attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
15 Paragraphs
19
15.1 normal paragraph syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
15.2 literal paragraph syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
15.3 quote and verse paragraph styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
15.4 Admonition Paragraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
15.4.1 Admonition Icons and Captions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
16 Delimited Blocks
21
16.1 Predefined Delimited Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
16.2 Listing Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
16.3 Literal Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
16.4 Sidebar Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
16.5 Comment Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Library SDK component:C# WPF PDF Viewer SDK to annotate PDF document in C#.NET
1. Highlight text. Click to highlight selected PDF text content. 2. Underline text. Click to underline selected PDF text. 3. Wavy underline text.
www.rasteredge.com
Library SDK component:VB.NET PDF Image Redact Library: redact selected PDF images in vb.
Create PDF from Tiff; C#: Convert PDF to Word; C#: Convert C#: Convert PDF to HTML; C#: Convert PDF to Jpeg; C# C# File: Split PDF; C# Page: Insert PDF pages; C#
www.rasteredge.com
AsciiDoc User Guide
v
16.6 Passthrough Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
16.7 Quote Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
16.8 Example Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
16.9 Admonition Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
16.10Open Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
17 Lists
26
17.1 Bulleted Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
17.2 Numbered Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
17.3 Labeled Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
17.3.1 Horizontal labeled list style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
17.4 Question and Answer Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
17.5 Glossary Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
17.6 Bibliography Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
17.7 List Item Continuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
18 Footnotes
32
19 Indexes
33
20 Callouts
33
20.1 Implementation Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
20.2 Including callouts in included code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
21 Macros
35
21.1 Inline Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
21.1.1 URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
21.1.2 Internal Cross References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
anchor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
xref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
21.1.3 Linking to Local Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
21.1.4 Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
21.1.5 Comment Lines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
21.2 Block Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
21.2.1 Block Identifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
21.2.2 Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
21.2.3 Comment Lines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
21.3 System Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
21.3.1 Include Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
21.3.2 Conditional Inclusion Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
21.3.3 Executable system macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
21.3.4 Template System Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
21.4 Passthrough macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
21.5 Macro Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Library SDK component:C# PDF Image Redact Library: redact selected PDF images in C#.net
C#.NET convert PDF to text, C#.NET convert PDF to images pages extract, copy, paste, C#.NET rotate PDF pages, C#.NET in C#.NET class to darken selected image on
www.rasteredge.com
Library SDK component:VB.NET PDF insert image library: insert images into PDF in vb.net
PDF document. Add images to any selected PDF page in VB.NET. Ability to put image into defined location on PDF page. Provide image
www.rasteredge.com
AsciiDoc User Guide
vi
22 HTML 5 audio and video block macros
44
23 Tables
45
23.1 Example tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
23.2 Table input data formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
23.3 Table attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
23.4 Column Specifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
23.5 Cell Specifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
23.6 Table styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
23.7 Markup attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
23.8 Nested tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
23.9 DocBook table limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
24 Manpage Documents
52
24.1 Document Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
24.2 The NAME Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
24.3 The SYNOPSIS Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
24.4 refmiscinfo attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
25 Mathematical Formulas
53
25.1 LaTeX Math. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
25.2 ASCIIMathML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
25.3 LaTeXMathML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
25.4 MathML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
26 Configuration Files
54
26.1 Configuration File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
26.2 Miscellaneous section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
26.3 Titles section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
26.4 Tags section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
26.5 Attributes section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
26.6 Special Characters section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
26.7 QuotedText section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
26.8 Special Words section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
26.9 Replacements section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
26.10Markup Template Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
26.11Configuration file names, precedence and locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
27 Document Attributes
61
28 Attribute Entries
61
28.1 Setting configuration entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Library SDK component:VB.NET PDF - Annotate PDF with WPF PDF Viewer for VB.NET
1. Highlight text. Click to highlight selected PDF text content. 2. Underline text. Click to underline selected PDF text. 3. Wavy underline text.
www.rasteredge.com
Library SDK component:VB.NET PDF - Annotate PDF Online with VB.NET HTML5 PDF Viewer
Click to highlight selected PDF text content. Fill color and transparency are able to be set in properties. 3. Click to underline selected PDF text.
www.rasteredge.com
AsciiDoc User Guide
vii
29 Attribute Lists
64
29.1 Options attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
29.2 Macro Attribute lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
30 Attribute References
65
30.1 Simple Attributes References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
30.2 Conditional Attribute References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
30.2.1 Conditional attribute examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
30.3 System Attribute References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
31 Intrinsic Attributes
68
32 Block Element Definitions
70
32.1 Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
32.2 Paragraphs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
32.3 Delimited Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
32.4 Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
32.5 Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
33 Filters
73
33.1 Filter Search Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
33.2 Filter Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
33.3 Example Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
33.4 Built-in filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
33.5 Filter plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
34 Plugins
75
35 Help Commands
75
35.1 Customizing Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
36 Tips and Tricks
76
36.1 Know Your Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
36.2 Vim Commands for Formatting AsciiDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
36.2.1 Text Wrap Paragraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
36.2.2 Format Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
36.2.3 Indent Paragraphs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
36.2.4 Example ~/.vimrc File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
36.3 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
36.4 Gotchas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
36.5 Combining separate documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
36.6 Processing document sections separately. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
AsciiDoc User Guide
viii
36.7 Processing document snippets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
36.8 Badges in HTML page footers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
36.9 Pretty printing AsciiDoc output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
36.10Supporting minor DocBook DTD variations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
36.11Creating stand-alone HTML documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
36.12Shipping stand-alone AsciiDoc source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
36.13Inserting blank space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
36.14Closing open sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
36.15Validating output files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
37 Glossary
81
A Migration Notes
81
A.1 Version 7 to version 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
B Packager Notes
82
C AsciiDoc Safe Mode
82
D Using AsciiDoc with non-English Languages
82
E Vim Syntax Highlighter
83
F Attribute Options
83
G Diagnostics
83
H Backend Attributes
85
I License
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 anoverly large document, itprobablyneeds toberefactored intoa Tutorial, QuickReference and FormalReference.
If you’re new to AsciiDoc read this section and theGettingStartedsection and take a look at the example AsciiDoc
(
*
.txt) source files in the distribution doc directory.
1 Introduction
AsciiDoc is a plain text human readable/writable document format that can be translated to DocBook or HTML using the
asciidoc(1) command. Youcantheneither use asciidoc(1)generated HTML directly or runasciidoc(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 lightweight: it consists of a single Python scriptand a bunch of configuration files. Apart from asciidoc(1) and
aPython interpreter, noother programs are requiredtoconvertAsciiDoc textfiles to DocBook or HTML. SeeExampleAsciiDoc
Documentsbelow.
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) comeswith asetof configurationfiles totranslate AsciiDocarticles, books andmanpages toHTMLor DocBook
backend formats.
My AsciiDoc Itch
DocBookhas emerged as the de facto standard Open Source documentation format. But DocBook is a complex language,
the markupis difficult to read and even more difficult to write directly—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 atPackagerNotes.
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:
• Take a look at the linked examples on the AsciiDoc web site home pagehttp://asciidoc.org/. Press the Page Source sidebar
menu item to view corresponding AsciiDoc source.
• 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 DocBookdocument types.
Use the asciidoc(1) -d (--doctype) optiontospecifytheAsciiDoc documenttype— the defaultdocumenttypeis article.
By convention the .txt 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.
AsciiDoc defines standard DocBookarticle frontmatter and backmattersectionmarkuptemplates (appendix, abstract, bibliogra-
phy, glossary, index).
3.2 book
Books share the same format as articles, with the following differences:
• The part titles in multi-part books aretopleveltitles (same level as book title).
• 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 backmattersectionmarkuptemplates (appendix, dedication, preface,
bibliography, glossary, index, colophon).
E
XAMPLE 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. AsciiDocmanpage documents observe special header titleand sectionnaming
conventions— see theManpageDocumentssection for details.
AsciiDoc defines the synopsissectionmarkuptemplate 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)
command-line option. asciidoc(1) itself has little intrinsic knowledge of backend formats, all translationrules are contained
in customizable cascading configuration files. Backend specific attributes are listed intheBackendAttributessection.
docbook45
Outputs DocBook XML 4.5 markup.
Documents you may be interested
Documents you may be interested