FooBarWidget-mizuho 0.9.3 → 0.9.4
Sign up to get free protection for your applications and to get access to all the features.
- data/asciidoc/BUGS +3 -3
- data/asciidoc/CHANGELOG +112 -63
- data/asciidoc/CHANGELOG.txt +50 -0
- data/asciidoc/INSTALL +6 -6
- data/asciidoc/Makefile.in +21 -5
- data/asciidoc/README +3 -3
- data/asciidoc/asciidoc.conf +9 -12
- data/asciidoc/asciidoc.py +204 -151
- data/asciidoc/common.aap +2 -2
- data/asciidoc/doc/a2x.1 +4 -3
- data/asciidoc/doc/a2x.1.txt +1 -1
- data/asciidoc/doc/article.css-embedded.html +13 -12
- data/asciidoc/doc/article.html +46 -644
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/asciidoc.1 +2 -2
- data/asciidoc/doc/asciidoc.1.css-embedded.html +14 -13
- data/asciidoc/doc/asciidoc.1.css.html +3 -3
- data/asciidoc/doc/asciidoc.1.html +3 -3
- data/asciidoc/doc/asciidoc.css-embedded.html +238 -225
- data/asciidoc/doc/asciidoc.css.html +227 -215
- data/asciidoc/doc/asciidoc.dict +10 -1
- data/asciidoc/doc/asciidoc.html +181 -164
- data/asciidoc/doc/asciidoc.txt +167 -148
- data/asciidoc/doc/asciimathml.txt +5 -4
- data/asciidoc/doc/book.css-embedded.html +13 -12
- data/asciidoc/doc/faq.txt +60 -3
- data/asciidoc/doc/music-filter.html +94 -41
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.html +125 -465
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/docbook.conf +8 -2
- data/asciidoc/examples/website/CHANGELOG.html +129 -4
- data/asciidoc/examples/website/INSTALL.html +6 -6
- data/asciidoc/examples/website/README-website.html +3 -3
- data/asciidoc/examples/website/README.html +3 -3
- data/asciidoc/examples/website/a2x.1.html +4 -4
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +3 -3
- data/asciidoc/examples/website/asciidoc-graphviz-sample.txt +1 -0
- data/asciidoc/examples/website/downloads.html +7 -7
- data/asciidoc/examples/website/faq.html +95 -40
- data/asciidoc/examples/website/index.html +34 -13
- data/asciidoc/examples/website/index.txt +25 -9
- data/asciidoc/examples/website/latex-backend.html +4 -4
- data/asciidoc/examples/website/manpage.html +3 -3
- data/asciidoc/examples/website/music-filter.html +3 -3
- data/asciidoc/examples/website/sample1.png +0 -0
- data/asciidoc/examples/website/sample3.png +0 -0
- data/asciidoc/examples/website/sample4.png +0 -0
- data/asciidoc/examples/website/source-highlight-filter.html +5 -5
- data/asciidoc/examples/website/support.html +3 -3
- data/asciidoc/examples/website/userguide.html +227 -215
- data/asciidoc/examples/website/version9.html +3 -3
- data/asciidoc/filters/{code-filter-readme.txt → code/code-filter-readme.txt} +0 -0
- data/asciidoc/filters/{code-filter-test.txt → code/code-filter-test.txt} +0 -0
- data/asciidoc/filters/{code-filter.conf → code/code-filter.conf} +1 -1
- data/asciidoc/filters/{code-filter.py → code/code-filter.py} +0 -0
- data/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt +130 -0
- data/asciidoc/filters/graphviz/graphviz-filter.conf +39 -0
- data/asciidoc/filters/graphviz/graphviz2png.py +154 -0
- data/asciidoc/filters/{music-filter-test.txt → music/music-filter-test.txt} +0 -0
- data/asciidoc/filters/{music-filter.conf → music/music-filter.conf} +0 -0
- data/asciidoc/filters/{music2png.py → music/music2png.py} +0 -0
- data/asciidoc/filters/{source-highlight-filter-test.txt → source/source-highlight-filter-test.txt} +0 -0
- data/asciidoc/filters/{source-highlight-filter.conf → source/source-highlight-filter.conf} +2 -1
- data/asciidoc/html4.conf +5 -2
- data/asciidoc/stylesheets/xhtml11-quirks.css +0 -8
- data/asciidoc/stylesheets/xhtml11.css +11 -2
- data/asciidoc/vim/syntax/asciidoc.vim +1 -1
- data/asciidoc/xhtml11.conf +5 -2
- data/lib/mizuho/parser.rb +5 -1
- data/mizuho.gemspec +5 -16
- data/test/parser_spec.rb +49 -0
- metadata +22 -10
data/asciidoc/doc/article.pdf
CHANGED
Binary file
|
data/asciidoc/doc/asciidoc.1
CHANGED
@@ -1,11 +1,11 @@
|
|
1
1
|
.\" Title: asciidoc
|
2
2
|
.\" Author:
|
3
3
|
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
|
4
|
-
.\" Date:
|
4
|
+
.\" Date: 01/02/2009
|
5
5
|
.\" Manual:
|
6
6
|
.\" Source:
|
7
7
|
.\"
|
8
|
-
.TH "ASCIIDOC" "1" "
|
8
|
+
.TH "ASCIIDOC" "1" "01/02/2009" "" ""
|
9
9
|
.\" disable hyphenation
|
10
10
|
.nh
|
11
11
|
.\" disable justification (adjust text to left margin only)
|
@@ -3,7 +3,7 @@
|
|
3
3
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
4
4
|
<head>
|
5
5
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
-
<meta name="generator" content="AsciiDoc 8.3.
|
6
|
+
<meta name="generator" content="AsciiDoc 8.3.3" />
|
7
7
|
<title>ASCIIDOC(1)</title>
|
8
8
|
<style type="text/css">
|
9
9
|
/* Debug borders */
|
@@ -228,12 +228,21 @@ dd > *:first-child {
|
|
228
228
|
ul, ol {
|
229
229
|
list-style-position: outside;
|
230
230
|
}
|
231
|
-
|
231
|
+
ol.arabic {
|
232
232
|
list-style-type: decimal;
|
233
233
|
}
|
234
|
-
|
234
|
+
ol.loweralpha {
|
235
235
|
list-style-type: lower-alpha;
|
236
236
|
}
|
237
|
+
ol.upperalpha {
|
238
|
+
list-style-type: upper-alpha;
|
239
|
+
}
|
240
|
+
ol.lowerroman {
|
241
|
+
list-style-type: lower-roman;
|
242
|
+
}
|
243
|
+
ol.upperroman {
|
244
|
+
list-style-type: upper-roman;
|
245
|
+
}
|
237
246
|
|
238
247
|
div.compact ul, div.compact ol,
|
239
248
|
div.compact p, div.compact p,
|
@@ -384,14 +393,6 @@ div.exampleblock-content {
|
|
384
393
|
|
385
394
|
/* IE6 sets dynamically generated links as visited. */
|
386
395
|
div#toc a:visited { color: blue; }
|
387
|
-
|
388
|
-
/* Because IE6 child selector is broken. */
|
389
|
-
div.olist2 ol {
|
390
|
-
list-style-type: lower-alpha;
|
391
|
-
}
|
392
|
-
div.olist2 div.olist ol {
|
393
|
-
list-style-type: decimal;
|
394
|
-
}
|
395
396
|
</style>
|
396
397
|
</head>
|
397
398
|
<body>
|
@@ -589,8 +590,8 @@ granted under the terms of the GNU General Public License (GPL).</p></div>
|
|
589
590
|
</div>
|
590
591
|
<div id="footer">
|
591
592
|
<div id="footer-text">
|
592
|
-
Version 8.3.
|
593
|
-
Last updated
|
593
|
+
Version 8.3.3<br />
|
594
|
+
Last updated 2009-01-02 12:45:00 NZDT
|
594
595
|
</div>
|
595
596
|
</div>
|
596
597
|
</body>
|
@@ -3,7 +3,7 @@
|
|
3
3
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
4
4
|
<head>
|
5
5
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
-
<meta name="generator" content="AsciiDoc 8.3.
|
6
|
+
<meta name="generator" content="AsciiDoc 8.3.3" />
|
7
7
|
<title>ASCIIDOC(1)</title>
|
8
8
|
<link rel="stylesheet" href="../stylesheets/xhtml11.css" type="text/css" />
|
9
9
|
<link rel="stylesheet" href="../stylesheets/xhtml11-manpage.css" type="text/css" />
|
@@ -204,8 +204,8 @@ granted under the terms of the GNU General Public License (GPL).</p></div>
|
|
204
204
|
</div>
|
205
205
|
<div id="footer">
|
206
206
|
<div id="footer-text">
|
207
|
-
Version 8.3.
|
208
|
-
Last updated
|
207
|
+
Version 8.3.3<br />
|
208
|
+
Last updated 2009-01-02 12:44:51 NZDT
|
209
209
|
</div>
|
210
210
|
</div>
|
211
211
|
</body>
|
@@ -2,7 +2,7 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
|
-
<meta name="generator" content="AsciiDoc 8.3.
|
5
|
+
<meta name="generator" content="AsciiDoc 8.3.3">
|
6
6
|
<title>asciidoc</title>
|
7
7
|
</head>
|
8
8
|
<body>
|
@@ -183,8 +183,8 @@ granted under the terms of the GNU General Public License (GPL).</p>
|
|
183
183
|
<p></p>
|
184
184
|
<p></p>
|
185
185
|
<hr /><p><small>
|
186
|
-
Version 8.3.
|
187
|
-
Last updated
|
186
|
+
Version 8.3.3<br />
|
187
|
+
Last updated 2009-01-02 12:44:42 NZDT
|
188
188
|
</small></p>
|
189
189
|
</body>
|
190
190
|
</html>
|
@@ -3,7 +3,7 @@
|
|
3
3
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
4
4
|
<head>
|
5
5
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
-
<meta name="generator" content="AsciiDoc 8.3.
|
6
|
+
<meta name="generator" content="AsciiDoc 8.3.3" />
|
7
7
|
<title>AsciiDoc User Guide</title>
|
8
8
|
<style type="text/css">
|
9
9
|
/* Debug borders */
|
@@ -228,12 +228,21 @@ dd > *:first-child {
|
|
228
228
|
ul, ol {
|
229
229
|
list-style-position: outside;
|
230
230
|
}
|
231
|
-
|
231
|
+
ol.arabic {
|
232
232
|
list-style-type: decimal;
|
233
233
|
}
|
234
|
-
|
234
|
+
ol.loweralpha {
|
235
235
|
list-style-type: lower-alpha;
|
236
236
|
}
|
237
|
+
ol.upperalpha {
|
238
|
+
list-style-type: upper-alpha;
|
239
|
+
}
|
240
|
+
ol.lowerroman {
|
241
|
+
list-style-type: lower-roman;
|
242
|
+
}
|
243
|
+
ol.upperroman {
|
244
|
+
list-style-type: upper-roman;
|
245
|
+
}
|
237
246
|
|
238
247
|
div.compact ul, div.compact ol,
|
239
248
|
div.compact p, div.compact p,
|
@@ -366,14 +375,6 @@ div.exampleblock-content {
|
|
366
375
|
|
367
376
|
/* IE6 sets dynamically generated links as visited. */
|
368
377
|
div#toc a:visited { color: blue; }
|
369
|
-
|
370
|
-
/* Because IE6 child selector is broken. */
|
371
|
-
div.olist2 ol {
|
372
|
-
list-style-type: lower-alpha;
|
373
|
-
}
|
374
|
-
div.olist2 div.olist ol {
|
375
|
-
list-style-type: decimal;
|
376
|
-
}
|
377
378
|
</style>
|
378
379
|
<script type="text/javascript">
|
379
380
|
/*<![CDATA[*/
|
@@ -455,8 +456,8 @@ function generateToc(toclevels) {
|
|
455
456
|
<h1>AsciiDoc User Guide</h1>
|
456
457
|
<span id="author">Stuart Rackham</span><br />
|
457
458
|
<span id="email"><tt><<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>></tt></span><br />
|
458
|
-
<span id="revision">version 8.3.
|
459
|
-
|
459
|
+
<span id="revision">version 8.3.3,</span>
|
460
|
+
2 January 2009
|
460
461
|
<div id="toc">
|
461
462
|
<div id="toctitle">Table of Contents</div>
|
462
463
|
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
|
@@ -753,8 +754,6 @@ stylesheet
|
|
753
754
|
specified by the <em>stylesdir</em> attribute.
|
754
755
|
</p>
|
755
756
|
</dd>
|
756
|
-
</dl></div>
|
757
|
-
<div class="dlist" id="X45"><dl>
|
758
757
|
<dt class="hdlist1">
|
759
758
|
icons
|
760
759
|
</dt>
|
@@ -765,8 +764,6 @@ icons
|
|
765
764
|
icon images.
|
766
765
|
</p>
|
767
766
|
</dd>
|
768
|
-
</dl></div>
|
769
|
-
<div class="dlist" id="X44"><dl>
|
770
767
|
<dt class="hdlist1">
|
771
768
|
iconsdir
|
772
769
|
</dt>
|
@@ -803,7 +800,7 @@ badges
|
|
803
800
|
</p>
|
804
801
|
</dd>
|
805
802
|
</dl></div>
|
806
|
-
<div class="admonitionblock">
|
803
|
+
<div class="admonitionblock" id="X44">
|
807
804
|
<table><tr>
|
808
805
|
<td class="icon">
|
809
806
|
<div class="title">Note</div>
|
@@ -1014,7 +1011,7 @@ address comes last and must be enclosed in angle <> brackets. Author
|
|
1014
1011
|
names cannot contain angle <> bracket characters.</p></div>
|
1015
1012
|
<div class="paragraph"><p>The optional document header revision line should immediately follow
|
1016
1013
|
the author line. The revision line can be one of two formats:</p></div>
|
1017
|
-
<div class="olist"><ol>
|
1014
|
+
<div class="olist arabic"><ol class="arabic">
|
1018
1015
|
<li>
|
1019
1016
|
<p>
|
1020
1017
|
An alphanumeric document revision number followed by a date:
|
@@ -1223,7 +1220,7 @@ Inline Macros
|
|
1223
1220
|
<h2 id="_document_processing">6. Document Processing</h2>
|
1224
1221
|
<div class="sectionbody">
|
1225
1222
|
<div class="paragraph"><p>The <em>AsciiDoc</em> source document is read and processed as follows:</p></div>
|
1226
|
-
<div class="olist"><ol>
|
1223
|
+
<div class="olist arabic"><ol class="arabic">
|
1227
1224
|
<li>
|
1228
1225
|
<p>
|
1229
1226
|
The document <em>Header</em> is parsed, header parameter values are
|
@@ -1254,7 +1251,7 @@ to be checked.</p></div>
|
|
1254
1251
|
and block syntax rules.</p></div>
|
1255
1252
|
<div class="paragraph"><p>Inline substitutions within block elements are performed in the
|
1256
1253
|
following default order:</p></div>
|
1257
|
-
<div class="olist"><ol>
|
1254
|
+
<div class="olist arabic"><ol class="arabic">
|
1258
1255
|
<li>
|
1259
1256
|
<p>
|
1260
1257
|
Special characters
|
@@ -1453,7 +1450,7 @@ constrained quotes) — here’s how to escape the previous
|
|
1453
1450
|
following line:</p></div>
|
1454
1451
|
<div class="literalblock">
|
1455
1452
|
<div class="content">
|
1456
|
-
<pre><tt>e
|
1453
|
+
<pre><tt>e^&#960;i^+1 = 0. H~2~O and x^10^. Some ^super text^
|
1457
1454
|
and ~some sub text~</tt></pre>
|
1458
1455
|
</div></div>
|
1459
1456
|
<div class="paragraph"><p>Is rendered like:</p></div>
|
@@ -1875,14 +1872,14 @@ often used for code and file listings.</p></div>
|
|
1875
1872
|
<div class="paragraph"><p>Here’s an example:</p></div>
|
1876
1873
|
<div class="listingblock">
|
1877
1874
|
<div class="content">
|
1878
|
-
<pre><tt
|
1879
|
-
|
1875
|
+
<pre><tt>--------------------------------------
|
1876
|
+
#include <stdio.h>
|
1880
1877
|
|
1881
|
-
|
1882
|
-
|
1883
|
-
|
1884
|
-
|
1885
|
-
|
1878
|
+
int main() {
|
1879
|
+
printf("Hello World!\n");
|
1880
|
+
exit(0);
|
1881
|
+
}
|
1882
|
+
--------------------------------------</tt></pre>
|
1886
1883
|
</div></div>
|
1887
1884
|
<div class="paragraph"><p>Which will be rendered like:</p></div>
|
1888
1885
|
<div class="listingblock">
|
@@ -1934,6 +1931,14 @@ SidebarBlocks) can be placed inside a sidebar.
|
|
1934
1931
|
<div class="paragraph"><p>Any <em>AsciiDoc</em> SectionBody element (apart from
|
1935
1932
|
SidebarBlocks) can be placed inside a sidebar.</p></div>
|
1936
1933
|
</div></div>
|
1934
|
+
<div class="paragraph"><p>Apply the <em>abstract</em> style to generate an abstract, for example:</p></div>
|
1935
|
+
<div class="listingblock">
|
1936
|
+
<div class="content">
|
1937
|
+
<pre><tt>[abstract]
|
1938
|
+
************************************************
|
1939
|
+
In this paper we will attempt to...
|
1940
|
+
************************************************</tt></pre>
|
1941
|
+
</div></div>
|
1937
1942
|
<h3 id="X26">12.5. Comment Blocks</h3><div style="clear:left"></div>
|
1938
1943
|
<div class="paragraph"><p>The contents of CommentBlocks are not processed; they are useful for
|
1939
1944
|
annotations and for excluding new or outdated content that you don’t
|
@@ -1946,6 +1951,14 @@ asciidoc(1).
|
|
1946
1951
|
//////////////////////////////////////////</tt></pre>
|
1947
1952
|
</div></div>
|
1948
1953
|
<div class="paragraph"><p>See also <a href="#X25">Comment Lines</a>.</p></div>
|
1954
|
+
<div class="admonitionblock">
|
1955
|
+
<table><tr>
|
1956
|
+
<td class="icon">
|
1957
|
+
<div class="title">Note</div>
|
1958
|
+
</td>
|
1959
|
+
<td class="content">System macros are executed inside comment blocks.</td>
|
1960
|
+
</tr></table>
|
1961
|
+
</div>
|
1949
1962
|
<h3 id="X76">12.6. Passthrough Blocks</h3><div style="clear:left"></div>
|
1950
1963
|
<div class="paragraph"><p>By default the block contents is subject to attribute and macro
|
1951
1964
|
substitution, no other markup is generated. PassthroughBlock content
|
@@ -2093,7 +2106,7 @@ adolescens.
|
|
2093
2106
|
<div class="title">A NOTE block</div>
|
2094
2107
|
<div class="paragraph"><p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis
|
2095
2108
|
adolescens.</p></div>
|
2096
|
-
<div class="olist"><ol>
|
2109
|
+
<div class="olist arabic"><ol class="arabic">
|
2097
2110
|
<li>
|
2098
2111
|
<p>
|
2099
2112
|
Fusce euismod commodo velit.
|
@@ -2103,7 +2116,7 @@ Fusce euismod commodo velit.
|
|
2103
2116
|
<p>
|
2104
2117
|
Vivamus fringilla mi eu lacus.
|
2105
2118
|
</p>
|
2106
|
-
<div class="olist2"><ol>
|
2119
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
2107
2120
|
<li>
|
2108
2121
|
<p>
|
2109
2122
|
Fusce euismod commodo velit.
|
@@ -2206,17 +2219,52 @@ space or tab character. Bulleted list syntaxes are:</p></div>
|
|
2206
2219
|
<pre><tt>- List item.
|
2207
2220
|
* List item.</tt></pre>
|
2208
2221
|
</div></div>
|
2209
|
-
<div class="paragraph"><p>
|
2210
|
-
|
2211
|
-
|
2212
|
-
<
|
2213
|
-
|
2214
|
-
|
2215
|
-
|
2216
|
-
|
2217
|
-
|
2218
|
-
|
2219
|
-
<
|
2222
|
+
<div class="paragraph"><p>There are two numbered list item syntaxes:</p></div>
|
2223
|
+
<div class="olist arabic"><ol class="arabic">
|
2224
|
+
<li>
|
2225
|
+
<p>
|
2226
|
+
List items beginning with a single period followed by a space. The
|
2227
|
+
period can be preceded by an optional decimal number. The default
|
2228
|
+
numbering style is arabic (decimal).
|
2229
|
+
</p>
|
2230
|
+
</li>
|
2231
|
+
<li>
|
2232
|
+
<p>
|
2233
|
+
List items beginning with two periods followed by a space. An alpha
|
2234
|
+
character or a roman number (upper or lower case) can optionally be
|
2235
|
+
used in place of the first period:
|
2236
|
+
</p>
|
2237
|
+
<div class="ulist"><ul>
|
2238
|
+
<li>
|
2239
|
+
<p>
|
2240
|
+
An attempt is made to set the number style based on number style
|
2241
|
+
of the first list item.
|
2242
|
+
</p>
|
2243
|
+
</li>
|
2244
|
+
<li>
|
2245
|
+
<p>
|
2246
|
+
The default numbering style is lowercase alpha.
|
2247
|
+
</p>
|
2248
|
+
</li>
|
2249
|
+
</ul></div>
|
2250
|
+
</li>
|
2251
|
+
</ol></div>
|
2252
|
+
<div class="paragraph"><p>You can use the <em>style</em> attribute to specify an alternative numbering
|
2253
|
+
style. The numbered list style can be set to one of the following
|
2254
|
+
values: <em>arabic</em>, <em>loweralpha</em>, <em>upperalpha</em>, <em>lowerroman</em>,
|
2255
|
+
<em>upperroman</em>.</p></div>
|
2256
|
+
<div class="paragraph"><p>Examples of numbered list items:</p></div>
|
2257
|
+
<div class="literalblock">
|
2258
|
+
<div class="content">
|
2259
|
+
<pre><tt>. Arabic (decimal) numbered list item.
|
2260
|
+
1. Arabic (decimal) numbered list item.
|
2261
|
+
.. Lower case letter numbered list item.
|
2262
|
+
a. Lower case letter numbered list item.
|
2263
|
+
A. Upper case letter numbered list item.
|
2264
|
+
iii. Lower case roman numbered list item.
|
2265
|
+
IX. Upper case roman numbered list item.</tt></pre>
|
2266
|
+
</div></div>
|
2267
|
+
<div class="paragraph"><p>Here are some examples of bulleted and numbered lists:</p></div>
|
2220
2268
|
<div class="listingblock">
|
2221
2269
|
<div class="content">
|
2222
2270
|
<pre><tt>- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
|
@@ -2229,6 +2277,7 @@ a. Lowercase letter numbered list item with optional numbering.</tt></pre>
|
|
2229
2277
|
- Nulla porttitor vulputate libero.
|
2230
2278
|
. Fusce euismod commodo velit.
|
2231
2279
|
. Vivamus fringilla mi eu lacus.
|
2280
|
+
[upperroman]
|
2232
2281
|
.. Fusce euismod commodo velit.
|
2233
2282
|
.. Vivamus fringilla mi eu lacus.
|
2234
2283
|
. Donec eget arcu bibendum nunc consequat lobortis.
|
@@ -2238,6 +2287,8 @@ a. Lowercase letter numbered list item with optional numbering.</tt></pre>
|
|
2238
2287
|
b. Vivamus fringilla mi eu lacus.
|
2239
2288
|
c. Donec eget arcu bibendum nunc consequat lobortis.
|
2240
2289
|
2. Vivamus fringilla mi eu lacus.
|
2290
|
+
.. Fusce euismod commodo velit.
|
2291
|
+
.. Vivamus fringilla mi eu lacus.
|
2241
2292
|
3. Donec eget arcu bibendum nunc consequat lobortis.
|
2242
2293
|
4. Nam fermentum mattis ante.</tt></pre>
|
2243
2294
|
</div></div>
|
@@ -2276,7 +2327,7 @@ Donec eget arcu bibendum nunc consequat lobortis.
|
|
2276
2327
|
<p>
|
2277
2328
|
Nulla porttitor vulputate libero.
|
2278
2329
|
</p>
|
2279
|
-
<div class="olist"><ol>
|
2330
|
+
<div class="olist arabic"><ol class="arabic">
|
2280
2331
|
<li>
|
2281
2332
|
<p>
|
2282
2333
|
Fusce euismod commodo velit.
|
@@ -2286,7 +2337,7 @@ Fusce euismod commodo velit.
|
|
2286
2337
|
<p>
|
2287
2338
|
Vivamus fringilla mi eu lacus.
|
2288
2339
|
</p>
|
2289
|
-
<div class="olist2"><ol>
|
2340
|
+
<div class="olist2 upperroman"><ol class="upperroman">
|
2290
2341
|
<li>
|
2291
2342
|
<p>
|
2292
2343
|
Fusce euismod commodo velit.
|
@@ -2310,12 +2361,12 @@ Donec eget arcu bibendum nunc consequat lobortis.
|
|
2310
2361
|
<p>
|
2311
2362
|
Praesent eget purus quis magna eleifend eleifend.
|
2312
2363
|
</p>
|
2313
|
-
<div class="olist"><ol>
|
2364
|
+
<div class="olist arabic"><ol class="arabic">
|
2314
2365
|
<li>
|
2315
2366
|
<p>
|
2316
2367
|
Fusce euismod commodo velit.
|
2317
2368
|
</p>
|
2318
|
-
<div class="olist2"><ol>
|
2369
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
2319
2370
|
<li>
|
2320
2371
|
<p>
|
2321
2372
|
Fusce euismod commodo velit.
|
@@ -2337,6 +2388,18 @@ Donec eget arcu bibendum nunc consequat lobortis.
|
|
2337
2388
|
<p>
|
2338
2389
|
Vivamus fringilla mi eu lacus.
|
2339
2390
|
</p>
|
2391
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
2392
|
+
<li>
|
2393
|
+
<p>
|
2394
|
+
Fusce euismod commodo velit.
|
2395
|
+
</p>
|
2396
|
+
</li>
|
2397
|
+
<li>
|
2398
|
+
<p>
|
2399
|
+
Vivamus fringilla mi eu lacus.
|
2400
|
+
</p>
|
2401
|
+
</li>
|
2402
|
+
</ol></div>
|
2340
2403
|
</li>
|
2341
2404
|
<li>
|
2342
2405
|
<p>
|
@@ -2705,7 +2768,7 @@ Nested list appended list item one paragraph
|
|
2705
2768
|
- Nested list item two.</tt></pre>
|
2706
2769
|
</div></div>
|
2707
2770
|
<div class="paragraph"><p>Renders:</p></div>
|
2708
|
-
<div class="olist"><ol>
|
2771
|
+
<div class="olist arabic"><ol class="arabic">
|
2709
2772
|
<li>
|
2710
2773
|
<p>
|
2711
2774
|
List item one.
|
@@ -2769,7 +2832,7 @@ Any block title or attributes are passed to the first element inside
|
|
2769
2832
|
</li>
|
2770
2833
|
</ul></div>
|
2771
2834
|
<div class="paragraph"><p>The List Block is useful for:</p></div>
|
2772
|
-
<div class="olist"><ol>
|
2835
|
+
<div class="olist arabic"><ol class="arabic">
|
2773
2836
|
<li>
|
2774
2837
|
<p>
|
2775
2838
|
Lists with long multi-element list items.
|
@@ -2805,13 +2868,13 @@ This paragraph belongs to item 1.
|
|
2805
2868
|
2. Item 2 of the outer list.</tt></pre>
|
2806
2869
|
</div></div>
|
2807
2870
|
<div class="paragraph"><p>Renders:</p></div>
|
2808
|
-
<div class="olist"><div class="title">Nested List Block</div><ol>
|
2871
|
+
<div class="olist arabic"><div class="title">Nested List Block</div><ol class="arabic">
|
2809
2872
|
<li>
|
2810
2873
|
<p>
|
2811
2874
|
List item one.
|
2812
2875
|
</p>
|
2813
2876
|
<div class="paragraph"><p>This paragraph is part of the preceding list item</p></div>
|
2814
|
-
<div class="olist2"><ol>
|
2877
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
2815
2878
|
<li>
|
2816
2879
|
<p>
|
2817
2880
|
This list is nested and does not require explicit item continuation.
|
@@ -2965,7 +3028,7 @@ example:</p></div>
|
|
2965
3028
|
11/16/97 17:17 61,865,984 pagefile.sys
|
2966
3029
|
2/13/94 6:21 9,349 WINA20.386 <b><3></b></tt></pre>
|
2967
3030
|
</div></div>
|
2968
|
-
<div class="colist"><ol>
|
3031
|
+
<div class="colist arabic"><ol>
|
2969
3032
|
<li>
|
2970
3033
|
<p>
|
2971
3034
|
This directory holds MS-DOS.
|
@@ -3068,12 +3131,12 @@ the <tt>test.py</tt> source file (containing a single callout) using the
|
|
3068
3131
|
<div class="listingblock">
|
3069
3132
|
<div class="title">AsciiDoc source</div>
|
3070
3133
|
<div class="content">
|
3071
|
-
<pre><tt>
|
3072
|
-
|
3073
|
-
|
3074
|
-
|
3134
|
+
<pre><tt>[source,python]
|
3135
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
3136
|
+
include::test.py[]
|
3137
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
3075
3138
|
|
3076
|
-
|
3139
|
+
<1> Print statement.</tt></pre>
|
3077
3140
|
</div></div>
|
3078
3141
|
<div class="listingblock">
|
3079
3142
|
<div class="title">Included <tt>test.py</tt> source</div>
|
@@ -3459,12 +3522,12 @@ paragraphs or delimited blocks. Example comment line:</p></div>
|
|
3459
3522
|
</div></div>
|
3460
3523
|
<div class="paragraph"><p>See also <a href="#X26">Comment Blocks</a>.</p></div>
|
3461
3524
|
<h3 id="_system_macros">17.3. System Macros</h3><div style="clear:left"></div>
|
3462
|
-
<div class="paragraph"><p>System macros are block macros that perform a predefined task
|
3525
|
+
<div class="paragraph"><p>System macros are block macros that perform a predefined task and are
|
3463
3526
|
hardwired into the <tt>asciidoc(1)</tt> program.</p></div>
|
3464
3527
|
<div class="ulist"><ul>
|
3465
3528
|
<li>
|
3466
3529
|
<p>
|
3467
|
-
You can
|
3530
|
+
You can escape system macros with a leading backslash character
|
3468
3531
|
(as you can with other macros).
|
3469
3532
|
</p>
|
3470
3533
|
</li>
|
@@ -3489,7 +3552,7 @@ verbatim embedded CSS or scripts into configuration file headers.
|
|
3489
3552
|
Example:</p></div>
|
3490
3553
|
<div class="listingblock">
|
3491
3554
|
<div class="content">
|
3492
|
-
<pre><tt>
|
3555
|
+
<pre><tt>include::chapter1.txt[tabsize=4]</tt></pre>
|
3493
3556
|
</div></div>
|
3494
3557
|
<div class="ulist"><div class="title">Include macro behavior</div><ul>
|
3495
3558
|
<li>
|
@@ -3748,7 +3811,7 @@ a markup template. If <tt><name></tt> is omitted then it is the value of t
|
|
3748
3811
|
regular expression match group named <em>name</em>. The optional
|
3749
3812
|
<tt>[<subslist]</tt> is a comma-separated list of substitution names enclosed
|
3750
3813
|
in <tt>[]</tt> brackets, it sets the default substitutions for passthrough
|
3751
|
-
text.</p></div>
|
3814
|
+
text, if omitted then no passthrough substitutions are performed.</p></div>
|
3752
3815
|
<div class="paragraph"><div class="title">Pattern named groups</div><p>The following named groups can be used in macro <tt><pattern></tt> regular
|
3753
3816
|
expressions and are available as markup template attributes:</p></div>
|
3754
3817
|
<div class="dlist"><dl>
|
@@ -3849,8 +3912,8 @@ There is no provision for cells to span multiple columns.
|
|
3849
3912
|
<div class="sidebar-title">Use tables sparingly</div>
|
3850
3913
|
<div class="paragraph"><p>When technical users first start creating documents, tables (complete
|
3851
3914
|
with column spanning and table nesting) are often considered very
|
3852
|
-
important.
|
3853
|
-
|
3915
|
+
important. The reality is that tables are seldom used, even in
|
3916
|
+
technical documentation.</p></div>
|
3854
3917
|
<div class="paragraph"><p>Try this exercise: thumb through your library of technical books,
|
3855
3918
|
you’ll be surprised just how seldom tables are actually used, even
|
3856
3919
|
less seldom are tables containing block elements such as paragraphs or
|
@@ -4126,11 +4189,11 @@ Buenos Aires</p></td>
|
|
4126
4189
|
<div class="paragraph"><p><em>AsciiDoc</em> source:</p></div>
|
4127
4190
|
<div class="listingblock">
|
4128
4191
|
<div class="content">
|
4129
|
-
<pre><tt>
|
4130
|
-
|
4131
|
-
|
4132
|
-
|
4133
|
-
|
4192
|
+
<pre><tt>[format="csv",cols="^1,4*2",options="header"]
|
4193
|
+
|===================================================
|
4194
|
+
ID,Customer Name,Contact Name,Customer Address,Phone
|
4195
|
+
include::customers.csv[]
|
4196
|
+
|===================================================</tt></pre>
|
4134
4197
|
</div></div>
|
4135
4198
|
<h3 id="X68">18.2. Table input data formats</h3><div style="clear:left"></div>
|
4136
4199
|
<div class="paragraph"><p><em>AsciiDoc</em> table data can be <em>psv</em>, <em>dsv</em> or <em>csv</em> formatted. The
|
@@ -5242,7 +5305,7 @@ explicitly (using the <tt>asciidoc(1)</tt> <tt>-f</tt> (<tt>--conf-file</tt>) co
|
|
5242
5305
|
option).</p></div>
|
5243
5306
|
<div class="paragraph"><p>Implicit configuration files are loaded from the following directories
|
5244
5307
|
in the following order:</p></div>
|
5245
|
-
<div class="olist"><ol>
|
5308
|
+
<div class="olist arabic"><ol class="arabic">
|
5246
5309
|
<li>
|
5247
5310
|
<p>
|
5248
5311
|
The global configuration directory (normally <tt>/etc/asciidoc</tt> or
|
@@ -5267,7 +5330,7 @@ The directory containing the <em>AsciiDoc</em> source file.
|
|
5267
5330
|
</ol></div>
|
5268
5331
|
<div class="paragraph"><p>The following implicit configuration files from each of the above
|
5269
5332
|
locations are loaded in the following order:</p></div>
|
5270
|
-
<div class="olist"><ol>
|
5333
|
+
<div class="olist arabic"><ol class="arabic">
|
5271
5334
|
<li>
|
5272
5335
|
<p>
|
5273
5336
|
<tt>asciidoc.conf</tt>
|
@@ -5311,7 +5374,7 @@ files will be processed in the order they appear on the command-line.</p></div>
|
|
5311
5374
|
</div></div>
|
5312
5375
|
<div class="paragraph"><p>Configuration files (if they exist) will be processed in the following
|
5313
5376
|
order:</p></div>
|
5314
|
-
<div class="olist"><ol>
|
5377
|
+
<div class="olist arabic"><ol class="arabic">
|
5315
5378
|
<li>
|
5316
5379
|
<p>
|
5317
5380
|
First default global configuration files from the asciidoc program
|
@@ -5652,7 +5715,8 @@ List attributes can only be referenced in configuration file markup
|
|
5652
5715
|
</li>
|
5653
5716
|
<li>
|
5654
5717
|
<p>
|
5655
|
-
Attribute references are allowed inside attribute lists
|
5718
|
+
Attribute references are allowed inside attribute lists — this is
|
5719
|
+
the only substitution performed on attribute lists.
|
5656
5720
|
</p>
|
5657
5721
|
</li>
|
5658
5722
|
<li>
|
@@ -5715,7 +5779,8 @@ attribute values to macro markup templates.</p></div>
|
|
5715
5779
|
<div class="paragraph"><p>An <a href="#X21">attribute list</a> on a line by itself constitutes an
|
5716
5780
|
<em>AttributeList</em> block element, its attributes apply to the following
|
5717
5781
|
block element. The list attributes are passed to the next block
|
5718
|
-
element for markup template substitution
|
5782
|
+
element for markup template substitution. Often the first list
|
5783
|
+
parameter is used to specify the element’s <a href="#X23">style</a>.</p></div>
|
5719
5784
|
</div>
|
5720
5785
|
<h2 id="_attribute_references">25. Attribute References</h2>
|
5721
5786
|
<div class="sectionbody">
|
@@ -6019,7 +6084,7 @@ predefined intrinsic attributes:</p></div>
|
|
6019
6084
|
{user-dir} the ~/.asciidoc directory (if it exists)
|
6020
6085
|
{verbose} defined as '' if --verbose command option specified</tt></pre>
|
6021
6086
|
</div></div>
|
6022
|
-
<div class="olist"><div class="title">NOTES</div><ol>
|
6087
|
+
<div class="olist arabic"><div class="title">NOTES</div><ol class="arabic">
|
6023
6088
|
<li>
|
6024
6089
|
<p>
|
6025
6090
|
Intrinsic attributes are global so avoid defining custom attributes
|
@@ -6262,7 +6327,7 @@ delimiter=(?P<text>\S.*)
|
|
6262
6327
|
template=paragraph</tt></pre>
|
6263
6328
|
</div></div>
|
6264
6329
|
<div class="paragraph"><p>The Default paragraph definition has a couple of special properties:</p></div>
|
6265
|
-
<div class="olist"><ol>
|
6330
|
+
<div class="olist arabic"><ol class="arabic">
|
6266
6331
|
<li>
|
6267
6332
|
<p>
|
6268
6333
|
It must exist and be defined in a configuration file section named
|
@@ -6300,7 +6365,7 @@ options
|
|
6300
6365
|
</p>
|
6301
6366
|
</dd>
|
6302
6367
|
</dl></div>
|
6303
|
-
<div class="olist"><div class="title">Paragraph processing proceeds as follows:</div><ol>
|
6368
|
+
<div class="olist arabic"><div class="title">Paragraph processing proceeds as follows:</div><ol class="arabic">
|
6304
6369
|
<li>
|
6305
6370
|
<p>
|
6306
6371
|
The paragraph text is aligned to the left margin.
|
@@ -6348,7 +6413,7 @@ skip
|
|
6348
6413
|
</dt>
|
6349
6414
|
<dd>
|
6350
6415
|
<p>
|
6351
|
-
The block is treated as a comment (see CommentBlocks).
|
6416
|
+
The block is treated as a comment (see <a href="#X26">CommentBlocks</a>).
|
6352
6417
|
</p>
|
6353
6418
|
</dd>
|
6354
6419
|
<dt class="hdlist1">
|
@@ -6363,7 +6428,7 @@ list
|
|
6363
6428
|
<div class="paragraph"><p><em>presubs</em>, <em>postsubs</em> and <em>filter</em> entries are meaningless when
|
6364
6429
|
<em>sectionbody</em>, <em>skip</em> or <em>list</em> options are set.</p></div>
|
6365
6430
|
<div class="paragraph"><p>DelimitedBlock processing proceeds as follows:</p></div>
|
6366
|
-
<div class="olist"><ol>
|
6431
|
+
<div class="olist arabic"><ol class="arabic">
|
6367
6432
|
<li>
|
6368
6433
|
<p>
|
6369
6434
|
Optional <em>presubs</em> substitutions are performed on the block
|
@@ -6576,32 +6641,28 @@ Finally it relies on the executing shell to search the environment
|
|
6576
6641
|
</p>
|
6577
6642
|
</li>
|
6578
6643
|
</ul></div>
|
6644
|
+
<div class="paragraph"><p>Sub-directories are also included in the searches — standard practice
|
6645
|
+
is to install each filter in it’s own sub-directory with the same name
|
6646
|
+
as the filter’s style definition. For example the music filter’s style
|
6647
|
+
name is <em>music</em> so it’s configuration and filter files are stored in
|
6648
|
+
the <tt>filters/music</tt> directory.</p></div>
|
6579
6649
|
<h3 id="_filter_configuration_files">28.2. Filter Configuration Files</h3><div style="clear:left"></div>
|
6580
6650
|
<div class="paragraph"><p>Filters are normally accompanied by a configuration file containing a
|
6581
6651
|
Paragraph or DelimitedBlock definition along with corresponding markup
|
6582
6652
|
templates.</p></div>
|
6583
|
-
<div class="paragraph"><p>
|
6584
|
-
|
6585
|
-
<
|
6586
|
-
<
|
6587
|
-
|
6588
|
-
|
6589
|
-
|
6590
|
-
<li>
|
6591
|
-
<p>
|
6592
|
-
By styling an existing Paragraph or DelimitedBlock using a <em>style</em>
|
6593
|
-
configuration entry — the <em>source highlight</em> and <em>music</em> filters
|
6594
|
-
use this technique to customize the ListingBlock. By convention the
|
6595
|
-
style is given the same name as the filter.
|
6596
|
-
</p>
|
6597
|
-
</li>
|
6598
|
-
</ul></div>
|
6653
|
+
<div class="paragraph"><p>While it is possible to create new Paragraph or DelimitedBlock
|
6654
|
+
definitions the preferred way to implement a filter is to add a
|
6655
|
+
<a href="#X23">style</a> to an existing Paragraph or DelimitedBlock definition
|
6656
|
+
(all filters shipped with <em>AsciiDoc</em> use this technique). The filter is
|
6657
|
+
applied to the paragraph or delimited block by preceding it with an
|
6658
|
+
attribute list: the first positional attribute is the style name,
|
6659
|
+
remaining attributes are normally filter specific parameters.</p></div>
|
6599
6660
|
<div class="paragraph"><p><tt>asciidoc(1)</tt> auto-loads all <tt>.conf</tt> files found in the filter search
|
6600
6661
|
paths (see previous section).</p></div>
|
6601
6662
|
<h3 id="X56">28.3. Code Filter</h3><div style="clear:left"></div>
|
6602
|
-
<div class="paragraph"><p><em>AsciiDoc</em> comes with a
|
6603
|
-
|
6604
|
-
|
6663
|
+
<div class="paragraph"><p><em>AsciiDoc</em> comes with a toy filter for highlighting source code keywords
|
6664
|
+
and comments. See also the <tt>./filters/code/code-filter-readme.txt</tt>
|
6665
|
+
file.</p></div>
|
6605
6666
|
<div class="admonitionblock">
|
6606
6667
|
<table><tr>
|
6607
6668
|
<td class="icon">
|
@@ -6616,7 +6677,7 @@ If you want a full featured multi-language highlighter use the
|
|
6616
6677
|
<div class="content">
|
6617
6678
|
<pre><tt>.Code filter example
|
6618
6679
|
[code,python]
|
6619
|
-
|
6680
|
+
----------------------------------------------
|
6620
6681
|
''' A multi-line
|
6621
6682
|
comment.'''
|
6622
6683
|
def sub_word(mo):
|
@@ -6626,7 +6687,7 @@ def sub_word(mo):
|
|
6626
6687
|
return quote + word + quote
|
6627
6688
|
else:
|
6628
6689
|
return word
|
6629
|
-
|
6690
|
+
----------------------------------------------</tt></pre>
|
6630
6691
|
</div></div>
|
6631
6692
|
<div class="paragraph"><p>Outputs:</p></div>
|
6632
6693
|
<div class="listingblock">
|
@@ -6762,7 +6823,7 @@ suitable DocBook toolchain (see the
|
|
6762
6823
|
</li>
|
6763
6824
|
</ul></div>
|
6764
6825
|
<h3 id="_html_help_generation">29.4. HTML Help generation</h3><div style="clear:left"></div>
|
6765
|
-
<div class="olist"><ol>
|
6826
|
+
<div class="olist arabic"><ol class="arabic">
|
6766
6827
|
<li>
|
6767
6828
|
<p>
|
6768
6829
|
Convert DocBook XML documents to HTML Help compiler source files
|
@@ -6786,8 +6847,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6786
6847
|
Converts <em>AsciiDoc</em> (<tt>.txt</tt>) files to DocBook XML (<tt>.xml</tt>) files.
|
6787
6848
|
</p>
|
6788
6849
|
</dd>
|
6789
|
-
</dl></div>
|
6790
|
-
<div class="dlist" id="X13"><dl>
|
6791
6850
|
<dt class="hdlist1">
|
6792
6851
|
<a href="http://docbook.sourceforge.net/projects/xsl/">DocBook XSL Stylesheets</a>
|
6793
6852
|
</dt>
|
@@ -6799,8 +6858,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6799
6858
|
<a href="#X40">xsltproc(1)</a>.
|
6800
6859
|
</p>
|
6801
6860
|
</dd>
|
6802
|
-
</dl></div>
|
6803
|
-
<div class="dlist" id="X40"><dl>
|
6804
6861
|
<dt class="hdlist1">
|
6805
6862
|
<a href="http://www.xmlsoft.org">xsltproc</a>
|
6806
6863
|
</dt>
|
@@ -6810,8 +6867,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6810
6867
|
<a href="#X13">DocBook XSL Stylesheets</a>) to XML documents.
|
6811
6868
|
</p>
|
6812
6869
|
</dd>
|
6813
|
-
</dl></div>
|
6814
|
-
<div class="dlist" id="X31"><dl>
|
6815
6870
|
<dt class="hdlist1">
|
6816
6871
|
<a href="http://dblatex.sourceforge.net/">dblatex</a>
|
6817
6872
|
</dt>
|
@@ -6822,8 +6877,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6822
6877
|
<tt>latex(1)</tt>.
|
6823
6878
|
</p>
|
6824
6879
|
</dd>
|
6825
|
-
</dl></div>
|
6826
|
-
<div class="dlist" id="X14"><dl>
|
6827
6880
|
<dt class="hdlist1">
|
6828
6881
|
<a href="http://xml.apache.org/fop/">FOP</a>
|
6829
6882
|
</dt>
|
@@ -6835,8 +6888,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6835
6888
|
<a href="#X40">xsltproc(1)</a>.
|
6836
6889
|
</p>
|
6837
6890
|
</dd>
|
6838
|
-
</dl></div>
|
6839
|
-
<div class="dlist" id="X67"><dl>
|
6840
6891
|
<dt class="hdlist1">
|
6841
6892
|
Microsoft Help Compiler
|
6842
6893
|
</dt>
|
@@ -6849,7 +6900,7 @@ Microsoft Help Compiler
|
|
6849
6900
|
</p>
|
6850
6901
|
</dd>
|
6851
6902
|
</dl></div>
|
6852
|
-
<h3 id="
|
6903
|
+
<h3 id="X67">29.6. AsciiDoc dblatex configuration files</h3><div style="clear:left"></div>
|
6853
6904
|
<div class="paragraph"><p>The <em>AsciiDoc</em> distribution <tt>./dblatex</tt> directory contains
|
6854
6905
|
<tt>asciidoc-dblatex.xsl</tt> (customized XSL parameter settings) and
|
6855
6906
|
<tt>asciidoc-dblatex.sty</tt> (customized LaTeX settings). These are examples
|
@@ -7044,7 +7095,7 @@ follow.</p></div>
|
|
7044
7095
|
<pre><tt>:set textwidth=70</tt></pre>
|
7045
7096
|
</div></div>
|
7046
7097
|
<div class="paragraph"><p>To reformat a paragraph:</p></div>
|
7047
|
-
<div class="olist"><ol>
|
7098
|
+
<div class="olist arabic"><ol class="arabic">
|
7048
7099
|
<li>
|
7049
7100
|
<p>
|
7050
7101
|
Position the cursor at the start of the paragraph.
|
@@ -7094,7 +7145,7 @@ callout lists. First you need to set the <tt>comments</tt>, <tt>formatoptions</t
|
|
7094
7145
|
and <tt>formatlistpat</tt> (see the <a href="#X61">Example <tt>~/.vimrc</tt> file</a>).</p></div>
|
7095
7146
|
<div class="paragraph"><p>Now you can format simple lists that use dash, asterisk, period and
|
7096
7147
|
plus bullets along with numbered ordered lists:</p></div>
|
7097
|
-
<div class="olist"><ol>
|
7148
|
+
<div class="olist arabic"><ol class="arabic">
|
7098
7149
|
<li>
|
7099
7150
|
<p>
|
7100
7151
|
Position the cursor at the start of the list.
|
@@ -7122,17 +7173,16 @@ highlight clear Search
|
|
7122
7173
|
" Don't move to matched text while search pattern is being entered.
|
7123
7174
|
set noincsearch
|
7124
7175
|
|
7125
|
-
"
|
7126
|
-
nnoremap
|
7176
|
+
" Reformat paragraphs and list.
|
7177
|
+
nnoremap R gq}
|
7127
7178
|
|
7128
|
-
"
|
7129
|
-
|
7130
|
-
nnoremap W :%s/[\r \t]\+$//<CR>:set et<CR>:retab!<CR>
|
7179
|
+
" Delete trailing white space and Dos-returns and to expand tabs to spaces.
|
7180
|
+
nnoremap S :set et<CR>:retab!<CR>:%s/[\r \t]\+$//<CR>
|
7131
7181
|
|
7132
7182
|
autocmd BufRead,BufNewFile *.txt,README,TODO,CHANGELOG,NOTES
|
7133
|
-
\ setlocal autoindent expandtab tabstop=8 softtabstop=2 shiftwidth=2
|
7183
|
+
\ setlocal autoindent expandtab tabstop=8 softtabstop=2 shiftwidth=2 filetype=asciidoc
|
7134
7184
|
\ textwidth=70 wrap formatoptions=tcqn
|
7135
|
-
\ formatlistpat=^\\s*<
|
7185
|
+
\ formatlistpat=^\\s*\\d\\+\\.\\s\\+\\\\|^\\s*<\\d\\+>\\s\\+\\\\|^\\s*[a-zA-Z.]\\.\\s\\+\\\\|^\\s*[ivxIVX]\\+\\.\\s\\+
|
7136
7186
|
\ comments=s1:/*,ex:*/,://,b:#,:%,:XCOMM,fb:-,fb:*,fb:+,fb:.,fb:></tt></pre>
|
7137
7187
|
</div></div>
|
7138
7188
|
<h3 id="_troubleshooting">33.3. Troubleshooting</h3><div style="clear:left"></div>
|
@@ -7253,70 +7303,31 @@ Macro attribute lists
|
|
7253
7303
|
</div></div>
|
7254
7304
|
</dd>
|
7255
7305
|
</dl></div>
|
7256
|
-
<h3 id="_combining_separate_documents">33.5. Combining
|
7306
|
+
<h3 id="_combining_separate_documents">33.5. Combining separate documents</h3><div style="clear:left"></div>
|
7257
7307
|
<div class="paragraph"><p>You have a number of stand-alone <em>AsciiDoc</em> documents that you want to
|
7258
7308
|
process as a single document. Simply processing them with a series of
|
7259
|
-
<tt>include</tt> macros won’t work
|
7260
|
-
|
7261
|
-
document
|
7262
|
-
<div
|
7263
|
-
section titles are pushed down one level.</p></div>
|
7264
|
-
<div class="olist"><ol>
|
7265
|
-
<li>
|
7266
|
-
<p>
|
7267
|
-
Push the standard title underlines down one level by defining a new
|
7268
|
-
level 0 underline in a custom configuration file. For example
|
7269
|
-
<tt>combined.conf</tt>:
|
7270
|
-
</p>
|
7271
|
-
<div class="literalblock">
|
7272
|
-
<div class="content">
|
7273
|
-
<pre><tt>[titles]
|
7274
|
-
underlines="__","==","--","~~","^^"</tt></pre>
|
7275
|
-
</div></div>
|
7276
|
-
</li>
|
7277
|
-
<li>
|
7278
|
-
<p>
|
7279
|
-
If you use single line titles you’ll need to make corresponding
|
7280
|
-
adjustments to the <tt>[titles]</tt> section <tt>sect0</tt>…<tt>sect4</tt> entries.
|
7281
|
-
</p>
|
7282
|
-
</li>
|
7283
|
-
<li>
|
7284
|
-
<p>
|
7285
|
-
Create a top level wrapper document. For example <tt>combined.txt</tt>:
|
7286
|
-
</p>
|
7309
|
+
<tt>include</tt> macros won’t work because the documents contain (level 0)
|
7310
|
+
document titles. The solution is to create a top level wrapper
|
7311
|
+
document that redefines the document underlines, pushing them down one
|
7312
|
+
level. For example <tt>combined.txt</tt>:</p></div>
|
7287
7313
|
<div class="listingblock">
|
7288
7314
|
<div class="content">
|
7289
|
-
<pre><tt
|
7290
|
-
_______________________
|
7315
|
+
<pre><tt>:titles.underlines: "__","==","--","~~","^^"
|
7291
7316
|
|
7292
|
-
|
7317
|
+
Combined Document Title
|
7318
|
+
_______________________
|
7293
7319
|
|
7294
|
-
|
7320
|
+
include::document1.txt[]
|
7295
7321
|
|
7296
|
-
|
7297
|
-
|
7298
|
-
</
|
7299
|
-
<li>
|
7300
|
-
<p>
|
7301
|
-
Process the wrapper document. For example:
|
7302
|
-
</p>
|
7303
|
-
<div class="literalblock">
|
7304
|
-
<div class="content">
|
7305
|
-
<pre><tt>$ asciidoc --conf-file=combined.conf combined.txt</tt></pre>
|
7322
|
+
include::document2.txt[]
|
7323
|
+
|
7324
|
+
include::document3.txt[]</tt></pre>
|
7306
7325
|
</div></div>
|
7307
|
-
|
7308
|
-
|
7309
|
-
<div class="paragraph"><p>Actually the <tt>--conf-file</tt> option is unnecessary as <tt>asciidoc(1)</tt>
|
7310
|
-
automatically looks for a same-named <tt>.conf</tt> file.</p></div>
|
7326
|
+
<div class="paragraph"><p>The document titles in the included documents will now be processed as
|
7327
|
+
level 1 section titles.</p></div>
|
7311
7328
|
<div class="ulist"><ul>
|
7312
7329
|
<li>
|
7313
7330
|
<p>
|
7314
|
-
The combined document title uses the newly defined level 0 underline
|
7315
|
-
(underscore characters).
|
7316
|
-
</p>
|
7317
|
-
</li>
|
7318
|
-
<li>
|
7319
|
-
<p>
|
7320
7331
|
Put a blank line between the <tt>include</tt> macro lines to ensure the
|
7321
7332
|
title of the included document is not seen as part of the last
|
7322
7333
|
paragraph of the previous document.
|
@@ -7330,56 +7341,50 @@ You won’t want document Headers (Author and Revision lines) in the
|
|
7330
7341
|
</p>
|
7331
7342
|
</li>
|
7332
7343
|
</ul></div>
|
7333
|
-
<h3 id="_processing_document_sections_separately">33.6. Processing
|
7334
|
-
<div class="paragraph"><p>You have divided your <em>AsciiDoc</em> document into separate files (one per
|
7335
|
-
section) which are combined and processed with the following
|
7336
|
-
document:</p></div>
|
7344
|
+
<h3 id="_processing_document_sections_separately">33.6. Processing document sections separately</h3><div style="clear:left"></div>
|
7345
|
+
<div class="paragraph"><p>You have divided your <em>AsciiDoc</em> document into separate files (one per
|
7346
|
+
top level section) which are combined and processed with the following
|
7347
|
+
top level document:</p></div>
|
7337
7348
|
<div class="listingblock">
|
7338
7349
|
<div class="content">
|
7339
|
-
<pre><tt>
|
7340
|
-
|
7341
|
-
|
7342
|
-
|
7350
|
+
<pre><tt>Combined Document Title
|
7351
|
+
=======================
|
7352
|
+
Joe Bloggs
|
7353
|
+
v1.0, 12-Aug-03
|
7343
7354
|
|
7344
|
-
|
7355
|
+
include::section1.txt[]
|
7345
7356
|
|
7346
|
-
|
7357
|
+
include::section2.txt[]
|
7347
7358
|
|
7348
|
-
|
7359
|
+
include::section3.txt[]</tt></pre>
|
7349
7360
|
</div></div>
|
7350
7361
|
<div class="paragraph"><p>You also want to process the section files as separate documents.
|
7351
7362
|
This is easy because <tt>asciidoc(1)</tt> will quite happily process
|
7352
|
-
<tt>section1.txt</tt>, <tt>section2.txt</tt> and <tt>section3.txt</tt> separately
|
7353
|
-
|
7354
|
-
|
7355
|
-
|
7363
|
+
<tt>section1.txt</tt>, <tt>section2.txt</tt> and <tt>section3.txt</tt> separately — the
|
7364
|
+
resulting output documents contain the section but have no document
|
7365
|
+
title.</p></div>
|
7366
|
+
<div class="paragraph"><p>Use the <tt>-s</tt> (<tt>--no-header-footer</tt>) command-line option to suppress
|
7367
|
+
header and footer output, this is useful if the processed output is to
|
7368
|
+
be included in another file. For example:</p></div>
|
7356
7369
|
<div class="literalblock">
|
7357
7370
|
<div class="content">
|
7358
|
-
<pre><tt>
|
7359
|
-
underlines="--","~~","^^","++","__"</tt></pre>
|
7371
|
+
<pre><tt>$ asciidoc -s -b docbook section1.txt</tt></pre>
|
7360
7372
|
</div></div>
|
7361
|
-
<
|
7362
|
-
is necessary to legitimize the underline definition.</p></div>
|
7363
|
-
<div class="paragraph"><p>This is just the reverse of the technique used for combining separate
|
7364
|
-
documents explained in the previous section.</p></div>
|
7365
|
-
<h3 id="_processing_document_chunks">33.7. Processing Document Chunks</h3><div style="clear:left"></div>
|
7373
|
+
<h3 id="_processing_document_snippets">33.7. Processing document snippets</h3><div style="clear:left"></div>
|
7366
7374
|
<div class="paragraph"><p><tt>asciidoc(1)</tt> can be used as a filter, so you can pipe chunks of text
|
7367
7375
|
through it. For example:</p></div>
|
7368
7376
|
<div class="literalblock">
|
7369
7377
|
<div class="content">
|
7370
7378
|
<pre><tt>$ echo 'Hello *World!*' | asciidoc -s -
|
7371
|
-
<div class="
|
7379
|
+
<div class="paragraph"><p>Hello <strong>World!</strong></p></div></tt></pre>
|
7372
7380
|
</div></div>
|
7373
|
-
<
|
7374
|
-
and footer output and is useful if the processed output is to be
|
7375
|
-
included in another file.</p></div>
|
7376
|
-
<h3 id="_badges_in_html_page_footers">33.8. Badges in HTML Page Footers</h3><div style="clear:left"></div>
|
7381
|
+
<h3 id="_badges_in_html_page_footers">33.8. Badges in HTML page footers</h3><div style="clear:left"></div>
|
7377
7382
|
<div class="paragraph"><p>See the <tt>[footer]</tt> section in the <em>AsciiDoc</em> distribution <tt>xhtml11.conf</tt>
|
7378
7383
|
configuration file.</p></div>
|
7379
|
-
<h3 id="_pretty_printing_asciidoc_output">33.9. Pretty
|
7384
|
+
<h3 id="_pretty_printing_asciidoc_output">33.9. Pretty printing AsciiDoc output</h3><div style="clear:left"></div>
|
7380
7385
|
<div class="paragraph"><p>If the indentation and layout of the <tt>asciidoc(1)</tt> output is not to your
|
7381
7386
|
liking you can:</p></div>
|
7382
|
-
<div class="olist"><ol>
|
7387
|
+
<div class="olist arabic"><ol class="arabic">
|
7383
7388
|
<li>
|
7384
7389
|
<p>
|
7385
7390
|
Change the indentation and layout of configuration file markup
|
@@ -7389,22 +7394,30 @@ Change the indentation and layout of configuration file markup
|
|
7389
7394
|
</li>
|
7390
7395
|
<li>
|
7391
7396
|
<p>
|
7392
|
-
|
7393
|
-
<tt>asciidoc(1)</tt> output. Example:
|
7397
|
+
Use Dave Raggett’s <a href="http://tidy.sourceforge.net/">HTML Tidy</a> program
|
7398
|
+
to tidy <tt>asciidoc(1)</tt> output. Example:
|
7394
7399
|
</p>
|
7395
7400
|
<div class="literalblock">
|
7396
7401
|
<div class="content">
|
7397
7402
|
<pre><tt>$ asciidoc -b docbook -o - mydoc.txt | tidy -indent -xml >mydoc.xml</tt></pre>
|
7398
7403
|
</div></div>
|
7399
7404
|
</li>
|
7405
|
+
<li>
|
7406
|
+
<p>
|
7407
|
+
Use the <tt>xmllint(1)</tt> format option. Example:
|
7408
|
+
</p>
|
7409
|
+
<div class="literalblock">
|
7410
|
+
<div class="content">
|
7411
|
+
<pre><tt>$ xmllint --format mydoc.xml</tt></pre>
|
7412
|
+
</div></div>
|
7413
|
+
</li>
|
7400
7414
|
</ol></div>
|
7401
|
-
<
|
7402
|
-
<h3 id="_supporting_minor_docbook_dtd_variations">33.10. Supporting Minor DocBook DTD Variations</h3><div style="clear:left"></div>
|
7415
|
+
<h3 id="_supporting_minor_docbook_dtd_variations">33.10. Supporting minor DocBook DTD variations</h3><div style="clear:left"></div>
|
7403
7416
|
<div class="paragraph"><p>The conditional inclusion of DocBook SGML markup at the end of the
|
7404
7417
|
distribution <tt>docbook.conf</tt> file illustrates how to support minor DTD
|
7405
7418
|
variations. The included sections override corresponding entries from
|
7406
7419
|
preceding sections.</p></div>
|
7407
|
-
<h3 id="_shipping_stand_alone_asciidoc_source">33.11. Shipping
|
7420
|
+
<h3 id="_shipping_stand_alone_asciidoc_source">33.11. Shipping stand-alone AsciiDoc source</h3><div style="clear:left"></div>
|
7408
7421
|
<div class="paragraph"><p>Reproducing presentation documents from someone else’s source has one
|
7409
7422
|
major problem: unless your configuration files are the same as the
|
7410
7423
|
creator’s you won’t get the same output.</p></div>
|
@@ -7429,12 +7442,12 @@ regenerate the HMTL output:</p></div>
|
|
7429
7442
|
<div class="paragraph"><p>The <tt>-e</tt> (<tt>--no-conf</tt>) option excludes the use of implicit
|
7430
7443
|
configuration files, ensuring that only entries from the
|
7431
7444
|
<tt>mydoc-html.conf</tt> configuration are used.</p></div>
|
7432
|
-
<h3 id="_inserting_blank_space">33.12. Inserting
|
7445
|
+
<h3 id="_inserting_blank_space">33.12. Inserting blank space</h3><div style="clear:left"></div>
|
7433
7446
|
<div class="paragraph"><p>Adjust your style sheets to add the correct separation between block
|
7434
7447
|
elements. Inserting blank paragraphs containing a single non-breaking
|
7435
7448
|
space character <tt>{nbsp}</tt> works but is an ad hoc solution compared
|
7436
7449
|
to using style sheets.</p></div>
|
7437
|
-
<h3 id="_closing_open_sections">33.13. Closing
|
7450
|
+
<h3 id="_closing_open_sections">33.13. Closing open sections</h3><div style="clear:left"></div>
|
7438
7451
|
<div class="paragraph"><p>You can close off section tags up to level <tt>N</tt> by calling the
|
7439
7452
|
<tt>eval::[Section.setlevel(N)]</tt> system macro. This is useful if you
|
7440
7453
|
want to include a section composed of raw markup. The following
|
@@ -7442,21 +7455,21 @@ example includes a DocBook glossary division at the top section level
|
|
7442
7455
|
(level 0):</p></div>
|
7443
7456
|
<div class="listingblock">
|
7444
7457
|
<div class="content">
|
7445
|
-
<pre><tt>
|
7458
|
+
<pre><tt>ifdef::backend-docbook[]
|
7446
7459
|
|
7447
|
-
|
7460
|
+
eval::[Section.setlevel(0)]
|
7448
7461
|
|
7449
|
-
|
7450
|
-
|
7451
|
-
|
7452
|
-
|
7453
|
-
|
7454
|
-
|
7455
|
-
|
7456
|
-
|
7457
|
-
|
7458
|
-
</div></div>
|
7459
|
-
<h3 id="_validating_output_files">33.14. Validating
|
7462
|
+
+++++++++++++++++++++++++++++++
|
7463
|
+
<glossary>
|
7464
|
+
<title>Glossary</title>
|
7465
|
+
<glossdiv>
|
7466
|
+
...
|
7467
|
+
</glossdiv>
|
7468
|
+
</glossary>
|
7469
|
+
+++++++++++++++++++++++++++++++
|
7470
|
+
endif::backend-docbook[]</tt></pre>
|
7471
|
+
</div></div>
|
7472
|
+
<h3 id="_validating_output_files">33.14. Validating output files</h3><div style="clear:left"></div>
|
7460
7473
|
<div class="paragraph"><p>Use <tt>xmllint(1)</tt> to check the <em>AsciiDoc</em> generated markup is both well
|
7461
7474
|
formed and valid. Here are some examples:</p></div>
|
7462
7475
|
<div class="literalblock">
|
@@ -7577,7 +7590,7 @@ inclusion of arbitrary files.</p></div>
|
|
7577
7590
|
</li>
|
7578
7591
|
<li>
|
7579
7592
|
<p>
|
7580
|
-
<tt
|
7593
|
+
<tt>include::<filename>[]</tt> and <tt>\include1::<filename>[]</tt> block macro
|
7581
7594
|
files must reside inside the parent file’s directory.
|
7582
7595
|
</p>
|
7583
7596
|
</li>
|
@@ -7601,7 +7614,7 @@ Passthrough Blocks are dropped.
|
|
7601
7614
|
<td class="content">
|
7602
7615
|
<div class="paragraph"><p>The safe mode is not designed to protect against unsafe <em>AsciiDoc</em>
|
7603
7616
|
configuration files. Be especially careful when:</p></div>
|
7604
|
-
<div class="olist"><ol>
|
7617
|
+
<div class="olist arabic"><ol class="arabic">
|
7605
7618
|
<li>
|
7606
7619
|
<p>
|
7607
7620
|
Implementing filters.
|
@@ -7832,8 +7845,8 @@ width of the page irrespective of the current indentation.</p></td>
|
|
7832
7845
|
</div>
|
7833
7846
|
<div id="footer">
|
7834
7847
|
<div id="footer-text">
|
7835
|
-
Version 8.3.
|
7836
|
-
Last updated
|
7848
|
+
Version 8.3.3<br />
|
7849
|
+
Last updated 2009-01-02 13:12:59 NZDT
|
7837
7850
|
</div>
|
7838
7851
|
</div>
|
7839
7852
|
</body>
|