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.
Files changed (151) hide show
  1. data/.gitignore +1 -0
  2. data/Rakefile +31 -0
  3. data/SPEC.asciidoc +126 -0
  4. data/TODO.txt +29 -0
  5. data/bin/git-scribe +2 -1
  6. data/docbook-xsl/.CatalogManager.properties.example +61 -0
  7. data/docbook-xsl/.urilist +1 -0
  8. data/git-scribe.gemspec +32 -0
  9. data/lib/git-scribe.rb +21 -315
  10. data/lib/git-scribe/check.rb +60 -0
  11. data/lib/git-scribe/cli.rb +84 -0
  12. data/lib/git-scribe/generate.rb +222 -0
  13. data/lib/git-scribe/init.rb +16 -0
  14. data/lib/git-scribe/version.rb +3 -0
  15. data/template/.gitignore +1 -0
  16. data/template/.gitscribe +5 -0
  17. data/test/check_test.rb +12 -0
  18. data/test/gen_test.rb +78 -0
  19. data/test/init_test.rb +36 -0
  20. data/test/test_helper.rb +44 -0
  21. metadata +49 -161
  22. data/example/book/big.asc +0 -5604
  23. data/example/book/holmes.asc +0 -12983
  24. data/example/output/META-INF/container.xml +0 -6
  25. data/example/output/OEBPS/ar01s02.html +0 -15
  26. data/example/output/OEBPS/ar01s03.html +0 -3
  27. data/example/output/OEBPS/content.opf +0 -21
  28. data/example/output/OEBPS/index.html +0 -5
  29. data/example/output/OEBPS/toc.ncx +0 -37
  30. data/example/output/a_case_of_identity.html +0 -725
  31. data/example/output/a_example_appendix.html +0 -63
  32. data/example/output/a_migration_notes.html +0 -95
  33. data/example/output/apa.html +0 -20
  34. data/example/output/apb.html +0 -6
  35. data/example/output/apc.html +0 -24
  36. data/example/output/apd.html +0 -30
  37. data/example/output/ape.html +0 -26
  38. data/example/output/apf.html +0 -9
  39. data/example/output/apg.html +0 -42
  40. data/example/output/aph.html +0 -89
  41. data/example/output/ar01s02.html +0 -12
  42. data/example/output/ar01s03.html +0 -34
  43. data/example/output/ar01s04.html +0 -77
  44. data/example/output/ar01s05.html +0 -272
  45. data/example/output/ar01s06.html +0 -35
  46. data/example/output/ar01s07.html +0 -105
  47. data/example/output/ar01s08.html +0 -33
  48. data/example/output/ar01s09.html +0 -12
  49. data/example/output/ar01s10.html +0 -14
  50. data/example/output/ar01s11.html +0 -34
  51. data/example/output/ar01s12.html +0 -63
  52. data/example/output/ar01s13.html +0 -156
  53. data/example/output/ar01s14.html +0 -330
  54. data/example/output/ar01s15.html +0 -22
  55. data/example/output/ar01s16.html +0 -27
  56. data/example/output/ar01s17.html +0 -94
  57. data/example/output/ar01s18.html +0 -359
  58. data/example/output/ar01s19.html +0 -373
  59. data/example/output/ar01s20.html +0 -27
  60. data/example/output/ar01s21.html +0 -33
  61. data/example/output/ar01s22.html +0 -351
  62. data/example/output/ar01s23.html +0 -21
  63. data/example/output/ar01s24.html +0 -69
  64. data/example/output/ar01s25.html +0 -60
  65. data/example/output/ar01s26.html +0 -217
  66. data/example/output/ar01s27.html +0 -88
  67. data/example/output/ar01s28.html +0 -237
  68. data/example/output/ar01s29.html +0 -68
  69. data/example/output/ar01s30.html +0 -154
  70. data/example/output/ar01s31.html +0 -6
  71. data/example/output/ar01s32.html +0 -22
  72. data/example/output/ar01s33.html +0 -209
  73. data/example/output/asciidoc_backends.html +0 -190
  74. data/example/output/asciidoc_document_types.html +0 -131
  75. data/example/output/attribute_entries.html +0 -185
  76. data/example/output/attribute_lists.html +0 -157
  77. data/example/output/attribute_references.html +0 -414
  78. data/example/output/attributelist_element.html +0 -143
  79. data/example/output/b_packager_notes.html +0 -68
  80. data/example/output/bi01.html +0 -18
  81. data/example/output/big.asc +0 -5604
  82. data/example/output/block_element_definitions.html +0 -448
  83. data/example/output/block_titles.html +0 -83
  84. data/example/output/blockid_element.html +0 -80
  85. data/example/output/book.asc +0 -5604
  86. data/example/output/book.epub +0 -0
  87. data/example/output/book.fo +0 -3788
  88. data/example/output/book.html +0 -8793
  89. data/example/output/book.xml +0 -8265
  90. data/example/output/c_asciidoc_safe_mode.html +0 -105
  91. data/example/output/callouts.html +0 -214
  92. data/example/output/catalog +0 -10
  93. data/example/output/colophon.html +0 -397
  94. data/example/output/configuration_files.html +0 -672
  95. data/example/output/converting_docbook_to_other_file_formats.html +0 -324
  96. data/example/output/d_using_asciidoc_with_non-english_languages.html +0 -107
  97. data/example/output/delimited_blocks.html +0 -455
  98. data/example/output/document_attributes.html +0 -95
  99. data/example/output/document_processing.html +0 -116
  100. data/example/output/document_structure.html +0 -493
  101. data/example/output/e_vim_syntax_highlighter.html +0 -111
  102. data/example/output/example_bibliography.html +0 -82
  103. data/example/output/example_colophon.html +0 -58
  104. data/example/output/example_glossary.html +0 -73
  105. data/example/output/example_index.html +0 -108
  106. data/example/output/f_attribute_options.html +0 -129
  107. data/example/output/filters.html +0 -179
  108. data/example/output/footnotes.html +0 -103
  109. data/example/output/g_diagnostics.html +0 -148
  110. data/example/output/generating_plain_text_files.html +0 -68
  111. data/example/output/getting_started.html +0 -87
  112. data/example/output/glossary.html +0 -95
  113. data/example/output/go01.html +0 -24
  114. data/example/output/h_backend_attributes.html +0 -308
  115. data/example/output/help_commands.html +0 -96
  116. data/example/output/holmes.asc +0 -12983
  117. data/example/output/image/octocat_professor.png +0 -0
  118. data/example/output/include/hello.c +0 -10
  119. data/example/output/index.html +0 -656
  120. data/example/output/indexes.html +0 -104
  121. data/example/output/intrinsic_attributes.html +0 -165
  122. data/example/output/ix01.html +0 -3
  123. data/example/output/lists.html +0 -666
  124. data/example/output/macros.html +0 -737
  125. data/example/output/manpage_documents.html +0 -124
  126. data/example/output/master.css +0 -281
  127. data/example/output/mathematical_formulas.html +0 -125
  128. data/example/output/page.html +0 -60
  129. data/example/output/paragraphs.html +0 -192
  130. data/example/output/pr01.html +0 -3
  131. data/example/output/source_code_highlighting.html +0 -59
  132. data/example/output/stylesheets/handbookish-quirks.css +0 -0
  133. data/example/output/stylesheets/handbookish.css +0 -233
  134. data/example/output/tables.html +0 -797
  135. data/example/output/text_formatting.html +0 -273
  136. data/example/output/the_adventure_of_the_beryl_coronet.html +0 -968
  137. data/example/output/the_adventure_of_the_blue_carbuncle.html +0 -825
  138. data/example/output/the_adventure_of_the_copper_beeches.html +0 -998
  139. data/example/output/the_adventure_of_the_engineer_s_thumb.html +0 -851
  140. data/example/output/the_adventure_of_the_noble_bachelor.html +0 -861
  141. data/example/output/the_adventure_of_the_speckled_band.html +0 -1015
  142. data/example/output/the_boscombe_valley_mystery.html +0 -974
  143. data/example/output/the_first_chapter.html +0 -110
  144. data/example/output/the_five_orange_pips.html +0 -776
  145. data/example/output/the_man_with_the_twisted_lip.html +0 -946
  146. data/example/output/the_red-headed_league.html +0 -950
  147. data/example/output/the_second_chapter.html +0 -95
  148. data/example/output/the_third_chapter.html +0 -58
  149. data/example/output/tips_and_tricks.html +0 -452
  150. data/example/output/title.html +0 -120
  151. data/example/output/titles.html +0 -126
@@ -1,33 +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>Titles</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="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s07.html" title="Text Formatting" /><link rel="next" href="ar01s09.html" title="Block Titles" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Titles</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s07.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s09.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X17"></a>Titles</h2></div></div></div><p>Document and section titles can be in either of two formats:</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_two_line_titles"></a>Two line titles</h3></div></div></div><p>A two line title consists of a title line, starting hard against the
4
- left margin, and an underline. Section underlines consist a repeated
5
- character pairs spanning the width of the preceding title (give or
6
- take up to two characters):</p><p>The default title underlines for each of the document levels are:</p><pre class="literallayout">Level 0 (top level): ======================
7
- Level 1: ----------------------
8
- Level 2: ~~~~~~~~~~~~~~~~~~~~~~
9
- Level 3: ^^^^^^^^^^^^^^^^^^^^^^
10
- Level 4 (bottom level): ++++++++++++++++++++++</pre><p>Examples:</p><pre class="literallayout">Level One Section Title
11
- -----------------------</pre><pre class="literallayout">Level 2 Subsection Title
12
- ~~~~~~~~~~~~~~~~~~~~~~~~</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X46"></a>One line titles</h3></div></div></div><p>One line titles consist of a single line delimited on either side by
13
- one or more equals characters (the number of equals characters
14
- corresponds to the section level minus one). Here are some examples:</p><pre class="literallayout">= Document Title (level 0) =
15
- == Section title (level 1) ==
16
- === Section title (level 2) ===
17
- ==== Section title (level 3) ====
18
- ===== Section title (level 4) =====</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><div class="itemizedlist"><ul type="disc"><li>
19
- One or more spaces must fall between the title and the delimiters.
20
- </li><li>
21
- The trailing title delimiter is optional.
22
- </li><li>
23
- The one-line title syntax can be changed by editing the
24
- configuration file <code class="literal">[titles]</code> section <code class="literal">sect0</code>…<code class="literal">sect4</code> entries.
25
- </li></ul></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_floating_titles"></a>Floating titles</h3></div></div></div><p>Setting the title’s first positional attribute or <span class="emphasis"><em>style</em></span> attribute to
26
- <span class="emphasis"><em>float</em></span> generates a free-floating title. A free-floating title is
27
- rendered just like a normal section title but is not formally
28
- associated with a text body and is not part of the regular section
29
- hierarchy so the normal ordering rules do not apply. Floating titles
30
- can also be used in contexts where section titles are illegal: for
31
- example sidebar and admonition blocks. Example:</p><pre class="literallayout">[float]
32
- The second day
33
- ~~~~~~~~~~~~~~</pre><p>Floating titles do not appear in a document’s table of contents.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s07.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s09.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Text Formatting </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Block Titles</td></tr></table></div></body></html>
@@ -1,12 +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>Block Titles</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="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s08.html" title="Titles" /><link rel="next" href="ar01s10.html" title="BlockId Element" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Block Titles</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s08.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s10.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X42"></a>Block Titles</h2></div></div></div><p>A <span class="emphasis"><em>BlockTitle</em></span> element is a single line beginning with a period
4
- followed by the title text. A BlockTitle is applied to the immediately
5
- following Paragraph, DelimitedBlock, List, Table or BlockMacro. For
6
- example:</p><pre class="literallayout">.Notes
7
- - Note 1.
8
- - Note 2.</pre><p>is rendered as:</p><div class="itemizedlist"><p class="title"><b>Notes</b></p><ul type="disc"><li>
9
- Note 1.
10
- </li><li>
11
- Note 2.
12
- </li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s08.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s10.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Titles </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> BlockId Element</td></tr></table></div></body></html>
@@ -1,14 +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>BlockId Element</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="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s09.html" title="Block Titles" /><link rel="next" href="ar01s11.html" title="AttributeList Element" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">BlockId Element</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s09.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s11.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X41"></a>BlockId Element</h2></div></div></div><p>A <span class="emphasis"><em>BlockId</em></span> is a single line block element containing a unique
4
- identifier enclosed in double square brackets. It is used to assign an
5
- identifier to the ensuing block element. For example:</p><pre class="literallayout">[[chapter-titles]]
6
- Chapter titles can be ...</pre><p>The preceding example identifies the ensuing paragraph so it can be
7
- referenced from other locations, for example with
8
- <code class="literal">&lt;&lt;chapter-titles,chapter titles&gt;&gt;</code>.</p><p><span class="emphasis"><em>BlockId</em></span> elements can be applied to Title, Paragraph, List,
9
- DelimitedBlock, Table and BlockMacro elements. The BlockId element
10
- sets the <code class="literal">{id}</code> attribute for substitution in the subsequent block’s
11
- markup template. If a second positional argument is supplied it sets
12
- the <code class="literal">{reftext}</code> attribute which is used to set the DocBook <code class="literal">xreflabel</code>
13
- attribute.</p><p>The <span class="emphasis"><em>BlockId</em></span> element has the same syntax and serves the same function
14
- to the <a class="link" href="ar01s18.html#X30" title="anchor">anchor inline macro</a>.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s09.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s11.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Block Titles </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> AttributeList Element</td></tr></table></div></body></html>
@@ -1,34 +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>AttributeList Element</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="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s10.html" title="BlockId Element" /><link rel="next" href="ar01s12.html" title="Paragraphs" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">AttributeList Element</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s10.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s12.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X79"></a>AttributeList Element</h2></div></div></div><p>An <span class="emphasis"><em>AttributeList</em></span> block element is an <a class="link" href="ar01s25.html" title="Attribute Lists">attribute list</a> on a
4
- line by itself:</p><div class="itemizedlist"><ul type="disc"><li>
5
- <span class="emphasis"><em>AttributeList</em></span> attributes are only applied to the immediately
6
- following block element — the attributes are made available to the
7
- block’s markup template.
8
- </li><li>
9
- Multiple contiguous <span class="emphasis"><em>AttributeList</em></span> elements are additively combined
10
- in the order they appear..
11
- </li><li>
12
- The first positional attribute in the list is often used to specify
13
- the ensuing element’s <a class="link" href="ar01s28.html#X23" title="Styles">style</a>.
14
- </li></ul></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_attribute_value_substitution"></a>Attribute value substitution</h3></div></div></div><p>By default, only substitutions that take place inside attribute list
15
- values are attribute references, this is because not all attributes
16
- are destined to be marked up and rendered as text (for example the
17
- table <span class="emphasis"><em>cols</em></span> attribute). To perform normal inline text substitutions
18
- (special characters, quotes, macros, replacements) on an attribute
19
- value you need to enclose it in single quotes. In the following quote
20
- block the second attribute value in the AttributeList is quoted to
21
- ensure the <span class="emphasis"><em>http</em></span> macro is expanded to a hyperlink.</p><pre class="screen">[quote,'http://en.wikipedia.org/wiki/Samuel_Johnson[Samuel Johnson]']
22
- _____________________________________________________________________
23
- Sir, a woman's preaching is like a dog's walking on his hind legs. It
24
- is not done well; but you are surprised to find it done at all.
25
- _____________________________________________________________________</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_common_attributes"></a>Common attributes</h3></div></div></div><p>Most block elements support the following attributes:</p><div class="informaltable"><table border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th align="left" valign="top">Name </th><th align="left" valign="top">Backends </th><th align="left" valign="top">Description</th></tr></thead><tbody><tr><td align="left" valign="top"><p><span class="emphasis"><em>id</em></span></p></td><td align="left" valign="top"><p>html4, xhtml11, docbook</p></td><td align="left" valign="top"><p>Unique identifier typically serve as link targets.
26
- Can also be set by the <span class="emphasis"><em>BlockId</em></span> element.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>role</em></span></p></td><td align="left" valign="top"><p>xhtml11, docbook</p></td><td align="left" valign="top"><p>Role contains a string used to classify or subclassify an element and
27
- can be applied to AsciiDoc block elements. The AsciiDoc <span class="emphasis"><em>role</em></span>
28
- attribute is translated to the <span class="emphasis"><em>role</em></span> attribute in DocBook outputs and
29
- to the <span class="emphasis"><em>class</em></span> attribute in HTML outputs.</p>
30
- <p>DocBook XSL Stylesheets translate DocBook <span class="emphasis"><em>role</em></span> attributes to HTML
31
- <span class="emphasis"><em>class</em></span> attributes; CSS can then be used
32
- <a class="ulink" href="http://www.sagehill.net/docbookxsl/UsingCSS.html" target="_top">to style the
33
- generated HTML</a>.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>reftext</em></span></p></td><td align="left" valign="top"><p>docbook</p></td><td align="left" valign="top"><p><span class="emphasis"><em>reftext</em></span> is used to set the DocBook <span class="emphasis"><em>xreflabel</em></span> attribute.
34
- The <span class="emphasis"><em>reftext</em></span> attribute can an also be set by the <span class="emphasis"><em>BlockId</em></span> element.</p></td></tr></tbody></table></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s10.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s12.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">BlockId Element </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Paragraphs</td></tr></table></div></body></html>
@@ -1,63 +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>Paragraphs</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="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s11.html" title="AttributeList Element" /><link rel="next" href="ar01s13.html" title="Delimited Blocks" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Paragraphs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s11.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s13.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_paragraphs"></a>Paragraphs</h2></div></div></div><p>Paragraphs are blocks of text terminated by a blank line, the end of
4
- file, or the start of a delimited block or a list. There are three
5
- paragraph syntaxes: normal, indented (literal) and admonition which
6
- are rendered, by default, with the corresponding paragraph style. Each
7
- syntax has a default style, but you can, if you wish, explicitly
8
- apply any paragraph style to any paragraph syntax. The common
9
- paragraph styles are <span class="emphasis"><em>normal</em></span>, <span class="emphasis"><em>literal</em></span>, <span class="emphasis"><em>verse</em></span>, <span class="emphasis"><em>quote</em></span>, <span class="emphasis"><em>listing</em></span>,
10
- <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>IMPORTANT</em></span>, <span class="emphasis"><em>WARNING</em></span> and <span class="emphasis"><em>CAUTION</em></span>.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_normal_paragraph_syntax"></a>normal paragraph syntax</h3></div></div></div><p>Normal paragraph syntax consists of one or more non-blank lines of
11
- text. The first line must start hard against the left margin (no
12
- intervening white space). The default processing expectation is that
13
- of a normal paragraph of text.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X85"></a>literal paragraph syntax</h3></div></div></div><p>Literal paragraphs are rendered verbatim in a monospaced font without
14
- any distinguishing background or border. By default there is no text
15
- formatting or substitutions within Literal paragraphs apart from
16
- Special Characters and Callouts.</p><p>The <span class="emphasis"><em>literal</em></span> style is applied implicitly to indented paragraphs i.e.
17
- where the first line of the paragraph is indented by one or more space
18
- or tab characters. For example:</p><pre class="screen"> Consul *necessitatibus* per id,
19
- consetetur, eu pro everti postulant
20
- homero verear ea mea, qui.</pre><p>Renders:</p><pre class="literallayout">Consul *necessitatibus* per id,
21
- consetetur, eu pro everti postulant
22
- homero verear ea mea, qui.</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Because <a class="link" href="ar01s14.html" title="Lists">lists</a> can be indented it’s possible for your
23
- indented paragraph to be misinterpreted as a list — in situations
24
- like this apply the <span class="emphasis"><em>literal</em></span> style to a normal paragraph.</p></div><p>Instead of using a paragraph indent you could apply the <span class="emphasis"><em>literal</em></span>
25
- style explicitly, for example:</p><pre class="screen">[literal]
26
- Consul *necessitatibus* per id,
27
- consetetur, eu pro everti postulant
28
- homero verear ea mea, qui.</pre><p>Renders:</p><pre class="literallayout">Consul *necessitatibus* per id,
29
- consetetur, eu pro everti postulant
30
- homero verear ea mea, qui.</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X94"></a>quote and verse paragraph styles</h3></div></div></div><p>The optional <span class="emphasis"><em>attribution</em></span> and <span class="emphasis"><em>citetitle</em></span> attributes (positional
31
- attributes 2 and 3) specify the author and source respectively.</p><p>The <span class="emphasis"><em>verse</em></span> style retains the line breaks, for example:</p><pre class="screen">[verse, William Blake, from Auguries of Innocence]
32
- To see a world in a grain of sand,
33
- And a heaven in a wild flower,
34
- Hold infinity in the palm of your hand,
35
- And eternity in an hour.</pre><p>Which is rendered as:</p><div class="blockquote"><blockquote class="blockquote"><div class="literallayout"><p>To see a world in a grain of sand,<br />
36
- And a heaven in a wild flower,<br />
37
- Hold infinity in the palm of your hand,<br />
38
- And eternity in an hour.</p></div></blockquote></div><p>The <span class="emphasis"><em>quote</em></span> style flows the text at left and right margins, for
39
- example:</p><pre class="screen">[quote, Bertrand Russell, The World of Mathematics (1956)]
40
- A good notation has subtlety and suggestiveness which at times makes
41
- it almost seem like a live teacher.</pre><p>Which is rendered as:</p><p>A good notation has subtlety and suggestiveness which at times makes
42
- it almost seem like a live teacher.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X28"></a>Admonition Paragraphs</h3></div></div></div><p><span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>IMPORTANT</em></span>, <span class="emphasis"><em>WARNING</em></span> and <span class="emphasis"><em>CAUTION</em></span> admonishment
43
- paragraph styles are generated by placing <code class="literal">NOTE:</code>, <code class="literal">TIP:</code>,
44
- <code class="literal">IMPORTANT:</code>, <code class="literal">WARNING:</code> or <code class="literal">CAUTION:</code> as the first word of the
45
- paragraph. For example:</p><pre class="literallayout">NOTE: This is an example note.</pre><p>Alternatively, you can specify the paragraph admonition style
46
- explicitly using an <a class="link" href="ar01s11.html" title="AttributeList Element">AttributeList element</a>. For example:</p><pre class="literallayout">[NOTE]
47
- This is an example note.</pre><p>Renders:</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This is an example note.</p></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>If your admonition requires more than a single paragraph use an
48
- <a class="link" href="ar01s13.html#X22" title="Admonition Blocks">admonition block</a> instead.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="X47"></a>Admonition Icons and Captions</h4></div></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Admonition customization with <code class="literal">icons</code>, <code class="literal">iconsdir</code>, <code class="literal">icon</code> and
49
- <code class="literal">caption</code> attributes does not apply when generating DocBook output. If
50
- you are going the DocBook route then the <a class="link" href="ar01s30.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a> <code class="literal">--no-icons</code>
51
- and <code class="literal">--icons-dir</code> options can be used to set the appropriate XSL
52
- Stylesheets parameters.</p></div><p>By default the asciidoc(1) <code class="literal">xhtml11</code> and <code class="literal">html4</code> backends generate
53
- text captions instead of admonition icon image links. To generate
54
- links to icon images define the <a class="link" href="aph.html#X45"><code class="literal">icons</code></a> attribute, for example
55
- using the <code class="literal">-a icons</code> command-line option.</p><p>The <a class="link" href="aph.html#X44"><code class="literal">iconsdir</code></a> attribute sets the location of linked icon
56
- images.</p><p>You can override the default icon image using the <code class="literal">icon</code> attribute to
57
- specify the path of the linked image. For example:</p><pre class="literallayout">[icon="./images/icons/wink.png"]
58
- NOTE: What lovely war.</pre><p>Use the <code class="literal">caption</code> attribute to customize the admonition captions (not
59
- applicable to <code class="literal">docbook</code> backend). The following example suppresses the
60
- icon image and customizes the caption of a <span class="emphasis"><em>NOTE</em></span> admonition
61
- (undefining the <code class="literal">icons</code> attribute with <code class="literal">icons=None</code> is only necessary
62
- if <a class="link" href="aph.html#X45">admonition icons</a> have been enabled):</p><pre class="literallayout">[icons=None, caption="My Special Note"]
63
- NOTE: This is my special note.</pre><p>This subsection also applies to <a class="link" href="ar01s13.html#X22" title="Admonition Blocks">Admonition Blocks</a>.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s11.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s13.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">AttributeList Element </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Delimited Blocks</td></tr></table></div></body></html>
@@ -1,156 +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>Delimited Blocks</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="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s12.html" title="Paragraphs" /><link rel="next" href="ar01s14.html" title="Lists" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Delimited Blocks</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s12.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s14.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_delimited_blocks"></a>Delimited Blocks</h2></div></div></div><p>Delimited blocks are blocks of text enveloped by leading and trailing
4
- delimiter lines (normally a series of four or more repeated
5
- characters). The behavior of Delimited Blocks is specified by entries
6
- in configuration file <code class="literal">[blockdef-*]</code> sections.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_predefined_delimited_blocks"></a>Predefined Delimited Blocks</h3></div></div></div><p>AsciiDoc ships with a number of predefined DelimitedBlocks (see the
7
- <code class="literal">asciidoc.conf</code> configuration file in the asciidoc(1) program
8
- directory):</p><p>Predefined delimited block underlines:</p><pre class="literallayout">CommentBlock: //////////////////////////
9
- PassthroughBlock: ++++++++++++++++++++++++++
10
- ListingBlock: --------------------------
11
- LiteralBlock: ..........................
12
- SidebarBlock: **************************
13
- QuoteBlock: __________________________
14
- ExampleBlock: ==========================
15
- OpenBlock: --</pre><p>The <a class="link" href="ar01s29.html#X56" title="Code Filter">code</a>, <a class="link" href="ar01s29.html#X57" title="Source Code Highlighter Filter">source</a> and <a class="link" href="ar01s29.html#X58" title="Music Filter">music</a> filter blocks are
16
- detailed in the <a class="link" href="ar01s29.html" title="Filters">Filters</a> section.</p><div class="table"><a id="id36116502"></a><p class="title"><b>Table 1. Default DelimitedBlock substitutions</b></p><div class="table-contents"><table summary="Default DelimitedBlock substitutions" border="1"><colgroup><col /><col /><col /><col /><col /><col /><col /><col /></colgroup><thead><tr><th align="left" valign="top"> </th><th align="center" valign="top">Attributes </th><th align="center" valign="top">Callouts </th><th align="center" valign="top">Macros </th><th align="center" valign="top"> Quotes </th><th align="center" valign="top">Replacements</th><th align="center" valign="top">Special chars </th><th align="center" valign="top">Special words</th></tr></thead><tbody><tr><td align="left" valign="top"><p><span class="emphasis"><em>PassthroughBlock</em></span></p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>No</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>ListingBlock</em></span></p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>LiteralBlock</em></span></p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>SidebarBlock</em></span></p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>QuoteBlock</em></span></p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>ExampleBlock</em></span></p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>OpenBlock</em></span></p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>No</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td><td align="center" valign="top"><p>Yes</p></td></tr></tbody></table></div></div><br class="table-break" /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_listing_blocks"></a>Listing Blocks</h3></div></div></div><p><span class="emphasis"><em>ListingBlocks</em></span> are rendered verbatim in a monospaced font, they
17
- retain line and whitespace formatting and are often distinguished by a
18
- background or border. There is no text formatting or substitutions
19
- within Listing blocks apart from Special Characters and Callouts.
20
- Listing blocks are often used for computer output and file listings.</p><p>Here’s an example:</p><pre class="screen">--------------------------------------
21
- #include &lt;stdio.h&gt;
22
-
23
- int main() {
24
- printf("Hello World!\n");
25
- exit(0);
26
- }
27
- --------------------------------------</pre><p>Which will be rendered like:</p><pre class="screen">#include &lt;stdio.h&gt;
28
-
29
- int main() {
30
- printf("Hello World!\n");
31
- exit(0);
32
- }</pre><p>By convention <a class="link" href="ar01s29.html" title="Filters">filter blocks</a> use the listing block syntax and
33
- are implemented as distinct listing block styles.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X65"></a>Literal Blocks</h3></div></div></div><p><span class="emphasis"><em>LiteralBlocks</em></span> are rendered just like <a class="link" href="ar01s12.html#X85" title="literal paragraph syntax">literal paragraphs</a>.
34
- Example:</p><pre class="screen">...................................
35
- Consul *necessitatibus* per id,
36
- consetetur, eu pro everti postulant
37
- homero verear ea mea, qui.
38
- ...................................</pre><p>Renders:</p><pre class="literallayout">Consul *necessitatibus* per id,
39
- consetetur, eu pro everti postulant
40
- homero verear ea mea, qui.</pre><p>If the <span class="emphasis"><em>listing</em></span> style is applied to a LiteralBlock it will be
41
- rendered as a ListingBlock (this is handy if you have a listing
42
- containing a ListingBlock).</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_sidebar_blocks"></a>Sidebar Blocks</h3></div></div></div><p>A sidebar is a short piece of text presented outside the narrative
43
- flow of the main text. The sidebar is normally presented inside a
44
- bordered box to set it apart from the main text.</p><p>The sidebar body is treated like a normal section body.</p><p>Here’s an example:</p><pre class="screen">.An Example Sidebar
45
- ************************************************
46
- Any AsciiDoc SectionBody element (apart from
47
- SidebarBlocks) can be placed inside a sidebar.
48
- ************************************************</pre><p>Which will be rendered like:</p><div class="sidebar"><p class="title"><b>An Example Sidebar</b></p><p>Any AsciiDoc SectionBody element (apart from
49
- SidebarBlocks) can be placed inside a sidebar.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X26"></a>Comment Blocks</h3></div></div></div><p>The contents of <span class="emphasis"><em>CommentBlocks</em></span> are not processed; they are useful for
50
- annotations and for excluding new or outdated content that you don’t
51
- want displayed. CommentBlocks are never written to output files.
52
- Example:</p><pre class="screen">//////////////////////////////////////////
53
- CommentBlock contents are not processed by
54
- asciidoc(1).
55
- //////////////////////////////////////////</pre><p>See also <a class="link" href="ar01s18.html#X25" title="Comment Lines">Comment Lines</a>.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>System macros are executed inside comment blocks.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X76"></a>Passthrough Blocks</h3></div></div></div><p>By default the block contents is subject only to <span class="emphasis"><em>attributes</em></span> and
56
- <span class="emphasis"><em>macros</em></span> substitutions (use an explicit <span class="emphasis"><em>subs</em></span> attribute to apply
57
- different substitutions). PassthroughBlock content will often be
58
- backend specific. Here’s an example:</p><pre class="screen">[subs="quotes"]
59
- ++++++++++++++++++++++++++++++++++++++
60
- &lt;table border="1"&gt;&lt;tr&gt;
61
- &lt;td&gt;*Cell 1*&lt;/td&gt;
62
- &lt;td&gt;*Cell 2*&lt;/td&gt;
63
- &lt;/tr&gt;&lt;/table&gt;
64
- ++++++++++++++++++++++++++++++++++++++</pre><p>The following styles can be applied to passthrough blocks:</p><div class="variablelist"><dl><dt><span class="term">
65
- pass
66
- </span></dt><dd>
67
- No substitutions are performed. This is equivalent to <code class="literal">subs="none"</code>.
68
- </dd><dt><span class="term">
69
- asciimath, latexmath
70
- </span></dt><dd>
71
- By default no substitutions are performed, the contents are rendered
72
- as <a class="link" href="ar01s21.html" title="Mathematical Formulas">mathematical formulas</a>.
73
- </dd></dl></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_quote_blocks"></a>Quote Blocks</h3></div></div></div><p><span class="emphasis"><em>QuoteBlocks</em></span> are used for quoted passages of text. There are two
74
- styles: <span class="emphasis"><em>quote</em></span> and <span class="emphasis"><em>verse</em></span>. The style behavior is identical to
75
- <a class="link" href="ar01s12.html#X94" title="quote and verse paragraph styles">quote and verse paragraphs</a> except that blocks can contain
76
- multiple paragraphs and, in the case of the <span class="emphasis"><em>quote</em></span> style, other
77
- section elements. The first positional attribute sets the style, if
78
- no attributes are specified the <span class="emphasis"><em>quote</em></span> style is used. The optional
79
- <span class="emphasis"><em>attribution</em></span> and <span class="emphasis"><em>citetitle</em></span> attributes (positional attributes 2 and
80
- 3) specify the quote’s author and source. For example:</p><pre class="screen">[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes]
81
- ____________________________________________________________________
82
- As he spoke there was the sharp sound of horses' hoofs and
83
- grating wheels against the curb, followed by a sharp pull at the
84
- bell. Holmes whistled.
85
-
86
- "A pair, by the sound," said he. "Yes," he continued, glancing
87
- out of the window. "A nice little brougham and a pair of
88
- beauties. A hundred and fifty guineas apiece. There's money in
89
- this case, Watson, if there is nothing else."
90
- ____________________________________________________________________</pre><p>Which is rendered as:</p><div class="blockquote"><table border="0" width="100%" cellspacing="0" cellpadding="0" class="blockquote" summary="Block quote"><tr><td width="10%" valign="top"> </td><td width="80%" valign="top"><p>As he spoke there was the sharp sound of horses' hoofs and
91
- grating wheels against the curb, followed by a sharp pull at the
92
- bell. Holmes whistled.</p><p>"A pair, by the sound," said he. "Yes," he continued, glancing
93
- out of the window. "A nice little brougham and a pair of
94
- beauties. A hundred and fifty guineas apiece. There’s money in
95
- this case, Watson, if there is nothing else."</p></td><td width="10%" valign="top"> </td></tr><tr><td width="10%" valign="top"> </td><td colspan="2" align="right" valign="top">--<span class="attribution">
96
- Sir Arthur Conan Doyle
97
- <em class="citetitle">The Adventures of Sherlock Holmes</em>
98
- </span></td></tr></table></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X48"></a>Example Blocks</h3></div></div></div><p><span class="emphasis"><em>ExampleBlocks</em></span> encapsulate the DocBook Example element and are used
99
- for, well, examples. Example blocks can be titled by preceding them
100
- with a <span class="emphasis"><em>BlockTitle</em></span>. DocBook toolchains will normally automatically
101
- number examples and generate a <span class="emphasis"><em>List of Examples</em></span> backmatter section.</p><p>Example blocks are delimited by lines of equals characters and can
102
- contain any block elements apart from Titles, BlockTitles and
103
- Sidebars) inside an example block. For example:</p><pre class="screen">.An example
104
- =====================================================================
105
- Qui in magna commodo, est labitur dolorum an. Est ne magna primis
106
- adolescens.
107
- =====================================================================</pre><p>Renders:</p><div class="example"><a id="id36117482"></a><p class="title"><b>Example 1. An example</b></p><div class="example-contents"><p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis
108
- adolescens.</p></div></div><br class="example-break" /><p>A title prefix that can be inserted with the <code class="literal">caption</code> attribute
109
- (<code class="literal">xhtml11</code> and <code class="literal">html4</code> backends). For example:</p><pre class="screen">[caption="Example 1: "]
110
- .An example with a custom caption
111
- =====================================================================
112
- Qui in magna commodo, est labitur dolorum an. Est ne magna primis
113
- adolescens.
114
- =====================================================================</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X22"></a>Admonition Blocks</h3></div></div></div><p>The <span class="emphasis"><em>ExampleBlock</em></span> definition includes a set of admonition
115
- <a class="link" href="ar01s28.html#X23" title="Styles">styles</a> (<span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>IMPORTANT</em></span>, <span class="emphasis"><em>WARNING</em></span>, <span class="emphasis"><em>CAUTION</em></span>) for
116
- generating admonition blocks (admonitions containing more than a
117
- <a class="link" href="ar01s12.html#X28" title="Admonition Paragraphs">single paragraph</a>). Just precede the <span class="emphasis"><em>ExampleBlock</em></span> with an
118
- attribute list specifying the admonition style name. For example:</p><pre class="screen">[NOTE]
119
- .A NOTE admonition block
120
- =====================================================================
121
- Qui in magna commodo, est labitur dolorum an. Est ne magna primis
122
- adolescens.
123
-
124
- . Fusce euismod commodo velit.
125
- . Vivamus fringilla mi eu lacus.
126
- .. Fusce euismod commodo velit.
127
- .. Vivamus fringilla mi eu lacus.
128
- . Donec eget arcu bibendum
129
- nunc consequat lobortis.
130
- =====================================================================</pre><p>Renders:</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">A NOTE admonition block</h3><p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis
131
- adolescens.</p><div class="orderedlist"><ol type="1"><li>
132
- Fusce euismod commodo velit.
133
- </li><li><p>
134
- Vivamus fringilla mi eu lacus.
135
- </p><div class="orderedlist"><ol type="a"><li>
136
- Fusce euismod commodo velit.
137
- </li><li>
138
- Vivamus fringilla mi eu lacus.
139
- </li></ol></div></li><li>
140
- Donec eget arcu bibendum
141
- nunc consequat lobortis.
142
- </li></ol></div></div><p>See also <a class="link" href="ar01s12.html#X47" title="Admonition Icons and Captions">Admonition Icons and Captions</a>.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X29"></a>Open Blocks</h3></div></div></div><p>An <span class="emphasis"><em>OpenBlock</em></span> groups a set of block elements. <span class="emphasis"><em>OpenBlock</em></span> usage:</p><div class="orderedlist"><ol type="1"><li>
143
- <a class="link" href="ar01s14.html#X15" title="List Item Continuation">List item continuation</a>.
144
- </li><li><p>
145
- Apply the <span class="emphasis"><em>abstract</em></span> style to generate an abstract, for example:
146
- </p><pre class="literallayout">[abstract]
147
- --
148
- In this paper we will ...
149
- --</pre></li><li><p>
150
- Apply the <span class="emphasis"><em>partintro</em></span> style to generate a book part introduction for
151
- a multi-part book, for example:
152
- </p><pre class="literallayout">[partintro]
153
- .Optional part introduction title
154
- --
155
- Optional part introduction goes here.
156
- --</pre></li></ol></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s12.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s14.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Paragraphs </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Lists</td></tr></table></div></body></html>
@@ -1,330 +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>Lists</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="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s13.html" title="Delimited Blocks" /><link rel="next" href="ar01s15.html" title="Footnotes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Lists</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s13.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s15.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X64"></a>Lists</h2></div></div></div><div class="itemizedlist"><p class="title"><b>List types</b></p><ul type="disc"><li>
4
- Bulleted lists. Also known as itemized or unordered lists.
5
- </li><li>
6
- Numbered lists. Also called ordered lists.
7
- </li><li>
8
- Labeled lists. Sometimes called variable or definition lists.
9
- </li><li>
10
- Callout lists (a list of callout annotations).
11
- </li></ul></div><div class="itemizedlist"><p class="title"><b>List behavior</b></p><ul type="disc"><li>
12
- List item indentation is optional and does not determine nesting,
13
- indentation does however make the source more readable.
14
- </li><li>
15
- Another list or a literal paragraph immediately following a list
16
- item will be implicitly included in the list item; use <a class="link" href="ar01s14.html#X15" title="List Item Continuation">list item continuation</a> to explicitly append other block elements to a
17
- list item.
18
- </li><li>
19
- A comment block or a comment line block macro element will terminate
20
- a list — use inline comment lines to put comments inside lists.
21
- </li><li>
22
- The <code class="literal">listindex</code> <a class="link" href="ar01s27.html" title="Intrinsic Attributes">intrinsic attribute</a> is the current list item
23
- index (1..). If this attribute is used outside a list then it’s value
24
- is the number of items in the most recently closed list. Useful for
25
- displaying the number of items in a list.
26
- </li></ul></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_bulleted_lists"></a>Bulleted Lists</h3></div></div></div><p>Bulleted list items start with a single dash or one to five asterisks
27
- followed by some white space then some text. Bulleted list syntaxes
28
- are:</p><pre class="literallayout">- List item.
29
- * List item.
30
- ** List item.
31
- *** List item.
32
- **** List item.
33
- ***** List item.</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_numbered_lists"></a>Numbered Lists</h3></div></div></div><p>List item numbers are explicit or implicit.</p><p><b>Explicit numbering. </b>List items begin with a number followed by some white space then the
34
- item text. The numbers can be decimal (arabic), roman (upper or lower
35
- case) or alpha (upper or lower case). Decimal and alpha numbers are
36
- terminated with a period, roman numbers are terminated with a closing
37
- parenthesis. The different terminators are necessary to ensure <span class="emphasis"><em>i</em></span>,
38
- <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
39
- <span class="emphasis"><em>x</em></span> alpha numbers. Examples:</p><pre class="literallayout">1. Arabic (decimal) numbered list item.
40
- a. Lower case alpha (letter) numbered list item.
41
- F. Upper case alpha (letter) numbered list item.
42
- iii) Lower case roman numbered list item.
43
- IX) Upper case roman numbered list item.</pre><p><b>Implicit numbering. </b>List items begin one to five period characters, followed by some white
44
- space then the item text. Examples:</p><pre class="literallayout">. Arabic (decimal) numbered list item.
45
- .. Lower case alpha (letter) numbered list item.
46
- ... Lower case roman numbered list item.
47
- .... Upper case alpha (letter) numbered list item.
48
- ..... Upper case roman numbered list item.</pre><p>You can use the <span class="emphasis"><em>style</em></span> attribute (also the first positional
49
- attribute) to specify an alternative numbering style. The numbered
50
- list style can be one of the following values: <span class="emphasis"><em>arabic</em></span>, <span class="emphasis"><em>loweralpha</em></span>,
51
- <span class="emphasis"><em>upperalpha</em></span>, <span class="emphasis"><em>lowerroman</em></span>, <span class="emphasis"><em>upperroman</em></span>.</p><p>Here are some examples of bulleted and numbered lists:</p><pre class="screen">- Praesent eget purus quis magna eleifend eleifend.
52
- 1. Fusce euismod commodo velit.
53
- a. Fusce euismod commodo velit.
54
- b. Vivamus fringilla mi eu lacus.
55
- c. Donec eget arcu bibendum nunc consequat lobortis.
56
- 2. Vivamus fringilla mi eu lacus.
57
- i) Fusce euismod commodo velit.
58
- ii) Vivamus fringilla mi eu lacus.
59
- 3. Donec eget arcu bibendum nunc consequat lobortis.
60
- 4. Nam fermentum mattis ante.
61
- - Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
62
- * Fusce euismod commodo velit.
63
- ** Qui in magna commodo, est labitur dolorum an. Est ne magna primis
64
- adolescens. Sit munere ponderum dignissim et. Minim luptatum et
65
- vel.
66
- ** Vivamus fringilla mi eu lacus.
67
- * Donec eget arcu bibendum nunc consequat lobortis.
68
- - Nulla porttitor vulputate libero.
69
- . Fusce euismod commodo velit.
70
- . Vivamus fringilla mi eu lacus.
71
- [upperroman]
72
- .. Fusce euismod commodo velit.
73
- .. Vivamus fringilla mi eu lacus.
74
- . Donec eget arcu bibendum nunc consequat lobortis.</pre><p>Which render as:</p><div class="itemizedlist"><ul type="disc"><li><p>
75
- Praesent eget purus quis magna eleifend eleifend.
76
- </p><div class="orderedlist"><ol type="1"><li><p>
77
- Fusce euismod commodo velit.
78
- </p><div class="orderedlist"><ol type="a"><li>
79
- Fusce euismod commodo velit.
80
- </li><li>
81
- Vivamus fringilla mi eu lacus.
82
- </li><li>
83
- Donec eget arcu bibendum nunc consequat lobortis.
84
- </li></ol></div></li><li><p>
85
- Vivamus fringilla mi eu lacus.
86
- </p><div class="orderedlist"><ol type="i"><li>
87
- Fusce euismod commodo velit.
88
- </li><li>
89
- Vivamus fringilla mi eu lacus.
90
- </li></ol></div></li><li>
91
- Donec eget arcu bibendum nunc consequat lobortis.
92
- </li><li>
93
- Nam fermentum mattis ante.
94
- </li></ol></div></li><li><p>
95
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
96
- </p><div class="itemizedlist"><ul type="circle"><li><p>
97
- Fusce euismod commodo velit.
98
- </p><div class="itemizedlist"><ul type="square"><li>
99
- Qui in magna commodo, est labitur dolorum an. Est ne magna primis
100
- adolescens. Sit munere ponderum dignissim et. Minim luptatum et
101
- vel.
102
- </li><li>
103
- Vivamus fringilla mi eu lacus.
104
- </li></ul></div></li><li>
105
- Donec eget arcu bibendum nunc consequat lobortis.
106
- </li></ul></div></li><li><p>
107
- Nulla porttitor vulputate libero.
108
- </p><div class="orderedlist"><ol type="1"><li>
109
- Fusce euismod commodo velit.
110
- </li><li><p>
111
- Vivamus fringilla mi eu lacus.
112
- </p><div class="orderedlist"><ol type="I"><li>
113
- Fusce euismod commodo velit.
114
- </li><li>
115
- Vivamus fringilla mi eu lacus.
116
- </li></ol></div></li><li>
117
- Donec eget arcu bibendum nunc consequat lobortis.
118
- </li></ol></div></li></ul></div><p>A predefined <span class="emphasis"><em>compact</em></span> option is available to bulleted and numbered
119
- lists — this translates to the DocBook <span class="emphasis"><em>spacing="compact"</em></span> lists
120
- attribute which may or may not be processed by the DocBook toolchain.
121
- Example:</p><pre class="literallayout">[options="compact"]
122
- - Compact list item.
123
- - Another compact list item.</pre><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>To apply the <span class="emphasis"><em>compact</em></span> option globally define a document-wide
124
- <span class="emphasis"><em>compact-option</em></span> attribute, e.g. using the <code class="literal">-a compact-option</code>
125
- command-line option.</p></div><p>You can set the list start number using the <span class="emphasis"><em>start</em></span> attribute (works
126
- for HTML outputs and DocBook outputs processed by DocBook XSL
127
- Stylesheets). Example:</p><pre class="literallayout">[start=7]
128
- . List item 7.
129
- . List item 8.</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_labeled_lists"></a>Labeled Lists</h3></div></div></div><p>Labeled list items consist of one or more text labels followed by the
130
- text of the list item.</p><p>An item label begins a line with an alphanumeric character hard
131
- against the left margin and ends with two, three or four colons or two
132
- semi-colons. A list item can have multiple labels, one per line.</p><p>The list item text consists of one or more lines of text starting
133
- after the last label (either on the same line or a new line) and can
134
- be followed by nested List or ListParagraph elements. Item text can be
135
- optionally indented.</p><p>Here are some examples:</p><pre class="screen">In::
136
- Lorem::
137
- Fusce euismod commodo velit.
138
-
139
- Fusce euismod commodo velit.
140
-
141
- Ipsum:: Vivamus fringilla mi eu lacus.
142
- * Vivamus fringilla mi eu lacus.
143
- * Donec eget arcu bibendum nunc consequat lobortis.
144
- Dolor::
145
- Donec eget arcu bibendum nunc consequat lobortis.
146
- Suspendisse;;
147
- A massa id sem aliquam auctor.
148
- Morbi;;
149
- Pretium nulla vel lorem.
150
- In;;
151
- Dictum mauris in urna.
152
- Vivamus::: Fringilla mi eu lacus.
153
- Donec::: Eget arcu bibendum nunc consequat lobortis.</pre><p>Which render as:</p><div class="variablelist"><dl><dt><span class="term">
154
- In
155
- , </span><span class="term">
156
- Lorem
157
- </span></dt><dd><p>
158
- Fusce euismod commodo velit.
159
- </p><pre class="literallayout">Fusce euismod commodo velit.</pre></dd><dt><span class="term">
160
- Ipsum
161
- </span></dt><dd><p>
162
- Vivamus fringilla mi eu lacus.
163
- </p><div class="itemizedlist"><ul type="disc"><li>
164
- Vivamus fringilla mi eu lacus.
165
- </li><li>
166
- Donec eget arcu bibendum nunc consequat lobortis.
167
- </li></ul></div></dd><dt><span class="term">
168
- Dolor
169
- </span></dt><dd><p>
170
- Donec eget arcu bibendum nunc consequat lobortis.
171
- </p><div class="variablelist"><dl><dt><span class="term">
172
- Suspendisse
173
- </span></dt><dd>
174
- A massa id sem aliquam auctor.
175
- </dd><dt><span class="term">
176
- Morbi
177
- </span></dt><dd>
178
- Pretium nulla vel lorem.
179
- </dd><dt><span class="term">
180
- In
181
- </span></dt><dd><p>
182
- Dictum mauris in urna.
183
- </p><div class="variablelist"><dl><dt><span class="term">
184
- Vivamus
185
- </span></dt><dd>
186
- Fringilla mi eu lacus.
187
- </dd><dt><span class="term">
188
- Donec
189
- </span></dt><dd>
190
- Eget arcu bibendum nunc consequat lobortis.
191
- </dd></dl></div></dd></dl></div></dd></dl></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="_horizontal_labeled_list_style"></a>Horizontal labeled list style</h4></div></div></div><p>The <span class="emphasis"><em>horizontal</em></span> labeled list style (also the first positional
192
- attribute) places the list text side-by-side with the label instead of
193
- under the label. Here is an example:</p><pre class="screen">[horizontal]
194
- *Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est
195
- labitur dolorum an. Est ne magna primis adolescens.
196
-
197
- Fusce euismod commodo velit.
198
-
199
- *Ipsum*:: Vivamus fringilla mi eu lacus.
200
- - Vivamus fringilla mi eu lacus.
201
- - Donec eget arcu bibendum nunc consequat lobortis.
202
-
203
- *Dolor*::
204
- - Vivamus fringilla mi eu lacus.
205
- - Donec eget arcu bibendum nunc consequat lobortis.</pre><p>Which render as:</p><div class="horizontal"><table border="0"><colgroup><col /><col /></colgroup><tbody valign="top"><tr><td valign="top">
206
- <p>
207
- <span class="strong"><strong>Lorem</strong></span>
208
- </p>
209
- </td><td valign="top">
210
- <p>
211
- Fusce euismod commodo velit. Qui in magna commodo, est
212
- labitur dolorum an. Est ne magna primis adolescens.
213
- </p>
214
- <pre class="literallayout">Fusce euismod commodo velit.</pre>
215
- </td></tr><tr><td valign="top">
216
- <p>
217
- <span class="strong"><strong>Ipsum</strong></span>
218
- </p>
219
- </td><td valign="top">
220
- <p>
221
- Vivamus fringilla mi eu lacus.
222
- </p>
223
- <div class="itemizedlist"><ul type="disc"><li>
224
- Vivamus fringilla mi eu lacus.
225
- </li><li>
226
- Donec eget arcu bibendum nunc consequat lobortis.
227
- </li></ul></div>
228
- </td></tr><tr><td valign="top">
229
- <p>
230
- <span class="strong"><strong>Dolor</strong></span>
231
- </p>
232
- </td><td valign="top">
233
- <div class="itemizedlist"><ul type="disc"><li>
234
- Vivamus fringilla mi eu lacus.
235
- </li><li>
236
- Donec eget arcu bibendum nunc consequat lobortis.
237
- </li></ul></div>
238
- </td></tr></tbody></table></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><div class="itemizedlist"><ul type="disc"><li>
239
- Current PDF toolchains do not make a good job of determining
240
- the relative column widths for horizontal labeled lists.
241
- </li><li>
242
- Nested horizontal labeled lists will generate DocBook validation
243
- errors because the <span class="emphasis"><em>DocBook XML V4.2</em></span> DTD does not permit nested
244
- informal tables (although <a class="link" href="ar01s30.html#X13">DocBook XSL Stylesheets</a> and
245
- <a class="link" href="ar01s30.html#X31">dblatex</a> process them correctly).
246
- </li><li>
247
- The label width can be set as a percentage of the total width by
248
- setting the <span class="emphasis"><em>width</em></span> attribute e.g. <code class="literal">width="10%"</code>
249
- </li></ul></div></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_question_and_answer_lists"></a>Question and Answer Lists</h3></div></div></div><p>AsciiDoc comes pre-configured with a <span class="emphasis"><em>qanda</em></span> style labeled list for generating
250
- DocBook question and answer (Q&amp;A) lists. Example:</p><pre class="screen">[qanda]
251
- Question one::
252
- Answer one.
253
- Question two::
254
- Answer two.</pre><p>Renders:</p><div class="qandaset"><dl><dt>1. <a href="ar01s14.html#id36118638">
255
- Question one
256
- </a></dt><dt>2. <a href="ar01s14.html#id36118654">
257
- Question two
258
- </a></dt></dl><table border="0" summary="Q and A Set"><col align="left" width="1%" /><tbody><tr class="question"><td align="left" valign="top"><a id="id36118638"></a><a id="id36118640"></a><p><b>1.</b></p></td><td align="left" valign="top"><p>
259
- Question one
260
- </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
261
- Answer one.
262
- </p></td></tr><tr class="question"><td align="left" valign="top"><a id="id36118654"></a><a id="id36118656"></a><p><b>2.</b></p></td><td align="left" valign="top"><p>
263
- Question two
264
- </p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
265
- Answer two.
266
- </p></td></tr></tbody></table></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_glossary_lists"></a>Glossary Lists</h3></div></div></div><p>AsciiDoc comes pre-configured with a <span class="emphasis"><em>glossary</em></span> style labeled list for
267
- generating DocBook glossary lists. Example:</p><pre class="screen">[glossary]
268
- A glossary term::
269
- The corresponding definition.
270
- A second glossary term::
271
- The corresponding definition.</pre><p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in
272
- the AsciiDoc <code class="literal">./doc</code> distribution directory.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>To generate valid DocBook output glossary lists must be located
273
- in a section that uses the <span class="emphasis"><em>glossary</em></span> <a class="link" href="ar01s05.html#X93" title="Section markup templates">section markup template</a>.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_bibliography_lists"></a>Bibliography Lists</h3></div></div></div><p>AsciiDoc comes with a predefined <span class="emphasis"><em>bibliography</em></span> bulleted list style
274
- generating DocBook bibliography entries. Example:</p><pre class="screen">[bibliography]
275
- .Optional list title
276
- - [[[taoup]]] Eric Steven Raymond. 'The Art of UNIX
277
- Programming'. Addison-Wesley. ISBN 0-13-142901-9.
278
- - [[[walsh-muellner]]] Norman Walsh &amp; Leonard Muellner.
279
- 'DocBook - The Definitive Guide'. O'Reilly &amp; Associates.
280
- 1999. ISBN 1-56592-580-7.</pre><p>The <code class="literal">[[[&lt;reference&gt;]]]</code> syntax is a bibliography entry anchor, it
281
- generates an anchor named <code class="literal">&lt;reference&gt;</code> and additionally displays
282
- <code class="literal">[&lt;reference&gt;]</code> at the anchor position. For example <code class="literal">[[[taoup]]]</code>
283
- generates an anchor named <code class="literal">taoup</code> that displays <code class="literal">[taoup]</code> at the
284
- anchor position. Cite the reference from elsewhere your document using
285
- <code class="literal">&lt;&lt;taoup&gt;&gt;</code>, this displays a hyperlink (<code class="literal">[taoup]</code>) to the
286
- corresponding bibliography entry anchor.</p><p>For working examples see the <code class="literal">article.txt</code> and <code class="literal">book.txt</code> documents in
287
- the AsciiDoc <code class="literal">./doc</code> distribution directory.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>To generate valid DocBook output bibliography lists must be
288
- located in a <a class="link" href="ar01s05.html#X93" title="Section markup templates">bibliography section</a>.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X15"></a>List Item Continuation</h3></div></div></div><p>Another list or a literal paragraph immediately following a list item
289
- is implicitly appended to the list item; to append other block
290
- elements to a list item you need to explicitly join them to the list
291
- item with a <span class="emphasis"><em>list continuation</em></span> (a separator line containing a single
292
- plus character). Multiple block elements can be appended to a list
293
- item using list continuations (provided they are legal list item
294
- children in the backend markup).</p><p>Here are some examples of list item continuations: list item one
295
- contains multiple continuations; list item two is continued with an
296
- <a class="link" href="ar01s13.html#X29" title="Open Blocks">OpenBlock</a> containing multiple elements:</p><pre class="screen">1. List item one.
297
- +
298
- List item one continued with a second paragraph followed by an
299
- Indented block.
300
- +
301
- .................
302
- $ ls *.sh
303
- $ mv *.sh ~/tmp
304
- .................
305
- +
306
- List item continued with a third paragraph.
307
-
308
- 2. List item two continued with an open block.
309
- +
310
- --
311
- This paragraph is part of the preceding list item.
312
-
313
- a. This list is nested and does not require explicit item continuation.
314
- +
315
- This paragraph is part of the preceding list item.
316
-
317
- b. List item b.
318
-
319
- This paragraph belongs to item two of the outer list.
320
- --</pre><p>Renders:</p><div class="orderedlist"><ol type="1"><li><p>
321
- List item one.
322
- </p><p>List item one continued with a second paragraph followed by an
323
- Indented block.</p><pre class="literallayout">$ ls *.sh
324
- $ mv *.sh ~/tmp</pre><p>List item continued with a third paragraph.</p></li><li><p>
325
- List item two continued with an open block.
326
- </p><p>This paragraph is part of the preceding list item.</p><div class="orderedlist"><ol type="a"><li><p>
327
- This list is nested and does not require explicit item continuation.
328
- </p><p>This paragraph is part of the preceding list item.</p></li><li>
329
- List item b.
330
- </li></ol></div><p>This paragraph belongs to item two of the outer list.</p></li></ol></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s13.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s15.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Delimited Blocks </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Footnotes</td></tr></table></div></body></html>