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
data/example/output/converting_docbook_to_other_file_formats.html DELETED
@@ -1,324 +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>Converting DocBook to other file formats</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="filters.html">Prev</a><br/>
15
- Filters
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="generating_plain_text_files.html">Next</a><br/>
25
- Generating Plain Text Files
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="X12"></a>Converting DocBook to other file formats</h2></div></div></div>
37
- <p>DocBook files are validated, parsed and translated various
38
- presentation file formats using a combination of applications
39
- collectively called a DocBook <span class="emphasis"><em>tool chain</em></span>. The function of a tool
40
- chain is to read the DocBook markup (produced by AsciiDoc) and
41
- transform it to a presentation format (for example HTML, PDF, HTML
42
- Help, EPUB, DVI, PostScript, LaTeX).</p>
43
- <p>A wide range of user output format requirements coupled with a choice
44
- of available tools and stylesheets results in many valid tool chain
45
- combinations.</p>
46
- <div class="section" lang="en" xml:lang="en">
47
- <div class="titlepage"><div><div><h3 class="title">
48
- <a id="X43"></a>a2x Toolchain Wrapper</h3></div></div></div>
49
- <p>One of the biggest hurdles for new users is installing, configuring
50
- and using a DocBook XML toolchain. <code class="literal">a2x(1)</code> can help — it’s a
51
- toolchain wrapper command that will generate XHTML (chunked and
52
- unchunked), PDF, EPUB, DVI, PS, LaTeX, man page, HTML Help and text
53
- file outputs from an AsciiDoc text file. <code class="literal">a2x(1)</code> does all the grunt
54
- work associated with generating and sequencing the toolchain commands
55
- and managing intermediate and output files. <code class="literal">a2x(1)</code> also optionally
56
- deploys admonition and navigation icons and a CSS stylesheet. See the
57
- <code class="literal">a2x(1)</code> man page for more details. In addition to <code class="literal">asciidoc(1)</code> you
58
- also need <a class="link" href="converting_docbook_to_other_file_formats.html#X40">xsltproc(1)</a>, <a class="link" href="converting_docbook_to_other_file_formats.html#X13">DocBook XSL Stylesheets</a> and
59
- optionally: <a class="link" href="converting_docbook_to_other_file_formats.html#X31">dblatex</a> or <a class="link" href="converting_docbook_to_other_file_formats.html#X14">FOP</a> (to generate PDF);
60
- <code class="literal">w3m(1)</code> or <code class="literal">lynx(1)</code> (to generate text).</p>
61
- <p>The following examples generate <code class="literal">doc/source-highlight-filter.pdf</code> from
62
- the AsciiDoc <code class="literal">doc/source-highlight-filter.txt</code> source file. The first
63
- example uses <code class="literal">dblatex(1)</code> (the default PDF generator) the second
64
- example forces FOP to be used:</p>
65
- <pre class="literallayout">$ a2x -f pdf doc/source-highlight-filter.txt
66
- $ a2x -f pdf --fop doc/source-highlight-filter.txt</pre>
67
- <p>See the <code class="literal">a2x(1)</code> man page for details.</p>
68
- <div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
69
- <h3 class="title">Tip</h3>
70
- <p>Use the <code class="literal">--verbose</code> command-line option to view executed
71
- toolchain commands.</p>
72
- </div>
73
- </div>
74
- <div class="section" lang="en" xml:lang="en">
75
- <div class="titlepage"><div><div><h3 class="title">
76
- <a id="_html_generation"></a>HTML generation</h3></div></div></div>
77
- <p>AsciiDoc produces nicely styled HTML directly without requiring a
78
- DocBook toolchain but there are also advantages in going the DocBook
79
- route:</p>
80
- <div class="itemizedlist"><ul type="disc">
81
- <li>
82
- HTML from DocBook can optionally include automatically generated
83
- indexes, tables of contents, footnotes, lists of figures and tables.
84
- </li>
85
- <li>
86
- DocBook toolchains can also (optionally) generate separate (chunked)
87
- linked HTML pages for each document section.
88
- </li>
89
- <li>
90
- Toolchain processing performs link and document validity checks.
91
- </li>
92
- <li>
93
- If the DocBook <span class="emphasis"><em>lang</em></span> attribute is set then things like table of
94
- contents, figure and table captions and admonition captions will be
95
- output in the specified language (setting the AsciiDoc <span class="emphasis"><em>lang</em></span>
96
- attribute sets the DocBook <span class="emphasis"><em>lang</em></span> attribute).
97
- </li>
98
- </ul></div>
99
- <p>On the other hand, HTML output directly from AsciiDoc is much faster,
100
- is easily customized and can be used in situations where there is no
101
- suitable DocBook toolchain (for example, see the <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">AsciiDoc
102
- website</a>).</p>
103
- </div>
104
- <div class="section" lang="en" xml:lang="en">
105
- <div class="titlepage"><div><div><h3 class="title">
106
- <a id="_pdf_generation"></a>PDF generation</h3></div></div></div>
107
- <p>There are two commonly used tools to generate PDFs from DocBook,
108
- <a class="link" href="converting_docbook_to_other_file_formats.html#X31">dblatex</a> and <a class="link" href="converting_docbook_to_other_file_formats.html#X14">FOP</a>.</p>
109
- <div class="itemizedlist">
110
- <p class="title"><b>dblatex or FOP?</b></p>
111
- <ul type="disc">
112
- <li>
113
- <span class="emphasis"><em>dblatex</em></span> is easier to install, there’s zero configuration
114
- required and no Java VM to install — it just works out of the box.
115
- </li>
116
- <li>
117
- <span class="emphasis"><em>dblatex</em></span> source code highlighting and numbering is superb.
118
- </li>
119
- <li>
120
- <span class="emphasis"><em>dblatex</em></span> is easier to use as it converts DocBook directly to PDF
121
- whereas before using <span class="emphasis"><em>FOP</em></span> you have to convert DocBook to XML-FO
122
- using <a class="link" href="converting_docbook_to_other_file_formats.html#X13">DocBook XSL Stylesheets</a>.
123
- </li>
124
- <li>
125
- <span class="emphasis"><em>FOP</em></span> is more feature complete (for example, callouts are processed
126
- inside literal layouts) and arguably produces nicer looking output.
127
- </li>
128
- </ul>
129
- </div>
130
- </div>
131
- <div class="section" lang="en" xml:lang="en">
132
- <div class="titlepage"><div><div><h3 class="title">
133
- <a id="_html_help_generation"></a>HTML Help generation</h3></div></div></div>
134
- <div class="orderedlist"><ol type="1">
135
- <li>
136
- Convert DocBook XML documents to HTML Help compiler source files
137
- using <a class="link" href="converting_docbook_to_other_file_formats.html#X13">DocBook XSL Stylesheets</a> and <a class="link" href="converting_docbook_to_other_file_formats.html#X40">xsltproc(1)</a>.
138
- </li>
139
- <li>
140
- Convert the HTML Help source (<code class="literal">.hhp</code> and <code class="literal">.html</code>) files to HTML Help
141
- (<code class="literal">.chm</code>) files using the <a class="link" href="converting_docbook_to_other_file_formats.html#X67">Microsoft HTML Help Compiler</a>.
142
- </li>
143
- </ol></div>
144
- </div>
145
- <div class="section" lang="en" xml:lang="en">
146
- <div class="titlepage"><div><div><h3 class="title">
147
- <a id="_toolchain_components_summary"></a>Toolchain components summary</h3></div></div></div>
148
- <div class="variablelist"><dl>
149
- <dt><span class="term">
150
- AsciiDoc
151
- </span></dt>
152
- <dd>
153
- Converts AsciiDoc (<code class="literal">.txt</code>) files to DocBook XML (<code class="literal">.xml</code>) files.
154
- </dd>
155
- <dt><span class="term">
156
- <a id="X13"></a><a class="ulink" href="http://docbook.sourceforge.net/projects/xsl/" target="_top">DocBook XSL Stylesheets</a>
157
- </span></dt>
158
- <dd>
159
- These are a set of XSL stylesheets containing rules for converting
160
- DocBook XML documents to HTML, XSL-FO, manpage and HTML Help files.
161
- The stylesheets are used in conjunction with an XML parser such as
162
- <a class="link" href="converting_docbook_to_other_file_formats.html#X40">xsltproc(1)</a>.
163
- </dd>
164
- <dt><span class="term">
165
- <a id="X40"></a><a class="ulink" href="http://www.xmlsoft.org" target="_top">xsltproc</a>
166
- </span></dt>
167
- <dd>
168
- An XML parser for applying XSLT stylesheets (in our case the
169
- <a class="link" href="converting_docbook_to_other_file_formats.html#X13">DocBook XSL Stylesheets</a>) to XML documents.
170
- </dd>
171
- <dt><span class="term">
172
- <a id="X31"></a><a class="ulink" href="http://dblatex.sourceforge.net/" target="_top">dblatex</a>
173
- </span></dt>
174
- <dd>
175
- Generates PDF, DVI, PostScript and LaTeX formats directly from
176
- DocBook source via the intermediate LaTeX typesetting language —  uses <a class="link" href="converting_docbook_to_other_file_formats.html#X13">DocBook XSL Stylesheets</a>, <a class="link" href="converting_docbook_to_other_file_formats.html#X40">xsltproc(1)</a> and
177
- <code class="literal">latex(1)</code>.
178
- </dd>
179
- <dt><span class="term">
180
- <a id="X14"></a><a class="ulink" href="http://xml.apache.org/fop/" target="_top">FOP</a>
181
- </span></dt>
182
- <dd>
183
- The Apache Formatting Objects Processor converts XSL-FO (<code class="literal">.fo</code>)
184
- files to PDF files. The XSL-FO files are generated from DocBook
185
- source files using <a class="link" href="converting_docbook_to_other_file_formats.html#X13">DocBook XSL Stylesheets</a> and
186
- <a class="link" href="converting_docbook_to_other_file_formats.html#X40">xsltproc(1)</a>.
187
- </dd>
188
- <dt><span class="term">
189
- <a id="X67"></a>Microsoft Help Compiler
190
- </span></dt>
191
- <dd>
192
- The Microsoft HTML Help Compiler (<code class="literal">hhc.exe</code>) is a command-line tool
193
- that converts HTML Help source files to a single HTML Help (<code class="literal">.chm</code>)
194
- file. It runs on MS Windows platforms and can be downloaded from
195
- <a class="ulink" href="http://www.microsoft.com" target="_top">http://www.microsoft.com</a>.
196
- </dd>
197
- </dl></div>
198
- </div>
199
- <div class="section" lang="en" xml:lang="en">
200
- <div class="titlepage"><div><div><h3 class="title">
201
- <a id="_asciidoc_dblatex_configuration_files"></a>AsciiDoc dblatex configuration files</h3></div></div></div>
202
- <p>The AsciiDoc distribution <code class="literal">./dblatex</code> directory contains
203
- <code class="literal">asciidoc-dblatex.xsl</code> (customized XSL parameter settings) and
204
- <code class="literal">asciidoc-dblatex.sty</code> (customized LaTeX settings). These are examples
205
- of optional <a class="link" href="converting_docbook_to_other_file_formats.html#X31">dblatex</a> output customization and are used by
206
- <a class="link" href="converting_docbook_to_other_file_formats.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a>.</p>
207
- </div>
208
- <div class="section" lang="en" xml:lang="en">
209
- <div class="titlepage"><div><div><h3 class="title">
210
- <a id="_asciidoc_docbook_xsl_stylesheets_drivers"></a>AsciiDoc DocBook XSL Stylesheets drivers</h3></div></div></div>
211
- <p>You will have noticed that the distributed HTML and HTML Help
212
- documentation files (for example <code class="literal">./doc/asciidoc.html</code>) are not the
213
- plain outputs produced using the default <span class="emphasis"><em>DocBook XSL Stylesheets</em></span>
214
- configuration. This is because they have been processed using
215
- customized DocBook XSL Stylesheets along with (in the case of HTML
216
- outputs) the custom <code class="literal">./stylesheets/docbook.css</code> CSS stylesheet.</p>
217
- <p>You’ll find the customized DocBook XSL drivers along with additional
218
- documentation in the distribution <code class="literal">./docbook-xsl</code> directory. The
219
- examples that follow are executed from the distribution documentation
220
- (<code class="literal">./doc</code>) directory. These drivers are also used by <a class="link" href="converting_docbook_to_other_file_formats.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a>.</p>
221
- <div class="variablelist"><dl>
222
- <dt><span class="term">
223
- <code class="literal">common.xsl</code>
224
- </span></dt>
225
- <dd>
226
- Shared driver parameters. This file is not used directly but is
227
- included in all the following drivers.
228
- </dd>
229
- <dt><span class="term">
230
- <code class="literal">chunked.xsl</code>
231
- </span></dt>
232
- <dd>
233
- <p>
234
- Generate chunked XHTML (separate HTML pages for each document
235
- section) in the <code class="literal">./doc/chunked</code> directory. For example:
236
- </p>
237
- <pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt
238
- $ xsltproc --nonet ../docbook-xsl/chunked.xsl asciidoc.xml</pre>
239
- </dd>
240
- <dt><span class="term">
241
- <code class="literal">epub.xsl</code>
242
- </span></dt>
243
- <dd>
244
- Used by <a class="link" href="converting_docbook_to_other_file_formats.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a> to generate EPUB formatted documents.
245
- </dd>
246
- <dt><span class="term">
247
- <code class="literal">fo.xsl</code>
248
- </span></dt>
249
- <dd>
250
- <p>
251
- Generate XSL Formatting Object (<code class="literal">.fo</code>) files for subsequent PDF
252
- file generation using FOP. For example:
253
- </p>
254
- <pre class="literallayout">$ python ../asciidoc.py -b docbook article.txt
255
- $ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml &gt; article.fo
256
- $ fop article.fo article.pdf</pre>
257
- </dd>
258
- <dt><span class="term">
259
- <code class="literal">htmlhelp.xsl</code>
260
- </span></dt>
261
- <dd>
262
- <p>
263
- Generate Microsoft HTML Help source files for the MS HTML Help
264
- Compiler in the <code class="literal">./doc/htmlhelp</code> directory. This example is run on
265
- MS Windows from a Cygwin shell prompt:
266
- </p>
267
- <pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt
268
- $ xsltproc --nonet ../docbook-xsl/htmlhelp.xsl asciidoc.xml
269
- $ c:/Program\ Files/HTML\ Help\ Workshop/hhc.exe htmlhelp.hhp</pre>
270
- </dd>
271
- <dt><span class="term">
272
- <code class="literal">manpage.xsl</code>
273
- </span></dt>
274
- <dd>
275
- <p>
276
- Generate a <code class="literal">roff(1)</code> format UNIX man page from a DocBook XML
277
- <span class="emphasis"><em>refentry</em></span> document. This example generates an <code class="literal">asciidoc.1</code> man
278
- page file:
279
- </p>
280
- <pre class="literallayout">$ python ../asciidoc.py -d manpage -b docbook asciidoc.1.txt
281
- $ xsltproc --nonet ../docbook-xsl/manpage.xsl asciidoc.1.xml</pre>
282
- </dd>
283
- <dt><span class="term">
284
- <code class="literal">xhtml.xsl</code>
285
- </span></dt>
286
- <dd>
287
- <p>
288
- Convert a DocBook XML file to a single XHTML file. For example:
289
- </p>
290
- <pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt
291
- $ xsltproc --nonet ../docbook-xsl/xhtml.xsl asciidoc.xml &gt; asciidoc.html</pre>
292
- </dd>
293
- </dl></div>
294
- <p>If you want to see how the complete documentation set is processed
295
- take a look at the A-A-P script <code class="literal">./doc/main.aap</code>.</p>
296
- </div>
297
- </div>
298
-
299
- </div>
300
-
301
- <hr/>
302
-
303
- <div class="nav" id="navfooter">
304
- <table width="100%">
305
- <tr><td width="33%" align="left">
306
-
307
- <a href="filters.html">Prev</a><br/>
308
- Filters
309
-
310
- </td><td width="33%" align="center">
311
-
312
- <a href="index.html">Home</a><br/>
313
- AsciiDoc User Guide
314
-
315
- </td><td width="33%" align="right">
316
-
317
- <a href="generating_plain_text_files.html">Next</a><br/>
318
- Generating Plain Text Files
319
-
320
- </td></tr>
321
- </table>
322
- </div>
323
- </body>
324
- </html>
data/example/output/d_using_asciidoc_with_non-english_languages.html DELETED
@@ -1,107 +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>D. Using AsciiDoc with non-English Languages</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="c_asciidoc_safe_mode.html">Prev</a><br/>
15
- C. AsciiDoc Safe Mode
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="e_vim_syntax_highlighter.html">Next</a><br/>
25
- E. Vim Syntax Highlighter
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="appendix" lang="en" xml:lang="en">
35
- <div class="titlepage"><div><div><h2 class="title">
36
- <a id="_using_asciidoc_with_non_english_languages"></a>D. Using AsciiDoc with non-English Languages</h2></div></div></div>
37
- <p>AsciiDoc can process UTF-8 character sets but there are some things
38
- you need to be aware of:</p>
39
- <div class="itemizedlist"><ul type="disc">
40
- <li>
41
- <p>
42
- If you are generating output documents using a DocBook toolchain
43
- then you should set the AsciiDoc <code class="literal">lang</code> attribute to the appropriate
44
- language (it defaults to <code class="literal">en</code> (English)). This will ensure things
45
- like table of contents, figure and table captions and admonition
46
- captions are output in the specified language. For example:
47
- </p>
48
- <pre class="literallayout">$ a2x -a lang=es doc/article.txt</pre>
49
- </li>
50
- <li>
51
- <p>
52
- If you are outputting HTML directly from asciidoc(1) you’ll
53
- need to set the various <code class="literal">*_caption</code> attributes to match your target
54
- language (see the list of captions and titles in the <code class="literal">[attributes]</code>
55
- section of the distribution <code class="literal">lang-*.conf</code> files). The easiest way is
56
- to create a language <code class="literal">.conf</code> file (see the AsciiDoc’s <code class="literal">lang-en.conf</code>
57
- file).
58
- </p>
59
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
60
- <h3 class="title">Note</h3>
61
- <p>You still use the <span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>CAUTION</em></span>, <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>WARNING</em></span>,
62
- <span class="emphasis"><em>IMPORTANT</em></span> captions in the AsciiDoc source, they get translated in
63
- the HTML output file.</p>
64
- </div>
65
- </li>
66
- <li>
67
- asciidoc(1) automatically loads configuration files named like
68
- <code class="literal">lang-&lt;lang&gt;.conf</code> where <code class="literal">&lt;lang&gt;</code> is a two letter language code that
69
- matches the current AsciiDoc <code class="literal">lang</code> attribute. See also
70
- <a class="link" href="configuration_files.html#X27" title="Configuration File Names and Locations">Configuration File Names and Locations</a>.
71
- </li>
72
- <li>
73
- Some character sets display double-width characters (for example
74
- Japanese). As far as <a class="link" href="titles.html" title="Titles">title underlines</a> are concerned they
75
- should be treated as single character. If you think this looks
76
- untidy so you may prefer to use the <a class="link" href="titles.html#X46" title="One line titles">single line title</a>
77
- format.
78
- </li>
79
- </ul></div>
80
- </div>
81
-
82
- </div>
83
-
84
- <hr/>
85
-
86
- <div class="nav" id="navfooter">
87
- <table width="100%">
88
- <tr><td width="33%" align="left">
89
-
90
- <a href="c_asciidoc_safe_mode.html">Prev</a><br/>
91
- C. AsciiDoc Safe Mode
92
-
93
- </td><td width="33%" align="center">
94
-
95
- <a href="index.html">Home</a><br/>
96
- AsciiDoc User Guide
97
-
98
- </td><td width="33%" align="right">
99
-
100
- <a href="e_vim_syntax_highlighter.html">Next</a><br/>
101
- E. Vim Syntax Highlighter
102
-
103
- </td></tr>
104
- </table>
105
- </div>
106
- </body>
107
- </html>
data/example/output/delimited_blocks.html DELETED
@@ -1,455 +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>Delimited Blocks</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="paragraphs.html">Prev</a><br/>
15
- Paragraphs
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="lists.html">Next</a><br/>
25
- Lists
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="_delimited_blocks"></a>Delimited Blocks</h2></div></div></div>
37
- <p>Delimited blocks are blocks of text enveloped by leading and trailing
38
- delimiter lines (normally a series of four or more repeated
39
- characters). The behavior of Delimited Blocks is specified by entries
40
- in configuration file <code class="literal">[blockdef-*]</code> sections.</p>
41
- <div class="section" lang="en" xml:lang="en">
42
- <div class="titlepage"><div><div><h3 class="title">
43
- <a id="_predefined_delimited_blocks"></a>Predefined Delimited Blocks</h3></div></div></div>
44
- <p>AsciiDoc ships with a number of predefined DelimitedBlocks (see the
45
- <code class="literal">asciidoc.conf</code> configuration file in the asciidoc(1) program
46
- directory):</p>
47
- <p>Predefined delimited block underlines:</p>
48
- <pre class="literallayout">CommentBlock: //////////////////////////
49
- PassthroughBlock: ++++++++++++++++++++++++++
50
- ListingBlock: --------------------------
51
- LiteralBlock: ..........................
52
- SidebarBlock: **************************
53
- QuoteBlock: __________________________
54
- ExampleBlock: ==========================
55
- OpenBlock: --</pre>
56
- <p>The <a class="link" href="filters.html#X56" title="Code Filter">code</a>, <a class="link" href="filters.html#X57" title="Source Code Highlighter Filter">source</a> and <a class="link" href="filters.html#X58" title="Music Filter">music</a> filter blocks are
57
- detailed in the <a class="link" href="filters.html" title="Filters">Filters</a> section.</p>
58
- <div class="table">
59
- <a id="id36116502"></a><p class="title"><b>Table 1. Default DelimitedBlock substitutions</b></p>
60
- <div class="table-contents"><table summary="Default DelimitedBlock substitutions" border="1">
61
- <colgroup>
62
- <col>
63
- <col>
64
- <col>
65
- <col>
66
- <col>
67
- <col>
68
- <col>
69
- <col>
70
- </colgroup>
71
- <thead><tr>
72
- <th align="left" valign="top"> </th>
73
- <th align="center" valign="top">Attributes </th>
74
- <th align="center" valign="top">Callouts </th>
75
- <th align="center" valign="top">Macros </th>
76
- <th align="center" valign="top"> Quotes </th>
77
- <th align="center" valign="top">Replacements</th>
78
- <th align="center" valign="top">Special chars </th>
79
- <th align="center" valign="top">Special words</th>
80
- </tr></thead>
81
- <tbody>
82
- <tr>
83
- <td align="left" valign="top"><p><span class="emphasis"><em>PassthroughBlock</em></span></p></td>
84
- <td align="center" valign="top"><p>Yes</p></td>
85
- <td align="center" valign="top"><p>No</p></td>
86
- <td align="center" valign="top"><p>Yes</p></td>
87
- <td align="center" valign="top"><p>No</p></td>
88
- <td align="center" valign="top"><p>No</p></td>
89
- <td align="center" valign="top"><p>No</p></td>
90
- <td align="center" valign="top"><p>No</p></td>
91
- </tr>
92
- <tr>
93
- <td align="left" valign="top"><p><span class="emphasis"><em>ListingBlock</em></span></p></td>
94
- <td align="center" valign="top"><p>No</p></td>
95
- <td align="center" valign="top"><p>Yes</p></td>
96
- <td align="center" valign="top"><p>No</p></td>
97
- <td align="center" valign="top"><p>No</p></td>
98
- <td align="center" valign="top"><p>No</p></td>
99
- <td align="center" valign="top"><p>Yes</p></td>
100
- <td align="center" valign="top"><p>No</p></td>
101
- </tr>
102
- <tr>
103
- <td align="left" valign="top"><p><span class="emphasis"><em>LiteralBlock</em></span></p></td>
104
- <td align="center" valign="top"><p>No</p></td>
105
- <td align="center" valign="top"><p>Yes</p></td>
106
- <td align="center" valign="top"><p>No</p></td>
107
- <td align="center" valign="top"><p>No</p></td>
108
- <td align="center" valign="top"><p>No</p></td>
109
- <td align="center" valign="top"><p>Yes</p></td>
110
- <td align="center" valign="top"><p>No</p></td>
111
- </tr>
112
- <tr>
113
- <td align="left" valign="top"><p><span class="emphasis"><em>SidebarBlock</em></span></p></td>
114
- <td align="center" valign="top"><p>Yes</p></td>
115
- <td align="center" valign="top"><p>No</p></td>
116
- <td align="center" valign="top"><p>Yes</p></td>
117
- <td align="center" valign="top"><p>Yes</p></td>
118
- <td align="center" valign="top"><p>Yes</p></td>
119
- <td align="center" valign="top"><p>Yes</p></td>
120
- <td align="center" valign="top"><p>Yes</p></td>
121
- </tr>
122
- <tr>
123
- <td align="left" valign="top"><p><span class="emphasis"><em>QuoteBlock</em></span></p></td>
124
- <td align="center" valign="top"><p>Yes</p></td>
125
- <td align="center" valign="top"><p>No</p></td>
126
- <td align="center" valign="top"><p>Yes</p></td>
127
- <td align="center" valign="top"><p>Yes</p></td>
128
- <td align="center" valign="top"><p>Yes</p></td>
129
- <td align="center" valign="top"><p>Yes</p></td>
130
- <td align="center" valign="top"><p>Yes</p></td>
131
- </tr>
132
- <tr>
133
- <td align="left" valign="top"><p><span class="emphasis"><em>ExampleBlock</em></span></p></td>
134
- <td align="center" valign="top"><p>Yes</p></td>
135
- <td align="center" valign="top"><p>No</p></td>
136
- <td align="center" valign="top"><p>Yes</p></td>
137
- <td align="center" valign="top"><p>Yes</p></td>
138
- <td align="center" valign="top"><p>Yes</p></td>
139
- <td align="center" valign="top"><p>Yes</p></td>
140
- <td align="center" valign="top"><p>Yes</p></td>
141
- </tr>
142
- <tr>
143
- <td align="left" valign="top"><p><span class="emphasis"><em>OpenBlock</em></span></p></td>
144
- <td align="center" valign="top"><p>Yes</p></td>
145
- <td align="center" valign="top"><p>No</p></td>
146
- <td align="center" valign="top"><p>Yes</p></td>
147
- <td align="center" valign="top"><p>Yes</p></td>
148
- <td align="center" valign="top"><p>Yes</p></td>
149
- <td align="center" valign="top"><p>Yes</p></td>
150
- <td align="center" valign="top"><p>Yes</p></td>
151
- </tr>
152
- </tbody>
153
- </table></div>
154
- </div>
155
- <br class="table-break">
156
- </div>
157
- <div class="section" lang="en" xml:lang="en">
158
- <div class="titlepage"><div><div><h3 class="title">
159
- <a id="_listing_blocks"></a>Listing Blocks</h3></div></div></div>
160
- <p><span class="emphasis"><em>ListingBlocks</em></span> are rendered verbatim in a monospaced font, they
161
- retain line and whitespace formatting and are often distinguished by a
162
- background or border. There is no text formatting or substitutions
163
- within Listing blocks apart from Special Characters and Callouts.
164
- Listing blocks are often used for computer output and file listings.</p>
165
- <p>Here’s an example:</p>
166
- <pre class="screen">--------------------------------------
167
- #include &lt;stdio.h&gt;
168
-
169
- int main() {
170
- printf("Hello World!\n");
171
- exit(0);
172
- }
173
- --------------------------------------</pre>
174
- <p>Which will be rendered like:</p>
175
- <pre class="screen">#include &lt;stdio.h&gt;
176
-
177
- int main() {
178
- printf("Hello World!\n");
179
- exit(0);
180
- }</pre>
181
- <p>By convention <a class="link" href="filters.html" title="Filters">filter blocks</a> use the listing block syntax and
182
- are implemented as distinct listing block styles.</p>
183
- </div>
184
- <div class="section" lang="en" xml:lang="en">
185
- <div class="titlepage"><div><div><h3 class="title">
186
- <a id="X65"></a>Literal Blocks</h3></div></div></div>
187
- <p><span class="emphasis"><em>LiteralBlocks</em></span> are rendered just like <a class="link" href="paragraphs.html#X85" title="literal paragraph syntax">literal paragraphs</a>.
188
- Example:</p>
189
- <pre class="screen">...................................
190
- Consul *necessitatibus* per id,
191
- consetetur, eu pro everti postulant
192
- homero verear ea mea, qui.
193
- ...................................</pre>
194
- <p>Renders:</p>
195
- <pre class="literallayout">Consul *necessitatibus* per id,
196
- consetetur, eu pro everti postulant
197
- homero verear ea mea, qui.</pre>
198
- <p>If the <span class="emphasis"><em>listing</em></span> style is applied to a LiteralBlock it will be
199
- rendered as a ListingBlock (this is handy if you have a listing
200
- containing a ListingBlock).</p>
201
- </div>
202
- <div class="section" lang="en" xml:lang="en">
203
- <div class="titlepage"><div><div><h3 class="title">
204
- <a id="_sidebar_blocks"></a>Sidebar Blocks</h3></div></div></div>
205
- <p>A sidebar is a short piece of text presented outside the narrative
206
- flow of the main text. The sidebar is normally presented inside a
207
- bordered box to set it apart from the main text.</p>
208
- <p>The sidebar body is treated like a normal section body.</p>
209
- <p>Here’s an example:</p>
210
- <pre class="screen">.An Example Sidebar
211
- ************************************************
212
- Any AsciiDoc SectionBody element (apart from
213
- SidebarBlocks) can be placed inside a sidebar.
214
- ************************************************</pre>
215
- <p>Which will be rendered like:</p>
216
- <div class="sidebar">
217
- <p class="title"><b>An Example Sidebar</b></p>
218
- <p>Any AsciiDoc SectionBody element (apart from
219
- SidebarBlocks) can be placed inside a sidebar.</p>
220
- </div>
221
- </div>
222
- <div class="section" lang="en" xml:lang="en">
223
- <div class="titlepage"><div><div><h3 class="title">
224
- <a id="X26"></a>Comment Blocks</h3></div></div></div>
225
- <p>The contents of <span class="emphasis"><em>CommentBlocks</em></span> are not processed; they are useful for
226
- annotations and for excluding new or outdated content that you don’t
227
- want displayed. CommentBlocks are never written to output files.
228
- Example:</p>
229
- <pre class="screen">//////////////////////////////////////////
230
- CommentBlock contents are not processed by
231
- asciidoc(1).
232
- //////////////////////////////////////////</pre>
233
- <p>See also <a class="link" href="macros.html#X25" title="Comment Lines">Comment Lines</a>.</p>
234
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
235
- <h3 class="title">Note</h3>
236
- <p>System macros are executed inside comment blocks.</p>
237
- </div>
238
- </div>
239
- <div class="section" lang="en" xml:lang="en">
240
- <div class="titlepage"><div><div><h3 class="title">
241
- <a id="X76"></a>Passthrough Blocks</h3></div></div></div>
242
- <p>By default the block contents is subject only to <span class="emphasis"><em>attributes</em></span> and
243
- <span class="emphasis"><em>macros</em></span> substitutions (use an explicit <span class="emphasis"><em>subs</em></span> attribute to apply
244
- different substitutions). PassthroughBlock content will often be
245
- backend specific. Here’s an example:</p>
246
- <pre class="screen">[subs="quotes"]
247
- ++++++++++++++++++++++++++++++++++++++
248
- &lt;table border="1"&gt;&lt;tr&gt;
249
- &lt;td&gt;*Cell 1*&lt;/td&gt;
250
- &lt;td&gt;*Cell 2*&lt;/td&gt;
251
- &lt;/tr&gt;&lt;/table&gt;
252
- ++++++++++++++++++++++++++++++++++++++</pre>
253
- <p>The following styles can be applied to passthrough blocks:</p>
254
- <div class="variablelist"><dl>
255
- <dt><span class="term">
256
- pass
257
- </span></dt>
258
- <dd>
259
- No substitutions are performed. This is equivalent to <code class="literal">subs="none"</code>.
260
- </dd>
261
- <dt><span class="term">
262
- asciimath, latexmath
263
- </span></dt>
264
- <dd>
265
- By default no substitutions are performed, the contents are rendered
266
- as <a class="link" href="mathematical_formulas.html" title="Mathematical Formulas">mathematical formulas</a>.
267
- </dd>
268
- </dl></div>
269
- </div>
270
- <div class="section" lang="en" xml:lang="en">
271
- <div class="titlepage"><div><div><h3 class="title">
272
- <a id="_quote_blocks"></a>Quote Blocks</h3></div></div></div>
273
- <p><span class="emphasis"><em>QuoteBlocks</em></span> are used for quoted passages of text. There are two
274
- styles: <span class="emphasis"><em>quote</em></span> and <span class="emphasis"><em>verse</em></span>. The style behavior is identical to
275
- <a class="link" href="paragraphs.html#X94" title="quote and verse paragraph styles">quote and verse paragraphs</a> except that blocks can contain
276
- multiple paragraphs and, in the case of the <span class="emphasis"><em>quote</em></span> style, other
277
- section elements. The first positional attribute sets the style, if
278
- no attributes are specified the <span class="emphasis"><em>quote</em></span> style is used. The optional
279
- <span class="emphasis"><em>attribution</em></span> and <span class="emphasis"><em>citetitle</em></span> attributes (positional attributes 2 and
280
- 3) specify the quote’s author and source. For example:</p>
281
- <pre class="screen">[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes]
282
- ____________________________________________________________________
283
- As he spoke there was the sharp sound of horses' hoofs and
284
- grating wheels against the curb, followed by a sharp pull at the
285
- bell. Holmes whistled.
286
-
287
- "A pair, by the sound," said he. "Yes," he continued, glancing
288
- out of the window. "A nice little brougham and a pair of
289
- beauties. A hundred and fifty guineas apiece. There's money in
290
- this case, Watson, if there is nothing else."
291
- ____________________________________________________________________</pre>
292
- <p>Which is rendered as:</p>
293
- <div class="blockquote"><table border="0" width="100%" cellspacing="0" cellpadding="0" class="blockquote" summary="Block quote">
294
- <tr>
295
- <td width="10%" valign="top"> </td>
296
- <td width="80%" valign="top">
297
- <p>As he spoke there was the sharp sound of horses' hoofs and
298
- grating wheels against the curb, followed by a sharp pull at the
299
- bell. Holmes whistled.</p>
300
- <p>"A pair, by the sound," said he. "Yes," he continued, glancing
301
- out of the window. "A nice little brougham and a pair of
302
- beauties. A hundred and fifty guineas apiece. There’s money in
303
- this case, Watson, if there is nothing else."</p>
304
- </td>
305
- <td width="10%" valign="top"> </td>
306
- </tr>
307
- <tr>
308
- <td width="10%" valign="top"> </td>
309
- <td colspan="2" align="right" valign="top">--<span class="attribution">
310
- Sir Arthur Conan Doyle
311
- <em class="citetitle">The Adventures of Sherlock Holmes</em>
312
- </span>
313
- </td>
314
- </tr>
315
- </table></div>
316
- </div>
317
- <div class="section" lang="en" xml:lang="en">
318
- <div class="titlepage"><div><div><h3 class="title">
319
- <a id="X48"></a>Example Blocks</h3></div></div></div>
320
- <p><span class="emphasis"><em>ExampleBlocks</em></span> encapsulate the DocBook Example element and are used
321
- for, well, examples. Example blocks can be titled by preceding them
322
- with a <span class="emphasis"><em>BlockTitle</em></span>. DocBook toolchains will normally automatically
323
- number examples and generate a <span class="emphasis"><em>List of Examples</em></span> backmatter section.</p>
324
- <p>Example blocks are delimited by lines of equals characters and can
325
- contain any block elements apart from Titles, BlockTitles and
326
- Sidebars) inside an example block. For example:</p>
327
- <pre class="screen">.An example
328
- =====================================================================
329
- Qui in magna commodo, est labitur dolorum an. Est ne magna primis
330
- adolescens.
331
- =====================================================================</pre>
332
- <p>Renders:</p>
333
- <div class="example">
334
- <a id="id36117482"></a><p class="title"><b>Example 1. An example</b></p>
335
- <div class="example-contents"><p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis
336
- adolescens.</p></div>
337
- </div>
338
- <br class="example-break"><p>A title prefix that can be inserted with the <code class="literal">caption</code> attribute
339
- (<code class="literal">xhtml11</code> and <code class="literal">html4</code> backends). For example:</p>
340
- <pre class="screen">[caption="Example 1: "]
341
- .An example with a custom caption
342
- =====================================================================
343
- Qui in magna commodo, est labitur dolorum an. Est ne magna primis
344
- adolescens.
345
- =====================================================================</pre>
346
- </div>
347
- <div class="section" lang="en" xml:lang="en">
348
- <div class="titlepage"><div><div><h3 class="title">
349
- <a id="X22"></a>Admonition Blocks</h3></div></div></div>
350
- <p>The <span class="emphasis"><em>ExampleBlock</em></span> definition includes a set of admonition
351
- <a class="link" href="block_element_definitions.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
352
- generating admonition blocks (admonitions containing more than a
353
- <a class="link" href="paragraphs.html#X28" title="Admonition Paragraphs">single paragraph</a>). Just precede the <span class="emphasis"><em>ExampleBlock</em></span> with an
354
- attribute list specifying the admonition style name. For example:</p>
355
- <pre class="screen">[NOTE]
356
- .A NOTE admonition block
357
- =====================================================================
358
- Qui in magna commodo, est labitur dolorum an. Est ne magna primis
359
- adolescens.
360
-
361
- . Fusce euismod commodo velit.
362
- . Vivamus fringilla mi eu lacus.
363
- .. Fusce euismod commodo velit.
364
- .. Vivamus fringilla mi eu lacus.
365
- . Donec eget arcu bibendum
366
- nunc consequat lobortis.
367
- =====================================================================</pre>
368
- <p>Renders:</p>
369
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
370
- <h3 class="title">A NOTE admonition block</h3>
371
- <p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis
372
- adolescens.</p>
373
- <div class="orderedlist"><ol type="1">
374
- <li>
375
- Fusce euismod commodo velit.
376
- </li>
377
- <li>
378
- <p>
379
- Vivamus fringilla mi eu lacus.
380
- </p>
381
- <div class="orderedlist"><ol type="a">
382
- <li>
383
- Fusce euismod commodo velit.
384
- </li>
385
- <li>
386
- Vivamus fringilla mi eu lacus.
387
- </li>
388
- </ol></div>
389
- </li>
390
- <li>
391
- Donec eget arcu bibendum
392
- nunc consequat lobortis.
393
- </li>
394
- </ol></div>
395
- </div>
396
- <p>See also <a class="link" href="paragraphs.html#X47" title="Admonition Icons and Captions">Admonition Icons and Captions</a>.</p>
397
- </div>
398
- <div class="section" lang="en" xml:lang="en">
399
- <div class="titlepage"><div><div><h3 class="title">
400
- <a id="X29"></a>Open Blocks</h3></div></div></div>
401
- <p>An <span class="emphasis"><em>OpenBlock</em></span> groups a set of block elements. <span class="emphasis"><em>OpenBlock</em></span> usage:</p>
402
- <div class="orderedlist"><ol type="1">
403
- <li>
404
- <a class="link" href="lists.html#X15" title="List Item Continuation">List item continuation</a>.
405
- </li>
406
- <li>
407
- <p>
408
- Apply the <span class="emphasis"><em>abstract</em></span> style to generate an abstract, for example:
409
- </p>
410
- <pre class="literallayout">[abstract]
411
- --
412
- In this paper we will ...
413
- --</pre>
414
- </li>
415
- <li>
416
- <p>
417
- Apply the <span class="emphasis"><em>partintro</em></span> style to generate a book part introduction for
418
- a multi-part book, for example:
419
- </p>
420
- <pre class="literallayout">[partintro]
421
- .Optional part introduction title
422
- --
423
- Optional part introduction goes here.
424
- --</pre>
425
- </li>
426
- </ol></div>
427
- </div>
428
- </div>
429
-
430
- </div>
431
-
432
- <hr/>
433
-
434
- <div class="nav" id="navfooter">
435
- <table width="100%">
436
- <tr><td width="33%" align="left">
437
-
438
- <a href="paragraphs.html">Prev</a><br/>
439
- Paragraphs
440
-
441
- </td><td width="33%" align="center">
442
-
443
- <a href="index.html">Home</a><br/>
444
- AsciiDoc User Guide
445
-
446
- </td><td width="33%" align="right">
447
-
448
- <a href="lists.html">Next</a><br/>
449
- Lists
450
-
451
- </td></tr>
452
- </table>
453
- </div>
454
- </body>
455
- </html>