The First Chapter

Hi there

Something belongs here.

Information about your visit can be found here.

Tiger image
Figure 1. Tiger block image
Note This is something important
Tip This is something important
Warning This is something important
Caution This is something important
Important This is something important
An Example Sidebar

Any AsciiDoc SectionBody element (apart from SidebarBlocks) can be placed inside a sidebar.

Listing block for verbatim text
#include <stdio.h>

int main() {
   printf("Hello World!\n");
   exit(0);
}

Section 1

Something belongs here.

Section 2

Something belongs here.

Section 3

Something belongs here.

The Second Chapter

Hi there

Something belongs here

You can see more things about your visit.

Index examples

This is an inline index entry.

Text markers Marker

Italic marker

Replacement text © copyright, ™ trademark, ® registered trademark, — em dash, … ellipsis, → right arrow, ← left arrow, ⇒ right double arrow, ⇐ left double arrow.

[red]Block titles

Notes

  • Note 1.

  • Note 2.

Example 1. An example task

Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens.

  1. do this

  2. then do this

  3. finally do this

Table 1. Simple table
Header more

Cats

dogs

Mice

scorpions

A sample footnote is here.
[An example footnote.]

Advanced usage

Advanced

AsciiDoc supports many advanced features such as:

  • Creating a graphviz image

  • Adding callouts

  • QR code library

  • Macros to include system commands

  • Loading a CSV file into a table

  • Conditional inclusion macros

  • Embedding images in data-uri for XHTML output

Embed images in data-uri

This is built-in to AsciiDoc and enables you to convert your PNG images into base64 encodings that are included in the HTML output file. This avoids having to distribute the images files. Read the AsciiDoc documentation for instructions using :data-uri:.

Graphviz charts

This requires that you install Graphviz on the computer that generates output.

book_advanced__1.png
../images/test_sample2.png
../images/test_sample3.png

Callouts

Callouts functionality is built into AsciiDoc. Read the AsciiDoc documentation for instructions.

MS-DOS directory listing
-----------------------------------------------------
10/17/97   9:04         <DIR>    bin
10/16/97  14:11         <DIR>    DOS            1
10/16/97  14:40         <DIR>    Program Files
10/16/97  14:46         <DIR>    TEMP
10/17/97   9:04         <DIR>    tmp
10/16/97  14:37         <DIR>    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
11/16/97  17:17      61,865,984  pagefile.sys
 2/13/94   6:21           9,349  WINA20.386     3
-----------------------------------------------------
1 This directory holds MS-DOS.
2 System startup code for DOS.
3 Some sort of Windows 3.1 hack.

QR Code

This requires that you install qrencode and the qrcode plugin for AsciiDoc on the computer that generates output.

book_advanced__2.png

Macros

Run script on your system and incorporate that into the documentation.

-rw-r--r--  1 shawn  staff  2915 Nov 15 23:47 README.asciidoc
-rw-r--r--  1 shawn  staff  7572 Nov 16 01:32 sample_conversions.asciidoc

External scripts

For example, run an external script such as a pychart and then load the resulting image.

bar chart

Importing CSV data

ID Customer Name Contact Name Customer Address Phone

AROUT

Around the Horn

Thomas Hardy

120 Hanover Sq. London

(171) 555-7788

BERGS

Berglunds snabbkop

Christina Berglund

Berguvsvagen 8 Lulea

0921-12 34 65

BLAUS

Blauer See Delikatessen

Hanna Moos

Forsterstr. 57 Mannheim

0621-08460

BLONP

Blondel pere et fils

Frederique Citeaux

24, place Kleber Strasbourg

88.60.15.31

BOLID

Bolido Comidas preparadas

Martin Sommer

C/ Araquil, 67 Madrid

(91) 555 22 82

BONAP

Bon app'

Laurence Lebihan

12, rue des Bouchers Marseille

91.24.45.40

BOTTM

Bottom-Dollar Markets

Elizabeth Lincoln

23 Tsawassen Blvd. Tsawassen

(604) 555-4729

BSBEV

B’s Beverages

Victoria Ashworth

Fauntleroy Circus London

(171) 555-1212

CACTU

Cactus Comidas para llevar

Patricio Simpson

Cerrito 333 Buenos Aires

(1) 135-5555

Appendix A: Migration Notes

Here is some text

Glossary

Glossaries are optional. Glossary entries are an example of a style of AsciiDoc labeled lists.

A glossary term

The corresponding (indented) definition.

A second glossary term

The corresponding definition.

Index