AsciiDoc Writer’s Guide

AsciiDoc Writer's Guide

Table of Contents

.................................................................................................................................. vii 1. Writing in AsciiDoc ................................................................................................ 1

1.1. "It's just text, mate." .................................................................................... 1 1.2. Content is king! ........................................................................................... 1 1.3. Admonitions ................................................................................................. 3 1.4. Mild punctuation, strong impact .................................................................. 3

1.4.1. Quoted text ....................................................................................... 3 1.4.2. Preventing substitution ...................................................................... 5 1.4.3. Replacements ................................................................................... 6 1.5. Lists, lists, lists ............................................................................................ 7 1.5.1. Lists of things .................................................................................... 7 1.5.2. Ordering the things ........................................................................... 9 1.5.3. Titling a list ...................................................................................... 11 1.5.4. Labeled lists .................................................................................... 11 1.5.5. Hybrid lists ...................................................................................... 13 1.5.6. Complex list content ....................................................................... 15 1.5.7. Dividing lists .................................................................................... 17 1.6. Links and images ...................................................................................... 17 1.6.1. External links ................................................................................... 17 1.6.2. Target window and role attributes for links ...................................... 18 1.6.3. Links to relative files ....................................................................... 19 1.6.4. Internal cross references ................................................................ 19 1.6.5. Images ............................................................................................ 19 1.7. Titles, titles, titles ....................................................................................... 21 1.7.1. Document title ................................................................................. 21 1.7.2. Document attributes ........................................................................ 23 1.7.3. Section titles .................................................................................... 24 1.7.4. Block titles ....................................................................................... 27 2. Building blocks in AsciiDoc ................................................................................. 28 2.1. Delimited blocks ........................................................................................ 28 2.2. Block metadata ......................................................................................... 30 2.3. Masquerading blocks ................................................................................ 31 2.3.1. Admonition blocks ........................................................................... 31 2.3.2. Listing and source code blocks ....................................................... 32 2.3.3. Open blocks .................................................................................... 33 2.3.4. Passthrough blocks ......................................................................... 34

ii

AsciiDoc Writer's Guide 2.4. Delimiters optional ..................................................................................... 34 2.5. A new perspective on tables ..................................................................... 35 3. What else can AsciiDoc do? ............................................................................... 40 4. Rendering your document ................................................................................... 41 4.1. Installing AsciiDoc ..................................................................................... 41

4.1.1. Installing AsciiDoc via a package manager .................................... 41 4.1.2. Installing AsciiDoc manually ........................................................... 42 4.2. Converting a document to HTML 5 ........................................................... 43 4.3. Converting a document to DocBook ......................................................... 46 4.4. Converting the document to PDF ............................................................. 47 4.5. Producing HTML-based presentations ...................................................... 47 4.6. Output galore ............................................................................................ 48 4.7. Where else is AsciiDoc rendered? ............................................................ 48 5. Wrap-up ............................................................................................................... 49 Glossary ................................................................................................................... 50

iii

List of Figures

1.1. A mountain sunset ........................................................................................... 20

iv

List of Tables

1.1. Ordered list numbering scheme by level .......................................................... 10

v

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download