-
Notifications
You must be signed in to change notification settings - Fork 0
/
asciidoc.html
9513 lines (9412 loc) · 318 KB
/
asciidoc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.4" />
<title>AsciiDoc User Guide</title>
<style type="text/css">
/* Sans-serif font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
div#toctitle,
span#author, span#revnumber, span#revdate, span#revremark,
div#footer {
font-family: Arial,Helvetica,sans-serif;
}
/* Serif font. */
div.sectionbody {
font-family: Georgia,"Times New Roman",Times,serif;
}
/* Monospace font. */
tt {
font-size: inherit;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
font-size: inherit;
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
}
div#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>AsciiDoc User Guide</h1>
<span id="author">Stuart Rackham</span><br />
<span id="email"><tt><<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>></tt></span><br />
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>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.</p></div>
<div class="sidebarblock">
<div class="content">
<div class="title">This document</div>
<div class="paragraph"><p>This is an overly large document, it probably needs to be refactored
into a Tutorial, Quick Reference and Formal Reference.</p></div>
<div class="paragraph"><p>If you’re new to AsciiDoc read this section and the <a href="#X6">Getting Started</a> section and take a look at the example AsciiDoc (<tt>*.txt</tt>)
source files in the distribution <tt>doc</tt> directory.</p></div>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_introduction">1. Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p>AsciiDoc is a plain text human readable/writable document format that
can be translated to DocBook or HTML using the <tt>asciidoc(1)</tt> command.
You can then either use <tt>asciidoc(1)</tt> generated HTML directly or run
<tt>asciidoc(1)</tt> DocBook output through your favorite DocBook toolchain or
use the AsciiDoc <tt>a2x(1)</tt> toolchain wrapper to produce PDF, EPUB, DVI,
LaTeX, PostScript, man page, HTML and text formats.</p></div>
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>AsciiDoc is light weight: it consists of a single Python script and a
bunch of configuration files. Apart from <tt>asciidoc(1)</tt> and a Python
interpreter, no other programs are required to convert AsciiDoc text
files to DocBook or HTML. See <a href="#X11">Example AsciiDoc Documents</a>
below.</p></div>
<div class="paragraph"><p>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 <tt>asciidoc(1)</tt> configuration files.
You can also create configuration files to translate AsciiDoc
documents to almost any SGML/XML markup.</p></div>
<div class="paragraph"><p><tt>asciidoc(1)</tt> comes with a set of configuration files to translate
AsciiDoc articles, books and man pages to HTML or DocBook backend
formats.</p></div>
<div class="sidebarblock">
<div class="content">
<div class="title">My AsciiDoc Itch</div>
<div class="paragraph"><p>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 — I found I was
spending more time typing markup tags, consulting reference manuals
and fixing syntax errors, than I was writing the documentation.</p></div>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="X6">2. Getting Started</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_installing_asciidoc">2.1. Installing AsciiDoc</h3>
<div class="paragraph"><p>See the <tt>README</tt> and <tt>INSTALL</tt> files for install prerequisites and
procedures. Packagers take a look at <a href="#X38">Packager Notes</a>.</p></div>
</div>
<div class="sect2">
<h3 id="X11">2.2. Example AsciiDoc Documents</h3>
<div class="paragraph"><p>The best way to quickly get a feel for AsciiDoc is to view the
AsciiDoc web site and/or distributed examples:</p></div>
<div class="ulist"><ul>
<li>
<p>
Take a look at the linked examples on the AsciiDoc web site home
page <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a>. Press the <em>Page Source</em> sidebar menu item to view
corresponding AsciiDoc source.
</p>
</li>
<li>
<p>
Read the <tt>*.txt</tt> source files in the distribution <tt>./doc</tt> directory
along with the corresponding HTML and DocBook XML files.
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_asciidoc_document_types">3. AsciiDoc Document Types</h2>
<div class="sectionbody">
<div class="paragraph"><p>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).</p></div>
<div class="paragraph"><p>Use the <tt>asciidoc(1)</tt> <tt>-d</tt> (<tt>--doctype</tt>) option to specify the AsciiDoc
document type — the default document type is <em>article</em>.</p></div>
<div class="paragraph"><p>By convention the <tt>.txt</tt> file extension is used for AsciiDoc document
source files.</p></div>
<div class="sect2">
<h3 id="_article">3.1. article</h3>
<div class="paragraph"><p>Used for short documents, articles and general documentation. See the
AsciiDoc distribution <tt>./doc/article.txt</tt> example.</p></div>
<div class="paragraph"><p>AsciiDoc defines standard DocBook article frontmatter and backmatter
<a href="#X93">section markup templates</a> (appendix, abstract, bibliography,
glossary, index).</p></div>
</div>
<div class="sect2">
<h3 id="_book">3.2. book</h3>
<div class="paragraph"><p>Books share the same format as articles, with the following
differences:</p></div>
<div class="ulist"><ul>
<li>
<p>
The part titles in multi-part books are <a href="#X17">top level titles</a>
(same level as book title).
</p>
</li>
<li>
<p>
Some sections are book specific e.g. preface and colophon.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Book documents will normally be used to produce DocBook output since
DocBook processors can automatically generate footnotes, table of
contents, list of tables, list of figures, list of examples and
indexes.</p></div>
<div class="paragraph"><p>AsciiDoc defines standard DocBook book frontmatter and backmatter
<a href="#X93">section markup templates</a> (appendix, dedication, preface,
bibliography, glossary, index, colophon).</p></div>
<div class="dlist"><div class="title">Example book documents</div><dl>
<dt class="hdlist1">
Book
</dt>
<dd>
<p>
The <tt>./doc/book.txt</tt> file in the AsciiDoc distribution.
</p>
</dd>
<dt class="hdlist1">
Multi-part book
</dt>
<dd>
<p>
The <tt>./doc/book-multi.txt</tt> file in the AsciiDoc distribution.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_manpage">3.3. manpage</h3>
<div class="paragraph"><p>Used to generate roff format UNIX manual pages. AsciiDoc manpage
documents observe special header title and section naming conventions — see the <a href="#X1">Manpage Documents</a> section for details.</p></div>
<div class="paragraph"><p>AsciiDoc defines the <em>synopsis</em> <a href="#X93">section markup template</a> to
generate the DocBook <tt>refsynopsisdiv</tt> section.</p></div>
<div class="paragraph"><p>See also the <tt>asciidoc(1)</tt> man page source (<tt>./doc/asciidoc.1.txt</tt>) from
the AsciiDoc distribution.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="X5">4. AsciiDoc Backends</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <tt>asciidoc(1)</tt> command translates an AsciiDoc formatted file to the
backend format specified by the <tt>-b</tt> (<tt>--backend</tt>) command-line
option. <tt>asciidoc(1)</tt> 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
<a href="#X88">Backend Attributes</a> section.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
docbook45
</dt>
<dd>
<p>
Outputs DocBook XML 4.5 markup.
</p>
</dd>
<dt class="hdlist1">
html4
</dt>
<dd>
<p>
This backend generates plain HTML 4.01 Transitional markup.
</p>
</dd>
<dt class="hdlist1">
xhtml11
</dt>
<dd>
<p>
This backend generates XHTML 1.1 markup styled with CSS2. Output
files have an <tt>.html</tt> extension.
</p>
</dd>
<dt class="hdlist1">
slidy
</dt>
<dd>
<p>
Use this backend to generate self-contained
<a href="http://www.w3.org/Talks/Tools/Slidy2/">Slidy</a> HTML slideshows for
your web browser from AsciiDoc documents. The Slidy backend is
documented in the distribution <tt>doc/slidy.txt</tt> file and
<a href="http://www.methods.co.nz/asciidoc/slidy.html">online</a>.
</p>
</dd>
<dt class="hdlist1">
wordpress
</dt>
<dd>
<p>
A minor variant of the <em>html4</em> backend to support
<a href="http://srackham.wordpress.com/blogpost1/">blogpost</a>.
</p>
</dd>
<dt class="hdlist1">
latex
</dt>
<dd>
<p>
Experimental LaTeX backend.
</p>
</dd>
</dl></div>
<div class="sect2">
<h3 id="_backend_aliases">4.1. Backend Aliases</h3>
<div class="paragraph"><p>Backend aliases are alternative names for AsciiDoc backends. AsciiDoc
comes with two backend aliases: <em>html</em> (aliased to <em>xhtml11</em>) and
<em>docbook</em> (aliased to <em>docbook45</em>).</p></div>
<div class="paragraph"><p>You can assign (or reassign) backend aliases by setting an AsciiDoc
attribute named like <tt>backend-alias-<alias></tt> to an AsciiDoc backend
name. For example, the following backend alias attribute definitions
appear in the <tt>[attributes]</tt> section of the global <tt>asciidoc.conf</tt>
configuration file:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>backend-alias-html=xhtml11
backend-alias-docbook=docbook45</tt></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_docbook">4.2. DocBook</h3>
<div class="paragraph"><p>AsciiDoc generates <em>article</em>, <em>book</em> and <em>refentry</em>
<a href="http://www.docbook.org/">DocBook</a> documents (corresponding to the
AsciiDoc <em>article</em>, <em>book</em> and <em>manpage</em> document types).</p></div>
<div class="paragraph"><p>DocBook documents are not designed to be viewed directly. Most Linux
distributions come with conversion tools (collectively called a
toolchain) for <a href="#X12">converting DocBook files</a> to presentation
formats such as Postscript, HTML, PDF, EPUB, DVI, PostScript, LaTeX,
roff (the native man page format), HTMLHelp, JavaHelp and text.</p></div>
</div>
<div class="sect2">
<h3 id="X35">4.3. XHTML Stylesheets</h3>
<div class="paragraph"><p>AsciiDoc XHTML output is styled using CSS2 stylesheets from the
distribution <tt>./stylesheets/</tt> directory.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/important.png" alt="Important" />
</td>
<td class="content">
<div class="paragraph"><p>All browsers have CSS quirks, but Microsoft’s IE6 has so many
omissions and errors that the <tt>xhtml11-quirks.css</tt> stylesheet and
<tt>xhtml11-quirks.conf</tt> configuration files are available for inclusion
during XHTML backend processing to to implement workarounds for IE6.
Set the AsciiDoc <em>quirks</em> attribute to enable AsciiDoc’s quirks mode,
for example with the <tt>--attribute quirks!</tt> command-line option.</p></div>
</td>
</tr></table>
</div>
<div class="paragraph"><p>Default <em>xhtml11</em> stylesheets:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<tt>./stylesheets/xhtml11.css</tt>
</dt>
<dd>
<p>
The main stylesheet.
</p>
</dd>
<dt class="hdlist1">
<tt>./stylesheets/xhtml11-manpage.css</tt>
</dt>
<dd>
<p>
Tweaks for manpage document type generation.
</p>
</dd>
<dt class="hdlist1">
<tt>./stylesheets/xhtml11-quirks.css</tt>
</dt>
<dd>
<p>
Stylesheet modifications to work around IE6 browser
incompatibilities.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Use the <em>theme</em> attribute to select an alternative set of stylesheets.
For example, the command-line option <tt>-a theme=foo</tt> will use
stylesheets <tt>foo.css</tt>, <tt>foo-manpage.css</tt> (and <tt>foo-quirks.css</tt> if
quirks mode is enabled) instead of the default stylesheets.</p></div>
<div class="paragraph"><p>Use the <em>stylesheet</em> attribute to include an additional stylesheet in
XHTML documents. For example, the command-line option <tt>-a
stylesheet=newsletter.css</tt> will use stylesheets <tt>newsletter.css</tt>.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_document_structure">5. Document Structure</h2>
<div class="sectionbody">
<div class="paragraph"><p>An AsciiDoc document consists of a series of <a href="#X8">block elements</a>
starting with an optional document Header, followed by an optional
Preamble, followed by zero or more document Sections.</p></div>
<div class="paragraph"><p>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.</p></div>
<div class="sect2">
<h3 id="_block_elements">5.1. Block Elements</h3>
<div class="paragraph"><p>Block elements consist of one or more lines of text and may contain
other block elements.</p></div>
<div class="paragraph"><p>The AsciiDoc block structure can be informally summarized as follows
<span class="footnote"><br />[This is a rough structural guide, not a rigorous syntax
definition]<br /></span>:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>Document ::= (Header?,Preamble?,Section*)
Header ::= (Title,(AuthorInfo,RevisionInfo?)?)
AuthorInfo ::= (FirstName,(MiddleName?,LastName)?,EmailAddress?)
RevisionInfo ::= (RevisionNumber?,RevisionDate,RevisionRemark?)
Preamble ::= (SectionBody)
Section ::= (Title,SectionBody?,(Section)*)
SectionBody ::= ((BlockTitle?,Block)|BlockMacro)+
Block ::= (Paragraph|DelimitedBlock|List|Table)
List ::= (BulletedList|NumberedList|LabeledList|CalloutList)
BulletedList ::= (ListItem)+
NumberedList ::= (ListItem)+
CalloutList ::= (ListItem)+
LabeledList ::= (ListEntry)+
ListEntry ::= (ListLabel,ListItem)
ListLabel ::= (ListTerm+)
ListItem ::= (ItemText,(List|ListParagraph|ListContinuation)*)</tt></pre>
</div></div>
<div class="paragraph"><p>Where:</p></div>
<div class="ulist"><ul>
<li>
<p>
<em>?</em> implies zero or one occurrence, <em>+</em> implies one or more
occurrences, <em>*</em> implies zero or more occurrences.
</p>
</li>
<li>
<p>
All block elements are separated by line boundaries.
</p>
</li>
<li>
<p>
<tt>BlockId</tt>, <tt>AttributeEntry</tt> and <tt>AttributeList</tt> block elements (not
shown) can occur almost anywhere.
</p>
</li>
<li>
<p>
There are a number of document type and backend specific
restrictions imposed on the block syntax.
</p>
</li>
<li>
<p>
The following elements cannot contain blank lines: Header, Title,
Paragraph, ItemText.
</p>
</li>
<li>
<p>
A ListParagraph is a Paragraph with its <em>listelement</em> option set.
</p>
</li>
<li>
<p>
A ListContinuation is a <a href="#X15">list continuation element</a>.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="X95">5.2. Header</h3>
<div class="paragraph"><p>The Header contains document meta-data, typically title plus optional
authorship and revision information:</p></div>
<div class="ulist"><ul>
<li>
<p>
The Header is optional, but if it is used it must start with a
document <a href="#X17">title</a>.
</p>
</li>
<li>
<p>
Optional Author and Revision information immediately follows the
header title.
</p>
</li>
<li>
<p>
The document header must be separated from the remainder of the
document by one or more blank lines and cannot contain blank lines.
</p>
</li>
<li>
<p>
The header can include comments.
</p>
</li>
<li>
<p>
The header can include <a href="#X18">attribute entries</a>, typically
<em>doctype</em>, <em>lang</em>, <em>encoding</em>, <em>icons</em>, <em>data-uri</em>, <em>toc</em>,
<em>numbered</em>.
</p>
</li>
<li>