git-scribe 0.0.4 → 0.0.5
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +1 -0
- data/Rakefile +31 -0
- data/SPEC.asciidoc +126 -0
- data/TODO.txt +29 -0
- data/bin/git-scribe +2 -1
- data/docbook-xsl/.CatalogManager.properties.example +61 -0
- data/docbook-xsl/.urilist +1 -0
- data/git-scribe.gemspec +32 -0
- data/lib/git-scribe.rb +21 -315
- data/lib/git-scribe/check.rb +60 -0
- data/lib/git-scribe/cli.rb +84 -0
- data/lib/git-scribe/generate.rb +222 -0
- data/lib/git-scribe/init.rb +16 -0
- data/lib/git-scribe/version.rb +3 -0
- data/template/.gitignore +1 -0
- data/template/.gitscribe +5 -0
- data/test/check_test.rb +12 -0
- data/test/gen_test.rb +78 -0
- data/test/init_test.rb +36 -0
- data/test/test_helper.rb +44 -0
- metadata +49 -161
- data/example/book/big.asc +0 -5604
- data/example/book/holmes.asc +0 -12983
- data/example/output/META-INF/container.xml +0 -6
- data/example/output/OEBPS/ar01s02.html +0 -15
- data/example/output/OEBPS/ar01s03.html +0 -3
- data/example/output/OEBPS/content.opf +0 -21
- data/example/output/OEBPS/index.html +0 -5
- data/example/output/OEBPS/toc.ncx +0 -37
- data/example/output/a_case_of_identity.html +0 -725
- data/example/output/a_example_appendix.html +0 -63
- data/example/output/a_migration_notes.html +0 -95
- data/example/output/apa.html +0 -20
- data/example/output/apb.html +0 -6
- data/example/output/apc.html +0 -24
- data/example/output/apd.html +0 -30
- data/example/output/ape.html +0 -26
- data/example/output/apf.html +0 -9
- data/example/output/apg.html +0 -42
- data/example/output/aph.html +0 -89
- data/example/output/ar01s02.html +0 -12
- data/example/output/ar01s03.html +0 -34
- data/example/output/ar01s04.html +0 -77
- data/example/output/ar01s05.html +0 -272
- data/example/output/ar01s06.html +0 -35
- data/example/output/ar01s07.html +0 -105
- data/example/output/ar01s08.html +0 -33
- data/example/output/ar01s09.html +0 -12
- data/example/output/ar01s10.html +0 -14
- data/example/output/ar01s11.html +0 -34
- data/example/output/ar01s12.html +0 -63
- data/example/output/ar01s13.html +0 -156
- data/example/output/ar01s14.html +0 -330
- data/example/output/ar01s15.html +0 -22
- data/example/output/ar01s16.html +0 -27
- data/example/output/ar01s17.html +0 -94
- data/example/output/ar01s18.html +0 -359
- data/example/output/ar01s19.html +0 -373
- data/example/output/ar01s20.html +0 -27
- data/example/output/ar01s21.html +0 -33
- data/example/output/ar01s22.html +0 -351
- data/example/output/ar01s23.html +0 -21
- data/example/output/ar01s24.html +0 -69
- data/example/output/ar01s25.html +0 -60
- data/example/output/ar01s26.html +0 -217
- data/example/output/ar01s27.html +0 -88
- data/example/output/ar01s28.html +0 -237
- data/example/output/ar01s29.html +0 -68
- data/example/output/ar01s30.html +0 -154
- data/example/output/ar01s31.html +0 -6
- data/example/output/ar01s32.html +0 -22
- data/example/output/ar01s33.html +0 -209
- data/example/output/asciidoc_backends.html +0 -190
- data/example/output/asciidoc_document_types.html +0 -131
- data/example/output/attribute_entries.html +0 -185
- data/example/output/attribute_lists.html +0 -157
- data/example/output/attribute_references.html +0 -414
- data/example/output/attributelist_element.html +0 -143
- data/example/output/b_packager_notes.html +0 -68
- data/example/output/bi01.html +0 -18
- data/example/output/big.asc +0 -5604
- data/example/output/block_element_definitions.html +0 -448
- data/example/output/block_titles.html +0 -83
- data/example/output/blockid_element.html +0 -80
- data/example/output/book.asc +0 -5604
- data/example/output/book.epub +0 -0
- data/example/output/book.fo +0 -3788
- data/example/output/book.html +0 -8793
- data/example/output/book.xml +0 -8265
- data/example/output/c_asciidoc_safe_mode.html +0 -105
- data/example/output/callouts.html +0 -214
- data/example/output/catalog +0 -10
- data/example/output/colophon.html +0 -397
- data/example/output/configuration_files.html +0 -672
- data/example/output/converting_docbook_to_other_file_formats.html +0 -324
- data/example/output/d_using_asciidoc_with_non-english_languages.html +0 -107
- data/example/output/delimited_blocks.html +0 -455
- data/example/output/document_attributes.html +0 -95
- data/example/output/document_processing.html +0 -116
- data/example/output/document_structure.html +0 -493
- data/example/output/e_vim_syntax_highlighter.html +0 -111
- data/example/output/example_bibliography.html +0 -82
- data/example/output/example_colophon.html +0 -58
- data/example/output/example_glossary.html +0 -73
- data/example/output/example_index.html +0 -108
- data/example/output/f_attribute_options.html +0 -129
- data/example/output/filters.html +0 -179
- data/example/output/footnotes.html +0 -103
- data/example/output/g_diagnostics.html +0 -148
- data/example/output/generating_plain_text_files.html +0 -68
- data/example/output/getting_started.html +0 -87
- data/example/output/glossary.html +0 -95
- data/example/output/go01.html +0 -24
- data/example/output/h_backend_attributes.html +0 -308
- data/example/output/help_commands.html +0 -96
- data/example/output/holmes.asc +0 -12983
- data/example/output/image/octocat_professor.png +0 -0
- data/example/output/include/hello.c +0 -10
- data/example/output/index.html +0 -656
- data/example/output/indexes.html +0 -104
- data/example/output/intrinsic_attributes.html +0 -165
- data/example/output/ix01.html +0 -3
- data/example/output/lists.html +0 -666
- data/example/output/macros.html +0 -737
- data/example/output/manpage_documents.html +0 -124
- data/example/output/master.css +0 -281
- data/example/output/mathematical_formulas.html +0 -125
- data/example/output/page.html +0 -60
- data/example/output/paragraphs.html +0 -192
- data/example/output/pr01.html +0 -3
- data/example/output/source_code_highlighting.html +0 -59
- data/example/output/stylesheets/handbookish-quirks.css +0 -0
- data/example/output/stylesheets/handbookish.css +0 -233
- data/example/output/tables.html +0 -797
- data/example/output/text_formatting.html +0 -273
- data/example/output/the_adventure_of_the_beryl_coronet.html +0 -968
- data/example/output/the_adventure_of_the_blue_carbuncle.html +0 -825
- data/example/output/the_adventure_of_the_copper_beeches.html +0 -998
- data/example/output/the_adventure_of_the_engineer_s_thumb.html +0 -851
- data/example/output/the_adventure_of_the_noble_bachelor.html +0 -861
- data/example/output/the_adventure_of_the_speckled_band.html +0 -1015
- data/example/output/the_boscombe_valley_mystery.html +0 -974
- data/example/output/the_first_chapter.html +0 -110
- data/example/output/the_five_orange_pips.html +0 -776
- data/example/output/the_man_with_the_twisted_lip.html +0 -946
- data/example/output/the_red-headed_league.html +0 -950
- data/example/output/the_second_chapter.html +0 -95
- data/example/output/the_third_chapter.html +0 -58
- data/example/output/tips_and_tricks.html +0 -452
- data/example/output/title.html +0 -120
- data/example/output/titles.html +0 -126
@@ -1,448 +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>Block Element Definitions</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="intrinsic_attributes.html">Prev</a><br/>
|
15
|
-
Intrinsic Attributes
|
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="filters.html">Next</a><br/>
|
25
|
-
Filters
|
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="X73"></a>Block Element Definitions</h2></div></div></div>
|
37
|
-
<p>The syntax and behavior of Paragraph, DelimitedBlock, List and Table
|
38
|
-
block elements is determined by block definitions contained in
|
39
|
-
<a class="link" href="configuration_files.html" title="Configuration Files">AsciiDoc configuration file</a> sections.</p>
|
40
|
-
<p>Each definition consists of a section title followed by one or more
|
41
|
-
section entries. Each entry defines a block parameter controlling some
|
42
|
-
aspect of the block’s behavior. Here’s an example:</p>
|
43
|
-
<pre class="screen">[blockdef-listing]
|
44
|
-
delimiter=^-{4,}$
|
45
|
-
template=listingblock
|
46
|
-
presubs=specialcharacters,callouts</pre>
|
47
|
-
<p>AsciiDoc Paragraph, DelimitedBlock, List and Table block elements
|
48
|
-
share a common subset of configuration file parameters:</p>
|
49
|
-
<div class="variablelist"><dl>
|
50
|
-
<dt><span class="term">
|
51
|
-
delimiter
|
52
|
-
</span></dt>
|
53
|
-
<dd>
|
54
|
-
A Python regular expression that matches the first line of a block
|
55
|
-
element — in the case of DelimitedBlocks and Tables it also matches
|
56
|
-
the last line.
|
57
|
-
</dd>
|
58
|
-
<dt><span class="term">
|
59
|
-
template
|
60
|
-
</span></dt>
|
61
|
-
<dd>
|
62
|
-
The name of the configuration file markup template section that will
|
63
|
-
envelope the block contents. The pipe (<span class="emphasis"><em>|</em></span>) character is substituted
|
64
|
-
for the block contents. List elements use a set of (list specific)
|
65
|
-
tag parameters instead of a single template. The template name can
|
66
|
-
contain attribute references allowing dynamic template selection a
|
67
|
-
the time of template substitution.
|
68
|
-
</dd>
|
69
|
-
<dt><span class="term">
|
70
|
-
options
|
71
|
-
</span></dt>
|
72
|
-
<dd>
|
73
|
-
A comma delimited list of element specific option names. In addition
|
74
|
-
to being used internally, options are available during markup tag
|
75
|
-
and template substitution as attributes with an empty string value
|
76
|
-
named like <code class="literal"><option>-option</code> (where <code class="literal"><option></code> is the option name).
|
77
|
-
See <a class="link" href="f_attribute_options.html" title="F. Attribute Options">attribute options</a> for a complete list of available
|
78
|
-
options.
|
79
|
-
</dd>
|
80
|
-
<dt><span class="term">
|
81
|
-
subs, presubs, postsubs
|
82
|
-
</span></dt>
|
83
|
-
<dd><div class="itemizedlist"><ul type="disc">
|
84
|
-
<li>
|
85
|
-
<span class="emphasis"><em>presubs</em></span> and <span class="emphasis"><em>postsubs</em></span> are lists of comma separated substitutions that are
|
86
|
-
performed on the block contents. <span class="emphasis"><em>presubs</em></span> is applied first,
|
87
|
-
<span class="emphasis"><em>postsubs</em></span> (if specified) second.
|
88
|
-
</li>
|
89
|
-
<li>
|
90
|
-
<span class="emphasis"><em>subs</em></span> is an alias for <span class="emphasis"><em>presubs</em></span>.
|
91
|
-
</li>
|
92
|
-
<li>
|
93
|
-
If a <span class="emphasis"><em>filter</em></span> is allowed (Paragraphs, DelimitedBlocks and Tables)
|
94
|
-
and has been specified then <span class="emphasis"><em>presubs</em></span> and <span class="emphasis"><em>postsubs</em></span> substitutions
|
95
|
-
are performed before and after the filter is run respectively.
|
96
|
-
</li>
|
97
|
-
<li>
|
98
|
-
Allowed values: <span class="emphasis"><em>specialcharacters</em></span>, <span class="emphasis"><em>quotes</em></span>, <span class="emphasis"><em>specialwords</em></span>,
|
99
|
-
<span class="emphasis"><em>replacements</em></span>, <span class="emphasis"><em>macros</em></span>, <span class="emphasis"><em>attributes</em></span>, <span class="emphasis"><em>callouts</em></span>.
|
100
|
-
</li>
|
101
|
-
<li>
|
102
|
-
<p>
|
103
|
-
The following composite values are also allowed:
|
104
|
-
</p>
|
105
|
-
<div class="variablelist"><dl>
|
106
|
-
<dt><span class="term">
|
107
|
-
<span class="emphasis"><em>none</em></span>
|
108
|
-
</span></dt>
|
109
|
-
<dd>
|
110
|
-
No substitutions.
|
111
|
-
</dd>
|
112
|
-
<dt><span class="term">
|
113
|
-
<span class="emphasis"><em>normal</em></span>
|
114
|
-
</span></dt>
|
115
|
-
<dd>
|
116
|
-
The following substitutions:
|
117
|
-
<span class="emphasis"><em>specialcharacters</em></span>,<span class="emphasis"><em>quotes</em></span>,<span class="emphasis"><em>attributes</em></span>,<span class="emphasis"><em>specialwords</em></span>,
|
118
|
-
<span class="emphasis"><em>replacements</em></span>,<span class="emphasis"><em>macros</em></span>.
|
119
|
-
</dd>
|
120
|
-
<dt><span class="term">
|
121
|
-
<span class="emphasis"><em>verbatim</em></span>
|
122
|
-
</span></dt>
|
123
|
-
<dd>
|
124
|
-
<span class="emphasis"><em>specialcharacters</em></span> and <span class="emphasis"><em>callouts</em></span> substitutions.
|
125
|
-
</dd>
|
126
|
-
</dl></div>
|
127
|
-
</li>
|
128
|
-
<li>
|
129
|
-
<span class="emphasis"><em>normal</em></span> and <span class="emphasis"><em>verbatim</em></span> substitutions can be redefined by with
|
130
|
-
<code class="literal">subsnormal</code> and <code class="literal">subsverbatim</code> entries in a configuration file
|
131
|
-
<code class="literal">[miscellaneous]</code> section.
|
132
|
-
</li>
|
133
|
-
<li>
|
134
|
-
The substitutions are processed in the order in which they are
|
135
|
-
listed and can appear more than once.
|
136
|
-
</li>
|
137
|
-
</ul></div></dd>
|
138
|
-
<dt><span class="term">
|
139
|
-
filter
|
140
|
-
</span></dt>
|
141
|
-
<dd>
|
142
|
-
This optional entry specifies an executable shell command for
|
143
|
-
processing block content (Paragraphs, DelimitedBlocks and Tables).
|
144
|
-
The filter command can contain attribute references.
|
145
|
-
</dd>
|
146
|
-
<dt><span class="term">
|
147
|
-
posattrs
|
148
|
-
</span></dt>
|
149
|
-
<dd>
|
150
|
-
<p>
|
151
|
-
Optional comma separated list of positional attribute names. This
|
152
|
-
list maps positional attributes (in the block’s <a class="link" href="attribute_lists.html" title="Attribute Lists">attribute list</a>) to named block attributes. The following example, from the
|
153
|
-
QuoteBlock definition, maps the first and section positional
|
154
|
-
attributes:
|
155
|
-
</p>
|
156
|
-
<pre class="literallayout">posattrs=attribution,citetitle</pre>
|
157
|
-
</dd>
|
158
|
-
<dt><span class="term">
|
159
|
-
style
|
160
|
-
</span></dt>
|
161
|
-
<dd>
|
162
|
-
This optional parameter specifies the default style name.
|
163
|
-
</dd>
|
164
|
-
<dt><span class="term">
|
165
|
-
<stylename>-style
|
166
|
-
</span></dt>
|
167
|
-
<dd>
|
168
|
-
Optional style definition (see <a class="link" href="block_element_definitions.html#X23" title="Styles">Styles</a> below).
|
169
|
-
</dd>
|
170
|
-
</dl></div>
|
171
|
-
<p>The following block parameters behave like document attributes and can
|
172
|
-
be set in block attribute lists and style definitions: <span class="emphasis"><em>template</em></span>,
|
173
|
-
<span class="emphasis"><em>options</em></span>, <span class="emphasis"><em>subs</em></span>, <span class="emphasis"><em>presubs</em></span>, <span class="emphasis"><em>postsubs</em></span>, <span class="emphasis"><em>filter</em></span>.</p>
|
174
|
-
<div class="section" lang="en" xml:lang="en">
|
175
|
-
<div class="titlepage"><div><div><h3 class="title">
|
176
|
-
<a id="X23"></a>Styles</h3></div></div></div>
|
177
|
-
<p>A style is a set of block attributes bundled as a single named
|
178
|
-
attribute. The following example defines a style named <span class="emphasis"><em>verbatim</em></span>:</p>
|
179
|
-
<pre class="literallayout">verbatim-style=template="literalblock",subs="verbatim"</pre>
|
180
|
-
<div class="itemizedlist"><ul type="disc">
|
181
|
-
<li>
|
182
|
-
All style parameter names must be suffixed with <code class="literal">-style</code> and the
|
183
|
-
style parameter value is in the form of a list of <a class="link" href="attribute_lists.html" title="Attribute Lists">named attributes</a>.
|
184
|
-
</li>
|
185
|
-
<li>
|
186
|
-
Multi-item style attributes (<span class="emphasis"><em>subs</em></span>,<span class="emphasis"><em>presubs</em></span>,<span class="emphasis"><em>postsubs</em></span>,<span class="emphasis"><em>posattrs</em></span>)
|
187
|
-
must be specified using Python tuple syntax rather than a simple
|
188
|
-
list of values as they in separate entries e.g.
|
189
|
-
<code class="literal">postsubs=("callouts",)</code> not <code class="literal">postsubs="callouts"</code>.
|
190
|
-
</li>
|
191
|
-
</ul></div>
|
192
|
-
</div>
|
193
|
-
<div class="section" lang="en" xml:lang="en">
|
194
|
-
<div class="titlepage"><div><div><h3 class="title">
|
195
|
-
<a id="_paragraphs_2"></a>Paragraphs</h3></div></div></div>
|
196
|
-
<p>Paragraph translation is controlled by <code class="literal">[paradef-*]</code> configuration
|
197
|
-
file section entries. Users can define new types of paragraphs and
|
198
|
-
modify the behavior of existing types by editing AsciiDoc
|
199
|
-
configuration files.</p>
|
200
|
-
<p>Here is the shipped Default paragraph definition:</p>
|
201
|
-
<pre class="screen">[paradef-default]
|
202
|
-
delimiter=(?P<text>\S.*)
|
203
|
-
template=paragraph</pre>
|
204
|
-
<p>The normal paragraph definition has a couple of special properties:</p>
|
205
|
-
<div class="orderedlist"><ol type="1">
|
206
|
-
<li>
|
207
|
-
It must exist and be defined in a configuration file section named
|
208
|
-
<code class="literal">[paradef-default]</code>.
|
209
|
-
</li>
|
210
|
-
<li>
|
211
|
-
Irrespective of its position in the configuration files default
|
212
|
-
paragraph document matches are attempted only after trying all
|
213
|
-
other paragraph types.
|
214
|
-
</li>
|
215
|
-
</ol></div>
|
216
|
-
<p>Paragraph specific block parameter notes:</p>
|
217
|
-
<div class="variablelist"><dl>
|
218
|
-
<dt><span class="term">
|
219
|
-
delimiter
|
220
|
-
</span></dt>
|
221
|
-
<dd>
|
222
|
-
This regular expression must contain the named group <span class="emphasis"><em>text</em></span> which
|
223
|
-
matches the text on the first line. Paragraphs are terminated by a
|
224
|
-
blank line, the end of file, or the start of a DelimitedBlock.
|
225
|
-
</dd>
|
226
|
-
<dt><span class="term">
|
227
|
-
options
|
228
|
-
</span></dt>
|
229
|
-
<dd>
|
230
|
-
The <span class="emphasis"><em>listelement</em></span> option specifies that paragraphs of this type will
|
231
|
-
automatically be considered part of immediately preceding list
|
232
|
-
items.
|
233
|
-
</dd>
|
234
|
-
</dl></div>
|
235
|
-
<div class="orderedlist">
|
236
|
-
<p class="title"><b>Paragraph processing proceeds as follows:</b></p>
|
237
|
-
<ol type="1">
|
238
|
-
<li>
|
239
|
-
The paragraph text is aligned to the left margin.
|
240
|
-
</li>
|
241
|
-
<li>
|
242
|
-
Optional <span class="emphasis"><em>presubs</em></span> inline substitutions are performed on the
|
243
|
-
paragraph text.
|
244
|
-
</li>
|
245
|
-
<li>
|
246
|
-
If a filter command is specified it is executed and the paragraph
|
247
|
-
text piped to its standard input; the filter output replaces the
|
248
|
-
paragraph text.
|
249
|
-
</li>
|
250
|
-
<li>
|
251
|
-
Optional <span class="emphasis"><em>postsubs</em></span> inline substitutions are performed on the
|
252
|
-
paragraph text.
|
253
|
-
</li>
|
254
|
-
<li>
|
255
|
-
The paragraph text is enveloped by the paragraph’s markup template
|
256
|
-
and written to the output file.
|
257
|
-
</li>
|
258
|
-
</ol>
|
259
|
-
</div>
|
260
|
-
</div>
|
261
|
-
<div class="section" lang="en" xml:lang="en">
|
262
|
-
<div class="titlepage"><div><div><h3 class="title">
|
263
|
-
<a id="_delimited_blocks_2"></a>Delimited Blocks</h3></div></div></div>
|
264
|
-
<p>DelimitedBlock <span class="emphasis"><em>options</em></span> values are:</p>
|
265
|
-
<div class="variablelist"><dl>
|
266
|
-
<dt><span class="term">
|
267
|
-
sectionbody
|
268
|
-
</span></dt>
|
269
|
-
<dd>
|
270
|
-
The block contents are processed as a SectionBody.
|
271
|
-
</dd>
|
272
|
-
<dt><span class="term">
|
273
|
-
skip
|
274
|
-
</span></dt>
|
275
|
-
<dd>
|
276
|
-
The block is treated as a comment (see <a class="link" href="delimited_blocks.html#X26" title="Comment Blocks">CommentBlocks</a>).
|
277
|
-
</dd>
|
278
|
-
</dl></div>
|
279
|
-
<p><span class="emphasis"><em>presubs</em></span>, <span class="emphasis"><em>postsubs</em></span> and <span class="emphasis"><em>filter</em></span> entries are ignored when
|
280
|
-
<span class="emphasis"><em>sectionbody</em></span> or <span class="emphasis"><em>skip</em></span> options are set.</p>
|
281
|
-
<p>DelimitedBlock processing proceeds as follows:</p>
|
282
|
-
<div class="orderedlist"><ol type="1">
|
283
|
-
<li>
|
284
|
-
Optional <span class="emphasis"><em>presubs</em></span> substitutions are performed on the block
|
285
|
-
contents.
|
286
|
-
</li>
|
287
|
-
<li>
|
288
|
-
If a filter is specified it is executed and the block’s contents
|
289
|
-
piped to its standard input. The filter output replaces the block
|
290
|
-
contents.
|
291
|
-
</li>
|
292
|
-
<li>
|
293
|
-
Optional <span class="emphasis"><em>postsubs</em></span> substitutions are performed on the block
|
294
|
-
contents.
|
295
|
-
</li>
|
296
|
-
<li>
|
297
|
-
The block contents is enveloped by the block’s markup template and
|
298
|
-
written to the output file.
|
299
|
-
</li>
|
300
|
-
</ol></div>
|
301
|
-
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
|
302
|
-
<h3 class="title">Tip</h3>
|
303
|
-
<p>Attribute expansion is performed on the block filter command
|
304
|
-
before it is executed, this is useful for passing arguments to the
|
305
|
-
filter.</p>
|
306
|
-
</div>
|
307
|
-
</div>
|
308
|
-
<div class="section" lang="en" xml:lang="en">
|
309
|
-
<div class="titlepage"><div><div><h3 class="title">
|
310
|
-
<a id="_lists"></a>Lists</h3></div></div></div>
|
311
|
-
<p>List behavior and syntax is determined by <code class="literal">[listdef-*]</code> configuration
|
312
|
-
file sections. The user can change existing list behavior and add new
|
313
|
-
list types by editing configuration files.</p>
|
314
|
-
<p>List specific block definition notes:</p>
|
315
|
-
<div class="variablelist"><dl>
|
316
|
-
<dt><span class="term">
|
317
|
-
type
|
318
|
-
</span></dt>
|
319
|
-
<dd>
|
320
|
-
This is either <span class="emphasis"><em>bulleted</em></span>,<span class="emphasis"><em>numbered</em></span>,<span class="emphasis"><em>labeled</em></span> or <span class="emphasis"><em>callout</em></span>.
|
321
|
-
</dd>
|
322
|
-
<dt><span class="term">
|
323
|
-
delimiter
|
324
|
-
</span></dt>
|
325
|
-
<dd>
|
326
|
-
A Python regular expression that matches the first line of a
|
327
|
-
list element entry. This expression can contain the named groups
|
328
|
-
<span class="emphasis"><em>text</em></span> (bulleted groups), <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>text</em></span> (numbered lists),
|
329
|
-
<span class="emphasis"><em>label</em></span> and <span class="emphasis"><em>text</em></span> (labeled lists).
|
330
|
-
</dd>
|
331
|
-
<dt><span class="term">
|
332
|
-
tags
|
333
|
-
</span></dt>
|
334
|
-
<dd>
|
335
|
-
The <code class="literal"><name></code> of the <code class="literal">[listtags-<name>]</code> configuration file section
|
336
|
-
containing list markup tag definitions. The tag entries (<span class="emphasis"><em>list</em></span>,
|
337
|
-
<span class="emphasis"><em>entry</em></span>, <span class="emphasis"><em>label</em></span>, <span class="emphasis"><em>term</em></span>, <span class="emphasis"><em>text</em></span>) map the AsciiDoc list structure to
|
338
|
-
backend markup; see the <span class="emphasis"><em>listtags</em></span> sections in the AsciiDoc
|
339
|
-
distributed backend <code class="literal">.conf</code> configuration files for examples.
|
340
|
-
</dd>
|
341
|
-
</dl></div>
|
342
|
-
</div>
|
343
|
-
<div class="section" lang="en" xml:lang="en">
|
344
|
-
<div class="titlepage"><div><div><h3 class="title">
|
345
|
-
<a id="_tables_2"></a>Tables</h3></div></div></div>
|
346
|
-
<p>Table behavior and syntax is determined by <code class="literal">[tabledef-*]</code> and
|
347
|
-
<code class="literal">[tabletags-*]</code> configuration file sections. The user can change
|
348
|
-
existing table behavior and add new table types by editing
|
349
|
-
configuration files. The following <code class="literal">[tabledef-*]</code> section entries
|
350
|
-
generate table output markup elements:</p>
|
351
|
-
<div class="variablelist"><dl>
|
352
|
-
<dt><span class="term">
|
353
|
-
colspec
|
354
|
-
</span></dt>
|
355
|
-
<dd>
|
356
|
-
The table <span class="emphasis"><em>colspec</em></span> tag definition.
|
357
|
-
</dd>
|
358
|
-
<dt><span class="term">
|
359
|
-
headrow, footrow, bodyrow
|
360
|
-
</span></dt>
|
361
|
-
<dd>
|
362
|
-
Table header, footer and body row tag definitions. <span class="emphasis"><em>headrow</em></span> and
|
363
|
-
<span class="emphasis"><em>footrow</em></span> table definition entries default to <span class="emphasis"><em>bodyrow</em></span> if
|
364
|
-
they are undefined.
|
365
|
-
</dd>
|
366
|
-
<dt><span class="term">
|
367
|
-
headdata, footdata, bodydata
|
368
|
-
</span></dt>
|
369
|
-
<dd>
|
370
|
-
Table header, footer and body data tag definitions. <span class="emphasis"><em>headdata</em></span> and
|
371
|
-
<span class="emphasis"><em>footdata</em></span> table definition entries default to <span class="emphasis"><em>bodydata</em></span> if they
|
372
|
-
are undefined.
|
373
|
-
</dd>
|
374
|
-
<dt><span class="term">
|
375
|
-
paragraph
|
376
|
-
</span></dt>
|
377
|
-
<dd>
|
378
|
-
If the <span class="emphasis"><em>paragraph</em></span> tag is specified then blank lines in the cell
|
379
|
-
data are treated as paragraph delimiters and marked up using this
|
380
|
-
tag.
|
381
|
-
</dd>
|
382
|
-
</dl></div>
|
383
|
-
<p><a id="X4"></a>Table behavior is also influenced by the following <code class="literal">[miscellaneous]</code>
|
384
|
-
configuration file entries:</p>
|
385
|
-
<div class="variablelist"><dl>
|
386
|
-
<dt><span class="term">
|
387
|
-
pagewidth
|
388
|
-
</span></dt>
|
389
|
-
<dd>
|
390
|
-
This integer value is the printable width of the output media. See
|
391
|
-
<a class="link" href="tables.html#X69" title="Table attributes">table attributes</a>.
|
392
|
-
</dd>
|
393
|
-
<dt><span class="term">
|
394
|
-
pageunits
|
395
|
-
</span></dt>
|
396
|
-
<dd>
|
397
|
-
The units of width in output markup width attribute values.
|
398
|
-
</dd>
|
399
|
-
</dl></div>
|
400
|
-
<div class="itemizedlist">
|
401
|
-
<p class="title"><b>Table definition behavior</b></p>
|
402
|
-
<ul type="disc">
|
403
|
-
<li>
|
404
|
-
The output markup generation is specifically designed to work with
|
405
|
-
the HTML and CALS (DocBook) table models, but should be adaptable to
|
406
|
-
most XML table schema.
|
407
|
-
</li>
|
408
|
-
<li>
|
409
|
-
Table definitions can be “mixed in” from multiple cascading
|
410
|
-
configuration files.
|
411
|
-
</li>
|
412
|
-
<li>
|
413
|
-
New table definitions inherit the default table and table tags
|
414
|
-
definitions (<code class="literal">[tabledef-default]</code> and <code class="literal">[tabletags-default]</code>) so you
|
415
|
-
only need to override those conf file entries that require
|
416
|
-
modification.
|
417
|
-
</li>
|
418
|
-
</ul>
|
419
|
-
</div>
|
420
|
-
</div>
|
421
|
-
</div>
|
422
|
-
|
423
|
-
</div>
|
424
|
-
|
425
|
-
<hr/>
|
426
|
-
|
427
|
-
<div class="nav" id="navfooter">
|
428
|
-
<table width="100%">
|
429
|
-
<tr><td width="33%" align="left">
|
430
|
-
|
431
|
-
<a href="intrinsic_attributes.html">Prev</a><br/>
|
432
|
-
Intrinsic Attributes
|
433
|
-
|
434
|
-
</td><td width="33%" align="center">
|
435
|
-
|
436
|
-
<a href="index.html">Home</a><br/>
|
437
|
-
AsciiDoc User Guide
|
438
|
-
|
439
|
-
</td><td width="33%" align="right">
|
440
|
-
|
441
|
-
<a href="filters.html">Next</a><br/>
|
442
|
-
Filters
|
443
|
-
|
444
|
-
</td></tr>
|
445
|
-
</table>
|
446
|
-
</div>
|
447
|
-
</body>
|
448
|
-
</html>
|
@@ -1,83 +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>Block Titles</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="titles.html">Prev</a><br/>
|
15
|
-
Titles
|
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="blockid_element.html">Next</a><br/>
|
25
|
-
BlockId Element
|
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="X42"></a>Block Titles</h2></div></div></div>
|
37
|
-
<p>A <span class="emphasis"><em>BlockTitle</em></span> element is a single line beginning with a period
|
38
|
-
followed by the title text. A BlockTitle is applied to the immediately
|
39
|
-
following Paragraph, DelimitedBlock, List, Table or BlockMacro. For
|
40
|
-
example:</p>
|
41
|
-
<pre class="literallayout">.Notes
|
42
|
-
- Note 1.
|
43
|
-
- Note 2.</pre>
|
44
|
-
<p>is rendered as:</p>
|
45
|
-
<div class="itemizedlist">
|
46
|
-
<p class="title"><b>Notes</b></p>
|
47
|
-
<ul type="disc">
|
48
|
-
<li>
|
49
|
-
Note 1.
|
50
|
-
</li>
|
51
|
-
<li>
|
52
|
-
Note 2.
|
53
|
-
</li>
|
54
|
-
</ul>
|
55
|
-
</div>
|
56
|
-
</div>
|
57
|
-
|
58
|
-
</div>
|
59
|
-
|
60
|
-
<hr/>
|
61
|
-
|
62
|
-
<div class="nav" id="navfooter">
|
63
|
-
<table width="100%">
|
64
|
-
<tr><td width="33%" align="left">
|
65
|
-
|
66
|
-
<a href="titles.html">Prev</a><br/>
|
67
|
-
Titles
|
68
|
-
|
69
|
-
</td><td width="33%" align="center">
|
70
|
-
|
71
|
-
<a href="index.html">Home</a><br/>
|
72
|
-
AsciiDoc User Guide
|
73
|
-
|
74
|
-
</td><td width="33%" align="right">
|
75
|
-
|
76
|
-
<a href="blockid_element.html">Next</a><br/>
|
77
|
-
BlockId Element
|
78
|
-
|
79
|
-
</td></tr>
|
80
|
-
</table>
|
81
|
-
</div>
|
82
|
-
</body>
|
83
|
-
</html>
|