FooBarWidget-mizuho 0.9.1 → 0.9.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +1 -1
- data/Rakefile +14 -2
- data/asciidoc/BUGS +11 -6
- data/asciidoc/BUGS.txt +7 -3
- data/asciidoc/CHANGELOG +313 -151
- data/asciidoc/CHANGELOG.txt +177 -12
- data/asciidoc/INSTALL +30 -36
- data/asciidoc/INSTALL.txt +20 -20
- data/asciidoc/Makefile.in +145 -0
- data/asciidoc/README +11 -11
- data/asciidoc/README.txt +9 -9
- data/asciidoc/a2x +40 -7
- data/asciidoc/asciidoc.conf +180 -126
- data/asciidoc/asciidoc.py +1667 -977
- data/asciidoc/common.aap +2 -2
- data/asciidoc/configure +2840 -0
- data/asciidoc/configure.ac +11 -0
- data/asciidoc/dblatex/asciidoc-dblatex.sty +2 -0
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +15 -0
- data/asciidoc/dblatex/dblatex-readme.txt +19 -2
- data/asciidoc/doc/a2x.1 +77 -67
- data/asciidoc/doc/a2x.1.txt +11 -2
- data/asciidoc/doc/article.css-embedded.html +85 -63
- data/asciidoc/doc/article.html +644 -62
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +15 -17
- data/asciidoc/doc/asciidoc.1 +34 -40
- data/asciidoc/doc/asciidoc.1.css-embedded.html +67 -32
- data/asciidoc/doc/asciidoc.1.css.html +28 -28
- data/asciidoc/doc/asciidoc.1.html +33 -33
- data/asciidoc/doc/asciidoc.css-embedded.html +2234 -2348
- data/asciidoc/doc/asciidoc.css.html +2203 -2352
- data/asciidoc/doc/asciidoc.dict +52 -1
- data/asciidoc/doc/asciidoc.html +980 -1160
- data/asciidoc/doc/asciidoc.txt +941 -738
- data/asciidoc/doc/asciimathml.txt +63 -0
- data/asciidoc/doc/book-multi.html +26 -43
- data/asciidoc/doc/book-multi.txt +19 -23
- data/asciidoc/doc/book.css-embedded.html +92 -71
- data/asciidoc/doc/book.html +24 -41
- data/asciidoc/doc/book.txt +19 -21
- data/asciidoc/doc/docbook-xsl.css +1 -0
- data/asciidoc/doc/faq.txt +288 -60
- data/asciidoc/doc/images +1 -0
- data/asciidoc/doc/latex-backend.html +16 -123
- data/asciidoc/doc/latex-backend.txt +17 -19
- data/asciidoc/doc/latexmath.txt +233 -24
- data/asciidoc/doc/latexmathml.txt +41 -0
- data/asciidoc/doc/main.aap +9 -5
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +2 -2
- data/asciidoc/doc/source-highlight-filter.html +476 -105
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +39 -10
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +1 -29
- data/asciidoc/docbook-xsl/fo.xsl +35 -3
- data/asciidoc/docbook-xsl/manpage.xsl +3 -0
- data/asciidoc/docbook-xsl/text.xsl +50 -0
- data/asciidoc/docbook.conf +182 -73
- data/asciidoc/examples/website/ASCIIMathML.js +1 -0
- data/asciidoc/examples/website/CHANGELOG.html +618 -182
- data/asciidoc/examples/website/CHANGELOG.txt +1 -0
- data/asciidoc/examples/website/INSTALL.html +34 -36
- data/asciidoc/examples/website/INSTALL.txt +1 -0
- data/asciidoc/examples/website/LaTeXMathML.js +1 -0
- data/asciidoc/examples/website/README-website.html +26 -37
- data/asciidoc/examples/website/README-website.txt +6 -6
- data/asciidoc/examples/website/README.html +15 -15
- data/asciidoc/examples/website/README.txt +1 -0
- data/asciidoc/examples/website/a2x.1.html +74 -50
- data/asciidoc/examples/website/a2x.1.txt +1 -0
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +13 -48
- data/asciidoc/examples/website/asciidoc-docbook-xsl.txt +1 -0
- data/asciidoc/examples/website/asciimathml.txt +1 -0
- data/asciidoc/examples/website/customers.csv +1 -0
- data/asciidoc/examples/website/downloads.html +69 -31
- data/asciidoc/examples/website/downloads.txt +28 -5
- data/asciidoc/examples/website/faq.html +370 -124
- data/asciidoc/examples/website/faq.txt +1 -0
- data/asciidoc/examples/website/images +1 -0
- data/asciidoc/examples/website/index.html +64 -64
- data/asciidoc/examples/website/index.txt +22 -15
- data/asciidoc/examples/website/latex-backend.html +152 -257
- data/asciidoc/examples/website/latex-backend.txt +1 -0
- data/asciidoc/examples/website/latexmathml.txt +1 -0
- data/asciidoc/examples/website/manpage.html +27 -27
- data/asciidoc/examples/website/manpage.txt +1 -0
- data/asciidoc/examples/website/music-filter.html +18 -18
- data/asciidoc/examples/website/music-filter.txt +1 -0
- data/asciidoc/examples/website/music1.abc +1 -1
- data/asciidoc/examples/website/music1.png +0 -0
- data/asciidoc/examples/website/music2.ly +1 -1
- data/asciidoc/examples/website/music2.png +0 -0
- data/asciidoc/examples/website/newlists.txt +40 -0
- data/asciidoc/examples/website/newtables.txt +397 -0
- data/asciidoc/examples/website/source-highlight-filter.html +67 -32
- data/asciidoc/examples/website/source-highlight-filter.txt +1 -0
- data/asciidoc/examples/website/support.html +4 -4
- data/asciidoc/examples/website/toc.js +1 -0
- data/asciidoc/examples/website/userguide.html +2190 -2339
- data/asciidoc/examples/website/userguide.txt +1 -0
- data/asciidoc/examples/website/version83.txt +37 -0
- data/asciidoc/examples/website/version9.html +13 -13
- data/asciidoc/examples/website/xhtml11-manpage.css +1 -0
- data/asciidoc/examples/website/xhtml11-quirks.css +1 -0
- data/asciidoc/examples/website/xhtml11.css +1 -0
- data/asciidoc/filters/code-filter-readme.txt +3 -3
- data/asciidoc/filters/code-filter-test.txt +6 -6
- data/asciidoc/filters/source-highlight-filter.conf +12 -5
- data/asciidoc/html4.conf +152 -58
- data/asciidoc/install-sh +201 -0
- data/asciidoc/latex.conf +41 -41
- data/asciidoc/stylesheets/docbook-xsl.css +1 -0
- data/asciidoc/stylesheets/xhtml11.css +39 -4
- data/asciidoc/text.conf +4 -4
- data/asciidoc/vim/syntax/asciidoc.vim +58 -32
- data/asciidoc/wordpress.conf +48 -0
- data/asciidoc/xhtml11-quirks.conf +1 -1
- data/asciidoc/xhtml11.conf +198 -70
- data/bin/mizuho +5 -2
- data/lib/mizuho/generator.rb +48 -19
- data/mizuho.gemspec +16 -6
- metadata +58 -15
- data/asciidoc/doc/asciimath.txt +0 -47
- data/asciidoc/docbook-xsl/shaded-literallayout.patch +0 -32
- data/asciidoc/examples/website/asciimath.html +0 -157
- data/asciidoc/examples/website/latexmath.html +0 -119
- data/asciidoc/filters/code-filter-test-c++.txt +0 -7
- data/asciidoc/install.sh +0 -55
- data/asciidoc/linuxdoc.conf +0 -285
- data/asciidoc/math.conf +0 -50
- data/asciidoc/stylesheets/xhtml-deprecated-manpage.css +0 -21
- data/asciidoc/stylesheets/xhtml-deprecated.css +0 -247
- data/asciidoc/t.conf +0 -20
- data/asciidoc/xhtml-deprecated-css.conf +0 -235
- data/asciidoc/xhtml-deprecated.conf +0 -351
@@ -0,0 +1 @@
|
|
1
|
+
../../doc/a2x.1.txt
|
@@ -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.
|
6
|
+
<meta name="generator" content="AsciiDoc 8.3.1" />
|
7
7
|
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
8
8
|
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
9
9
|
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
@@ -37,9 +37,9 @@
|
|
37
37
|
</div>
|
38
38
|
<div id="preamble">
|
39
39
|
<div class="sectionbody">
|
40
|
-
<div class="
|
40
|
+
<div class="paragraph"><p>PDF generation from <em>AsciiDoc</em> generated DocBook using FOP plus DocBook XSL
|
41
41
|
Stylesheets.</p></div>
|
42
|
-
<div class="
|
42
|
+
<div class="ulist"><ul>
|
43
43
|
<li>
|
44
44
|
<p>
|
45
45
|
FOP 0.95beta.
|
@@ -47,27 +47,27 @@ FOP 0.95beta.
|
|
47
47
|
</li>
|
48
48
|
<li>
|
49
49
|
<p>
|
50
|
-
DocBook XSL Stylesheets version 1.
|
50
|
+
DocBook XSL Stylesheets version 1.74.0.
|
51
51
|
</p>
|
52
52
|
</li>
|
53
53
|
</ul></div>
|
54
|
-
<div class="
|
55
|
-
stylesheets. I
|
54
|
+
<div class="paragraph"><p>Output file customisation is achieved by tweaking the DocBook XSL
|
55
|
+
stylesheets. I’ve tried to keep customization to a minimum and
|
56
56
|
confine it to the separate XSL driver files in the distribution
|
57
57
|
<tt>./docbook-xsl/</tt> directory (see the User Guide for details).</p></div>
|
58
|
-
<div class="
|
59
|
-
XSL stylesheets
|
58
|
+
<div class="paragraph"><p>To polish some rough edges I’ve written some patches for the DocBook
|
59
|
+
XSL stylesheets — you don’t need them but they’re documented below
|
60
60
|
and included in the distribution <tt>./docbook-xsl/</tt> directory.</p></div>
|
61
61
|
</div>
|
62
62
|
</div>
|
63
63
|
<h2 id="_manually_upgrading_debian_to_the_latest_docbook_xsl_stylesheets">Manually upgrading Debian to the latest DocBook XSL stylesheets</h2>
|
64
64
|
<div class="sectionbody">
|
65
|
-
<div class="
|
65
|
+
<div class="paragraph"><p>The DocBook XSL Stylesheets distribution is just a directory full of
|
66
66
|
text files and you can switch between releases by changing the
|
67
67
|
directory name in the system XML catalog.</p></div>
|
68
|
-
<div class="
|
68
|
+
<div class="paragraph"><p>To upgrade to the latest docbook-xsl stylesheets without having to
|
69
69
|
wait for the Debian <tt>docbook-xsl</tt> package:</p></div>
|
70
|
-
<div class="
|
70
|
+
<div class="ulist"><ul>
|
71
71
|
<li>
|
72
72
|
<p>
|
73
73
|
Download the latest docbook-xsl tarball from
|
@@ -97,47 +97,12 @@ $ sudo cp -p docbook-xsl.xml docbook-xsl.xml.ORIG
|
|
97
97
|
$ sudo vi docbook-xsl.xml</tt></pre>
|
98
98
|
</div></div>
|
99
99
|
</li>
|
100
|
-
<li>
|
101
|
-
<p>
|
102
|
-
Apply optional patches (see below).
|
103
|
-
</p>
|
104
|
-
</li>
|
105
100
|
</ul></div>
|
106
101
|
</div>
|
107
|
-
<h2 id="_patches_to_docbook_xsl_stylesheets">Patches to DocBook XSL Stylesheets</h2>
|
108
|
-
<div class="sectionbody">
|
109
|
-
<div class="admonitionblock">
|
110
|
-
<table><tr>
|
111
|
-
<td class="icon">
|
112
|
-
<img src="./images/icons/note.png" alt="Note" />
|
113
|
-
</td>
|
114
|
-
<td class="content">You'll find the patch files in the <em>AsciiDoc</em> distribution archive
|
115
|
-
<tt>./docbook-xsl/</tt> directory.</td>
|
116
|
-
</tr></table>
|
117
|
-
</div>
|
118
|
-
<h3 id="_shade_literal_block_patch">Shade Literal Block Patch</h3><div style="clear:left"></div>
|
119
|
-
<div class="para"><p>The processing expectation for <em>AsciiDoc</em> LiteralBlocks and
|
120
|
-
LiteralParagraphs is that they are not shaded. The
|
121
|
-
<tt>shaded-literallayout.patch</tt> was devised to allow AciiDoc Listing
|
122
|
-
blocks to be shaded while leaving Literal paragraphs and Literal
|
123
|
-
blocks unshaded (the default DocBook XSL Stylesheets behavior is to
|
124
|
-
shade all verbatim elements).</p></div>
|
125
|
-
<div class="para"><p>The patch implements a <tt>shade.literallayout</tt> XSL parameter so that
|
126
|
-
shading in literal elements could be disabled while other verbatim
|
127
|
-
elements are left shaded (by setting the XSL <tt>shade.verbatim</tt>
|
128
|
-
parameter).</p></div>
|
129
|
-
<div class="para"><p>The relevant patch file is <tt>shaded-literallayout.patch</tt> and it can be
|
130
|
-
applied from the DocBook XSL Stylesheets directory:</p></div>
|
131
|
-
<div class="literalblock">
|
132
|
-
<div class="content">
|
133
|
-
<pre><tt>$ cd /usr/share/xml/docbook/stylesheet/docbook-xsl-1.72.0
|
134
|
-
$ sudo patch -p0 < /tmp/shaded-literallayout.patch</tt></pre>
|
135
|
-
</div></div>
|
136
|
-
</div>
|
137
102
|
<div id="footer">
|
138
103
|
<div id="footer-text">
|
139
|
-
Version 8.
|
140
|
-
Last updated 2008-
|
104
|
+
Version 8.3.1<br />
|
105
|
+
Last updated 2008-12-13 09:59:38 NZDT
|
141
106
|
</div>
|
142
107
|
<div id="footer-badges">
|
143
108
|
<a href="http://validator.w3.org/check?uri=referer">
|
@@ -0,0 +1 @@
|
|
1
|
+
../../docbook-xsl/asciidoc-docbook-xsl.txt
|
@@ -0,0 +1 @@
|
|
1
|
+
../../doc/asciimathml.txt
|
@@ -0,0 +1 @@
|
|
1
|
+
../../doc/customers.csv
|
@@ -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.
|
6
|
+
<meta name="generator" content="AsciiDoc 8.3.1" />
|
7
7
|
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
8
8
|
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
9
9
|
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
@@ -47,18 +47,18 @@ window.onload = function(){generateToc(1)}
|
|
47
47
|
</div>
|
48
48
|
<div id="preamble">
|
49
49
|
<div class="sectionbody">
|
50
|
-
<div class="
|
50
|
+
<div class="paragraph"><p>See the <a href="README.html">README</a> and <a href="INSTALL.html">INSTALL</a> pages
|
51
51
|
for install prerequisites and procedures.</p></div>
|
52
52
|
</div>
|
53
53
|
</div>
|
54
54
|
<h2 id="X2">Distribution Archives</h2>
|
55
55
|
<div class="sectionbody">
|
56
|
-
<div class="
|
56
|
+
<div class="paragraph"><p>These distribution archives are also available, along with previous
|
57
57
|
<em>AsciiDoc</em> versions, at the SourceForge
|
58
58
|
<a href="http://sourceforge.net/projects/asciidoc/">http://sourceforge.net/projects/asciidoc/</a>.</p></div>
|
59
|
-
<div class="
|
60
|
-
<dt>
|
61
|
-
<a href="asciidoc-8.
|
59
|
+
<div class="dlist"><dl>
|
60
|
+
<dt class="hdlist1">
|
61
|
+
<a href="asciidoc-8.3.1.tar.gz">asciidoc-8.3.1.tar.gz</a>
|
62
62
|
</dt>
|
63
63
|
<dd>
|
64
64
|
<p>
|
@@ -66,8 +66,8 @@ for install prerequisites and procedures.</p></div>
|
|
66
66
|
platforms.
|
67
67
|
</p>
|
68
68
|
</dd>
|
69
|
-
<dt>
|
70
|
-
<a href="asciidoc-8.
|
69
|
+
<dt class="hdlist1">
|
70
|
+
<a href="asciidoc-8.3.1.zip">asciidoc-8.3.1.zip</a>
|
71
71
|
</dt>
|
72
72
|
<dd>
|
73
73
|
<p>
|
@@ -80,49 +80,78 @@ for install prerequisites and procedures.</p></div>
|
|
80
80
|
</div>
|
81
81
|
<h2 id="X3">Mercurial Repository</h2>
|
82
82
|
<div class="sectionbody">
|
83
|
-
<div class="
|
83
|
+
<div class="paragraph"><p>The <em>AsciiDoc</em> <a href="http://www.selenic.com/mercurial/">Mercurial</a> repository
|
84
84
|
is hosted by <a href="http://sharesource.org">ShareSource</a>. ShareSource is a
|
85
85
|
Mercurial friendly website for hosting Open Source projects.</p></div>
|
86
|
-
<div class="
|
87
|
-
<
|
86
|
+
<div class="paragraph"><p>To browse the repo go to <a href="http://hg.sharesource.org/asciidoc/">http://hg.sharesource.org/asciidoc/</a>.</p></div>
|
87
|
+
<h3 id="_installing_from_the_repository">Installing from the repository</h3><div style="clear:left"></div>
|
88
|
+
<div class="paragraph"><p>This is an easy way to install <em>AsciiDoc</em> if you don’t have an up to
|
89
|
+
date packaged version or want to get the latest version from the
|
90
|
+
trunk:</p></div>
|
91
|
+
<div class="ulist"><ul>
|
92
|
+
<li>
|
93
|
+
<p>
|
94
|
+
Make sure you have <a href="http://www.selenic.com/mercurial/">Mercurial</a>
|
95
|
+
installed, you can check with:
|
96
|
+
</p>
|
97
|
+
<div class="literalblock">
|
98
|
+
<div class="content">
|
99
|
+
<pre><tt>$ hg --version</tt></pre>
|
100
|
+
</div></div>
|
101
|
+
</li>
|
102
|
+
<li>
|
103
|
+
<p>
|
104
|
+
Go to the directory you want to install <em>AsciiDoc</em> into and download
|
105
|
+
the repository. This example gets the 8.3.1 tagged release:
|
106
|
+
</p>
|
88
107
|
<div class="literalblock">
|
89
108
|
<div class="content">
|
90
|
-
<pre><tt>$
|
109
|
+
<pre><tt>$ cd ~/bin
|
110
|
+
$ hg clone -r 8.3.1 http://hg.sharesource.org/asciidoc asciidoc.hg</tt></pre>
|
91
111
|
</div></div>
|
92
|
-
|
112
|
+
</li>
|
113
|
+
<li>
|
114
|
+
<p>
|
115
|
+
Create a symlink to the <em>AsciiDoc</em> script in a search <tt>PATH</tt> directory
|
116
|
+
so it’s easy to execute <tt>asciidoc</tt> from the command-line, for
|
117
|
+
example:
|
118
|
+
</p>
|
93
119
|
<div class="literalblock">
|
94
120
|
<div class="content">
|
95
|
-
<pre><tt>$
|
96
|
-
$ hg pull http://hg.sharesource.org/asciidoc</tt></pre>
|
121
|
+
<pre><tt>$ ln -s ~/bin/asciidoc.hg/asciidoc.py ~/bin/asciidoc</tt></pre>
|
97
122
|
</div></div>
|
123
|
+
</li>
|
124
|
+
</ul></div>
|
125
|
+
<div class="paragraph"><p>You can now use the Mercurial <tt>pull</tt> command to update your <em>AsciiDoc</em>
|
126
|
+
repository.</p></div>
|
98
127
|
</div>
|
99
128
|
<h2 id="X1">Prepackaged Versions</h2>
|
100
129
|
<div class="sectionbody">
|
101
|
-
<div class="
|
102
|
-
<div class="
|
103
|
-
<dt>
|
130
|
+
<div class="paragraph"><p>The following platform specific packages are available:</p></div>
|
131
|
+
<div class="dlist"><dl>
|
132
|
+
<dt class="hdlist1">
|
104
133
|
<strong>Debian GNU/Linux</strong>
|
105
134
|
</dt>
|
106
135
|
<dd>
|
107
136
|
<p>
|
108
|
-
If you use Debian or a Debian based distribution there
|
137
|
+
If you use Debian or a Debian based distribution there’s an
|
109
138
|
<a href="http://packages.debian.org/asciidoc"><em>AsciiDoc</em> Debian package</a>
|
110
139
|
available. Thanks to <a href="mailto:stone@debian.org">Fredrik Steen</a> who
|
111
140
|
built and maintains the Debian <em>AsciiDoc</em> package.
|
112
141
|
</p>
|
113
142
|
</dd>
|
114
|
-
<dt>
|
143
|
+
<dt class="hdlist1">
|
115
144
|
<strong>Gentoo Linux</strong>
|
116
145
|
</dt>
|
117
146
|
<dd>
|
118
147
|
<p>
|
119
|
-
If you use Gentoo Linux there
|
148
|
+
If you use Gentoo Linux there’s a
|
120
149
|
<a href="http://packages.gentoo.org/packages/?category=app-text;name=asciidoc">Gentoo
|
121
150
|
<em>AsciiDoc</em> package</a> available. Thanks to
|
122
151
|
<a href="mailto:brandon@ifup.org">Brandon Philips</a> for writing the ebuild.
|
123
152
|
</p>
|
124
153
|
</dd>
|
125
|
-
<dt>
|
154
|
+
<dt class="hdlist1">
|
126
155
|
<strong>Fedora Linux</strong>
|
127
156
|
</dt>
|
128
157
|
<dd>
|
@@ -136,7 +165,7 @@ $ hg pull http://hg.sharesource.org/asciidoc</tt></pre>
|
|
136
165
|
<pre><tt>$ yum install asciidoc</tt></pre>
|
137
166
|
</div></div>
|
138
167
|
</dd>
|
139
|
-
<dt>
|
168
|
+
<dt class="hdlist1">
|
140
169
|
<strong>Slackware Linux</strong>
|
141
170
|
</dt>
|
142
171
|
<dd>
|
@@ -145,18 +174,18 @@ $ hg pull http://hg.sharesource.org/asciidoc</tt></pre>
|
|
145
174
|
be downloaded from <a href="http://linuxpackages.net/">http://linuxpackages.net/</a>.
|
146
175
|
</p>
|
147
176
|
</dd>
|
148
|
-
<dt>
|
177
|
+
<dt class="hdlist1">
|
149
178
|
<strong>Ark Linux</strong>
|
150
179
|
</dt>
|
151
180
|
<dd>
|
152
181
|
<p>
|
153
182
|
<a href="mailto:bero@arklinux.org">Bernhard Rosenkraenzer</a> added <em>AsciiDoc</em> to
|
154
|
-
Ark Linux
|
183
|
+
Ark Linux — the package is available from the Ark Linux repository
|
155
184
|
at <a href="http://arklinux.osuosl.org/dockyard-devel/">http://arklinux.osuosl.org/dockyard-devel/</a>, so Ark Linux users
|
156
185
|
should just run <tt>apt-get install asciidoc</tt>.
|
157
186
|
</p>
|
158
187
|
</dd>
|
159
|
-
<dt>
|
188
|
+
<dt class="hdlist1">
|
160
189
|
<strong>T2 Linux</strong>
|
161
190
|
</dt>
|
162
191
|
<dd>
|
@@ -169,7 +198,7 @@ $ hg pull http://hg.sharesource.org/asciidoc</tt></pre>
|
|
169
198
|
(default: <tt>/usr/src/t2-src</tt>).
|
170
199
|
</p>
|
171
200
|
</dd>
|
172
|
-
<dt>
|
201
|
+
<dt class="hdlist1">
|
173
202
|
<strong>Red Hat Enterprise Linux, Fedora and CentOS packages</strong>
|
174
203
|
</dt>
|
175
204
|
<dd>
|
@@ -179,19 +208,28 @@ $ hg pull http://hg.sharesource.org/asciidoc</tt></pre>
|
|
179
208
|
<a href="http://dag.wieers.com/rpm/packages/asciidoc/">http://dag.wieers.com/rpm/packages/asciidoc/</a>.
|
180
209
|
</p>
|
181
210
|
</dd>
|
211
|
+
<dt class="hdlist1">
|
212
|
+
<strong>CSW Package for Sun Solaris</strong>
|
213
|
+
</dt>
|
214
|
+
<dd>
|
215
|
+
<p>
|
216
|
+
Ben Walton has created a CSW package for <em>AsciiDoc</em>, you can find it
|
217
|
+
here: <a href="http://opencsw.org/packages/asciidoc">http://opencsw.org/packages/asciidoc</a>.
|
218
|
+
</p>
|
219
|
+
</dd>
|
182
220
|
</dl></div>
|
183
|
-
<div class="
|
221
|
+
<div class="paragraph"><p>See also <a href="userguide.html#X38">Packager Notes</a> in the <em><em>AsciiDoc</em> User
|
184
222
|
Guide</em>.</p></div>
|
185
223
|
</div>
|
186
224
|
<h2 id="_copying">Copying</h2>
|
187
225
|
<div class="sectionbody">
|
188
|
-
<div class="
|
226
|
+
<div class="paragraph"><p>Copyright © 2002-2008 Stuart Rackham. Free use of <em>AsciiDoc</em> is
|
189
227
|
granted under the terms of the GNU General Public License (GPL).</p></div>
|
190
228
|
</div>
|
191
229
|
<div id="footer">
|
192
230
|
<div id="footer-text">
|
193
|
-
Version 8.
|
194
|
-
Last updated 2008-
|
231
|
+
Version 8.3.1<br />
|
232
|
+
Last updated 2008-12-13 09:59:43 NZDT
|
195
233
|
</div>
|
196
234
|
<div id="footer-badges">
|
197
235
|
<a href="http://validator.w3.org/check?uri=referer">
|
@@ -31,14 +31,34 @@ Mercurial friendly website for hosting Open Source projects.
|
|
31
31
|
|
32
32
|
To browse the repo go to http://hg.sharesource.org/asciidoc/.
|
33
33
|
|
34
|
-
|
34
|
+
Installing from the repository
|
35
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
36
|
+
This is an easy way to install AsciiDoc if you don't have an up to
|
37
|
+
date packaged version or want to get the latest version from the
|
38
|
+
trunk:
|
35
39
|
|
36
|
-
|
40
|
+
- Make sure you have http://www.selenic.com/mercurial/[Mercurial]
|
41
|
+
installed, you can check with:
|
37
42
|
|
38
|
-
|
43
|
+
$ hg --version
|
39
44
|
|
40
|
-
|
41
|
-
|
45
|
+
- Go to the directory you want to install AsciiDoc into and download
|
46
|
+
the repository. This example gets the {revision} tagged release:
|
47
|
+
+
|
48
|
+
--
|
49
|
+
[subs="attributes"]
|
50
|
+
$ cd ~/bin
|
51
|
+
$ hg clone -r {revision} http://hg.sharesource.org/asciidoc asciidoc.hg
|
52
|
+
--
|
53
|
+
|
54
|
+
- Create a symlink to the AsciiDoc script in a search `PATH` directory
|
55
|
+
so it's easy to execute `asciidoc` from the command-line, for
|
56
|
+
example:
|
57
|
+
|
58
|
+
$ ln -s ~/bin/asciidoc.hg/asciidoc.py ~/bin/asciidoc
|
59
|
+
|
60
|
+
You can now use the Mercurial `pull` command to update your AsciiDoc
|
61
|
+
repository.
|
42
62
|
|
43
63
|
|
44
64
|
[[X1]]
|
@@ -88,6 +108,9 @@ The following platform specific packages are available:
|
|
88
108
|
distributions, they can be downloaded from
|
89
109
|
http://dag.wieers.com/rpm/packages/asciidoc/.
|
90
110
|
|
111
|
+
*CSW Package for Sun Solaris*::
|
112
|
+
Ben Walton has created a CSW package for AsciiDoc, you can find it
|
113
|
+
here: http://opencsw.org/packages/asciidoc.
|
91
114
|
|
92
115
|
See also link:userguide.html#X38[Packager Notes] in the 'AsciiDoc User
|
93
116
|
Guide'.
|
@@ -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.
|
6
|
+
<meta name="generator" content="AsciiDoc 8.3.1" />
|
7
7
|
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
8
8
|
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
9
9
|
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
@@ -47,12 +47,264 @@ window.onload = function(){generateToc(2)}
|
|
47
47
|
</div>
|
48
48
|
<div id="preamble">
|
49
49
|
<div class="sectionbody">
|
50
|
-
<div class="
|
50
|
+
<div class="paragraph"><p>An embryonic <em>AsciiDoc</em> FAQ.</p></div>
|
51
51
|
</div>
|
52
52
|
</div>
|
53
|
-
<h2 id="
|
53
|
+
<h2 id="_how_can_i_render_indented_paragraphs">1. How can I render indented paragraphs?</h2>
|
54
54
|
<div class="sectionbody">
|
55
|
-
<div class="
|
55
|
+
<div class="paragraph"><p>To unconditionally indent all paragraphs add the following line to the
|
56
|
+
<tt>xhtml11.css</tt> stylesheet (or a custom stylesheet).</p></div>
|
57
|
+
<div class="listingblock">
|
58
|
+
<div class="content">
|
59
|
+
<pre><tt>div.paragraph p {text-indent: 3em;}</tt></pre>
|
60
|
+
</div></div>
|
61
|
+
<div class="paragraph"><p>This will restyle the entire document by indenting all paragraphs
|
62
|
+
which is normally what you want to do (mixed paragraph styles produce
|
63
|
+
ugly documents).</p></div>
|
64
|
+
<div class="paragraph"><p>To selectively indent paragraphs with the <em>indented</em> style add the
|
65
|
+
following line to the <tt>xhtml11.css</tt> stylesheet (or a custom
|
66
|
+
stylesheet).</p></div>
|
67
|
+
<div class="listingblock">
|
68
|
+
<div class="content">
|
69
|
+
<pre><tt>div.paragraph.indented p {text-indent: 3em;}</tt></pre>
|
70
|
+
</div></div>
|
71
|
+
<div class="paragraph"><p>Then apply the <em>indented</em> style to normal paragraphs, for example:</p></div>
|
72
|
+
<div class="listingblock">
|
73
|
+
<div class="content">
|
74
|
+
<pre><tt>[indented]
|
75
|
+
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas
|
76
|
+
ultrices justo porttitor augue. Vestibulum pretium. Donec porta
|
77
|
+
vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed
|
78
|
+
lacinia. Vivamus at lectus.</tt></pre>
|
79
|
+
</div></div>
|
80
|
+
<div class="admonitionblock">
|
81
|
+
<table><tr>
|
82
|
+
<td class="icon">
|
83
|
+
<img src="./images/icons/note.png" alt="Note" />
|
84
|
+
</td>
|
85
|
+
<td class="content">This FAQ applies to XHTML output not DocBook. To achieve the
|
86
|
+
same results with DocBook you would need to customize the DocBook XSL
|
87
|
+
stylesheets to indent paragraphs with the <tt>simpara</tt> element
|
88
|
+
<tt>role="indented"</tt> attribute.</td>
|
89
|
+
</tr></table>
|
90
|
+
</div>
|
91
|
+
</div>
|
92
|
+
<h2 id="_is_there_a_way_to_set_default_image_height_and_width_attributes">2. Is there a way to set default image height and width attributes?</h2>
|
93
|
+
<div class="sectionbody">
|
94
|
+
<div class="paragraph"><p>You can set the <em>height</em> and <em>width</em> attributes globally in your
|
95
|
+
document with Attribute Entries or from the command-line using the
|
96
|
+
<tt>--attribute</tt> option. In the following example images that don’t
|
97
|
+
explicitly set the <em>height</em> and <em>width</em> values will be 350 by 250
|
98
|
+
pixels.</p></div>
|
99
|
+
<div class="listingblock">
|
100
|
+
<div class="content">
|
101
|
+
<pre><tt>:height: 250
|
102
|
+
:width: 350
|
103
|
+
|
104
|
+
image:images/tiger.png[]</tt></pre>
|
105
|
+
</div></div>
|
106
|
+
</div>
|
107
|
+
<h2 id="_how_can_i_place_a_backslash_character_in_front_of_an_attribute_reference_without_escaping_the_reference">3. How can I place a backslash character in front of an attribute reference without escaping the reference?</h2>
|
108
|
+
<div class="sectionbody">
|
109
|
+
<div class="paragraph"><p>Use the predefined <tt>{backslash}</tt> attribute reference instead of an
|
110
|
+
actual backslash, for example if the <tt>{projectname}</tt> attribute has
|
111
|
+
the value <tt>foobar</tt> then:</p></div>
|
112
|
+
<div class="literalblock">
|
113
|
+
<div class="content">
|
114
|
+
<pre><tt>d:\data{backslash}{projectname}</tt></pre>
|
115
|
+
</div></div>
|
116
|
+
<div class="paragraph"><p>would be rendered as:</p></div>
|
117
|
+
<div class="literalblock">
|
118
|
+
<div class="content">
|
119
|
+
<pre><tt>d:\data\foobar</tt></pre>
|
120
|
+
</div></div>
|
121
|
+
</div>
|
122
|
+
<h2 id="_how_can_i_escape_asciidoc_markup">4. How can I escape AsciiDoc markup?</h2>
|
123
|
+
<div class="sectionbody">
|
124
|
+
<div class="paragraph"><p>Most <em>AsciiDoc</em> inline elements can be suppressed by preceding them with
|
125
|
+
a backslash character. These elements include:</p></div>
|
126
|
+
<div class="ulist"><ul>
|
127
|
+
<li>
|
128
|
+
<p>
|
129
|
+
Attribute references.
|
130
|
+
</p>
|
131
|
+
</li>
|
132
|
+
<li>
|
133
|
+
<p>
|
134
|
+
Text formatting.
|
135
|
+
</p>
|
136
|
+
</li>
|
137
|
+
<li>
|
138
|
+
<p>
|
139
|
+
Quoting,
|
140
|
+
</p>
|
141
|
+
</li>
|
142
|
+
<li>
|
143
|
+
<p>
|
144
|
+
<em>URLs</em>, <em>image</em> and <em>link</em> macros.
|
145
|
+
</p>
|
146
|
+
</li>
|
147
|
+
<li>
|
148
|
+
<p>
|
149
|
+
Replacements.
|
150
|
+
</p>
|
151
|
+
</li>
|
152
|
+
<li>
|
153
|
+
<p>
|
154
|
+
Special words.
|
155
|
+
</p>
|
156
|
+
</li>
|
157
|
+
<li>
|
158
|
+
<p>
|
159
|
+
Table cell separators.
|
160
|
+
</p>
|
161
|
+
</li>
|
162
|
+
</ul></div>
|
163
|
+
<div class="paragraph"><p>But there are exceptions — see the next question.</p></div>
|
164
|
+
</div>
|
165
|
+
<h2 id="_some_elements_can_8217_t_be_escaped_with_a_single_backslash">5. Some elements can’t be escaped with a single backslash</h2>
|
166
|
+
<div class="sectionbody">
|
167
|
+
<div class="paragraph"><p>There are a number of exceptions to the usual single backslash rule — mostly relating to URL macros that have two syntaxes or quoting
|
168
|
+
ambiguity. Here are some non-standard escape examples:</p></div>
|
169
|
+
<div class="tableblock">
|
170
|
+
<table rules="none"
|
171
|
+
width="70%"
|
172
|
+
frame="void"
|
173
|
+
cellspacing="0" cellpadding="4">
|
174
|
+
<col width="20%" />
|
175
|
+
<col width="80%" />
|
176
|
+
<tbody valign="top">
|
177
|
+
<tr>
|
178
|
+
<td align="left"><p class="table">Mailto URLs</p></td>
|
179
|
+
<td align="left"><div class="literal"><pre><tt>\srackham@methods.co.nz
|
180
|
+
<\srackham@methods.co.nz>
|
181
|
+
\mailto:[\srackham@methods.co.nz]</tt></pre></div></td>
|
182
|
+
</tr>
|
183
|
+
<tr>
|
184
|
+
<td align="left"><p class="table">Web URLs</p></td>
|
185
|
+
<td align="left"><div class="literal"><pre><tt>\http://www.foo1.co.nz
|
186
|
+
\\http://www.foobar.com[]
|
187
|
+
\\http://www.foobar.com[Foobar Limited]</tt></pre></div></td>
|
188
|
+
</tr>
|
189
|
+
<tr>
|
190
|
+
<td align="left"><p class="table">Other</p></td>
|
191
|
+
<td align="left"><div class="literal"><pre><tt>A C+\+ Library for C++
|
192
|
+
A C+\+ Library for C+\+ \+++
|
193
|
+
\\``double-quotes''
|
194
|
+
\*\*F**ile Open...</tt></pre></div></td>
|
195
|
+
</tr>
|
196
|
+
</tbody>
|
197
|
+
</table>
|
198
|
+
</div>
|
199
|
+
<div class="paragraph"><p>The source of this problem is ambiguity across substitution types — the first match unescapes allowing the second to substitute. A
|
200
|
+
work-around for difficult cases is to side-step the problem using the
|
201
|
+
<tt>pass:[]</tt> passthrough inline macro.</p></div>
|
202
|
+
<div class="admonitionblock">
|
203
|
+
<table><tr>
|
204
|
+
<td class="icon">
|
205
|
+
<img src="./images/icons/note.png" alt="Note" />
|
206
|
+
</td>
|
207
|
+
<td class="content">System macros cannot be escaped.</td>
|
208
|
+
</tr></table>
|
209
|
+
</div>
|
210
|
+
</div>
|
211
|
+
<h2 id="_how_can_i_set_default_list_and_tables_styles">6. How can I set default list and tables styles?</h2>
|
212
|
+
<div class="sectionbody">
|
213
|
+
<div class="paragraph"><p>You can set the element’s <em>style</em> entry in a global or custom
|
214
|
+
configuration file.</p></div>
|
215
|
+
<div class="paragraph"><p>This example this will horizontally style all labeled lists that don’t
|
216
|
+
have an explicit style attribute:</p></div>
|
217
|
+
<div class="listingblock">
|
218
|
+
<div class="content">
|
219
|
+
<pre><tt>[listdef-labeled]
|
220
|
+
style=horizontal
|
221
|
+
|
222
|
+
[listdef-labeled2]
|
223
|
+
style=horizontal</tt></pre>
|
224
|
+
</div></div>
|
225
|
+
<div class="paragraph"><p>This example will put a top and bottom border on all tables that don’t
|
226
|
+
already have an explicit style attribute:</p></div>
|
227
|
+
<div class="listingblock">
|
228
|
+
<div class="content">
|
229
|
+
<pre><tt>[tabledef-default]
|
230
|
+
style=topbot
|
231
|
+
topbot-style=frame="topbot"</tt></pre>
|
232
|
+
</div></div>
|
233
|
+
<div class="paragraph"><p>Alternatively you can set the configuration entries from inside your
|
234
|
+
document, the above examples are equivalent to:</p></div>
|
235
|
+
<div class="listingblock">
|
236
|
+
<div class="content">
|
237
|
+
<pre><tt>:listdef-labeled.style: horizontal
|
238
|
+
:listdef-labeled2.style: horizontal
|
239
|
+
|
240
|
+
:tabledef-default.topbot-style: frame="topbot"
|
241
|
+
:tabledef-default.style: topbot</tt></pre>
|
242
|
+
</div></div>
|
243
|
+
</div>
|
244
|
+
<h2 id="_why_do_i_get_a_filter_non_zero_exit_code_error">7. Why do I get a filter non-zero exit code error?</h2>
|
245
|
+
<div class="sectionbody">
|
246
|
+
<div class="paragraph"><p>An error was returned when <em>AsciiDoc</em> tried to execute an external
|
247
|
+
filter command. The most common reason for this is that the filter
|
248
|
+
command could not be found by the command shell. To figure out what
|
249
|
+
the problem is run <em>AsciiDoc</em> with the <tt>--verbose</tt> option to determine
|
250
|
+
the command that is failing and then try to run the command manually
|
251
|
+
from the command-line.</p></div>
|
252
|
+
</div>
|
253
|
+
<h2 id="_are_there_any_docbook_viewers">8. Are there any DocBook viewers?</h2>
|
254
|
+
<div class="sectionbody">
|
255
|
+
<div class="paragraph"><p><a href="http://live.gnome.org/Yelp">Yelp</a>, the GNOME help viewer, does a
|
256
|
+
creditable job of displaying DocBook files XML files directly. Just
|
257
|
+
run it from the command-line, for example:</p></div>
|
258
|
+
<div class="literalblock">
|
259
|
+
<div class="content">
|
260
|
+
<pre><tt>$ yelp file://home/srackham/tmp/book.xml</tt></pre>
|
261
|
+
</div></div>
|
262
|
+
<div class="paragraph"><p>Note that you have to supply the full path name in URI format, this
|
263
|
+
shell script makes interactive use easier:</p></div>
|
264
|
+
<div class="listingblock">
|
265
|
+
<div class="content">
|
266
|
+
<pre><tt>#!/bin/sh
|
267
|
+
if [ -z "$1" ]; then
|
268
|
+
echo "usage: dbkview FILE"
|
269
|
+
exit 1
|
270
|
+
fi
|
271
|
+
yelp "file://$(pwd)/$1"</tt></pre>
|
272
|
+
</div></div>
|
273
|
+
<div class="paragraph"><p>This tip was submitted by Lionel Orry.</p></div>
|
274
|
+
</div>
|
275
|
+
<h2 id="_can_you_create_odf_documents_using_asciidoc">9. Can you create ODF documents using AsciiDoc?</h2>
|
276
|
+
<div class="sectionbody">
|
277
|
+
<div class="paragraph"><p>The easiest and highest fidelity methods I’ve seen is to generate
|
278
|
+
HTML from <em>AsciiDoc</em> then paste it from your browser (we use Firefox)
|
279
|
+
into OpenOffice Writer.</p></div>
|
280
|
+
<div class="ulist"><ul>
|
281
|
+
<li>
|
282
|
+
<p>
|
283
|
+
I found that that there is better fidelity pasting HTML generated by
|
284
|
+
the <em>html4</em> backend instead of the default <em>xhtml11</em> backend.
|
285
|
+
</p>
|
286
|
+
</li>
|
287
|
+
<li>
|
288
|
+
<p>
|
289
|
+
Don’t paste <em>AsciiDoc</em> tables of contents, OpenOffice Writer (I was
|
290
|
+
using version 2.3) hangs when saving. This may be something to do
|
291
|
+
with the embedded JavaScript but I haven’t looked closely at it, I
|
292
|
+
may even be wrong about this.
|
293
|
+
</p>
|
294
|
+
</li>
|
295
|
+
</ul></div>
|
296
|
+
<div class="paragraph"><p>This tip was contributed by Bernard Amade.</p></div>
|
297
|
+
</div>
|
298
|
+
<h2 id="_how_can_i_supress_cell_separators_in_included_table_data_files">10. How can I supress cell separators in included table data files?</h2>
|
299
|
+
<div class="sectionbody">
|
300
|
+
<div class="paragraph"><p>Use the <tt>{include:}</tt> system attribute instead of the <tt>\include::[]</tt>
|
301
|
+
macro (the former is not expanded until after the table data has been
|
302
|
+
parsed into cells, whereas the latter is included before the table is
|
303
|
+
processed.</p></div>
|
304
|
+
</div>
|
305
|
+
<h2 id="_how_can_i_preserve_paragraph_line_boundaries">11. How can I preserve paragraph line boundaries?</h2>
|
306
|
+
<div class="sectionbody">
|
307
|
+
<div class="paragraph"><p>Apply the The <em>verse</em> paragraph style, the rendered text preserves
|
56
308
|
line boundaries and is useful for lyrics and poems. For example:</p></div>
|
57
309
|
<div class="listingblock">
|
58
310
|
<div class="content">
|
@@ -61,15 +313,29 @@ Consul *necessitatibus* per id,
|
|
61
313
|
consetetur, eu pro everti postulant
|
62
314
|
homero verear ea mea, qui.</tt></pre>
|
63
315
|
</div></div>
|
316
|
+
<div class="paragraph"><p>If you are generating PDF files (using FOP) or HTML files then you can
|
317
|
+
use line breaks. For example:</p></div>
|
318
|
+
<div class="listingblock">
|
319
|
+
<div class="content">
|
320
|
+
<pre><tt>Consul *necessitatibus* per id, +
|
321
|
+
consetetur, eu pro everti postulant +
|
322
|
+
homero verear ea mea, qui.</tt></pre>
|
323
|
+
</div></div>
|
324
|
+
</div>
|
325
|
+
<h2 id="_how_can_i_include_non_breaking_space_characters">12. How can I include non-breaking space characters?</h2>
|
326
|
+
<div class="sectionbody">
|
327
|
+
<div class="paragraph"><p>The predefined <tt>{nbsp}</tt> attribute reference will be replaced by a
|
328
|
+
non-breaking space character. You could also use the non-breaking
|
329
|
+
space character entity reference <tt>&#160;</tt> (see the next question).</p></div>
|
64
330
|
</div>
|
65
|
-
<h2 id="
|
331
|
+
<h2 id="_can_i_include_html_and_xml_character_entity_references_in_my_document">13. Can I include HTML and XML character entity references in my document?</h2>
|
66
332
|
<div class="sectionbody">
|
67
|
-
<div class="
|
68
|
-
|
333
|
+
<div class="paragraph"><p>Yes, just enter the reference in your document. For example <tt>&#946;</tt>
|
334
|
+
will print a Greek small beta character β</p></div>
|
69
335
|
</div>
|
70
|
-
<h2 id="
|
336
|
+
<h2 id="X1">14. How do I include spaces in URLs?</h2>
|
71
337
|
<div class="sectionbody">
|
72
|
-
<div class="
|
338
|
+
<div class="paragraph"><p>URL inline macro targets (addresses) cannot contain white space
|
73
339
|
characters. If you need spaces encode them as <tt>%20</tt>. For example:</p></div>
|
74
340
|
<div class="literalblock">
|
75
341
|
<div class="content">
|
@@ -77,35 +343,35 @@ characters. If you need spaces encode them as <tt>%20</tt>. For example:</p></di
|
|
77
343
|
http://www.foo.bar.com/an%20example%20document.html</tt></pre>
|
78
344
|
</div></div>
|
79
345
|
</div>
|
80
|
-
<h2 id="_how_can_i_get_asciidoc_to_assign_the_correct_docbook_language_attribute">
|
346
|
+
<h2 id="_how_can_i_get_asciidoc_to_assign_the_correct_docbook_language_attribute">15. How can I get AsciiDoc to assign the correct DocBook language attribute?</h2>
|
81
347
|
<div class="sectionbody">
|
82
|
-
<div class="
|
348
|
+
<div class="paragraph"><p>Set the <em>AsciiDoc</em> <em>lang</em> attribute to the appropriate language code.
|
83
349
|
For example:</p></div>
|
84
350
|
<div class="literalblock">
|
85
351
|
<div class="content">
|
86
352
|
<pre><tt>$ a2x -a lang=es doc/article.txt</tt></pre>
|
87
353
|
</div></div>
|
88
|
-
<div class="
|
354
|
+
<div class="paragraph"><p>This will ensure that downstream DocBook processing will generate the
|
89
355
|
correct language specific document headings (things like table of
|
90
356
|
contents, revision history, figure and table captions, admonition
|
91
357
|
captions).</p></div>
|
92
358
|
</div>
|
93
|
-
<h2 id="_why_does_asciidoc_give_me_a_8220_malformed_author_8221_error">
|
359
|
+
<h2 id="_why_does_asciidoc_give_me_a_8220_malformed_author_8221_error">16. Why does AsciiDoc give me a “malformed author” error?</h2>
|
94
360
|
<div class="sectionbody">
|
95
|
-
<div class="
|
361
|
+
<div class="paragraph"><p>This is normally because there are more than three names (up to three
|
96
362
|
are expected: first name, middle name and last name). For example,
|
97
363
|
this author line would result in an error:</p></div>
|
98
364
|
<div class="literalblock">
|
99
365
|
<div class="content">
|
100
366
|
<pre><tt>Vincent Willem van Gogh</tt></pre>
|
101
367
|
</div></div>
|
102
|
-
<div class="
|
368
|
+
<div class="paragraph"><p>You can enter multi-word first, middle and last names in the author
|
103
369
|
line using the underscore as a word separator. For example:</p></div>
|
104
370
|
<div class="literalblock">
|
105
371
|
<div class="content">
|
106
372
|
<pre><tt>Vincent Willem van_Gogh</tt></pre>
|
107
373
|
</div></div>
|
108
|
-
<div class="
|
374
|
+
<div class="paragraph"><p>You could also resolve the problem by replacing the author line with
|
109
375
|
explicit attribute entries:</p></div>
|
110
376
|
<div class="literalblock">
|
111
377
|
<div class="content">
|
@@ -114,9 +380,9 @@ explicit attribute entries:</p></div>
|
|
114
380
|
:Last name: Van Gogh</tt></pre>
|
115
381
|
</div></div>
|
116
382
|
</div>
|
117
|
-
<h2 id="_how_can_i_assign_multiple_author_names">
|
383
|
+
<h2 id="_how_can_i_assign_multiple_author_names">17. How can I assign multiple author names?</h2>
|
118
384
|
<div class="sectionbody">
|
119
|
-
<div class="
|
385
|
+
<div class="paragraph"><p>A quick way to do this is put both authors in a single first name, for
|
120
386
|
example:</p></div>
|
121
387
|
<div class="literalblock">
|
122
388
|
<div class="content">
|
@@ -125,8 +391,8 @@ example:</p></div>
|
|
125
391
|
:Author: Bill_and_Ben_the_Flowerpot_Men
|
126
392
|
:Author Initials: BB & BC</tt></pre>
|
127
393
|
</div></div>
|
128
|
-
<div class="
|
129
|
-
<div class="
|
394
|
+
<div class="paragraph"><p><tt>asciidoc(1)</tt> replaces the underscores with spaces.</p></div>
|
395
|
+
<div class="paragraph"><p>The longer, semantically correct, way is to override the
|
130
396
|
<tt>[header]</tt> configuration file section in a document specific <tt>.conf</tt>
|
131
397
|
file. For example if your document is <tt>mydoc.txt</tt> then a file called
|
132
398
|
<tt>mydoc.conf</tt> in the document directory would be picked up
|
@@ -141,48 +407,9 @@ related markup:</p></div>
|
|
141
407
|
:</tt></pre>
|
142
408
|
</div></div>
|
143
409
|
</div>
|
144
|
-
<h2 id="
|
410
|
+
<h2 id="_how_can_i_escape_a_labeled_list_entry">18. How can I escape a labeled list entry?</h2>
|
145
411
|
<div class="sectionbody">
|
146
|
-
<div class="
|
147
|
-
a backslash character. These elements include:</p></div>
|
148
|
-
<div class="ilist"><ul>
|
149
|
-
<li>
|
150
|
-
<p>
|
151
|
-
Attribute references.
|
152
|
-
</p>
|
153
|
-
</li>
|
154
|
-
<li>
|
155
|
-
<p>
|
156
|
-
Text formatting.
|
157
|
-
</p>
|
158
|
-
</li>
|
159
|
-
<li>
|
160
|
-
<p>
|
161
|
-
Quoting,
|
162
|
-
</p>
|
163
|
-
</li>
|
164
|
-
<li>
|
165
|
-
<p>
|
166
|
-
<em>URLs</em>, <em>image</em> and <em>link</em> macros.
|
167
|
-
</p>
|
168
|
-
</li>
|
169
|
-
<li>
|
170
|
-
<p>
|
171
|
-
Replacements.
|
172
|
-
</p>
|
173
|
-
</li>
|
174
|
-
<li>
|
175
|
-
<p>
|
176
|
-
Special words.
|
177
|
-
</p>
|
178
|
-
</li>
|
179
|
-
</ul></div>
|
180
|
-
<div class="para"><p>In some cases you may need to escape both left and right quotes (see
|
181
|
-
the <em><em>AsciiDoc</em> User Guide</em>).</p></div>
|
182
|
-
</div>
|
183
|
-
<h2 id="_how_can_i_escape_a_labeled_list_entry">8. How can I escape a labeled list entry?</h2>
|
184
|
-
<div class="sectionbody">
|
185
|
-
<div class="para"><p>Two colons or semicolons in a paragraph may be confused with a labeled
|
412
|
+
<div class="paragraph"><p>Two colons or semicolons in a paragraph may be confused with a labeled
|
186
413
|
list entry. Use the predefined <tt>{two_colons}</tt> and <tt>{two_semicolons}</tt>
|
187
414
|
to suppress this behavior, for example:</p></div>
|
188
415
|
<div class="literalblock">
|
@@ -190,14 +417,14 @@ to suppress this behavior, for example:</p></div>
|
|
190
417
|
<pre><tt>Qui in magna commodo{two_colons} est labitur dolorum an. Est ne
|
191
418
|
magna primis adolescens.</tt></pre>
|
192
419
|
</div></div>
|
193
|
-
<div class="
|
194
|
-
<div class="
|
420
|
+
<div class="paragraph"><p>Will be rendered as:</p></div>
|
421
|
+
<div class="paragraph"><p>Qui in magna commodo:: est labitur dolorum an. Est ne
|
195
422
|
magna primis adolescens.</p></div>
|
196
423
|
</div>
|
197
|
-
<h2 id="
|
424
|
+
<h2 id="_how_can_i_selectively_disable_a_quoted_text_substitution">19. How can I selectively disable a quoted text substitution?</h2>
|
198
425
|
<div class="sectionbody">
|
199
|
-
<div class="
|
200
|
-
superscripts or subscripts then put the following in a custom
|
426
|
+
<div class="paragraph"><p>Omitting the tag name will disable quoting. For example, if you don’t
|
427
|
+
want superscripts or subscripts then put the following in a custom
|
201
428
|
configuration file or edit the global <tt>asciidoc.conf</tt> configuration
|
202
429
|
file:</p></div>
|
203
430
|
<div class="listingblock">
|
@@ -206,22 +433,17 @@ file:</p></div>
|
|
206
433
|
^=
|
207
434
|
~=</tt></pre>
|
208
435
|
</div></div>
|
209
|
-
|
210
|
-
|
211
|
-
<div class="sectionbody">
|
212
|
-
<div class="para"><p>You can selectively choose which substitutions to perform by setting
|
213
|
-
the <em>subs</em> attribute at the start of a block. For example:</p></div>
|
436
|
+
<div class="paragraph"><p>Alternatively you can set the configuration entries from within your
|
437
|
+
document, the above examples are equivalent to:</p></div>
|
214
438
|
<div class="listingblock">
|
215
439
|
<div class="content">
|
216
|
-
<pre><tt
|
217
|
-
|
218
|
-
Nor will the non-alphanumeric characters in the following URL:
|
219
|
-
http://host/~user/file#_anchor_tag_str_</tt></pre>
|
440
|
+
<pre><tt>:quotes.^:
|
441
|
+
:quotes.~:</tt></pre>
|
220
442
|
</div></div>
|
221
443
|
</div>
|
222
|
-
<h2 id="_how_can_i_customize_the_localdate_format">
|
444
|
+
<h2 id="_how_can_i_customize_the_localdate_format">20. How can I customize the {localdate} format?</h2>
|
223
445
|
<div class="sectionbody">
|
224
|
-
<div class="
|
446
|
+
<div class="paragraph"><p>The default format for the <tt>{localdate}</tt> attribute is the ISO 8601
|
225
447
|
<tt>yyyy-mm-dd</tt> format. You can change this format by explicitly setting
|
226
448
|
the <tt>{localdate}</tt> attribute. For example by setting it using the
|
227
449
|
<tt>asciidoc(1)</tt> <tt>-a</tt> command-line option:</p></div>
|
@@ -229,26 +451,26 @@ the <tt>{localdate}</tt> attribute. For example by setting it using the
|
|
229
451
|
<div class="content">
|
230
452
|
<pre><tt>$ asciidoc -a localdate=`date +%d-%d-%Y` mydoc.txt</tt></pre>
|
231
453
|
</div></div>
|
232
|
-
<div class="
|
454
|
+
<div class="paragraph"><p>You could also set it by adding an Attribute Entry to your souce
|
233
455
|
document, for example:</p></div>
|
234
456
|
<div class="literalblock">
|
235
457
|
<div class="content">
|
236
458
|
<pre><tt>:localdate: {sys: date +%Y-%m-%d}</tt></pre>
|
237
459
|
</div></div>
|
238
|
-
<div class="
|
239
|
-
include the <tt
|
460
|
+
<div class="paragraph"><p>Since it’s set using an executable attribute you’ll also need to
|
461
|
+
include the <tt>--unsafe</tt> option when you run asciidoc).</p></div>
|
240
462
|
</div>
|
241
|
-
<h2 id="
|
463
|
+
<h2 id="_why_doesn_8217_t_asciidoc_support_strike_through_text">21. Why doesn’t AsciiDoc support strike through text?</h2>
|
242
464
|
<div class="sectionbody">
|
243
|
-
<div class="
|
465
|
+
<div class="paragraph"><p>The reason it’s not in the distribution is that DocBook does not have
|
244
466
|
provision for strike through text and one of the <em>AsciiDoc</em> design goals
|
245
467
|
is that <em>AsciiDoc</em> markup should be applicable to all output formats.</p></div>
|
246
|
-
<div class="
|
468
|
+
<div class="paragraph"><p>Strike through is normally used to mark deleted text — a more
|
247
469
|
comprehensive way to manage document revisions is to use a version
|
248
470
|
control system such as Subversion. You can also use the <em>AsciiDoc</em>
|
249
471
|
<em>CommentLines</em> and <em>CommentBlocks</em> to retain revised text in the
|
250
472
|
source document.</p></div>
|
251
|
-
<div class="
|
473
|
+
<div class="paragraph"><p>If you really need strike through text for (X)HTML outputs then adding
|
252
474
|
the following to a configuration file will allow you to quote strike
|
253
475
|
through text with hyphen characters:</p></div>
|
254
476
|
<div class="listingblock">
|
@@ -264,56 +486,41 @@ through text with hyphen characters:</p></div>
|
|
264
486
|
endif::basebackend-html[]</tt></pre>
|
265
487
|
</div></div>
|
266
488
|
</div>
|
267
|
-
<h2 id="_where_can_i_find_examples_of_commands_used_to_build_output_documents">
|
489
|
+
<h2 id="_where_can_i_find_examples_of_commands_used_to_build_output_documents">22. Where can I find examples of commands used to build output documents?</h2>
|
268
490
|
<div class="sectionbody">
|
269
|
-
<div class="
|
491
|
+
<div class="paragraph"><p>The User Guide has some. You could also look at <tt>./doc/main.aap</tt> in
|
270
492
|
the <em>AsciiDoc</em> distribution, it has all the commands used to build the
|
271
|
-
<em>AsciiDoc</em> documentation (even if you don
|
493
|
+
<em>AsciiDoc</em> documentation (even if you don’t use A-A-P you’ll still find
|
272
494
|
it useful).</p></div>
|
273
495
|
</div>
|
274
|
-
<h2 id="
|
275
|
-
<div class="sectionbody">
|
276
|
-
<div class="para"><p>Use the predefined <tt>{backslash}</tt> attribute reference instead of an
|
277
|
-
actual backslash, for example if the <tt>{projectname}</tt> attribute has
|
278
|
-
the value <tt>foobar</tt> then:</p></div>
|
279
|
-
<div class="literalblock">
|
280
|
-
<div class="content">
|
281
|
-
<pre><tt>d:\data{backslash}{projectname}</tt></pre>
|
282
|
-
</div></div>
|
283
|
-
<div class="para"><p>would be rendered as:</p></div>
|
284
|
-
<div class="literalblock">
|
285
|
-
<div class="content">
|
286
|
-
<pre><tt>d:\data\foobar</tt></pre>
|
287
|
-
</div></div>
|
288
|
-
</div>
|
289
|
-
<h2 id="_why_have_you_used_the_docbook_lt_simpara_gt_element_instead_of_lt_para_gt">15. Why have you used the DocBook <simpara> element instead of <para>?</h2>
|
496
|
+
<h2 id="_why_have_you_used_the_docbook_lt_simpara_gt_element_instead_of_lt_para_gt">23. Why have you used the DocBook <simpara> element instead of <para>?</h2>
|
290
497
|
<div class="sectionbody">
|
291
|
-
<div class="
|
292
|
-
block elements
|
498
|
+
<div class="paragraph"><p><tt><simpara></tt> is really the same as <tt><para></tt> except it can’t contain
|
499
|
+
block elements — this matched, more closely, the <em>AsciiDoc</em> paragraph
|
293
500
|
semantics.</p></div>
|
294
501
|
</div>
|
295
|
-
<h2 id="
|
502
|
+
<h2 id="_how_can_i_format_text_inside_a_listing_block">24. How can I format text inside a listing block?</h2>
|
296
503
|
<div class="sectionbody">
|
297
|
-
<div class="
|
504
|
+
<div class="paragraph"><p>By default only <em>specialcharacters</em> and <em>callouts</em> are substituted in
|
298
505
|
listing blocks; you can add quotes substitutions by explicitly setting
|
299
506
|
the block <em>subs</em> attribute, for example:</p></div>
|
300
507
|
<div class="literalblock">
|
301
508
|
<div class="content">
|
302
|
-
<pre><tt>[subs="
|
509
|
+
<pre><tt>[subs="quotes"]
|
303
510
|
------------------------------------------
|
304
511
|
$ ls *-al*
|
305
512
|
------------------------------------------</tt></pre>
|
306
513
|
</div></div>
|
307
|
-
<div class="
|
308
|
-
<div class="
|
514
|
+
<div class="paragraph"><p>The <tt>-al</tt> will rendered bold. Note that:</p></div>
|
515
|
+
<div class="ulist"><ul>
|
309
516
|
<li>
|
310
517
|
<p>
|
311
|
-
You would need to explicitly escape text you didn
|
518
|
+
You would need to explicitly escape text you didn’t want quoted.
|
312
519
|
</p>
|
313
520
|
</li>
|
314
521
|
<li>
|
315
522
|
<p>
|
316
|
-
Don
|
523
|
+
Don’t do this in source code listing blocks because it modifies the
|
317
524
|
source code which confuses the syntax highlighter.
|
318
525
|
</p>
|
319
526
|
</li>
|
@@ -325,26 +532,65 @@ This only works if your DocBook processor recognizes DocBook
|
|
325
532
|
</li>
|
326
533
|
</ul></div>
|
327
534
|
</div>
|
328
|
-
<h2 id="
|
535
|
+
<h2 id="_why_doesn_8217_t_the_include1_macro_work">25. Why doesn’t the include1::[] macro work?</h2>
|
329
536
|
<div class="sectionbody">
|
330
|
-
<div class="
|
537
|
+
<div class="paragraph"><p>Internally the <tt>include1</tt> macro is translated to the <tt>include1</tt> system
|
331
538
|
attribute which means it must be evaluated in a region where attribute
|
332
|
-
substitution is enabled.
|
333
|
-
|
334
|
-
|
539
|
+
substitution is enabled. <tt>include1</tt> won’t work, for example, in a
|
540
|
+
ListingBlock (unless attribute substitution is enabled). <tt>include1</tt>
|
541
|
+
is intended for use in configuration files, use the <tt>include</tt> macro
|
542
|
+
and set the attribute <tt>depth=1</tt> instead, for example:</p></div>
|
543
|
+
<div class="literalblock">
|
544
|
+
<div class="content">
|
545
|
+
<pre><tt>-----------------------------------------------
|
546
|
+
include::blogpost_media_processing.txt[depth=1]
|
547
|
+
-----------------------------------------------</tt></pre>
|
548
|
+
</div></div>
|
549
|
+
</div>
|
550
|
+
<h2 id="_how_can_i_customize_pdf_files_generated_by_dblatex">26. How can I customize PDF files generated by dblatex?</h2>
|
551
|
+
<div class="sectionbody">
|
552
|
+
<div class="paragraph"><p>There are a number of dblatex XSL parameters that can be used to
|
553
|
+
customize PDF output. You can set them globally in the <em>AsciiDoc</em>
|
554
|
+
<tt>./dblatex/asciidoc-dblatex.xsl</tt> configuration file or you can also
|
555
|
+
pass them on the <tt>a2x(1)</tt> command-line, for example:</p></div>
|
556
|
+
<div class="literalblock">
|
557
|
+
<div class="content">
|
558
|
+
<pre><tt>a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" doc/article.txt</tt></pre>
|
559
|
+
</div></div>
|
560
|
+
<div class="paragraph"><p>See also the <a href="http://dblatex.sourceforge.net/">dblatex</a> documentation.</p></div>
|
561
|
+
</div>
|
562
|
+
<h2 id="_how_can_i_make_the_mailto_macro_work_with_multiple_email_addresses">27. How can I make the mailto macro work with multiple email addresses?</h2>
|
563
|
+
<div class="sectionbody">
|
564
|
+
<div class="paragraph"><p>For the <em>AsciiDoc</em> <em>mailto</em> macro to work with multiple email addresses
|
565
|
+
(as per RFC2368) you need to URL encode the <em>@</em> characters (replace
|
566
|
+
them with <em>%40</em>), if you don’t the individual addresses will be
|
567
|
+
rendered as separate links. You also need to <a href="#X1">replace spaces with <em>%20</em></a>.</p></div>
|
568
|
+
<div class="paragraph"><p>For example, the following call won’t work:</p></div>
|
569
|
+
<div class="literalblock">
|
570
|
+
<div class="content">
|
571
|
+
<pre><tt>mailto:jb@foobar.com,jd@acme.co.nz?subject=New foofoo release[New foofoo release]</tt></pre>
|
572
|
+
</div></div>
|
573
|
+
<div class="paragraph"><p>Use this instead:</p></div>
|
574
|
+
<div class="literalblock">
|
575
|
+
<div class="content">
|
576
|
+
<pre><tt>mailto:jb%40foobar.com,jd%40acme.co.nz?subject=New%20foofoo%20release[New foofoo release]</tt></pre>
|
577
|
+
</div></div>
|
578
|
+
</div>
|
579
|
+
<h2 id="_how_can_a_replacement_have_a_trailing_backslash">28. How can a replacement have a trailing backslash?</h2>
|
580
|
+
<div class="sectionbody">
|
581
|
+
<div class="paragraph"><p>Quote the entry name — this nonsensical example replaces <tt>x\</tt> with
|
582
|
+
<tt>y</tt>:</p></div>
|
335
583
|
<div class="literalblock">
|
336
584
|
<div class="content">
|
337
|
-
<pre><tt>
|
338
|
-
-----------------------------------------
|
339
|
-
include1::blogpost_media_processing.txt[]
|
340
|
-
-----------------------------------------</tt></pre>
|
585
|
+
<pre><tt>"x\\"=y</tt></pre>
|
341
586
|
</div></div>
|
342
|
-
<div class="
|
587
|
+
<div class="paragraph"><p>If quoting were omitted the equals character (separating the
|
588
|
+
entry name <tt>x</tt> from the value <tt>y</tt>) would be escaped.</p></div>
|
343
589
|
</div>
|
344
590
|
<div id="footer">
|
345
591
|
<div id="footer-text">
|
346
|
-
Version 8.
|
347
|
-
Last updated 2008-
|
592
|
+
Version 8.3.1<br />
|
593
|
+
Last updated 2008-12-13 09:59:43 NZDT
|
348
594
|
</div>
|
349
595
|
<div id="footer-badges">
|
350
596
|
<a href="http://validator.w3.org/check?uri=referer">
|