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
@@ -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
|
<link rel="stylesheet" href="../stylesheets/xhtml11.css" type="text/css" />
|
9
9
|
<link rel="stylesheet" href="../stylesheets/xhtml11-quirks.css" type="text/css" />
|
@@ -19,8 +19,8 @@ window.onload = function(){generateToc(2)}
|
|
19
19
|
<h1>AsciiDoc User Guide</h1>
|
20
20
|
<span id="author">Stuart Rackham</span><br />
|
21
21
|
<span id="email"><tt><<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>></tt></span><br />
|
22
|
-
<span id="revision">version 8.3.
|
23
|
-
|
22
|
+
<span id="revision">version 8.3.3,</span>
|
23
|
+
2 January 2009
|
24
24
|
<div id="toc">
|
25
25
|
<div id="toctitle">Table of Contents</div>
|
26
26
|
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
|
@@ -317,8 +317,6 @@ stylesheet
|
|
317
317
|
specified by the <em>stylesdir</em> attribute.
|
318
318
|
</p>
|
319
319
|
</dd>
|
320
|
-
</dl></div>
|
321
|
-
<div class="dlist" id="X45"><dl>
|
322
320
|
<dt class="hdlist1">
|
323
321
|
icons
|
324
322
|
</dt>
|
@@ -329,8 +327,6 @@ icons
|
|
329
327
|
icon images.
|
330
328
|
</p>
|
331
329
|
</dd>
|
332
|
-
</dl></div>
|
333
|
-
<div class="dlist" id="X44"><dl>
|
334
330
|
<dt class="hdlist1">
|
335
331
|
iconsdir
|
336
332
|
</dt>
|
@@ -367,7 +363,7 @@ badges
|
|
367
363
|
</p>
|
368
364
|
</dd>
|
369
365
|
</dl></div>
|
370
|
-
<div class="admonitionblock">
|
366
|
+
<div class="admonitionblock" id="X44">
|
371
367
|
<table><tr>
|
372
368
|
<td class="icon">
|
373
369
|
<img src="./images/icons/note.png" alt="Note" />
|
@@ -578,7 +574,7 @@ address comes last and must be enclosed in angle <> brackets. Author
|
|
578
574
|
names cannot contain angle <> bracket characters.</p></div>
|
579
575
|
<div class="paragraph"><p>The optional document header revision line should immediately follow
|
580
576
|
the author line. The revision line can be one of two formats:</p></div>
|
581
|
-
<div class="olist"><ol>
|
577
|
+
<div class="olist arabic"><ol class="arabic">
|
582
578
|
<li>
|
583
579
|
<p>
|
584
580
|
An alphanumeric document revision number followed by a date:
|
@@ -787,7 +783,7 @@ Inline Macros
|
|
787
783
|
<h2 id="_document_processing">6. Document Processing</h2>
|
788
784
|
<div class="sectionbody">
|
789
785
|
<div class="paragraph"><p>The <em>AsciiDoc</em> source document is read and processed as follows:</p></div>
|
790
|
-
<div class="olist"><ol>
|
786
|
+
<div class="olist arabic"><ol class="arabic">
|
791
787
|
<li>
|
792
788
|
<p>
|
793
789
|
The document <em>Header</em> is parsed, header parameter values are
|
@@ -818,7 +814,7 @@ to be checked.</p></div>
|
|
818
814
|
and block syntax rules.</p></div>
|
819
815
|
<div class="paragraph"><p>Inline substitutions within block elements are performed in the
|
820
816
|
following default order:</p></div>
|
821
|
-
<div class="olist"><ol>
|
817
|
+
<div class="olist arabic"><ol class="arabic">
|
822
818
|
<li>
|
823
819
|
<p>
|
824
820
|
Special characters
|
@@ -1017,7 +1013,7 @@ constrained quotes) — here’s how to escape the previous
|
|
1017
1013
|
following line:</p></div>
|
1018
1014
|
<div class="literalblock">
|
1019
1015
|
<div class="content">
|
1020
|
-
<pre><tt>e
|
1016
|
+
<pre><tt>e^&#960;i^+1 = 0. H~2~O and x^10^. Some ^super text^
|
1021
1017
|
and ~some sub text~</tt></pre>
|
1022
1018
|
</div></div>
|
1023
1019
|
<div class="paragraph"><p>Is rendered like:</p></div>
|
@@ -1439,14 +1435,14 @@ often used for code and file listings.</p></div>
|
|
1439
1435
|
<div class="paragraph"><p>Here’s an example:</p></div>
|
1440
1436
|
<div class="listingblock">
|
1441
1437
|
<div class="content">
|
1442
|
-
<pre><tt
|
1443
|
-
|
1438
|
+
<pre><tt>--------------------------------------
|
1439
|
+
#include <stdio.h>
|
1444
1440
|
|
1445
|
-
|
1446
|
-
|
1447
|
-
|
1448
|
-
|
1449
|
-
|
1441
|
+
int main() {
|
1442
|
+
printf("Hello World!\n");
|
1443
|
+
exit(0);
|
1444
|
+
}
|
1445
|
+
--------------------------------------</tt></pre>
|
1450
1446
|
</div></div>
|
1451
1447
|
<div class="paragraph"><p>Which will be rendered like:</p></div>
|
1452
1448
|
<div class="listingblock">
|
@@ -1498,6 +1494,14 @@ SidebarBlocks) can be placed inside a sidebar.
|
|
1498
1494
|
<div class="paragraph"><p>Any <em>AsciiDoc</em> SectionBody element (apart from
|
1499
1495
|
SidebarBlocks) can be placed inside a sidebar.</p></div>
|
1500
1496
|
</div></div>
|
1497
|
+
<div class="paragraph"><p>Apply the <em>abstract</em> style to generate an abstract, for example:</p></div>
|
1498
|
+
<div class="listingblock">
|
1499
|
+
<div class="content">
|
1500
|
+
<pre><tt>[abstract]
|
1501
|
+
************************************************
|
1502
|
+
In this paper we will attempt to...
|
1503
|
+
************************************************</tt></pre>
|
1504
|
+
</div></div>
|
1501
1505
|
<h3 id="X26">12.5. Comment Blocks</h3><div style="clear:left"></div>
|
1502
1506
|
<div class="paragraph"><p>The contents of CommentBlocks are not processed; they are useful for
|
1503
1507
|
annotations and for excluding new or outdated content that you don’t
|
@@ -1510,6 +1514,14 @@ asciidoc(1).
|
|
1510
1514
|
//////////////////////////////////////////</tt></pre>
|
1511
1515
|
</div></div>
|
1512
1516
|
<div class="paragraph"><p>See also <a href="#X25">Comment Lines</a>.</p></div>
|
1517
|
+
<div class="admonitionblock">
|
1518
|
+
<table><tr>
|
1519
|
+
<td class="icon">
|
1520
|
+
<img src="./images/icons/note.png" alt="Note" />
|
1521
|
+
</td>
|
1522
|
+
<td class="content">System macros are executed inside comment blocks.</td>
|
1523
|
+
</tr></table>
|
1524
|
+
</div>
|
1513
1525
|
<h3 id="X76">12.6. Passthrough Blocks</h3><div style="clear:left"></div>
|
1514
1526
|
<div class="paragraph"><p>By default the block contents is subject to attribute and macro
|
1515
1527
|
substitution, no other markup is generated. PassthroughBlock content
|
@@ -1657,7 +1669,7 @@ adolescens.
|
|
1657
1669
|
<div class="title">A NOTE block</div>
|
1658
1670
|
<div class="paragraph"><p>Qui in magna commodo, est labitur dolorum an. Est ne magna primis
|
1659
1671
|
adolescens.</p></div>
|
1660
|
-
<div class="olist"><ol>
|
1672
|
+
<div class="olist arabic"><ol class="arabic">
|
1661
1673
|
<li>
|
1662
1674
|
<p>
|
1663
1675
|
Fusce euismod commodo velit.
|
@@ -1667,7 +1679,7 @@ Fusce euismod commodo velit.
|
|
1667
1679
|
<p>
|
1668
1680
|
Vivamus fringilla mi eu lacus.
|
1669
1681
|
</p>
|
1670
|
-
<div class="olist2"><ol>
|
1682
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
1671
1683
|
<li>
|
1672
1684
|
<p>
|
1673
1685
|
Fusce euismod commodo velit.
|
@@ -1770,17 +1782,52 @@ space or tab character. Bulleted list syntaxes are:</p></div>
|
|
1770
1782
|
<pre><tt>- List item.
|
1771
1783
|
* List item.</tt></pre>
|
1772
1784
|
</div></div>
|
1773
|
-
<div class="paragraph"><p>
|
1774
|
-
|
1775
|
-
|
1776
|
-
<
|
1777
|
-
|
1778
|
-
|
1779
|
-
|
1780
|
-
|
1781
|
-
|
1782
|
-
|
1783
|
-
<
|
1785
|
+
<div class="paragraph"><p>There are two numbered list item syntaxes:</p></div>
|
1786
|
+
<div class="olist arabic"><ol class="arabic">
|
1787
|
+
<li>
|
1788
|
+
<p>
|
1789
|
+
List items beginning with a single period followed by a space. The
|
1790
|
+
period can be preceded by an optional decimal number. The default
|
1791
|
+
numbering style is arabic (decimal).
|
1792
|
+
</p>
|
1793
|
+
</li>
|
1794
|
+
<li>
|
1795
|
+
<p>
|
1796
|
+
List items beginning with two periods followed by a space. An alpha
|
1797
|
+
character or a roman number (upper or lower case) can optionally be
|
1798
|
+
used in place of the first period:
|
1799
|
+
</p>
|
1800
|
+
<div class="ulist"><ul>
|
1801
|
+
<li>
|
1802
|
+
<p>
|
1803
|
+
An attempt is made to set the number style based on number style
|
1804
|
+
of the first list item.
|
1805
|
+
</p>
|
1806
|
+
</li>
|
1807
|
+
<li>
|
1808
|
+
<p>
|
1809
|
+
The default numbering style is lowercase alpha.
|
1810
|
+
</p>
|
1811
|
+
</li>
|
1812
|
+
</ul></div>
|
1813
|
+
</li>
|
1814
|
+
</ol></div>
|
1815
|
+
<div class="paragraph"><p>You can use the <em>style</em> attribute to specify an alternative numbering
|
1816
|
+
style. The numbered list style can be set to one of the following
|
1817
|
+
values: <em>arabic</em>, <em>loweralpha</em>, <em>upperalpha</em>, <em>lowerroman</em>,
|
1818
|
+
<em>upperroman</em>.</p></div>
|
1819
|
+
<div class="paragraph"><p>Examples of numbered list items:</p></div>
|
1820
|
+
<div class="literalblock">
|
1821
|
+
<div class="content">
|
1822
|
+
<pre><tt>. Arabic (decimal) numbered list item.
|
1823
|
+
1. Arabic (decimal) numbered list item.
|
1824
|
+
.. Lower case letter numbered list item.
|
1825
|
+
a. Lower case letter numbered list item.
|
1826
|
+
A. Upper case letter numbered list item.
|
1827
|
+
iii. Lower case roman numbered list item.
|
1828
|
+
IX. Upper case roman numbered list item.</tt></pre>
|
1829
|
+
</div></div>
|
1830
|
+
<div class="paragraph"><p>Here are some examples of bulleted and numbered lists:</p></div>
|
1784
1831
|
<div class="listingblock">
|
1785
1832
|
<div class="content">
|
1786
1833
|
<pre><tt>- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
|
@@ -1793,6 +1840,7 @@ a. Lowercase letter numbered list item with optional numbering.</tt></pre>
|
|
1793
1840
|
- Nulla porttitor vulputate libero.
|
1794
1841
|
. Fusce euismod commodo velit.
|
1795
1842
|
. Vivamus fringilla mi eu lacus.
|
1843
|
+
[upperroman]
|
1796
1844
|
.. Fusce euismod commodo velit.
|
1797
1845
|
.. Vivamus fringilla mi eu lacus.
|
1798
1846
|
. Donec eget arcu bibendum nunc consequat lobortis.
|
@@ -1802,6 +1850,8 @@ a. Lowercase letter numbered list item with optional numbering.</tt></pre>
|
|
1802
1850
|
b. Vivamus fringilla mi eu lacus.
|
1803
1851
|
c. Donec eget arcu bibendum nunc consequat lobortis.
|
1804
1852
|
2. Vivamus fringilla mi eu lacus.
|
1853
|
+
.. Fusce euismod commodo velit.
|
1854
|
+
.. Vivamus fringilla mi eu lacus.
|
1805
1855
|
3. Donec eget arcu bibendum nunc consequat lobortis.
|
1806
1856
|
4. Nam fermentum mattis ante.</tt></pre>
|
1807
1857
|
</div></div>
|
@@ -1840,7 +1890,7 @@ Donec eget arcu bibendum nunc consequat lobortis.
|
|
1840
1890
|
<p>
|
1841
1891
|
Nulla porttitor vulputate libero.
|
1842
1892
|
</p>
|
1843
|
-
<div class="olist"><ol>
|
1893
|
+
<div class="olist arabic"><ol class="arabic">
|
1844
1894
|
<li>
|
1845
1895
|
<p>
|
1846
1896
|
Fusce euismod commodo velit.
|
@@ -1850,7 +1900,7 @@ Fusce euismod commodo velit.
|
|
1850
1900
|
<p>
|
1851
1901
|
Vivamus fringilla mi eu lacus.
|
1852
1902
|
</p>
|
1853
|
-
<div class="olist2"><ol>
|
1903
|
+
<div class="olist2 upperroman"><ol class="upperroman">
|
1854
1904
|
<li>
|
1855
1905
|
<p>
|
1856
1906
|
Fusce euismod commodo velit.
|
@@ -1874,12 +1924,12 @@ Donec eget arcu bibendum nunc consequat lobortis.
|
|
1874
1924
|
<p>
|
1875
1925
|
Praesent eget purus quis magna eleifend eleifend.
|
1876
1926
|
</p>
|
1877
|
-
<div class="olist"><ol>
|
1927
|
+
<div class="olist arabic"><ol class="arabic">
|
1878
1928
|
<li>
|
1879
1929
|
<p>
|
1880
1930
|
Fusce euismod commodo velit.
|
1881
1931
|
</p>
|
1882
|
-
<div class="olist2"><ol>
|
1932
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
1883
1933
|
<li>
|
1884
1934
|
<p>
|
1885
1935
|
Fusce euismod commodo velit.
|
@@ -1901,6 +1951,18 @@ Donec eget arcu bibendum nunc consequat lobortis.
|
|
1901
1951
|
<p>
|
1902
1952
|
Vivamus fringilla mi eu lacus.
|
1903
1953
|
</p>
|
1954
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
1955
|
+
<li>
|
1956
|
+
<p>
|
1957
|
+
Fusce euismod commodo velit.
|
1958
|
+
</p>
|
1959
|
+
</li>
|
1960
|
+
<li>
|
1961
|
+
<p>
|
1962
|
+
Vivamus fringilla mi eu lacus.
|
1963
|
+
</p>
|
1964
|
+
</li>
|
1965
|
+
</ol></div>
|
1904
1966
|
</li>
|
1905
1967
|
<li>
|
1906
1968
|
<p>
|
@@ -2269,7 +2331,7 @@ Nested list appended list item one paragraph
|
|
2269
2331
|
- Nested list item two.</tt></pre>
|
2270
2332
|
</div></div>
|
2271
2333
|
<div class="paragraph"><p>Renders:</p></div>
|
2272
|
-
<div class="olist"><ol>
|
2334
|
+
<div class="olist arabic"><ol class="arabic">
|
2273
2335
|
<li>
|
2274
2336
|
<p>
|
2275
2337
|
List item one.
|
@@ -2333,7 +2395,7 @@ Any block title or attributes are passed to the first element inside
|
|
2333
2395
|
</li>
|
2334
2396
|
</ul></div>
|
2335
2397
|
<div class="paragraph"><p>The List Block is useful for:</p></div>
|
2336
|
-
<div class="olist"><ol>
|
2398
|
+
<div class="olist arabic"><ol class="arabic">
|
2337
2399
|
<li>
|
2338
2400
|
<p>
|
2339
2401
|
Lists with long multi-element list items.
|
@@ -2369,13 +2431,13 @@ This paragraph belongs to item 1.
|
|
2369
2431
|
2. Item 2 of the outer list.</tt></pre>
|
2370
2432
|
</div></div>
|
2371
2433
|
<div class="paragraph"><p>Renders:</p></div>
|
2372
|
-
<div class="olist"><div class="title">Nested List Block</div><ol>
|
2434
|
+
<div class="olist arabic"><div class="title">Nested List Block</div><ol class="arabic">
|
2373
2435
|
<li>
|
2374
2436
|
<p>
|
2375
2437
|
List item one.
|
2376
2438
|
</p>
|
2377
2439
|
<div class="paragraph"><p>This paragraph is part of the preceding list item</p></div>
|
2378
|
-
<div class="olist2"><ol>
|
2440
|
+
<div class="olist2 loweralpha"><ol class="loweralpha">
|
2379
2441
|
<li>
|
2380
2442
|
<p>
|
2381
2443
|
This list is nested and does not require explicit item continuation.
|
@@ -2529,7 +2591,7 @@ example:</p></div>
|
|
2529
2591
|
11/16/97 17:17 61,865,984 pagefile.sys
|
2530
2592
|
2/13/94 6:21 9,349 WINA20.386 <b><3></b></tt></pre>
|
2531
2593
|
</div></div>
|
2532
|
-
<div class="colist"><ol>
|
2594
|
+
<div class="colist arabic"><ol>
|
2533
2595
|
<li>
|
2534
2596
|
<p>
|
2535
2597
|
This directory holds MS-DOS.
|
@@ -2632,12 +2694,12 @@ the <tt>test.py</tt> source file (containing a single callout) using the
|
|
2632
2694
|
<div class="listingblock">
|
2633
2695
|
<div class="title">AsciiDoc source</div>
|
2634
2696
|
<div class="content">
|
2635
|
-
<pre><tt>
|
2636
|
-
|
2637
|
-
|
2638
|
-
|
2697
|
+
<pre><tt>[source,python]
|
2698
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2699
|
+
include::test.py[]
|
2700
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2639
2701
|
|
2640
|
-
|
2702
|
+
<1> Print statement.</tt></pre>
|
2641
2703
|
</div></div>
|
2642
2704
|
<div class="listingblock">
|
2643
2705
|
<div class="title">Included <tt>test.py</tt> source</div>
|
@@ -3023,12 +3085,12 @@ paragraphs or delimited blocks. Example comment line:</p></div>
|
|
3023
3085
|
</div></div>
|
3024
3086
|
<div class="paragraph"><p>See also <a href="#X26">Comment Blocks</a>.</p></div>
|
3025
3087
|
<h3 id="_system_macros">17.3. System Macros</h3><div style="clear:left"></div>
|
3026
|
-
<div class="paragraph"><p>System macros are block macros that perform a predefined task
|
3088
|
+
<div class="paragraph"><p>System macros are block macros that perform a predefined task and are
|
3027
3089
|
hardwired into the <tt>asciidoc(1)</tt> program.</p></div>
|
3028
3090
|
<div class="ulist"><ul>
|
3029
3091
|
<li>
|
3030
3092
|
<p>
|
3031
|
-
You can
|
3093
|
+
You can escape system macros with a leading backslash character
|
3032
3094
|
(as you can with other macros).
|
3033
3095
|
</p>
|
3034
3096
|
</li>
|
@@ -3053,7 +3115,7 @@ verbatim embedded CSS or scripts into configuration file headers.
|
|
3053
3115
|
Example:</p></div>
|
3054
3116
|
<div class="listingblock">
|
3055
3117
|
<div class="content">
|
3056
|
-
<pre><tt>
|
3118
|
+
<pre><tt>include::chapter1.txt[tabsize=4]</tt></pre>
|
3057
3119
|
</div></div>
|
3058
3120
|
<div class="ulist"><div class="title">Include macro behavior</div><ul>
|
3059
3121
|
<li>
|
@@ -3312,7 +3374,7 @@ a markup template. If <tt><name></tt> is omitted then it is the value of t
|
|
3312
3374
|
regular expression match group named <em>name</em>. The optional
|
3313
3375
|
<tt>[<subslist]</tt> is a comma-separated list of substitution names enclosed
|
3314
3376
|
in <tt>[]</tt> brackets, it sets the default substitutions for passthrough
|
3315
|
-
text.</p></div>
|
3377
|
+
text, if omitted then no passthrough substitutions are performed.</p></div>
|
3316
3378
|
<div class="paragraph"><div class="title">Pattern named groups</div><p>The following named groups can be used in macro <tt><pattern></tt> regular
|
3317
3379
|
expressions and are available as markup template attributes:</p></div>
|
3318
3380
|
<div class="dlist"><dl>
|
@@ -3413,8 +3475,8 @@ There is no provision for cells to span multiple columns.
|
|
3413
3475
|
<div class="sidebar-title">Use tables sparingly</div>
|
3414
3476
|
<div class="paragraph"><p>When technical users first start creating documents, tables (complete
|
3415
3477
|
with column spanning and table nesting) are often considered very
|
3416
|
-
important.
|
3417
|
-
|
3478
|
+
important. The reality is that tables are seldom used, even in
|
3479
|
+
technical documentation.</p></div>
|
3418
3480
|
<div class="paragraph"><p>Try this exercise: thumb through your library of technical books,
|
3419
3481
|
you’ll be surprised just how seldom tables are actually used, even
|
3420
3482
|
less seldom are tables containing block elements such as paragraphs or
|
@@ -3690,11 +3752,11 @@ Buenos Aires</p></td>
|
|
3690
3752
|
<div class="paragraph"><p><em>AsciiDoc</em> source:</p></div>
|
3691
3753
|
<div class="listingblock">
|
3692
3754
|
<div class="content">
|
3693
|
-
<pre><tt>
|
3694
|
-
|
3695
|
-
|
3696
|
-
|
3697
|
-
|
3755
|
+
<pre><tt>[format="csv",cols="^1,4*2",options="header"]
|
3756
|
+
|===================================================
|
3757
|
+
ID,Customer Name,Contact Name,Customer Address,Phone
|
3758
|
+
include::customers.csv[]
|
3759
|
+
|===================================================</tt></pre>
|
3698
3760
|
</div></div>
|
3699
3761
|
<h3 id="X68">18.2. Table input data formats</h3><div style="clear:left"></div>
|
3700
3762
|
<div class="paragraph"><p><em>AsciiDoc</em> table data can be <em>psv</em>, <em>dsv</em> or <em>csv</em> formatted. The
|
@@ -4806,7 +4868,7 @@ explicitly (using the <tt>asciidoc(1)</tt> <tt>-f</tt> (<tt>--conf-file</tt>) co
|
|
4806
4868
|
option).</p></div>
|
4807
4869
|
<div class="paragraph"><p>Implicit configuration files are loaded from the following directories
|
4808
4870
|
in the following order:</p></div>
|
4809
|
-
<div class="olist"><ol>
|
4871
|
+
<div class="olist arabic"><ol class="arabic">
|
4810
4872
|
<li>
|
4811
4873
|
<p>
|
4812
4874
|
The global configuration directory (normally <tt>/etc/asciidoc</tt> or
|
@@ -4831,7 +4893,7 @@ The directory containing the <em>AsciiDoc</em> source file.
|
|
4831
4893
|
</ol></div>
|
4832
4894
|
<div class="paragraph"><p>The following implicit configuration files from each of the above
|
4833
4895
|
locations are loaded in the following order:</p></div>
|
4834
|
-
<div class="olist"><ol>
|
4896
|
+
<div class="olist arabic"><ol class="arabic">
|
4835
4897
|
<li>
|
4836
4898
|
<p>
|
4837
4899
|
<tt>asciidoc.conf</tt>
|
@@ -4875,7 +4937,7 @@ files will be processed in the order they appear on the command-line.</p></div>
|
|
4875
4937
|
</div></div>
|
4876
4938
|
<div class="paragraph"><p>Configuration files (if they exist) will be processed in the following
|
4877
4939
|
order:</p></div>
|
4878
|
-
<div class="olist"><ol>
|
4940
|
+
<div class="olist arabic"><ol class="arabic">
|
4879
4941
|
<li>
|
4880
4942
|
<p>
|
4881
4943
|
First default global configuration files from the asciidoc program
|
@@ -5216,7 +5278,8 @@ List attributes can only be referenced in configuration file markup
|
|
5216
5278
|
</li>
|
5217
5279
|
<li>
|
5218
5280
|
<p>
|
5219
|
-
Attribute references are allowed inside attribute lists
|
5281
|
+
Attribute references are allowed inside attribute lists — this is
|
5282
|
+
the only substitution performed on attribute lists.
|
5220
5283
|
</p>
|
5221
5284
|
</li>
|
5222
5285
|
<li>
|
@@ -5279,7 +5342,8 @@ attribute values to macro markup templates.</p></div>
|
|
5279
5342
|
<div class="paragraph"><p>An <a href="#X21">attribute list</a> on a line by itself constitutes an
|
5280
5343
|
<em>AttributeList</em> block element, its attributes apply to the following
|
5281
5344
|
block element. The list attributes are passed to the next block
|
5282
|
-
element for markup template substitution
|
5345
|
+
element for markup template substitution. Often the first list
|
5346
|
+
parameter is used to specify the element’s <a href="#X23">style</a>.</p></div>
|
5283
5347
|
</div>
|
5284
5348
|
<h2 id="_attribute_references">25. Attribute References</h2>
|
5285
5349
|
<div class="sectionbody">
|
@@ -5583,7 +5647,7 @@ predefined intrinsic attributes:</p></div>
|
|
5583
5647
|
{user-dir} the ~/.asciidoc directory (if it exists)
|
5584
5648
|
{verbose} defined as '' if --verbose command option specified</tt></pre>
|
5585
5649
|
</div></div>
|
5586
|
-
<div class="olist"><div class="title">NOTES</div><ol>
|
5650
|
+
<div class="olist arabic"><div class="title">NOTES</div><ol class="arabic">
|
5587
5651
|
<li>
|
5588
5652
|
<p>
|
5589
5653
|
Intrinsic attributes are global so avoid defining custom attributes
|
@@ -5826,7 +5890,7 @@ delimiter=(?P<text>\S.*)
|
|
5826
5890
|
template=paragraph</tt></pre>
|
5827
5891
|
</div></div>
|
5828
5892
|
<div class="paragraph"><p>The Default paragraph definition has a couple of special properties:</p></div>
|
5829
|
-
<div class="olist"><ol>
|
5893
|
+
<div class="olist arabic"><ol class="arabic">
|
5830
5894
|
<li>
|
5831
5895
|
<p>
|
5832
5896
|
It must exist and be defined in a configuration file section named
|
@@ -5864,7 +5928,7 @@ options
|
|
5864
5928
|
</p>
|
5865
5929
|
</dd>
|
5866
5930
|
</dl></div>
|
5867
|
-
<div class="olist"><div class="title">Paragraph processing proceeds as follows:</div><ol>
|
5931
|
+
<div class="olist arabic"><div class="title">Paragraph processing proceeds as follows:</div><ol class="arabic">
|
5868
5932
|
<li>
|
5869
5933
|
<p>
|
5870
5934
|
The paragraph text is aligned to the left margin.
|
@@ -5912,7 +5976,7 @@ skip
|
|
5912
5976
|
</dt>
|
5913
5977
|
<dd>
|
5914
5978
|
<p>
|
5915
|
-
The block is treated as a comment (see CommentBlocks).
|
5979
|
+
The block is treated as a comment (see <a href="#X26">CommentBlocks</a>).
|
5916
5980
|
</p>
|
5917
5981
|
</dd>
|
5918
5982
|
<dt class="hdlist1">
|
@@ -5927,7 +5991,7 @@ list
|
|
5927
5991
|
<div class="paragraph"><p><em>presubs</em>, <em>postsubs</em> and <em>filter</em> entries are meaningless when
|
5928
5992
|
<em>sectionbody</em>, <em>skip</em> or <em>list</em> options are set.</p></div>
|
5929
5993
|
<div class="paragraph"><p>DelimitedBlock processing proceeds as follows:</p></div>
|
5930
|
-
<div class="olist"><ol>
|
5994
|
+
<div class="olist arabic"><ol class="arabic">
|
5931
5995
|
<li>
|
5932
5996
|
<p>
|
5933
5997
|
Optional <em>presubs</em> substitutions are performed on the block
|
@@ -6140,32 +6204,28 @@ Finally it relies on the executing shell to search the environment
|
|
6140
6204
|
</p>
|
6141
6205
|
</li>
|
6142
6206
|
</ul></div>
|
6207
|
+
<div class="paragraph"><p>Sub-directories are also included in the searches — standard practice
|
6208
|
+
is to install each filter in it’s own sub-directory with the same name
|
6209
|
+
as the filter’s style definition. For example the music filter’s style
|
6210
|
+
name is <em>music</em> so it’s configuration and filter files are stored in
|
6211
|
+
the <tt>filters/music</tt> directory.</p></div>
|
6143
6212
|
<h3 id="_filter_configuration_files">28.2. Filter Configuration Files</h3><div style="clear:left"></div>
|
6144
6213
|
<div class="paragraph"><p>Filters are normally accompanied by a configuration file containing a
|
6145
6214
|
Paragraph or DelimitedBlock definition along with corresponding markup
|
6146
6215
|
templates.</p></div>
|
6147
|
-
<div class="paragraph"><p>
|
6148
|
-
|
6149
|
-
<
|
6150
|
-
<
|
6151
|
-
|
6152
|
-
|
6153
|
-
|
6154
|
-
<li>
|
6155
|
-
<p>
|
6156
|
-
By styling an existing Paragraph or DelimitedBlock using a <em>style</em>
|
6157
|
-
configuration entry — the <em>source highlight</em> and <em>music</em> filters
|
6158
|
-
use this technique to customize the ListingBlock. By convention the
|
6159
|
-
style is given the same name as the filter.
|
6160
|
-
</p>
|
6161
|
-
</li>
|
6162
|
-
</ul></div>
|
6216
|
+
<div class="paragraph"><p>While it is possible to create new Paragraph or DelimitedBlock
|
6217
|
+
definitions the preferred way to implement a filter is to add a
|
6218
|
+
<a href="#X23">style</a> to an existing Paragraph or DelimitedBlock definition
|
6219
|
+
(all filters shipped with <em>AsciiDoc</em> use this technique). The filter is
|
6220
|
+
applied to the paragraph or delimited block by preceding it with an
|
6221
|
+
attribute list: the first positional attribute is the style name,
|
6222
|
+
remaining attributes are normally filter specific parameters.</p></div>
|
6163
6223
|
<div class="paragraph"><p><tt>asciidoc(1)</tt> auto-loads all <tt>.conf</tt> files found in the filter search
|
6164
6224
|
paths (see previous section).</p></div>
|
6165
6225
|
<h3 id="X56">28.3. Code Filter</h3><div style="clear:left"></div>
|
6166
|
-
<div class="paragraph"><p><em>AsciiDoc</em> comes with a
|
6167
|
-
|
6168
|
-
|
6226
|
+
<div class="paragraph"><p><em>AsciiDoc</em> comes with a toy filter for highlighting source code keywords
|
6227
|
+
and comments. See also the <tt>./filters/code/code-filter-readme.txt</tt>
|
6228
|
+
file.</p></div>
|
6169
6229
|
<div class="admonitionblock">
|
6170
6230
|
<table><tr>
|
6171
6231
|
<td class="icon">
|
@@ -6180,7 +6240,7 @@ If you want a full featured multi-language highlighter use the
|
|
6180
6240
|
<div class="content">
|
6181
6241
|
<pre><tt>.Code filter example
|
6182
6242
|
[code,python]
|
6183
|
-
|
6243
|
+
----------------------------------------------
|
6184
6244
|
''' A multi-line
|
6185
6245
|
comment.'''
|
6186
6246
|
def sub_word(mo):
|
@@ -6190,7 +6250,7 @@ def sub_word(mo):
|
|
6190
6250
|
return quote + word + quote
|
6191
6251
|
else:
|
6192
6252
|
return word
|
6193
|
-
|
6253
|
+
----------------------------------------------</tt></pre>
|
6194
6254
|
</div></div>
|
6195
6255
|
<div class="paragraph"><p>Outputs:</p></div>
|
6196
6256
|
<div class="listingblock">
|
@@ -6326,7 +6386,7 @@ suitable DocBook toolchain (see the
|
|
6326
6386
|
</li>
|
6327
6387
|
</ul></div>
|
6328
6388
|
<h3 id="_html_help_generation">29.4. HTML Help generation</h3><div style="clear:left"></div>
|
6329
|
-
<div class="olist"><ol>
|
6389
|
+
<div class="olist arabic"><ol class="arabic">
|
6330
6390
|
<li>
|
6331
6391
|
<p>
|
6332
6392
|
Convert DocBook XML documents to HTML Help compiler source files
|
@@ -6350,8 +6410,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6350
6410
|
Converts <em>AsciiDoc</em> (<tt>.txt</tt>) files to DocBook XML (<tt>.xml</tt>) files.
|
6351
6411
|
</p>
|
6352
6412
|
</dd>
|
6353
|
-
</dl></div>
|
6354
|
-
<div class="dlist" id="X13"><dl>
|
6355
6413
|
<dt class="hdlist1">
|
6356
6414
|
<a href="http://docbook.sourceforge.net/projects/xsl/">DocBook XSL Stylesheets</a>
|
6357
6415
|
</dt>
|
@@ -6363,8 +6421,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6363
6421
|
<a href="#X40">xsltproc(1)</a>.
|
6364
6422
|
</p>
|
6365
6423
|
</dd>
|
6366
|
-
</dl></div>
|
6367
|
-
<div class="dlist" id="X40"><dl>
|
6368
6424
|
<dt class="hdlist1">
|
6369
6425
|
<a href="http://www.xmlsoft.org">xsltproc</a>
|
6370
6426
|
</dt>
|
@@ -6374,8 +6430,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6374
6430
|
<a href="#X13">DocBook XSL Stylesheets</a>) to XML documents.
|
6375
6431
|
</p>
|
6376
6432
|
</dd>
|
6377
|
-
</dl></div>
|
6378
|
-
<div class="dlist" id="X31"><dl>
|
6379
6433
|
<dt class="hdlist1">
|
6380
6434
|
<a href="http://dblatex.sourceforge.net/">dblatex</a>
|
6381
6435
|
</dt>
|
@@ -6386,8 +6440,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6386
6440
|
<tt>latex(1)</tt>.
|
6387
6441
|
</p>
|
6388
6442
|
</dd>
|
6389
|
-
</dl></div>
|
6390
|
-
<div class="dlist" id="X14"><dl>
|
6391
6443
|
<dt class="hdlist1">
|
6392
6444
|
<a href="http://xml.apache.org/fop/">FOP</a>
|
6393
6445
|
</dt>
|
@@ -6399,8 +6451,6 @@ Convert the HTML Help source (<tt>.hhp</tt> and <tt>.html</tt>) files to HTML He
|
|
6399
6451
|
<a href="#X40">xsltproc(1)</a>.
|
6400
6452
|
</p>
|
6401
6453
|
</dd>
|
6402
|
-
</dl></div>
|
6403
|
-
<div class="dlist" id="X67"><dl>
|
6404
6454
|
<dt class="hdlist1">
|
6405
6455
|
Microsoft Help Compiler
|
6406
6456
|
</dt>
|
@@ -6413,7 +6463,7 @@ Microsoft Help Compiler
|
|
6413
6463
|
</p>
|
6414
6464
|
</dd>
|
6415
6465
|
</dl></div>
|
6416
|
-
<h3 id="
|
6466
|
+
<h3 id="X67">29.6. AsciiDoc dblatex configuration files</h3><div style="clear:left"></div>
|
6417
6467
|
<div class="paragraph"><p>The <em>AsciiDoc</em> distribution <tt>./dblatex</tt> directory contains
|
6418
6468
|
<tt>asciidoc-dblatex.xsl</tt> (customized XSL parameter settings) and
|
6419
6469
|
<tt>asciidoc-dblatex.sty</tt> (customized LaTeX settings). These are examples
|
@@ -6608,7 +6658,7 @@ follow.</p></div>
|
|
6608
6658
|
<pre><tt>:set textwidth=70</tt></pre>
|
6609
6659
|
</div></div>
|
6610
6660
|
<div class="paragraph"><p>To reformat a paragraph:</p></div>
|
6611
|
-
<div class="olist"><ol>
|
6661
|
+
<div class="olist arabic"><ol class="arabic">
|
6612
6662
|
<li>
|
6613
6663
|
<p>
|
6614
6664
|
Position the cursor at the start of the paragraph.
|
@@ -6658,7 +6708,7 @@ callout lists. First you need to set the <tt>comments</tt>, <tt>formatoptions</t
|
|
6658
6708
|
and <tt>formatlistpat</tt> (see the <a href="#X61">Example <tt>~/.vimrc</tt> file</a>).</p></div>
|
6659
6709
|
<div class="paragraph"><p>Now you can format simple lists that use dash, asterisk, period and
|
6660
6710
|
plus bullets along with numbered ordered lists:</p></div>
|
6661
|
-
<div class="olist"><ol>
|
6711
|
+
<div class="olist arabic"><ol class="arabic">
|
6662
6712
|
<li>
|
6663
6713
|
<p>
|
6664
6714
|
Position the cursor at the start of the list.
|
@@ -6686,17 +6736,16 @@ highlight clear Search
|
|
6686
6736
|
" Don't move to matched text while search pattern is being entered.
|
6687
6737
|
set noincsearch
|
6688
6738
|
|
6689
|
-
"
|
6690
|
-
nnoremap
|
6739
|
+
" Reformat paragraphs and list.
|
6740
|
+
nnoremap R gq}
|
6691
6741
|
|
6692
|
-
"
|
6693
|
-
|
6694
|
-
nnoremap W :%s/[\r \t]\+$//<CR>:set et<CR>:retab!<CR>
|
6742
|
+
" Delete trailing white space and Dos-returns and to expand tabs to spaces.
|
6743
|
+
nnoremap S :set et<CR>:retab!<CR>:%s/[\r \t]\+$//<CR>
|
6695
6744
|
|
6696
6745
|
autocmd BufRead,BufNewFile *.txt,README,TODO,CHANGELOG,NOTES
|
6697
|
-
\ setlocal autoindent expandtab tabstop=8 softtabstop=2 shiftwidth=2
|
6746
|
+
\ setlocal autoindent expandtab tabstop=8 softtabstop=2 shiftwidth=2 filetype=asciidoc
|
6698
6747
|
\ textwidth=70 wrap formatoptions=tcqn
|
6699
|
-
\ formatlistpat=^\\s*<
|
6748
|
+
\ formatlistpat=^\\s*\\d\\+\\.\\s\\+\\\\|^\\s*<\\d\\+>\\s\\+\\\\|^\\s*[a-zA-Z.]\\.\\s\\+\\\\|^\\s*[ivxIVX]\\+\\.\\s\\+
|
6700
6749
|
\ comments=s1:/*,ex:*/,://,b:#,:%,:XCOMM,fb:-,fb:*,fb:+,fb:.,fb:></tt></pre>
|
6701
6750
|
</div></div>
|
6702
6751
|
<h3 id="_troubleshooting">33.3. Troubleshooting</h3><div style="clear:left"></div>
|
@@ -6817,70 +6866,31 @@ Macro attribute lists
|
|
6817
6866
|
</div></div>
|
6818
6867
|
</dd>
|
6819
6868
|
</dl></div>
|
6820
|
-
<h3 id="_combining_separate_documents">33.5. Combining
|
6869
|
+
<h3 id="_combining_separate_documents">33.5. Combining separate documents</h3><div style="clear:left"></div>
|
6821
6870
|
<div class="paragraph"><p>You have a number of stand-alone <em>AsciiDoc</em> documents that you want to
|
6822
6871
|
process as a single document. Simply processing them with a series of
|
6823
|
-
<tt>include</tt> macros won’t work
|
6824
|
-
|
6825
|
-
document
|
6826
|
-
<div
|
6827
|
-
section titles are pushed down one level.</p></div>
|
6828
|
-
<div class="olist"><ol>
|
6829
|
-
<li>
|
6830
|
-
<p>
|
6831
|
-
Push the standard title underlines down one level by defining a new
|
6832
|
-
level 0 underline in a custom configuration file. For example
|
6833
|
-
<tt>combined.conf</tt>:
|
6834
|
-
</p>
|
6835
|
-
<div class="literalblock">
|
6836
|
-
<div class="content">
|
6837
|
-
<pre><tt>[titles]
|
6838
|
-
underlines="__","==","--","~~","^^"</tt></pre>
|
6839
|
-
</div></div>
|
6840
|
-
</li>
|
6841
|
-
<li>
|
6842
|
-
<p>
|
6843
|
-
If you use single line titles you’ll need to make corresponding
|
6844
|
-
adjustments to the <tt>[titles]</tt> section <tt>sect0</tt>…<tt>sect4</tt> entries.
|
6845
|
-
</p>
|
6846
|
-
</li>
|
6847
|
-
<li>
|
6848
|
-
<p>
|
6849
|
-
Create a top level wrapper document. For example <tt>combined.txt</tt>:
|
6850
|
-
</p>
|
6872
|
+
<tt>include</tt> macros won’t work because the documents contain (level 0)
|
6873
|
+
document titles. The solution is to create a top level wrapper
|
6874
|
+
document that redefines the document underlines, pushing them down one
|
6875
|
+
level. For example <tt>combined.txt</tt>:</p></div>
|
6851
6876
|
<div class="listingblock">
|
6852
6877
|
<div class="content">
|
6853
|
-
<pre><tt
|
6854
|
-
_______________________
|
6878
|
+
<pre><tt>:titles.underlines: "__","==","--","~~","^^"
|
6855
6879
|
|
6856
|
-
|
6880
|
+
Combined Document Title
|
6881
|
+
_______________________
|
6857
6882
|
|
6858
|
-
|
6883
|
+
include::document1.txt[]
|
6859
6884
|
|
6860
|
-
|
6861
|
-
|
6862
|
-
</
|
6863
|
-
<li>
|
6864
|
-
<p>
|
6865
|
-
Process the wrapper document. For example:
|
6866
|
-
</p>
|
6867
|
-
<div class="literalblock">
|
6868
|
-
<div class="content">
|
6869
|
-
<pre><tt>$ asciidoc --conf-file=combined.conf combined.txt</tt></pre>
|
6885
|
+
include::document2.txt[]
|
6886
|
+
|
6887
|
+
include::document3.txt[]</tt></pre>
|
6870
6888
|
</div></div>
|
6871
|
-
|
6872
|
-
|
6873
|
-
<div class="paragraph"><p>Actually the <tt>--conf-file</tt> option is unnecessary as <tt>asciidoc(1)</tt>
|
6874
|
-
automatically looks for a same-named <tt>.conf</tt> file.</p></div>
|
6889
|
+
<div class="paragraph"><p>The document titles in the included documents will now be processed as
|
6890
|
+
level 1 section titles.</p></div>
|
6875
6891
|
<div class="ulist"><ul>
|
6876
6892
|
<li>
|
6877
6893
|
<p>
|
6878
|
-
The combined document title uses the newly defined level 0 underline
|
6879
|
-
(underscore characters).
|
6880
|
-
</p>
|
6881
|
-
</li>
|
6882
|
-
<li>
|
6883
|
-
<p>
|
6884
6894
|
Put a blank line between the <tt>include</tt> macro lines to ensure the
|
6885
6895
|
title of the included document is not seen as part of the last
|
6886
6896
|
paragraph of the previous document.
|
@@ -6894,56 +6904,50 @@ You won’t want document Headers (Author and Revision lines) in the
|
|
6894
6904
|
</p>
|
6895
6905
|
</li>
|
6896
6906
|
</ul></div>
|
6897
|
-
<h3 id="_processing_document_sections_separately">33.6. Processing
|
6898
|
-
<div class="paragraph"><p>You have divided your <em>AsciiDoc</em> document into separate files (one per
|
6899
|
-
section) which are combined and processed with the following
|
6900
|
-
document:</p></div>
|
6907
|
+
<h3 id="_processing_document_sections_separately">33.6. Processing document sections separately</h3><div style="clear:left"></div>
|
6908
|
+
<div class="paragraph"><p>You have divided your <em>AsciiDoc</em> document into separate files (one per
|
6909
|
+
top level section) which are combined and processed with the following
|
6910
|
+
top level document:</p></div>
|
6901
6911
|
<div class="listingblock">
|
6902
6912
|
<div class="content">
|
6903
|
-
<pre><tt>
|
6904
|
-
|
6905
|
-
|
6906
|
-
|
6913
|
+
<pre><tt>Combined Document Title
|
6914
|
+
=======================
|
6915
|
+
Joe Bloggs
|
6916
|
+
v1.0, 12-Aug-03
|
6907
6917
|
|
6908
|
-
|
6918
|
+
include::section1.txt[]
|
6909
6919
|
|
6910
|
-
|
6920
|
+
include::section2.txt[]
|
6911
6921
|
|
6912
|
-
|
6922
|
+
include::section3.txt[]</tt></pre>
|
6913
6923
|
</div></div>
|
6914
6924
|
<div class="paragraph"><p>You also want to process the section files as separate documents.
|
6915
6925
|
This is easy because <tt>asciidoc(1)</tt> will quite happily process
|
6916
|
-
<tt>section1.txt</tt>, <tt>section2.txt</tt> and <tt>section3.txt</tt> separately
|
6917
|
-
|
6918
|
-
|
6919
|
-
|
6926
|
+
<tt>section1.txt</tt>, <tt>section2.txt</tt> and <tt>section3.txt</tt> separately — the
|
6927
|
+
resulting output documents contain the section but have no document
|
6928
|
+
title.</p></div>
|
6929
|
+
<div class="paragraph"><p>Use the <tt>-s</tt> (<tt>--no-header-footer</tt>) command-line option to suppress
|
6930
|
+
header and footer output, this is useful if the processed output is to
|
6931
|
+
be included in another file. For example:</p></div>
|
6920
6932
|
<div class="literalblock">
|
6921
6933
|
<div class="content">
|
6922
|
-
<pre><tt>
|
6923
|
-
underlines="--","~~","^^","++","__"</tt></pre>
|
6934
|
+
<pre><tt>$ asciidoc -s -b docbook section1.txt</tt></pre>
|
6924
6935
|
</div></div>
|
6925
|
-
<
|
6926
|
-
is necessary to legitimize the underline definition.</p></div>
|
6927
|
-
<div class="paragraph"><p>This is just the reverse of the technique used for combining separate
|
6928
|
-
documents explained in the previous section.</p></div>
|
6929
|
-
<h3 id="_processing_document_chunks">33.7. Processing Document Chunks</h3><div style="clear:left"></div>
|
6936
|
+
<h3 id="_processing_document_snippets">33.7. Processing document snippets</h3><div style="clear:left"></div>
|
6930
6937
|
<div class="paragraph"><p><tt>asciidoc(1)</tt> can be used as a filter, so you can pipe chunks of text
|
6931
6938
|
through it. For example:</p></div>
|
6932
6939
|
<div class="literalblock">
|
6933
6940
|
<div class="content">
|
6934
6941
|
<pre><tt>$ echo 'Hello *World!*' | asciidoc -s -
|
6935
|
-
<div class="
|
6942
|
+
<div class="paragraph"><p>Hello <strong>World!</strong></p></div></tt></pre>
|
6936
6943
|
</div></div>
|
6937
|
-
<
|
6938
|
-
and footer output and is useful if the processed output is to be
|
6939
|
-
included in another file.</p></div>
|
6940
|
-
<h3 id="_badges_in_html_page_footers">33.8. Badges in HTML Page Footers</h3><div style="clear:left"></div>
|
6944
|
+
<h3 id="_badges_in_html_page_footers">33.8. Badges in HTML page footers</h3><div style="clear:left"></div>
|
6941
6945
|
<div class="paragraph"><p>See the <tt>[footer]</tt> section in the <em>AsciiDoc</em> distribution <tt>xhtml11.conf</tt>
|
6942
6946
|
configuration file.</p></div>
|
6943
|
-
<h3 id="_pretty_printing_asciidoc_output">33.9. Pretty
|
6947
|
+
<h3 id="_pretty_printing_asciidoc_output">33.9. Pretty printing AsciiDoc output</h3><div style="clear:left"></div>
|
6944
6948
|
<div class="paragraph"><p>If the indentation and layout of the <tt>asciidoc(1)</tt> output is not to your
|
6945
6949
|
liking you can:</p></div>
|
6946
|
-
<div class="olist"><ol>
|
6950
|
+
<div class="olist arabic"><ol class="arabic">
|
6947
6951
|
<li>
|
6948
6952
|
<p>
|
6949
6953
|
Change the indentation and layout of configuration file markup
|
@@ -6953,22 +6957,30 @@ Change the indentation and layout of configuration file markup
|
|
6953
6957
|
</li>
|
6954
6958
|
<li>
|
6955
6959
|
<p>
|
6956
|
-
|
6957
|
-
<tt>asciidoc(1)</tt> output. Example:
|
6960
|
+
Use Dave Raggett’s <a href="http://tidy.sourceforge.net/">HTML Tidy</a> program
|
6961
|
+
to tidy <tt>asciidoc(1)</tt> output. Example:
|
6958
6962
|
</p>
|
6959
6963
|
<div class="literalblock">
|
6960
6964
|
<div class="content">
|
6961
6965
|
<pre><tt>$ asciidoc -b docbook -o - mydoc.txt | tidy -indent -xml >mydoc.xml</tt></pre>
|
6962
6966
|
</div></div>
|
6963
6967
|
</li>
|
6968
|
+
<li>
|
6969
|
+
<p>
|
6970
|
+
Use the <tt>xmllint(1)</tt> format option. Example:
|
6971
|
+
</p>
|
6972
|
+
<div class="literalblock">
|
6973
|
+
<div class="content">
|
6974
|
+
<pre><tt>$ xmllint --format mydoc.xml</tt></pre>
|
6975
|
+
</div></div>
|
6976
|
+
</li>
|
6964
6977
|
</ol></div>
|
6965
|
-
<
|
6966
|
-
<h3 id="_supporting_minor_docbook_dtd_variations">33.10. Supporting Minor DocBook DTD Variations</h3><div style="clear:left"></div>
|
6978
|
+
<h3 id="_supporting_minor_docbook_dtd_variations">33.10. Supporting minor DocBook DTD variations</h3><div style="clear:left"></div>
|
6967
6979
|
<div class="paragraph"><p>The conditional inclusion of DocBook SGML markup at the end of the
|
6968
6980
|
distribution <tt>docbook.conf</tt> file illustrates how to support minor DTD
|
6969
6981
|
variations. The included sections override corresponding entries from
|
6970
6982
|
preceding sections.</p></div>
|
6971
|
-
<h3 id="_shipping_stand_alone_asciidoc_source">33.11. Shipping
|
6983
|
+
<h3 id="_shipping_stand_alone_asciidoc_source">33.11. Shipping stand-alone AsciiDoc source</h3><div style="clear:left"></div>
|
6972
6984
|
<div class="paragraph"><p>Reproducing presentation documents from someone else’s source has one
|
6973
6985
|
major problem: unless your configuration files are the same as the
|
6974
6986
|
creator’s you won’t get the same output.</p></div>
|
@@ -6993,12 +7005,12 @@ regenerate the HMTL output:</p></div>
|
|
6993
7005
|
<div class="paragraph"><p>The <tt>-e</tt> (<tt>--no-conf</tt>) option excludes the use of implicit
|
6994
7006
|
configuration files, ensuring that only entries from the
|
6995
7007
|
<tt>mydoc-html.conf</tt> configuration are used.</p></div>
|
6996
|
-
<h3 id="_inserting_blank_space">33.12. Inserting
|
7008
|
+
<h3 id="_inserting_blank_space">33.12. Inserting blank space</h3><div style="clear:left"></div>
|
6997
7009
|
<div class="paragraph"><p>Adjust your style sheets to add the correct separation between block
|
6998
7010
|
elements. Inserting blank paragraphs containing a single non-breaking
|
6999
7011
|
space character <tt>{nbsp}</tt> works but is an ad hoc solution compared
|
7000
7012
|
to using style sheets.</p></div>
|
7001
|
-
<h3 id="_closing_open_sections">33.13. Closing
|
7013
|
+
<h3 id="_closing_open_sections">33.13. Closing open sections</h3><div style="clear:left"></div>
|
7002
7014
|
<div class="paragraph"><p>You can close off section tags up to level <tt>N</tt> by calling the
|
7003
7015
|
<tt>eval::[Section.setlevel(N)]</tt> system macro. This is useful if you
|
7004
7016
|
want to include a section composed of raw markup. The following
|
@@ -7006,21 +7018,21 @@ example includes a DocBook glossary division at the top section level
|
|
7006
7018
|
(level 0):</p></div>
|
7007
7019
|
<div class="listingblock">
|
7008
7020
|
<div class="content">
|
7009
|
-
<pre><tt>
|
7021
|
+
<pre><tt>ifdef::backend-docbook[]
|
7010
7022
|
|
7011
|
-
|
7023
|
+
eval::[Section.setlevel(0)]
|
7012
7024
|
|
7013
|
-
|
7014
|
-
|
7015
|
-
|
7016
|
-
|
7017
|
-
|
7018
|
-
|
7019
|
-
|
7020
|
-
|
7021
|
-
|
7022
|
-
</div></div>
|
7023
|
-
<h3 id="_validating_output_files">33.14. Validating
|
7025
|
+
+++++++++++++++++++++++++++++++
|
7026
|
+
<glossary>
|
7027
|
+
<title>Glossary</title>
|
7028
|
+
<glossdiv>
|
7029
|
+
...
|
7030
|
+
</glossdiv>
|
7031
|
+
</glossary>
|
7032
|
+
+++++++++++++++++++++++++++++++
|
7033
|
+
endif::backend-docbook[]</tt></pre>
|
7034
|
+
</div></div>
|
7035
|
+
<h3 id="_validating_output_files">33.14. Validating output files</h3><div style="clear:left"></div>
|
7024
7036
|
<div class="paragraph"><p>Use <tt>xmllint(1)</tt> to check the <em>AsciiDoc</em> generated markup is both well
|
7025
7037
|
formed and valid. Here are some examples:</p></div>
|
7026
7038
|
<div class="literalblock">
|
@@ -7141,7 +7153,7 @@ inclusion of arbitrary files.</p></div>
|
|
7141
7153
|
</li>
|
7142
7154
|
<li>
|
7143
7155
|
<p>
|
7144
|
-
<tt
|
7156
|
+
<tt>include::<filename>[]</tt> and <tt>\include1::<filename>[]</tt> block macro
|
7145
7157
|
files must reside inside the parent file’s directory.
|
7146
7158
|
</p>
|
7147
7159
|
</li>
|
@@ -7165,7 +7177,7 @@ Passthrough Blocks are dropped.
|
|
7165
7177
|
<td class="content">
|
7166
7178
|
<div class="paragraph"><p>The safe mode is not designed to protect against unsafe <em>AsciiDoc</em>
|
7167
7179
|
configuration files. Be especially careful when:</p></div>
|
7168
|
-
<div class="olist"><ol>
|
7180
|
+
<div class="olist arabic"><ol class="arabic">
|
7169
7181
|
<li>
|
7170
7182
|
<p>
|
7171
7183
|
Implementing filters.
|
@@ -7396,8 +7408,8 @@ width of the page irrespective of the current indentation.</p></td>
|
|
7396
7408
|
</div>
|
7397
7409
|
<div id="footer">
|
7398
7410
|
<div id="footer-text">
|
7399
|
-
Version 8.3.
|
7400
|
-
Last updated
|
7411
|
+
Version 8.3.3<br />
|
7412
|
+
Last updated 2009-01-02 13:12:48 NZDT
|
7401
7413
|
</div>
|
7402
7414
|
</div>
|
7403
7415
|
</body>
|