git-scribe 0.0.4 → 0.0.5
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +1 -0
- data/Rakefile +31 -0
- data/SPEC.asciidoc +126 -0
- data/TODO.txt +29 -0
- data/bin/git-scribe +2 -1
- data/docbook-xsl/.CatalogManager.properties.example +61 -0
- data/docbook-xsl/.urilist +1 -0
- data/git-scribe.gemspec +32 -0
- data/lib/git-scribe.rb +21 -315
- data/lib/git-scribe/check.rb +60 -0
- data/lib/git-scribe/cli.rb +84 -0
- data/lib/git-scribe/generate.rb +222 -0
- data/lib/git-scribe/init.rb +16 -0
- data/lib/git-scribe/version.rb +3 -0
- data/template/.gitignore +1 -0
- data/template/.gitscribe +5 -0
- data/test/check_test.rb +12 -0
- data/test/gen_test.rb +78 -0
- data/test/init_test.rb +36 -0
- data/test/test_helper.rb +44 -0
- metadata +49 -161
- data/example/book/big.asc +0 -5604
- data/example/book/holmes.asc +0 -12983
- data/example/output/META-INF/container.xml +0 -6
- data/example/output/OEBPS/ar01s02.html +0 -15
- data/example/output/OEBPS/ar01s03.html +0 -3
- data/example/output/OEBPS/content.opf +0 -21
- data/example/output/OEBPS/index.html +0 -5
- data/example/output/OEBPS/toc.ncx +0 -37
- data/example/output/a_case_of_identity.html +0 -725
- data/example/output/a_example_appendix.html +0 -63
- data/example/output/a_migration_notes.html +0 -95
- data/example/output/apa.html +0 -20
- data/example/output/apb.html +0 -6
- data/example/output/apc.html +0 -24
- data/example/output/apd.html +0 -30
- data/example/output/ape.html +0 -26
- data/example/output/apf.html +0 -9
- data/example/output/apg.html +0 -42
- data/example/output/aph.html +0 -89
- data/example/output/ar01s02.html +0 -12
- data/example/output/ar01s03.html +0 -34
- data/example/output/ar01s04.html +0 -77
- data/example/output/ar01s05.html +0 -272
- data/example/output/ar01s06.html +0 -35
- data/example/output/ar01s07.html +0 -105
- data/example/output/ar01s08.html +0 -33
- data/example/output/ar01s09.html +0 -12
- data/example/output/ar01s10.html +0 -14
- data/example/output/ar01s11.html +0 -34
- data/example/output/ar01s12.html +0 -63
- data/example/output/ar01s13.html +0 -156
- data/example/output/ar01s14.html +0 -330
- data/example/output/ar01s15.html +0 -22
- data/example/output/ar01s16.html +0 -27
- data/example/output/ar01s17.html +0 -94
- data/example/output/ar01s18.html +0 -359
- data/example/output/ar01s19.html +0 -373
- data/example/output/ar01s20.html +0 -27
- data/example/output/ar01s21.html +0 -33
- data/example/output/ar01s22.html +0 -351
- data/example/output/ar01s23.html +0 -21
- data/example/output/ar01s24.html +0 -69
- data/example/output/ar01s25.html +0 -60
- data/example/output/ar01s26.html +0 -217
- data/example/output/ar01s27.html +0 -88
- data/example/output/ar01s28.html +0 -237
- data/example/output/ar01s29.html +0 -68
- data/example/output/ar01s30.html +0 -154
- data/example/output/ar01s31.html +0 -6
- data/example/output/ar01s32.html +0 -22
- data/example/output/ar01s33.html +0 -209
- data/example/output/asciidoc_backends.html +0 -190
- data/example/output/asciidoc_document_types.html +0 -131
- data/example/output/attribute_entries.html +0 -185
- data/example/output/attribute_lists.html +0 -157
- data/example/output/attribute_references.html +0 -414
- data/example/output/attributelist_element.html +0 -143
- data/example/output/b_packager_notes.html +0 -68
- data/example/output/bi01.html +0 -18
- data/example/output/big.asc +0 -5604
- data/example/output/block_element_definitions.html +0 -448
- data/example/output/block_titles.html +0 -83
- data/example/output/blockid_element.html +0 -80
- data/example/output/book.asc +0 -5604
- data/example/output/book.epub +0 -0
- data/example/output/book.fo +0 -3788
- data/example/output/book.html +0 -8793
- data/example/output/book.xml +0 -8265
- data/example/output/c_asciidoc_safe_mode.html +0 -105
- data/example/output/callouts.html +0 -214
- data/example/output/catalog +0 -10
- data/example/output/colophon.html +0 -397
- data/example/output/configuration_files.html +0 -672
- data/example/output/converting_docbook_to_other_file_formats.html +0 -324
- data/example/output/d_using_asciidoc_with_non-english_languages.html +0 -107
- data/example/output/delimited_blocks.html +0 -455
- data/example/output/document_attributes.html +0 -95
- data/example/output/document_processing.html +0 -116
- data/example/output/document_structure.html +0 -493
- data/example/output/e_vim_syntax_highlighter.html +0 -111
- data/example/output/example_bibliography.html +0 -82
- data/example/output/example_colophon.html +0 -58
- data/example/output/example_glossary.html +0 -73
- data/example/output/example_index.html +0 -108
- data/example/output/f_attribute_options.html +0 -129
- data/example/output/filters.html +0 -179
- data/example/output/footnotes.html +0 -103
- data/example/output/g_diagnostics.html +0 -148
- data/example/output/generating_plain_text_files.html +0 -68
- data/example/output/getting_started.html +0 -87
- data/example/output/glossary.html +0 -95
- data/example/output/go01.html +0 -24
- data/example/output/h_backend_attributes.html +0 -308
- data/example/output/help_commands.html +0 -96
- data/example/output/holmes.asc +0 -12983
- data/example/output/image/octocat_professor.png +0 -0
- data/example/output/include/hello.c +0 -10
- data/example/output/index.html +0 -656
- data/example/output/indexes.html +0 -104
- data/example/output/intrinsic_attributes.html +0 -165
- data/example/output/ix01.html +0 -3
- data/example/output/lists.html +0 -666
- data/example/output/macros.html +0 -737
- data/example/output/manpage_documents.html +0 -124
- data/example/output/master.css +0 -281
- data/example/output/mathematical_formulas.html +0 -125
- data/example/output/page.html +0 -60
- data/example/output/paragraphs.html +0 -192
- data/example/output/pr01.html +0 -3
- data/example/output/source_code_highlighting.html +0 -59
- data/example/output/stylesheets/handbookish-quirks.css +0 -0
- data/example/output/stylesheets/handbookish.css +0 -233
- data/example/output/tables.html +0 -797
- data/example/output/text_formatting.html +0 -273
- data/example/output/the_adventure_of_the_beryl_coronet.html +0 -968
- data/example/output/the_adventure_of_the_blue_carbuncle.html +0 -825
- data/example/output/the_adventure_of_the_copper_beeches.html +0 -998
- data/example/output/the_adventure_of_the_engineer_s_thumb.html +0 -851
- data/example/output/the_adventure_of_the_noble_bachelor.html +0 -861
- data/example/output/the_adventure_of_the_speckled_band.html +0 -1015
- data/example/output/the_boscombe_valley_mystery.html +0 -974
- data/example/output/the_first_chapter.html +0 -110
- data/example/output/the_five_orange_pips.html +0 -776
- data/example/output/the_man_with_the_twisted_lip.html +0 -946
- data/example/output/the_red-headed_league.html +0 -950
- data/example/output/the_second_chapter.html +0 -95
- data/example/output/the_third_chapter.html +0 -58
- data/example/output/tips_and_tricks.html +0 -452
- data/example/output/title.html +0 -120
- data/example/output/titles.html +0 -126
data/example/output/indexes.html
DELETED
@@ -1,104 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
2
|
-
<html xmlns="http://www.w3.org/1999/xhtml">
|
3
|
-
<head>
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
5
|
-
<link rel="stylesheet" href="master.css" type="text/css" />
|
6
|
-
<title>Indexes</title>
|
7
|
-
</head>
|
8
|
-
|
9
|
-
<body>
|
10
|
-
<div class="nav" id="navheader">
|
11
|
-
<table width="100%">
|
12
|
-
<tr><td width="33%" align="left">
|
13
|
-
|
14
|
-
<a href="footnotes.html">Prev</a><br/>
|
15
|
-
Footnotes
|
16
|
-
|
17
|
-
</td><td width="33%" align="center">
|
18
|
-
|
19
|
-
<a href="index.html">Home</a><br/>
|
20
|
-
<strong>AsciiDoc User Guide</strong>
|
21
|
-
|
22
|
-
</td><td width="33%" align="right">
|
23
|
-
|
24
|
-
<a href="callouts.html">Next</a><br/>
|
25
|
-
Callouts
|
26
|
-
|
27
|
-
</td></tr>
|
28
|
-
</table>
|
29
|
-
</div>
|
30
|
-
|
31
|
-
<hr/>
|
32
|
-
|
33
|
-
<div class="content">
|
34
|
-
<div class="section" lang="en" xml:lang="en">
|
35
|
-
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
36
|
-
<a id="_indexes"></a>Indexes</h2></div></div></div>
|
37
|
-
<p>The shipped AsciiDoc configuration includes the inline macros for
|
38
|
-
generating DocBook index entries.</p>
|
39
|
-
<div class="variablelist"><dl>
|
40
|
-
<dt>
|
41
|
-
<span class="term">
|
42
|
-
<code class="literal">indexterm:[<primary>,<secondary>,<tertiary>]</code>
|
43
|
-
, </span><span class="term">
|
44
|
-
<code class="literal">(((<primary>,<secondary>,<tertiary>)))</code>
|
45
|
-
</span>
|
46
|
-
</dt>
|
47
|
-
<dd>
|
48
|
-
This inline macro generates an index term (the <code class="literal"><secondary></code> and
|
49
|
-
<code class="literal"><tertiary></code> positional attributes are optional). Example:
|
50
|
-
<code class="literal">indexterm:[Tigers,Big cats]</code> (or, using the alternative syntax
|
51
|
-
<code class="literal">(((Tigers,Big cats)))</code>. Index terms that have secondary and
|
52
|
-
tertiary entries also generate separate index terms for the
|
53
|
-
secondary and tertiary entries. The index terms appear in the
|
54
|
-
index, not the primary text flow.
|
55
|
-
</dd>
|
56
|
-
<dt>
|
57
|
-
<span class="term">
|
58
|
-
<code class="literal">indexterm2:[<primary>]</code>
|
59
|
-
, </span><span class="term">
|
60
|
-
<code class="literal">((<primary>))</code>
|
61
|
-
</span>
|
62
|
-
</dt>
|
63
|
-
<dd>
|
64
|
-
This inline macro generates an index term that appears in both the
|
65
|
-
index and the primary text flow. The <code class="literal"><primary></code> should not be
|
66
|
-
padded to the left or right with white space characters.
|
67
|
-
</dd>
|
68
|
-
</dl></div>
|
69
|
-
<p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in
|
70
|
-
the AsciiDoc <code class="literal">./doc</code> distribution directory.</p>
|
71
|
-
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
|
72
|
-
<h3 class="title">Note</h3>
|
73
|
-
<p>Index entries only really make sense if you are generating
|
74
|
-
DocBook markup — DocBook conversion programs automatically generate
|
75
|
-
an index at the point an <span class="emphasis"><em>Index</em></span> section appears in source document.</p>
|
76
|
-
</div>
|
77
|
-
</div>
|
78
|
-
|
79
|
-
</div>
|
80
|
-
|
81
|
-
<hr/>
|
82
|
-
|
83
|
-
<div class="nav" id="navfooter">
|
84
|
-
<table width="100%">
|
85
|
-
<tr><td width="33%" align="left">
|
86
|
-
|
87
|
-
<a href="footnotes.html">Prev</a><br/>
|
88
|
-
Footnotes
|
89
|
-
|
90
|
-
</td><td width="33%" align="center">
|
91
|
-
|
92
|
-
<a href="index.html">Home</a><br/>
|
93
|
-
AsciiDoc User Guide
|
94
|
-
|
95
|
-
</td><td width="33%" align="right">
|
96
|
-
|
97
|
-
<a href="callouts.html">Next</a><br/>
|
98
|
-
Callouts
|
99
|
-
|
100
|
-
</td></tr>
|
101
|
-
</table>
|
102
|
-
</div>
|
103
|
-
</body>
|
104
|
-
</html>
|
@@ -1,165 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
2
|
-
<html xmlns="http://www.w3.org/1999/xhtml">
|
3
|
-
<head>
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
5
|
-
<link rel="stylesheet" href="master.css" type="text/css" />
|
6
|
-
<title>Intrinsic Attributes</title>
|
7
|
-
</head>
|
8
|
-
|
9
|
-
<body>
|
10
|
-
<div class="nav" id="navheader">
|
11
|
-
<table width="100%">
|
12
|
-
<tr><td width="33%" align="left">
|
13
|
-
|
14
|
-
<a href="attribute_references.html">Prev</a><br/>
|
15
|
-
Attribute References
|
16
|
-
|
17
|
-
</td><td width="33%" align="center">
|
18
|
-
|
19
|
-
<a href="index.html">Home</a><br/>
|
20
|
-
<strong>AsciiDoc User Guide</strong>
|
21
|
-
|
22
|
-
</td><td width="33%" align="right">
|
23
|
-
|
24
|
-
<a href="block_element_definitions.html">Next</a><br/>
|
25
|
-
Block Element Definitions
|
26
|
-
|
27
|
-
</td></tr>
|
28
|
-
</table>
|
29
|
-
</div>
|
30
|
-
|
31
|
-
<hr/>
|
32
|
-
|
33
|
-
<div class="content">
|
34
|
-
<div class="section" lang="en" xml:lang="en">
|
35
|
-
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
36
|
-
<a id="X60"></a>Intrinsic Attributes</h2></div></div></div>
|
37
|
-
<p>Intrinsic attributes are simple attributes that are created
|
38
|
-
automatically from: AsciiDoc document header parameters; asciidoc(1)
|
39
|
-
command-line arguments; attributes defined in the default
|
40
|
-
configuration files; the execution context. Here’s the list of
|
41
|
-
predefined intrinsic attributes:</p>
|
42
|
-
<pre class="literallayout">{amp} ampersand (&) character entity
|
43
|
-
{asciidoc-dir} the asciidoc(1) application directory
|
44
|
-
{asciidoc-file} the full path name of the asciidoc(1) script
|
45
|
-
{asciidoc-version} the version of asciidoc(1)
|
46
|
-
{author} author's full name
|
47
|
-
{authored} empty string '' if {author} or {email} defined,
|
48
|
-
{authorinitials} author initials (from document header)
|
49
|
-
{backend-<backend>} empty string ''
|
50
|
-
{<backend>-<doctype>} empty string ''
|
51
|
-
{backend} document backend specified by `-b` option
|
52
|
-
{backslash} backslash character
|
53
|
-
{basebackend-<base>} empty string ''
|
54
|
-
{basebackend} html or docbook
|
55
|
-
{brvbar} broken vertical bar (|) character
|
56
|
-
{revdate} document revision date (from document header)
|
57
|
-
{docdate} document last modified date
|
58
|
-
{doctime} document last modified time
|
59
|
-
{docname} document file name without extension
|
60
|
-
{docfile} document file name (note 5)
|
61
|
-
{docdir} document input directory name (note 5)
|
62
|
-
{doctitle} document title (from document header)
|
63
|
-
{doctype-<doctype>} empty string ''
|
64
|
-
{doctype} document type specified by `-d` option
|
65
|
-
{email} author's email address (from document header)
|
66
|
-
{empty} empty string ''
|
67
|
-
{encoding} specifies input and output encoding
|
68
|
-
{filetype-<fileext>} empty string ''
|
69
|
-
{filetype} output file name file extension
|
70
|
-
{firstname} author first name (from document header)
|
71
|
-
{gt} greater than (>) character entity
|
72
|
-
{id} running block id generated by BlockId elements
|
73
|
-
{indir} input file directory name (note 2,5)
|
74
|
-
{infile} input file name (note 2,5)
|
75
|
-
{lastname} author last name (from document header)
|
76
|
-
{level} title level 1..4 (in section titles)
|
77
|
-
{listindex} the list index (1..) of the most recent list item
|
78
|
-
{localdate} the current date
|
79
|
-
{localtime} the current time
|
80
|
-
{lt} less than (<) character entity
|
81
|
-
{manname} manpage name (defined in NAME section)
|
82
|
-
{manpurpose} manpage (defined in NAME section)
|
83
|
-
{mantitle} document title minus the manpage volume number
|
84
|
-
{manvolnum} manpage volume number (1..8) (from document header)
|
85
|
-
{middlename} author middle name (from document header)
|
86
|
-
{nbsp} non-breaking space character entity
|
87
|
-
{notitle} do not display the document title
|
88
|
-
{outdir} document output directory name (note 2)
|
89
|
-
{outfile} output file name (note 2)
|
90
|
-
{reftext} running block xreflabel generated by BlockId elements
|
91
|
-
{revnumber} document revision number (from document header)
|
92
|
-
{sectnum} formatted section number (in section titles)
|
93
|
-
{showcomments} send comment lines to the output
|
94
|
-
{title} section title (in titled elements)
|
95
|
-
{two-colons} Two colon characters
|
96
|
-
{two-semicolons} Two semicolon characters
|
97
|
-
{user-dir} the ~/.asciidoc directory (if it exists)
|
98
|
-
{verbose} defined as '' if --verbose command option specified
|
99
|
-
{zwsp} Zero-width space character entity</pre>
|
100
|
-
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
|
101
|
-
<h3 class="title">Note</h3>
|
102
|
-
<div class="orderedlist"><ol type="1">
|
103
|
-
<li>
|
104
|
-
Intrinsic attributes are global so avoid defining custom attributes
|
105
|
-
with the same names.
|
106
|
-
</li>
|
107
|
-
<li>
|
108
|
-
<code class="literal">{outfile}</code>, <code class="literal">{outdir}</code>, <code class="literal">{infile}</code>, <code class="literal">{indir}</code> attributes are
|
109
|
-
effectively read-only (you can set them but it won’t affect the
|
110
|
-
input or output file paths).
|
111
|
-
</li>
|
112
|
-
<li>
|
113
|
-
See also the <a class="link" href="h_backend_attributes.html" title="H. Backend Attributes">Backend Attributes</a> section for attributes
|
114
|
-
that relate to AsciiDoc XHTML file generation.
|
115
|
-
</li>
|
116
|
-
<li>
|
117
|
-
The entries that translate to blank strings are designed to be used
|
118
|
-
for conditional text inclusion. You can also use the <code class="literal">ifdef</code>,
|
119
|
-
<code class="literal">ifndef</code> and <code class="literal">endif</code> System macros for conditional inclusion.
|
120
|
-
<sup>[<a id="id36128467" href="#ftn.id36128467" class="footnote">4</a>]</sup>
|
121
|
-
</li>
|
122
|
-
<li>
|
123
|
-
<code class="literal">{docfile}</code> and <code class="literal">{docdir}</code> refer to root document specified on
|
124
|
-
the asciidoc(1) command-line; <code class="literal">{infile}</code> and <code class="literal">{indir}</code> refer to
|
125
|
-
the current input file which may be the root document or an
|
126
|
-
included file. When the input is being read from the standard
|
127
|
-
input (<code class="literal">stdin</code>) these attributes are undefined.
|
128
|
-
</li>
|
129
|
-
</ol></div>
|
130
|
-
</div>
|
131
|
-
<div class="footnotes">
|
132
|
-
<br><hr width="100" align="left">
|
133
|
-
<div class="footnote"><p><sup>[<a id="ftn.id36128467" href="#id36128467" class="simpara">4</a>] </sup>Conditional inclusion using <code class="literal">ifdef</code> and <code class="literal">ifndef</code> macros
|
134
|
-
differs from attribute conditional inclusion in that the former
|
135
|
-
occurs when the file is read while the latter occurs when the
|
136
|
-
contents are written.</p></div>
|
137
|
-
</div>
|
138
|
-
</div>
|
139
|
-
|
140
|
-
</div>
|
141
|
-
|
142
|
-
<hr/>
|
143
|
-
|
144
|
-
<div class="nav" id="navfooter">
|
145
|
-
<table width="100%">
|
146
|
-
<tr><td width="33%" align="left">
|
147
|
-
|
148
|
-
<a href="attribute_references.html">Prev</a><br/>
|
149
|
-
Attribute References
|
150
|
-
|
151
|
-
</td><td width="33%" align="center">
|
152
|
-
|
153
|
-
<a href="index.html">Home</a><br/>
|
154
|
-
AsciiDoc User Guide
|
155
|
-
|
156
|
-
</td><td width="33%" align="right">
|
157
|
-
|
158
|
-
<a href="block_element_definitions.html">Next</a><br/>
|
159
|
-
Block Element Definitions
|
160
|
-
|
161
|
-
</td></tr>
|
162
|
-
</table>
|
163
|
-
</div>
|
164
|
-
</body>
|
165
|
-
</html>
|
data/example/output/ix01.html
DELETED
@@ -1,3 +0,0 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
2
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Example Index</title><link rel="stylesheet" href="stylesheets/handbookish.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.1" /><link rel="home" href="index.html" title="Book Title Goes Here" /><link rel="up" href="index.html" title="Book Title Goes Here" /><link rel="prev" href="ar01s05.html" title="Example Colophon" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Example Index</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s05.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a id="_example_index"></a>Example Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>B</h3><dl><dt>Bengal Tiger, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt><dt>Big cats</dt><dd><dl><dt>Lions, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>E</h3><dl><dt>Example index entry, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>L</h3><dl><dt>Lions, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>M</h3><dl><dt>monkeys, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>Second example index entry, <a class="indexterm" href="ar01s03.html">The Second Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>T</h3><dl><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="ar01s02.html">The First Chapter</a></dt></dl></dd></dl></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s05.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Example Colophon </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
|
data/example/output/lists.html
DELETED
@@ -1,666 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
2
|
-
<html xmlns="http://www.w3.org/1999/xhtml">
|
3
|
-
<head>
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
5
|
-
<link rel="stylesheet" href="master.css" type="text/css" />
|
6
|
-
<title>Lists</title>
|
7
|
-
</head>
|
8
|
-
|
9
|
-
<body>
|
10
|
-
<div class="nav" id="navheader">
|
11
|
-
<table width="100%">
|
12
|
-
<tr><td width="33%" align="left">
|
13
|
-
|
14
|
-
<a href="delimited_blocks.html">Prev</a><br/>
|
15
|
-
Delimited Blocks
|
16
|
-
|
17
|
-
</td><td width="33%" align="center">
|
18
|
-
|
19
|
-
<a href="index.html">Home</a><br/>
|
20
|
-
<strong>AsciiDoc User Guide</strong>
|
21
|
-
|
22
|
-
</td><td width="33%" align="right">
|
23
|
-
|
24
|
-
<a href="footnotes.html">Next</a><br/>
|
25
|
-
Footnotes
|
26
|
-
|
27
|
-
</td></tr>
|
28
|
-
</table>
|
29
|
-
</div>
|
30
|
-
|
31
|
-
<hr/>
|
32
|
-
|
33
|
-
<div class="content">
|
34
|
-
<div class="section" lang="en" xml:lang="en">
|
35
|
-
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
36
|
-
<a id="X64"></a>Lists</h2></div></div></div>
|
37
|
-
<div class="itemizedlist">
|
38
|
-
<p class="title"><b>List types</b></p>
|
39
|
-
<ul type="disc">
|
40
|
-
<li>
|
41
|
-
Bulleted lists. Also known as itemized or unordered lists.
|
42
|
-
</li>
|
43
|
-
<li>
|
44
|
-
Numbered lists. Also called ordered lists.
|
45
|
-
</li>
|
46
|
-
<li>
|
47
|
-
Labeled lists. Sometimes called variable or definition lists.
|
48
|
-
</li>
|
49
|
-
<li>
|
50
|
-
Callout lists (a list of callout annotations).
|
51
|
-
</li>
|
52
|
-
</ul>
|
53
|
-
</div>
|
54
|
-
<div class="itemizedlist">
|
55
|
-
<p class="title"><b>List behavior</b></p>
|
56
|
-
<ul type="disc">
|
57
|
-
<li>
|
58
|
-
List item indentation is optional and does not determine nesting,
|
59
|
-
indentation does however make the source more readable.
|
60
|
-
</li>
|
61
|
-
<li>
|
62
|
-
Another list or a literal paragraph immediately following a list
|
63
|
-
item will be implicitly included in the list item; use <a class="link" href="lists.html#X15" title="List Item Continuation">list item continuation</a> to explicitly append other block elements to a
|
64
|
-
list item.
|
65
|
-
</li>
|
66
|
-
<li>
|
67
|
-
A comment block or a comment line block macro element will terminate
|
68
|
-
a list — use inline comment lines to put comments inside lists.
|
69
|
-
</li>
|
70
|
-
<li>
|
71
|
-
The <code class="literal">listindex</code> <a class="link" href="intrinsic_attributes.html" title="Intrinsic Attributes">intrinsic attribute</a> is the current list item
|
72
|
-
index (1..). If this attribute is used outside a list then it’s value
|
73
|
-
is the number of items in the most recently closed list. Useful for
|
74
|
-
displaying the number of items in a list.
|
75
|
-
</li>
|
76
|
-
</ul>
|
77
|
-
</div>
|
78
|
-
<div class="section" lang="en" xml:lang="en">
|
79
|
-
<div class="titlepage"><div><div><h3 class="title">
|
80
|
-
<a id="_bulleted_lists"></a>Bulleted Lists</h3></div></div></div>
|
81
|
-
<p>Bulleted list items start with a single dash or one to five asterisks
|
82
|
-
followed by some white space then some text. Bulleted list syntaxes
|
83
|
-
are:</p>
|
84
|
-
<pre class="literallayout">- List item.
|
85
|
-
* List item.
|
86
|
-
** List item.
|
87
|
-
*** List item.
|
88
|
-
**** List item.
|
89
|
-
***** List item.</pre>
|
90
|
-
</div>
|
91
|
-
<div class="section" lang="en" xml:lang="en">
|
92
|
-
<div class="titlepage"><div><div><h3 class="title">
|
93
|
-
<a id="_numbered_lists"></a>Numbered Lists</h3></div></div></div>
|
94
|
-
<p>List item numbers are explicit or implicit.</p>
|
95
|
-
<p><b>Explicit numbering. </b>List items begin with a number followed by some white space then the
|
96
|
-
item text. The numbers can be decimal (arabic), roman (upper or lower
|
97
|
-
case) or alpha (upper or lower case). Decimal and alpha numbers are
|
98
|
-
terminated with a period, roman numbers are terminated with a closing
|
99
|
-
parenthesis. The different terminators are necessary to ensure <span class="emphasis"><em>i</em></span>,
|
100
|
-
<span class="emphasis"><em>v</em></span> and <span class="emphasis"><em>x</em></span> roman numbers are are distinguishable from <span class="emphasis"><em>x</em></span>, <span class="emphasis"><em>v</em></span> and
|
101
|
-
<span class="emphasis"><em>x</em></span> alpha numbers. Examples:</p>
|
102
|
-
<pre class="literallayout">1. Arabic (decimal) numbered list item.
|
103
|
-
a. Lower case alpha (letter) numbered list item.
|
104
|
-
F. Upper case alpha (letter) numbered list item.
|
105
|
-
iii) Lower case roman numbered list item.
|
106
|
-
IX) Upper case roman numbered list item.</pre>
|
107
|
-
<p><b>Implicit numbering. </b>List items begin one to five period characters, followed by some white
|
108
|
-
space then the item text. Examples:</p>
|
109
|
-
<pre class="literallayout">. Arabic (decimal) numbered list item.
|
110
|
-
.. Lower case alpha (letter) numbered list item.
|
111
|
-
... Lower case roman numbered list item.
|
112
|
-
.... Upper case alpha (letter) numbered list item.
|
113
|
-
..... Upper case roman numbered list item.</pre>
|
114
|
-
<p>You can use the <span class="emphasis"><em>style</em></span> attribute (also the first positional
|
115
|
-
attribute) to specify an alternative numbering style. The numbered
|
116
|
-
list style can be one of the following values: <span class="emphasis"><em>arabic</em></span>, <span class="emphasis"><em>loweralpha</em></span>,
|
117
|
-
<span class="emphasis"><em>upperalpha</em></span>, <span class="emphasis"><em>lowerroman</em></span>, <span class="emphasis"><em>upperroman</em></span>.</p>
|
118
|
-
<p>Here are some examples of bulleted and numbered lists:</p>
|
119
|
-
<pre class="screen">- Praesent eget purus quis magna eleifend eleifend.
|
120
|
-
1. Fusce euismod commodo velit.
|
121
|
-
a. Fusce euismod commodo velit.
|
122
|
-
b. Vivamus fringilla mi eu lacus.
|
123
|
-
c. Donec eget arcu bibendum nunc consequat lobortis.
|
124
|
-
2. Vivamus fringilla mi eu lacus.
|
125
|
-
i) Fusce euismod commodo velit.
|
126
|
-
ii) Vivamus fringilla mi eu lacus.
|
127
|
-
3. Donec eget arcu bibendum nunc consequat lobortis.
|
128
|
-
4. Nam fermentum mattis ante.
|
129
|
-
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
|
130
|
-
* Fusce euismod commodo velit.
|
131
|
-
** Qui in magna commodo, est labitur dolorum an. Est ne magna primis
|
132
|
-
adolescens. Sit munere ponderum dignissim et. Minim luptatum et
|
133
|
-
vel.
|
134
|
-
** Vivamus fringilla mi eu lacus.
|
135
|
-
* Donec eget arcu bibendum nunc consequat lobortis.
|
136
|
-
- Nulla porttitor vulputate libero.
|
137
|
-
. Fusce euismod commodo velit.
|
138
|
-
. Vivamus fringilla mi eu lacus.
|
139
|
-
[upperroman]
|
140
|
-
.. Fusce euismod commodo velit.
|
141
|
-
.. Vivamus fringilla mi eu lacus.
|
142
|
-
. Donec eget arcu bibendum nunc consequat lobortis.</pre>
|
143
|
-
<p>Which render as:</p>
|
144
|
-
<div class="itemizedlist"><ul type="disc">
|
145
|
-
<li>
|
146
|
-
<p>
|
147
|
-
Praesent eget purus quis magna eleifend eleifend.
|
148
|
-
</p>
|
149
|
-
<div class="orderedlist"><ol type="1">
|
150
|
-
<li>
|
151
|
-
<p>
|
152
|
-
Fusce euismod commodo velit.
|
153
|
-
</p>
|
154
|
-
<div class="orderedlist"><ol type="a">
|
155
|
-
<li>
|
156
|
-
Fusce euismod commodo velit.
|
157
|
-
</li>
|
158
|
-
<li>
|
159
|
-
Vivamus fringilla mi eu lacus.
|
160
|
-
</li>
|
161
|
-
<li>
|
162
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
163
|
-
</li>
|
164
|
-
</ol></div>
|
165
|
-
</li>
|
166
|
-
<li>
|
167
|
-
<p>
|
168
|
-
Vivamus fringilla mi eu lacus.
|
169
|
-
</p>
|
170
|
-
<div class="orderedlist"><ol type="i">
|
171
|
-
<li>
|
172
|
-
Fusce euismod commodo velit.
|
173
|
-
</li>
|
174
|
-
<li>
|
175
|
-
Vivamus fringilla mi eu lacus.
|
176
|
-
</li>
|
177
|
-
</ol></div>
|
178
|
-
</li>
|
179
|
-
<li>
|
180
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
181
|
-
</li>
|
182
|
-
<li>
|
183
|
-
Nam fermentum mattis ante.
|
184
|
-
</li>
|
185
|
-
</ol></div>
|
186
|
-
</li>
|
187
|
-
<li>
|
188
|
-
<p>
|
189
|
-
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
|
190
|
-
</p>
|
191
|
-
<div class="itemizedlist"><ul type="circle">
|
192
|
-
<li>
|
193
|
-
<p>
|
194
|
-
Fusce euismod commodo velit.
|
195
|
-
</p>
|
196
|
-
<div class="itemizedlist"><ul type="square">
|
197
|
-
<li>
|
198
|
-
Qui in magna commodo, est labitur dolorum an. Est ne magna primis
|
199
|
-
adolescens. Sit munere ponderum dignissim et. Minim luptatum et
|
200
|
-
vel.
|
201
|
-
</li>
|
202
|
-
<li>
|
203
|
-
Vivamus fringilla mi eu lacus.
|
204
|
-
</li>
|
205
|
-
</ul></div>
|
206
|
-
</li>
|
207
|
-
<li>
|
208
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
209
|
-
</li>
|
210
|
-
</ul></div>
|
211
|
-
</li>
|
212
|
-
<li>
|
213
|
-
<p>
|
214
|
-
Nulla porttitor vulputate libero.
|
215
|
-
</p>
|
216
|
-
<div class="orderedlist"><ol type="1">
|
217
|
-
<li>
|
218
|
-
Fusce euismod commodo velit.
|
219
|
-
</li>
|
220
|
-
<li>
|
221
|
-
<p>
|
222
|
-
Vivamus fringilla mi eu lacus.
|
223
|
-
</p>
|
224
|
-
<div class="orderedlist"><ol type="I">
|
225
|
-
<li>
|
226
|
-
Fusce euismod commodo velit.
|
227
|
-
</li>
|
228
|
-
<li>
|
229
|
-
Vivamus fringilla mi eu lacus.
|
230
|
-
</li>
|
231
|
-
</ol></div>
|
232
|
-
</li>
|
233
|
-
<li>
|
234
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
235
|
-
</li>
|
236
|
-
</ol></div>
|
237
|
-
</li>
|
238
|
-
</ul></div>
|
239
|
-
<p>A predefined <span class="emphasis"><em>compact</em></span> option is available to bulleted and numbered
|
240
|
-
lists — this translates to the DocBook <span class="emphasis"><em>spacing="compact"</em></span> lists
|
241
|
-
attribute which may or may not be processed by the DocBook toolchain.
|
242
|
-
Example:</p>
|
243
|
-
<pre class="literallayout">[options="compact"]
|
244
|
-
- Compact list item.
|
245
|
-
- Another compact list item.</pre>
|
246
|
-
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
|
247
|
-
<h3 class="title">Tip</h3>
|
248
|
-
<p>To apply the <span class="emphasis"><em>compact</em></span> option globally define a document-wide
|
249
|
-
<span class="emphasis"><em>compact-option</em></span> attribute, e.g. using the <code class="literal">-a compact-option</code>
|
250
|
-
command-line option.</p>
|
251
|
-
</div>
|
252
|
-
<p>You can set the list start number using the <span class="emphasis"><em>start</em></span> attribute (works
|
253
|
-
for HTML outputs and DocBook outputs processed by DocBook XSL
|
254
|
-
Stylesheets). Example:</p>
|
255
|
-
<pre class="literallayout">[start=7]
|
256
|
-
. List item 7.
|
257
|
-
. List item 8.</pre>
|
258
|
-
</div>
|
259
|
-
<div class="section" lang="en" xml:lang="en">
|
260
|
-
<div class="titlepage"><div><div><h3 class="title">
|
261
|
-
<a id="_labeled_lists"></a>Labeled Lists</h3></div></div></div>
|
262
|
-
<p>Labeled list items consist of one or more text labels followed by the
|
263
|
-
text of the list item.</p>
|
264
|
-
<p>An item label begins a line with an alphanumeric character hard
|
265
|
-
against the left margin and ends with two, three or four colons or two
|
266
|
-
semi-colons. A list item can have multiple labels, one per line.</p>
|
267
|
-
<p>The list item text consists of one or more lines of text starting
|
268
|
-
after the last label (either on the same line or a new line) and can
|
269
|
-
be followed by nested List or ListParagraph elements. Item text can be
|
270
|
-
optionally indented.</p>
|
271
|
-
<p>Here are some examples:</p>
|
272
|
-
<pre class="screen">In::
|
273
|
-
Lorem::
|
274
|
-
Fusce euismod commodo velit.
|
275
|
-
|
276
|
-
Fusce euismod commodo velit.
|
277
|
-
|
278
|
-
Ipsum:: Vivamus fringilla mi eu lacus.
|
279
|
-
* Vivamus fringilla mi eu lacus.
|
280
|
-
* Donec eget arcu bibendum nunc consequat lobortis.
|
281
|
-
Dolor::
|
282
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
283
|
-
Suspendisse;;
|
284
|
-
A massa id sem aliquam auctor.
|
285
|
-
Morbi;;
|
286
|
-
Pretium nulla vel lorem.
|
287
|
-
In;;
|
288
|
-
Dictum mauris in urna.
|
289
|
-
Vivamus::: Fringilla mi eu lacus.
|
290
|
-
Donec::: Eget arcu bibendum nunc consequat lobortis.</pre>
|
291
|
-
<p>Which render as:</p>
|
292
|
-
<div class="variablelist"><dl>
|
293
|
-
<dt>
|
294
|
-
<span class="term">
|
295
|
-
In
|
296
|
-
, </span><span class="term">
|
297
|
-
Lorem
|
298
|
-
</span>
|
299
|
-
</dt>
|
300
|
-
<dd>
|
301
|
-
<p>
|
302
|
-
Fusce euismod commodo velit.
|
303
|
-
</p>
|
304
|
-
<pre class="literallayout">Fusce euismod commodo velit.</pre>
|
305
|
-
</dd>
|
306
|
-
<dt><span class="term">
|
307
|
-
Ipsum
|
308
|
-
</span></dt>
|
309
|
-
<dd>
|
310
|
-
<p>
|
311
|
-
Vivamus fringilla mi eu lacus.
|
312
|
-
</p>
|
313
|
-
<div class="itemizedlist"><ul type="disc">
|
314
|
-
<li>
|
315
|
-
Vivamus fringilla mi eu lacus.
|
316
|
-
</li>
|
317
|
-
<li>
|
318
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
319
|
-
</li>
|
320
|
-
</ul></div>
|
321
|
-
</dd>
|
322
|
-
<dt><span class="term">
|
323
|
-
Dolor
|
324
|
-
</span></dt>
|
325
|
-
<dd>
|
326
|
-
<p>
|
327
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
328
|
-
</p>
|
329
|
-
<div class="variablelist"><dl>
|
330
|
-
<dt><span class="term">
|
331
|
-
Suspendisse
|
332
|
-
</span></dt>
|
333
|
-
<dd>
|
334
|
-
A massa id sem aliquam auctor.
|
335
|
-
</dd>
|
336
|
-
<dt><span class="term">
|
337
|
-
Morbi
|
338
|
-
</span></dt>
|
339
|
-
<dd>
|
340
|
-
Pretium nulla vel lorem.
|
341
|
-
</dd>
|
342
|
-
<dt><span class="term">
|
343
|
-
In
|
344
|
-
</span></dt>
|
345
|
-
<dd>
|
346
|
-
<p>
|
347
|
-
Dictum mauris in urna.
|
348
|
-
</p>
|
349
|
-
<div class="variablelist"><dl>
|
350
|
-
<dt><span class="term">
|
351
|
-
Vivamus
|
352
|
-
</span></dt>
|
353
|
-
<dd>
|
354
|
-
Fringilla mi eu lacus.
|
355
|
-
</dd>
|
356
|
-
<dt><span class="term">
|
357
|
-
Donec
|
358
|
-
</span></dt>
|
359
|
-
<dd>
|
360
|
-
Eget arcu bibendum nunc consequat lobortis.
|
361
|
-
</dd>
|
362
|
-
</dl></div>
|
363
|
-
</dd>
|
364
|
-
</dl></div>
|
365
|
-
</dd>
|
366
|
-
</dl></div>
|
367
|
-
<div class="section" lang="en" xml:lang="en">
|
368
|
-
<div class="titlepage"><div><div><h4 class="title">
|
369
|
-
<a id="_horizontal_labeled_list_style"></a>Horizontal labeled list style</h4></div></div></div>
|
370
|
-
<p>The <span class="emphasis"><em>horizontal</em></span> labeled list style (also the first positional
|
371
|
-
attribute) places the list text side-by-side with the label instead of
|
372
|
-
under the label. Here is an example:</p>
|
373
|
-
<pre class="screen">[horizontal]
|
374
|
-
*Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est
|
375
|
-
labitur dolorum an. Est ne magna primis adolescens.
|
376
|
-
|
377
|
-
Fusce euismod commodo velit.
|
378
|
-
|
379
|
-
*Ipsum*:: Vivamus fringilla mi eu lacus.
|
380
|
-
- Vivamus fringilla mi eu lacus.
|
381
|
-
- Donec eget arcu bibendum nunc consequat lobortis.
|
382
|
-
|
383
|
-
*Dolor*::
|
384
|
-
- Vivamus fringilla mi eu lacus.
|
385
|
-
- Donec eget arcu bibendum nunc consequat lobortis.</pre>
|
386
|
-
<p>Which render as:</p>
|
387
|
-
<div class="horizontal"><table border="0">
|
388
|
-
<colgroup>
|
389
|
-
<col>
|
390
|
-
<col>
|
391
|
-
</colgroup>
|
392
|
-
<tbody valign="top">
|
393
|
-
<tr>
|
394
|
-
<td valign="top">
|
395
|
-
<p>
|
396
|
-
<span class="strong"><strong>Lorem</strong></span>
|
397
|
-
</p>
|
398
|
-
</td>
|
399
|
-
<td valign="top">
|
400
|
-
<p>
|
401
|
-
Fusce euismod commodo velit. Qui in magna commodo, est
|
402
|
-
labitur dolorum an. Est ne magna primis adolescens.
|
403
|
-
</p>
|
404
|
-
<pre class="literallayout">Fusce euismod commodo velit.</pre>
|
405
|
-
</td>
|
406
|
-
</tr>
|
407
|
-
<tr>
|
408
|
-
<td valign="top">
|
409
|
-
<p>
|
410
|
-
<span class="strong"><strong>Ipsum</strong></span>
|
411
|
-
</p>
|
412
|
-
</td>
|
413
|
-
<td valign="top">
|
414
|
-
<p>
|
415
|
-
Vivamus fringilla mi eu lacus.
|
416
|
-
</p>
|
417
|
-
<div class="itemizedlist"><ul type="disc">
|
418
|
-
<li>
|
419
|
-
Vivamus fringilla mi eu lacus.
|
420
|
-
</li>
|
421
|
-
<li>
|
422
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
423
|
-
</li>
|
424
|
-
</ul></div>
|
425
|
-
</td>
|
426
|
-
</tr>
|
427
|
-
<tr>
|
428
|
-
<td valign="top">
|
429
|
-
<p>
|
430
|
-
<span class="strong"><strong>Dolor</strong></span>
|
431
|
-
</p>
|
432
|
-
</td>
|
433
|
-
<td valign="top">
|
434
|
-
<div class="itemizedlist"><ul type="disc">
|
435
|
-
<li>
|
436
|
-
Vivamus fringilla mi eu lacus.
|
437
|
-
</li>
|
438
|
-
<li>
|
439
|
-
Donec eget arcu bibendum nunc consequat lobortis.
|
440
|
-
</li>
|
441
|
-
</ul></div>
|
442
|
-
</td>
|
443
|
-
</tr>
|
444
|
-
</tbody>
|
445
|
-
</table></div>
|
446
|
-
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
|
447
|
-
<h3 class="title">Note</h3>
|
448
|
-
<div class="itemizedlist"><ul type="disc">
|
449
|
-
<li>
|
450
|
-
Current PDF toolchains do not make a good job of determining
|
451
|
-
the relative column widths for horizontal labeled lists.
|
452
|
-
</li>
|
453
|
-
<li>
|
454
|
-
Nested horizontal labeled lists will generate DocBook validation
|
455
|
-
errors because the <span class="emphasis"><em>DocBook XML V4.2</em></span> DTD does not permit nested
|
456
|
-
informal tables (although <a class="link" href="converting_docbook_to_other_file_formats.html#X13">DocBook XSL Stylesheets</a> and
|
457
|
-
<a class="link" href="converting_docbook_to_other_file_formats.html#X31">dblatex</a> process them correctly).
|
458
|
-
</li>
|
459
|
-
<li>
|
460
|
-
The label width can be set as a percentage of the total width by
|
461
|
-
setting the <span class="emphasis"><em>width</em></span> attribute e.g. <code class="literal">width="10%"</code>
|
462
|
-
</li>
|
463
|
-
</ul></div>
|
464
|
-
</div>
|
465
|
-
</div>
|
466
|
-
</div>
|
467
|
-
<div class="section" lang="en" xml:lang="en">
|
468
|
-
<div class="titlepage"><div><div><h3 class="title">
|
469
|
-
<a id="_question_and_answer_lists"></a>Question and Answer Lists</h3></div></div></div>
|
470
|
-
<p>AsciiDoc comes pre-configured with a <span class="emphasis"><em>qanda</em></span> style labeled list for generating
|
471
|
-
DocBook question and answer (Q&A) lists. Example:</p>
|
472
|
-
<pre class="screen">[qanda]
|
473
|
-
Question one::
|
474
|
-
Answer one.
|
475
|
-
Question two::
|
476
|
-
Answer two.</pre>
|
477
|
-
<p>Renders:</p>
|
478
|
-
<div class="qandaset">
|
479
|
-
<dl>
|
480
|
-
<dt>1. <a href="lists.html#id36118638">
|
481
|
-
Question one
|
482
|
-
</a>
|
483
|
-
</dt>
|
484
|
-
<dt>2. <a href="lists.html#id36118654">
|
485
|
-
Question two
|
486
|
-
</a>
|
487
|
-
</dt>
|
488
|
-
</dl>
|
489
|
-
<table border="0" summary="Q and A Set">
|
490
|
-
<col align="left" width="1%">
|
491
|
-
<tbody>
|
492
|
-
<tr class="question">
|
493
|
-
<td align="left" valign="top">
|
494
|
-
<a id="id36118638"></a><a id="id36118640"></a><p><b>1.</b></p>
|
495
|
-
</td>
|
496
|
-
<td align="left" valign="top"><p>
|
497
|
-
Question one
|
498
|
-
</p></td>
|
499
|
-
</tr>
|
500
|
-
<tr class="answer">
|
501
|
-
<td align="left" valign="top"></td>
|
502
|
-
<td align="left" valign="top"><p>
|
503
|
-
Answer one.
|
504
|
-
</p></td>
|
505
|
-
</tr>
|
506
|
-
<tr class="question">
|
507
|
-
<td align="left" valign="top">
|
508
|
-
<a id="id36118654"></a><a id="id36118656"></a><p><b>2.</b></p>
|
509
|
-
</td>
|
510
|
-
<td align="left" valign="top"><p>
|
511
|
-
Question two
|
512
|
-
</p></td>
|
513
|
-
</tr>
|
514
|
-
<tr class="answer">
|
515
|
-
<td align="left" valign="top"></td>
|
516
|
-
<td align="left" valign="top"><p>
|
517
|
-
Answer two.
|
518
|
-
</p></td>
|
519
|
-
</tr>
|
520
|
-
</tbody>
|
521
|
-
</table>
|
522
|
-
</div>
|
523
|
-
</div>
|
524
|
-
<div class="section" lang="en" xml:lang="en">
|
525
|
-
<div class="titlepage"><div><div><h3 class="title">
|
526
|
-
<a id="_glossary_lists"></a>Glossary Lists</h3></div></div></div>
|
527
|
-
<p>AsciiDoc comes pre-configured with a <span class="emphasis"><em>glossary</em></span> style labeled list for
|
528
|
-
generating DocBook glossary lists. Example:</p>
|
529
|
-
<pre class="screen">[glossary]
|
530
|
-
A glossary term::
|
531
|
-
The corresponding definition.
|
532
|
-
A second glossary term::
|
533
|
-
The corresponding definition.</pre>
|
534
|
-
<p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in
|
535
|
-
the AsciiDoc <code class="literal">./doc</code> distribution directory.</p>
|
536
|
-
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
|
537
|
-
<h3 class="title">Note</h3>
|
538
|
-
<p>To generate valid DocBook output glossary lists must be located
|
539
|
-
in a section that uses the <span class="emphasis"><em>glossary</em></span> <a class="link" href="document_structure.html#X93" title="Section markup templates">section markup template</a>.</p>
|
540
|
-
</div>
|
541
|
-
</div>
|
542
|
-
<div class="section" lang="en" xml:lang="en">
|
543
|
-
<div class="titlepage"><div><div><h3 class="title">
|
544
|
-
<a id="_bibliography_lists"></a>Bibliography Lists</h3></div></div></div>
|
545
|
-
<p>AsciiDoc comes with a predefined <span class="emphasis"><em>bibliography</em></span> bulleted list style
|
546
|
-
generating DocBook bibliography entries. Example:</p>
|
547
|
-
<pre class="screen">[bibliography]
|
548
|
-
.Optional list title
|
549
|
-
- [[[taoup]]] Eric Steven Raymond. 'The Art of UNIX
|
550
|
-
Programming'. Addison-Wesley. ISBN 0-13-142901-9.
|
551
|
-
- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
|
552
|
-
'DocBook - The Definitive Guide'. O'Reilly & Associates.
|
553
|
-
1999. ISBN 1-56592-580-7.</pre>
|
554
|
-
<p>The <code class="literal">[[[<reference>]]]</code> syntax is a bibliography entry anchor, it
|
555
|
-
generates an anchor named <code class="literal"><reference></code> and additionally displays
|
556
|
-
<code class="literal">[<reference>]</code> at the anchor position. For example <code class="literal">[[[taoup]]]</code>
|
557
|
-
generates an anchor named <code class="literal">taoup</code> that displays <code class="literal">[taoup]</code> at the
|
558
|
-
anchor position. Cite the reference from elsewhere your document using
|
559
|
-
<code class="literal"><<taoup>></code>, this displays a hyperlink (<code class="literal">[taoup]</code>) to the
|
560
|
-
corresponding bibliography entry anchor.</p>
|
561
|
-
<p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in
|
562
|
-
the AsciiDoc <code class="literal">./doc</code> distribution directory.</p>
|
563
|
-
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
|
564
|
-
<h3 class="title">Note</h3>
|
565
|
-
<p>To generate valid DocBook output bibliography lists must be
|
566
|
-
located in a <a class="link" href="document_structure.html#X93" title="Section markup templates">bibliography section</a>.</p>
|
567
|
-
</div>
|
568
|
-
</div>
|
569
|
-
<div class="section" lang="en" xml:lang="en">
|
570
|
-
<div class="titlepage"><div><div><h3 class="title">
|
571
|
-
<a id="X15"></a>List Item Continuation</h3></div></div></div>
|
572
|
-
<p>Another list or a literal paragraph immediately following a list item
|
573
|
-
is implicitly appended to the list item; to append other block
|
574
|
-
elements to a list item you need to explicitly join them to the list
|
575
|
-
item with a <span class="emphasis"><em>list continuation</em></span> (a separator line containing a single
|
576
|
-
plus character). Multiple block elements can be appended to a list
|
577
|
-
item using list continuations (provided they are legal list item
|
578
|
-
children in the backend markup).</p>
|
579
|
-
<p>Here are some examples of list item continuations: list item one
|
580
|
-
contains multiple continuations; list item two is continued with an
|
581
|
-
<a class="link" href="delimited_blocks.html#X29" title="Open Blocks">OpenBlock</a> containing multiple elements:</p>
|
582
|
-
<pre class="screen">1. List item one.
|
583
|
-
+
|
584
|
-
List item one continued with a second paragraph followed by an
|
585
|
-
Indented block.
|
586
|
-
+
|
587
|
-
.................
|
588
|
-
$ ls *.sh
|
589
|
-
$ mv *.sh ~/tmp
|
590
|
-
.................
|
591
|
-
+
|
592
|
-
List item continued with a third paragraph.
|
593
|
-
|
594
|
-
2. List item two continued with an open block.
|
595
|
-
+
|
596
|
-
--
|
597
|
-
This paragraph is part of the preceding list item.
|
598
|
-
|
599
|
-
a. This list is nested and does not require explicit item continuation.
|
600
|
-
+
|
601
|
-
This paragraph is part of the preceding list item.
|
602
|
-
|
603
|
-
b. List item b.
|
604
|
-
|
605
|
-
This paragraph belongs to item two of the outer list.
|
606
|
-
--</pre>
|
607
|
-
<p>Renders:</p>
|
608
|
-
<div class="orderedlist"><ol type="1">
|
609
|
-
<li>
|
610
|
-
<p>
|
611
|
-
List item one.
|
612
|
-
</p>
|
613
|
-
<p>List item one continued with a second paragraph followed by an
|
614
|
-
Indented block.</p>
|
615
|
-
<pre class="literallayout">$ ls *.sh
|
616
|
-
$ mv *.sh ~/tmp</pre>
|
617
|
-
<p>List item continued with a third paragraph.</p>
|
618
|
-
</li>
|
619
|
-
<li>
|
620
|
-
<p>
|
621
|
-
List item two continued with an open block.
|
622
|
-
</p>
|
623
|
-
<p>This paragraph is part of the preceding list item.</p>
|
624
|
-
<div class="orderedlist"><ol type="a">
|
625
|
-
<li>
|
626
|
-
<p>
|
627
|
-
This list is nested and does not require explicit item continuation.
|
628
|
-
</p>
|
629
|
-
<p>This paragraph is part of the preceding list item.</p>
|
630
|
-
</li>
|
631
|
-
<li>
|
632
|
-
List item b.
|
633
|
-
</li>
|
634
|
-
</ol></div>
|
635
|
-
<p>This paragraph belongs to item two of the outer list.</p>
|
636
|
-
</li>
|
637
|
-
</ol></div>
|
638
|
-
</div>
|
639
|
-
</div>
|
640
|
-
|
641
|
-
</div>
|
642
|
-
|
643
|
-
<hr/>
|
644
|
-
|
645
|
-
<div class="nav" id="navfooter">
|
646
|
-
<table width="100%">
|
647
|
-
<tr><td width="33%" align="left">
|
648
|
-
|
649
|
-
<a href="delimited_blocks.html">Prev</a><br/>
|
650
|
-
Delimited Blocks
|
651
|
-
|
652
|
-
</td><td width="33%" align="center">
|
653
|
-
|
654
|
-
<a href="index.html">Home</a><br/>
|
655
|
-
AsciiDoc User Guide
|
656
|
-
|
657
|
-
</td><td width="33%" align="right">
|
658
|
-
|
659
|
-
<a href="footnotes.html">Next</a><br/>
|
660
|
-
Footnotes
|
661
|
-
|
662
|
-
</td></tr>
|
663
|
-
</table>
|
664
|
-
</div>
|
665
|
-
</body>
|
666
|
-
</html>
|