FooBarWidget-mizuho 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE.txt +20 -0
- data/README.markdown +68 -0
- data/Rakefile +9 -0
- data/asciidoc/BUGS +34 -0
- data/asciidoc/BUGS.txt +28 -0
- data/asciidoc/CHANGELOG +1585 -0
- data/asciidoc/CHANGELOG.txt +1595 -0
- data/asciidoc/COPYING +339 -0
- data/asciidoc/COPYRIGHT +18 -0
- data/asciidoc/INSTALL +82 -0
- data/asciidoc/INSTALL.txt +71 -0
- data/asciidoc/README +46 -0
- data/asciidoc/README.txt +36 -0
- data/asciidoc/a2x +641 -0
- data/asciidoc/asciidoc.conf +404 -0
- data/asciidoc/asciidoc.py +4255 -0
- data/asciidoc/common.aap +9 -0
- data/asciidoc/dblatex/asciidoc-dblatex.sty +18 -0
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +17 -0
- data/asciidoc/dblatex/dblatex-readme.txt +22 -0
- data/asciidoc/doc/a2x.1 +246 -0
- data/asciidoc/doc/a2x.1.txt +195 -0
- data/asciidoc/doc/article.css-embedded.html +579 -0
- data/asciidoc/doc/article.html +62 -0
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +124 -0
- data/asciidoc/doc/asciidoc-revhistory.xml +27 -0
- data/asciidoc/doc/asciidoc.1 +161 -0
- data/asciidoc/doc/asciidoc.1.css-embedded.html +562 -0
- data/asciidoc/doc/asciidoc.1.css.html +212 -0
- data/asciidoc/doc/asciidoc.1.html +190 -0
- data/asciidoc/doc/asciidoc.1.txt +118 -0
- data/asciidoc/doc/asciidoc.conf +8 -0
- data/asciidoc/doc/asciidoc.css-embedded.html +7954 -0
- data/asciidoc/doc/asciidoc.css.html +7553 -0
- data/asciidoc/doc/asciidoc.dict +673 -0
- data/asciidoc/doc/asciidoc.html +3502 -0
- data/asciidoc/doc/asciidoc.txt +4757 -0
- data/asciidoc/doc/asciimath.txt +47 -0
- data/asciidoc/doc/book-multi.css-embedded.html +575 -0
- data/asciidoc/doc/book-multi.html +72 -0
- data/asciidoc/doc/book-multi.txt +159 -0
- data/asciidoc/doc/book.css-embedded.html +585 -0
- data/asciidoc/doc/book.html +60 -0
- data/asciidoc/doc/book.txt +133 -0
- data/asciidoc/doc/customers.csv +18 -0
- data/asciidoc/doc/faq.txt +262 -0
- data/asciidoc/doc/latex-backend.html +224 -0
- data/asciidoc/doc/latex-backend.txt +193 -0
- data/asciidoc/doc/latexmath.txt +35 -0
- data/asciidoc/doc/main.aap +293 -0
- data/asciidoc/doc/music-filter.html +513 -0
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +158 -0
- data/asciidoc/doc/source-highlight-filter.html +183 -0
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +174 -0
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +71 -0
- data/asciidoc/docbook-xsl/chunked.xsl +19 -0
- data/asciidoc/docbook-xsl/common.xsl +67 -0
- data/asciidoc/docbook-xsl/fo.xsl +117 -0
- data/asciidoc/docbook-xsl/htmlhelp.xsl +17 -0
- data/asciidoc/docbook-xsl/manpage.xsl +28 -0
- data/asciidoc/docbook-xsl/shaded-literallayout.patch +32 -0
- data/asciidoc/docbook-xsl/xhtml.xsl +14 -0
- data/asciidoc/docbook.conf +606 -0
- data/asciidoc/examples/website/CHANGELOG.html +3828 -0
- data/asciidoc/examples/website/INSTALL.html +163 -0
- data/asciidoc/examples/website/README-website.html +129 -0
- data/asciidoc/examples/website/README-website.txt +29 -0
- data/asciidoc/examples/website/README.html +125 -0
- data/asciidoc/examples/website/a2x.1.html +395 -0
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +165 -0
- data/asciidoc/examples/website/asciimath.html +157 -0
- data/asciidoc/examples/website/build-website.sh +25 -0
- data/asciidoc/examples/website/downloads.html +219 -0
- data/asciidoc/examples/website/downloads.txt +98 -0
- data/asciidoc/examples/website/faq.html +372 -0
- data/asciidoc/examples/website/index.html +398 -0
- data/asciidoc/examples/website/index.txt +222 -0
- data/asciidoc/examples/website/latex-backend.html +640 -0
- data/asciidoc/examples/website/latexmath.html +119 -0
- data/asciidoc/examples/website/layout1.conf +161 -0
- data/asciidoc/examples/website/layout1.css +65 -0
- data/asciidoc/examples/website/layout2.conf +158 -0
- data/asciidoc/examples/website/layout2.css +93 -0
- data/asciidoc/examples/website/manpage.html +266 -0
- data/asciidoc/examples/website/music-filter.html +242 -0
- data/asciidoc/examples/website/music1.abc +12 -0
- data/asciidoc/examples/website/music1.png +0 -0
- data/asciidoc/examples/website/music2.ly +9 -0
- data/asciidoc/examples/website/music2.png +0 -0
- data/asciidoc/examples/website/source-highlight-filter.html +251 -0
- data/asciidoc/examples/website/support.html +78 -0
- data/asciidoc/examples/website/support.txt +5 -0
- data/asciidoc/examples/website/userguide.html +7597 -0
- data/asciidoc/examples/website/version9.html +143 -0
- data/asciidoc/examples/website/version9.txt +48 -0
- data/asciidoc/filters/code-filter-readme.txt +37 -0
- data/asciidoc/filters/code-filter-test-c++.txt +7 -0
- data/asciidoc/filters/code-filter-test.txt +15 -0
- data/asciidoc/filters/code-filter.conf +8 -0
- data/asciidoc/filters/code-filter.py +239 -0
- data/asciidoc/filters/music-filter-test.txt +40 -0
- data/asciidoc/filters/music-filter.conf +40 -0
- data/asciidoc/filters/music2png.py +189 -0
- data/asciidoc/filters/source-highlight-filter-test.txt +19 -0
- data/asciidoc/filters/source-highlight-filter.conf +100 -0
- data/asciidoc/help.conf +213 -0
- data/asciidoc/html4.conf +363 -0
- data/asciidoc/images/highlighter.png +0 -0
- data/asciidoc/images/icons/README +5 -0
- data/asciidoc/images/icons/callouts/1.png +0 -0
- data/asciidoc/images/icons/callouts/10.png +0 -0
- data/asciidoc/images/icons/callouts/11.png +0 -0
- data/asciidoc/images/icons/callouts/12.png +0 -0
- data/asciidoc/images/icons/callouts/13.png +0 -0
- data/asciidoc/images/icons/callouts/14.png +0 -0
- data/asciidoc/images/icons/callouts/15.png +0 -0
- data/asciidoc/images/icons/callouts/2.png +0 -0
- data/asciidoc/images/icons/callouts/3.png +0 -0
- data/asciidoc/images/icons/callouts/4.png +0 -0
- data/asciidoc/images/icons/callouts/5.png +0 -0
- data/asciidoc/images/icons/callouts/6.png +0 -0
- data/asciidoc/images/icons/callouts/7.png +0 -0
- data/asciidoc/images/icons/callouts/8.png +0 -0
- data/asciidoc/images/icons/callouts/9.png +0 -0
- data/asciidoc/images/icons/caution.png +0 -0
- data/asciidoc/images/icons/example.png +0 -0
- data/asciidoc/images/icons/home.png +0 -0
- data/asciidoc/images/icons/important.png +0 -0
- data/asciidoc/images/icons/next.png +0 -0
- data/asciidoc/images/icons/note.png +0 -0
- data/asciidoc/images/icons/prev.png +0 -0
- data/asciidoc/images/icons/tip.png +0 -0
- data/asciidoc/images/icons/up.png +0 -0
- data/asciidoc/images/icons/warning.png +0 -0
- data/asciidoc/images/smallnew.png +0 -0
- data/asciidoc/images/tiger.png +0 -0
- data/asciidoc/install.sh +55 -0
- data/asciidoc/javascripts/ASCIIMathML.js +938 -0
- data/asciidoc/javascripts/LaTeXMathML.js +1223 -0
- data/asciidoc/javascripts/toc.js +69 -0
- data/asciidoc/lang-es.conf +15 -0
- data/asciidoc/latex.conf +663 -0
- data/asciidoc/linuxdoc.conf +285 -0
- data/asciidoc/math.conf +50 -0
- data/asciidoc/stylesheets/docbook-xsl.css +271 -0
- data/asciidoc/stylesheets/xhtml-deprecated-manpage.css +21 -0
- data/asciidoc/stylesheets/xhtml-deprecated.css +247 -0
- data/asciidoc/stylesheets/xhtml11-manpage.css +18 -0
- data/asciidoc/stylesheets/xhtml11-quirks.css +49 -0
- data/asciidoc/stylesheets/xhtml11.css +284 -0
- data/asciidoc/t.conf +20 -0
- data/asciidoc/text.conf +16 -0
- data/asciidoc/vim/ftdetect/asciidoc_filetype.vim +53 -0
- data/asciidoc/vim/syntax/asciidoc.vim +139 -0
- data/asciidoc/xhtml-deprecated-css.conf +235 -0
- data/asciidoc/xhtml-deprecated.conf +351 -0
- data/asciidoc/xhtml11-quirks.conf +57 -0
- data/asciidoc/xhtml11.conf +514 -0
- data/bin/mizuho +40 -0
- data/lib/mizuho/chapter.rb +54 -0
- data/lib/mizuho/generator.rb +106 -0
- data/lib/mizuho/heading.rb +46 -0
- data/lib/mizuho/parser.rb +99 -0
- data/lib/mizuho/template.rb +50 -0
- data/mizuho.gemspec +34 -0
- data/templates/asciidoc.css +358 -0
- data/templates/asciidoc.html.erb +86 -0
- data/templates/manualsonrails.css +165 -0
- data/templates/manualsonrails.html.erb +97 -0
- data/test/parser_spec.rb +190 -0
- data/test/spec_helper.rb +43 -0
- metadata +234 -0
@@ -0,0 +1,372 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
+
<meta name="generator" content="AsciiDoc 8.2.7" />
|
7
|
+
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
8
|
+
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
9
|
+
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
10
|
+
<script type="text/javascript">
|
11
|
+
/*<![CDATA[*/
|
12
|
+
window.onload = function(){generateToc(2)}
|
13
|
+
/*]]>*/
|
14
|
+
</script>
|
15
|
+
<script type="text/javascript" src="./toc.js"></script>
|
16
|
+
<title>AsciiDoc Frequently Asked Questions</title>
|
17
|
+
</head>
|
18
|
+
<body>
|
19
|
+
<div id="layout-banner">
|
20
|
+
<div id="layout-title">AsciiDoc</div>
|
21
|
+
<div id="layout-description">Text based document generation</div>
|
22
|
+
</div>
|
23
|
+
<table>
|
24
|
+
<tr valign="top">
|
25
|
+
<td id="layout-menu">
|
26
|
+
<div>»<a href="index.html">Home</a></div>
|
27
|
+
<div>»<a href="manpage.html">Man Page</a></div>
|
28
|
+
<div>»<a href="userguide.html">User Guide</a></div>
|
29
|
+
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
|
30
|
+
<div>»<a href="a2x.1.html">a2x</a></div>
|
31
|
+
<div>»<a href="README.html">README</a></div>
|
32
|
+
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
|
33
|
+
<div>»<a href="INSTALL.html">Installation</a></div>
|
34
|
+
<div>»<a href="downloads.html">Downloads</a></div>
|
35
|
+
<div>»<a href="faq.html">FAQ</a></div>
|
36
|
+
<div>»<a href="support.html">Support</a></div>
|
37
|
+
<div id="page-source">»<a href="faq.txt">Page Source</a></div>
|
38
|
+
</td>
|
39
|
+
<td>
|
40
|
+
<div id="layout-content">
|
41
|
+
<div id="header">
|
42
|
+
<h1>AsciiDoc Frequently Asked Questions</h1>
|
43
|
+
</div>
|
44
|
+
<div id="toc">
|
45
|
+
<div id="toctitle">Table of Contents</div>
|
46
|
+
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
|
47
|
+
</div>
|
48
|
+
<div id="preamble">
|
49
|
+
<div class="sectionbody">
|
50
|
+
<div class="para"><p>An embryonic <em>AsciiDoc</em> FAQ.</p></div>
|
51
|
+
</div>
|
52
|
+
</div>
|
53
|
+
<h2 id="_how_can_i_preserve_paragraph_line_boundaries">1. How can I preserve paragraph line boundaries?</h2>
|
54
|
+
<div class="sectionbody">
|
55
|
+
<div class="para"><p>Apply the The <em>verse</em> paragraph style, the rendered text preserves
|
56
|
+
line boundaries and is useful for lyrics and poems. For example:</p></div>
|
57
|
+
<div class="listingblock">
|
58
|
+
<div class="content">
|
59
|
+
<pre><tt>[verse]
|
60
|
+
Consul *necessitatibus* per id,
|
61
|
+
consetetur, eu pro everti postulant
|
62
|
+
homero verear ea mea, qui.</tt></pre>
|
63
|
+
</div></div>
|
64
|
+
</div>
|
65
|
+
<h2 id="_how_can_i_include_non_breaking_space_characters">2. How can I include non-breaking space characters?</h2>
|
66
|
+
<div class="sectionbody">
|
67
|
+
<div class="para"><p>The predefined <tt>{nbsp}</tt> attribute reference will be replaced by a
|
68
|
+
non-breaking space character.</p></div>
|
69
|
+
</div>
|
70
|
+
<h2 id="_how_do_i_include_spaces_in_url_addresses">3. How do I include spaces in URL addresses?</h2>
|
71
|
+
<div class="sectionbody">
|
72
|
+
<div class="para"><p>URL inline macro targets (addresses) cannot contain white space
|
73
|
+
characters. If you need spaces encode them as <tt>%20</tt>. For example:</p></div>
|
74
|
+
<div class="literalblock">
|
75
|
+
<div class="content">
|
76
|
+
<pre><tt>image:large%20image.png[]
|
77
|
+
http://www.foo.bar.com/an%20example%20document.html</tt></pre>
|
78
|
+
</div></div>
|
79
|
+
</div>
|
80
|
+
<h2 id="_how_can_i_get_asciidoc_to_assign_the_correct_docbook_language_attribute">4. How can I get AsciiDoc to assign the correct DocBook language attribute?</h2>
|
81
|
+
<div class="sectionbody">
|
82
|
+
<div class="para"><p>Set the <em>AsciiDoc</em> <em>lang</em> attribute to the appropriate language code.
|
83
|
+
For example:</p></div>
|
84
|
+
<div class="literalblock">
|
85
|
+
<div class="content">
|
86
|
+
<pre><tt>$ a2x -a lang=es doc/article.txt</tt></pre>
|
87
|
+
</div></div>
|
88
|
+
<div class="para"><p>This will ensure that downstream DocBook processing will generate the
|
89
|
+
correct language specific document headings (things like table of
|
90
|
+
contents, revision history, figure and table captions, admonition
|
91
|
+
captions).</p></div>
|
92
|
+
</div>
|
93
|
+
<h2 id="_why_does_asciidoc_give_me_a_8220_malformed_author_8221_error">5. Why does AsciiDoc give me a “malformed author” error?</h2>
|
94
|
+
<div class="sectionbody">
|
95
|
+
<div class="para"><p>This is normally because there are more than three names (up to three
|
96
|
+
are expected: first name, middle name and last name). For example,
|
97
|
+
this author line would result in an error:</p></div>
|
98
|
+
<div class="literalblock">
|
99
|
+
<div class="content">
|
100
|
+
<pre><tt>Vincent Willem van Gogh</tt></pre>
|
101
|
+
</div></div>
|
102
|
+
<div class="para"><p>You can enter multi-word first, middle and last names in the author
|
103
|
+
line using the underscore as a word separator. For example:</p></div>
|
104
|
+
<div class="literalblock">
|
105
|
+
<div class="content">
|
106
|
+
<pre><tt>Vincent Willem van_Gogh</tt></pre>
|
107
|
+
</div></div>
|
108
|
+
<div class="para"><p>You could also resolve the problem by replacing the author line with
|
109
|
+
explicit attribute entries:</p></div>
|
110
|
+
<div class="literalblock">
|
111
|
+
<div class="content">
|
112
|
+
<pre><tt>:First name: Vincent
|
113
|
+
:Middle name: Willem
|
114
|
+
:Last name: Van Gogh</tt></pre>
|
115
|
+
</div></div>
|
116
|
+
</div>
|
117
|
+
<h2 id="_how_can_i_assign_multiple_author_names">6. How can I assign multiple author names?</h2>
|
118
|
+
<div class="sectionbody">
|
119
|
+
<div class="para"><p>A quick way to do this is put both authors in a single first name, for
|
120
|
+
example:</p></div>
|
121
|
+
<div class="literalblock">
|
122
|
+
<div class="content">
|
123
|
+
<pre><tt>My Document
|
124
|
+
===========
|
125
|
+
:Author: Bill_and_Ben_the_Flowerpot_Men
|
126
|
+
:Author Initials: BB & BC</tt></pre>
|
127
|
+
</div></div>
|
128
|
+
<div class="para"><p><tt>asciidoc(1)</tt> replaces the underscores with spaces.</p></div>
|
129
|
+
<div class="para"><p>The longer, but semantically correct way, is to override the
|
130
|
+
<tt>[header]</tt> configuration file section in a document specific <tt>.conf</tt>
|
131
|
+
file. For example if your document is <tt>mydoc.txt</tt> then a file called
|
132
|
+
<tt>mydoc.conf</tt> in the document directory would be picked up
|
133
|
+
automatically by <tt>asciidoc(1)</tt>. Copy and paste the default
|
134
|
+
<tt>docbook.conf</tt> file <tt>[header]</tt> to <tt>mydoc.conf</tt> and modify the author
|
135
|
+
related markup:</p></div>
|
136
|
+
<div class="literalblock">
|
137
|
+
<div class="content">
|
138
|
+
<pre><tt>[header]
|
139
|
+
:
|
140
|
+
<authorgroup>...
|
141
|
+
:</tt></pre>
|
142
|
+
</div></div>
|
143
|
+
</div>
|
144
|
+
<h2 id="_how_can_i_escape_asciidoc_markup">7. How can I escape AsciiDoc markup?</h2>
|
145
|
+
<div class="sectionbody">
|
146
|
+
<div class="para"><p>Most <em>AsciiDoc</em> inline elements can be suppressed by preceding them with
|
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
|
186
|
+
list entry. Use the predefined <tt>{two_colons}</tt> and <tt>{two_semicolons}</tt>
|
187
|
+
to suppress this behavior, for example:</p></div>
|
188
|
+
<div class="literalblock">
|
189
|
+
<div class="content">
|
190
|
+
<pre><tt>Qui in magna commodo{two_colons} est labitur dolorum an. Est ne
|
191
|
+
magna primis adolescens.</tt></pre>
|
192
|
+
</div></div>
|
193
|
+
<div class="para"><p>Will be rendered as:</p></div>
|
194
|
+
<div class="para"><p>Qui in magna commodo:: est labitur dolorum an. Est ne
|
195
|
+
magna primis adolescens.</p></div>
|
196
|
+
</div>
|
197
|
+
<h2 id="_how_can_i_disable_a_quoted_text_substitution">9. How can I disable a quoted text substitution?</h2>
|
198
|
+
<div class="sectionbody">
|
199
|
+
<div class="para"><p>Omitting the tag will disable quoting. For example, if you don't want
|
200
|
+
superscripts or subscripts then put the following in a custom
|
201
|
+
configuration file or edit the global <tt>asciidoc.conf</tt> configuration
|
202
|
+
file:</p></div>
|
203
|
+
<div class="listingblock">
|
204
|
+
<div class="content">
|
205
|
+
<pre><tt>[quotes]
|
206
|
+
^=
|
207
|
+
~=</tt></pre>
|
208
|
+
</div></div>
|
209
|
+
</div>
|
210
|
+
<h2 id="_i_have_a_paragraph_containing_some_funky_urls_is_there_a_way_to_suppress_asciidoc_substitutions_in_the_url_address">10. I have a paragraph containing some funky URLs, is there a way to suppress AsciiDoc substitutions in the URL address?</h2>
|
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>
|
214
|
+
<div class="listingblock">
|
215
|
+
<div class="content">
|
216
|
+
<pre><tt>[subs="macros"]
|
217
|
+
~subscripts~ and ^superscripts^ quotes won't be substituted.
|
218
|
+
Nor will the non-alphanumeric characters in the following URL:
|
219
|
+
http://host/~user/file#_anchor_tag_str_</tt></pre>
|
220
|
+
</div></div>
|
221
|
+
</div>
|
222
|
+
<h2 id="_how_can_i_customize_the_localdate_format">11. How can I customize the {localdate} format?</h2>
|
223
|
+
<div class="sectionbody">
|
224
|
+
<div class="para"><p>The default format for the <tt>{localdate}</tt> attribute is the ISO 8601
|
225
|
+
<tt>yyyy-mm-dd</tt> format. You can change this format by explicitly setting
|
226
|
+
the <tt>{localdate}</tt> attribute. For example by setting it using the
|
227
|
+
<tt>asciidoc(1)</tt> <tt>-a</tt> command-line option:</p></div>
|
228
|
+
<div class="literalblock">
|
229
|
+
<div class="content">
|
230
|
+
<pre><tt>$ asciidoc -a localdate=`date +%d-%d-%Y` mydoc.txt</tt></pre>
|
231
|
+
</div></div>
|
232
|
+
<div class="para"><p>You could also set it by adding an Attribute Entry to your souce
|
233
|
+
document, for example:</p></div>
|
234
|
+
<div class="literalblock">
|
235
|
+
<div class="content">
|
236
|
+
<pre><tt>:localdate: {sys: date +%Y-%m-%d}</tt></pre>
|
237
|
+
</div></div>
|
238
|
+
<div class="para"><p>Since it's set using an executable attribute you'll also need to
|
239
|
+
include the <tt>—unsafe</tt> option when you run asciidoc).</p></div>
|
240
|
+
</div>
|
241
|
+
<h2 id="_why_doesn_t_asciidoc_support_strike_through_text">12. Why doesn't AsciiDoc support strike through text?</h2>
|
242
|
+
<div class="sectionbody">
|
243
|
+
<div class="para"><p>The reason it's not in the distribution is that DocBook does not have
|
244
|
+
provision for strike through text and one of the <em>AsciiDoc</em> design goals
|
245
|
+
is that <em>AsciiDoc</em> markup should be applicable to all output formats.</p></div>
|
246
|
+
<div class="para"><p>Strike through is normally used to mark deleted text — a more
|
247
|
+
comprehensive way to manage document revisions is to use a version
|
248
|
+
control system such as Subversion. You can also use the <em>AsciiDoc</em>
|
249
|
+
<em>CommentLines</em> and <em>CommentBlocks</em> to retain revised text in the
|
250
|
+
source document.</p></div>
|
251
|
+
<div class="para"><p>If you really need strike through text for (X)HTML outputs then adding
|
252
|
+
the following to a configuration file will allow you to quote strike
|
253
|
+
through text with hyphen characters:</p></div>
|
254
|
+
<div class="listingblock">
|
255
|
+
<div class="content">
|
256
|
+
<pre><tt> ifdef::basebackend-html[]
|
257
|
+
|
258
|
+
[quotes]
|
259
|
+
-=strikethrough
|
260
|
+
|
261
|
+
[tags]
|
262
|
+
strikethrough=<span style="text-decoration: line-through;">|</span>
|
263
|
+
|
264
|
+
endif::basebackend-html[]</tt></pre>
|
265
|
+
</div></div>
|
266
|
+
</div>
|
267
|
+
<h2 id="_where_can_i_find_examples_of_commands_used_to_build_output_documents">13. Where can I find examples of commands used to build output documents?</h2>
|
268
|
+
<div class="sectionbody">
|
269
|
+
<div class="para"><p>The User Guide has some. You could also look at <tt>./doc/main.aap</tt> in
|
270
|
+
the <em>AsciiDoc</em> distribution, it has all the commands used to build the
|
271
|
+
<em>AsciiDoc</em> documentation (even if you don't use A-A-P you'll still find
|
272
|
+
it useful).</p></div>
|
273
|
+
</div>
|
274
|
+
<h2 id="_how_can_i_place_a_backslash_character_in_front_of_an_attribute_reference_without_escaping_the_reference">14. How can I place a backslash character in front of an attribute reference without escaping the reference?</h2>
|
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>
|
290
|
+
<div class="sectionbody">
|
291
|
+
<div class="para"><p><tt><simpara></tt> is really the same as <tt><para></tt> except it can't contain
|
292
|
+
block elements — this matched, more closely, the <em>AsciiDoc</em> paragraph
|
293
|
+
semantics.</p></div>
|
294
|
+
</div>
|
295
|
+
<h2 id="_how_can_i_format_text_inside_a_listting_block">16. How can I format text inside a listting block?</h2>
|
296
|
+
<div class="sectionbody">
|
297
|
+
<div class="para"><p>By default only <em>specialcharacters</em> and <em>callouts</em> are substituted in
|
298
|
+
listing blocks; you can add quotes substitutions by explicitly setting
|
299
|
+
the block <em>subs</em> attribute, for example:</p></div>
|
300
|
+
<div class="literalblock">
|
301
|
+
<div class="content">
|
302
|
+
<pre><tt>[subs="specialcharacters,callouts,quotes"]
|
303
|
+
------------------------------------------
|
304
|
+
$ ls *-al*
|
305
|
+
------------------------------------------</tt></pre>
|
306
|
+
</div></div>
|
307
|
+
<div class="para"><p>The <tt>-al</tt> will rendered bold. Note that:</p></div>
|
308
|
+
<div class="ilist"><ul>
|
309
|
+
<li>
|
310
|
+
<p>
|
311
|
+
You would need to explicitly escape text you didn't want quoted.
|
312
|
+
</p>
|
313
|
+
</li>
|
314
|
+
<li>
|
315
|
+
<p>
|
316
|
+
Don't do this in source code listing blocks because it modifies the
|
317
|
+
source code which confuses the syntax highlighter.
|
318
|
+
</p>
|
319
|
+
</li>
|
320
|
+
<li>
|
321
|
+
<p>
|
322
|
+
This only works if your DocBook processor recognizes DocBook
|
323
|
+
<tt><emphasis></tt> elements inside <tt><screen></tt> elements.
|
324
|
+
</p>
|
325
|
+
</li>
|
326
|
+
</ul></div>
|
327
|
+
</div>
|
328
|
+
<h2 id="_why_doesn_t_the_include1_macro_work">17. Why doesn't the include1::[] macro work?</h2>
|
329
|
+
<div class="sectionbody">
|
330
|
+
<div class="para"><p>Internally the <tt>include1</tt> macro is translated to the <tt>include1</tt> system
|
331
|
+
attribute which means it must be evaluated in a region where attribute
|
332
|
+
substitution is enabled. For example, if you want to evaluate it
|
333
|
+
inside a listing block you will need to enable attribute substitution
|
334
|
+
inside the block, for example:</p></div>
|
335
|
+
<div class="literalblock">
|
336
|
+
<div class="content">
|
337
|
+
<pre><tt>[subs="attributes"]
|
338
|
+
-----------------------------------------
|
339
|
+
include1::blogpost_media_processing.txt[]
|
340
|
+
-----------------------------------------</tt></pre>
|
341
|
+
</div></div>
|
342
|
+
<div class="para"><p>Or, preferably, use the <tt>include</tt> block macro instead.</p></div>
|
343
|
+
</div>
|
344
|
+
<div id="footer">
|
345
|
+
<div id="footer-text">
|
346
|
+
Version 8.2.7<br />
|
347
|
+
Last updated 2008-07-04 23:29:23 NZDT
|
348
|
+
</div>
|
349
|
+
<div id="footer-badges">
|
350
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
351
|
+
<img style="border:none; width:88px; height:31px;"
|
352
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
353
|
+
alt="Valid XHTML 1.1!" />
|
354
|
+
</a>
|
355
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
356
|
+
<img style="border:none; width:88px; height:31px;"
|
357
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
358
|
+
alt="Valid CSS!" />
|
359
|
+
</a>
|
360
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
361
|
+
<img style="border:none; width:110px; height:32px;"
|
362
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
363
|
+
alt="Get Firefox!" />
|
364
|
+
</a>
|
365
|
+
</div>
|
366
|
+
</div>
|
367
|
+
</div>
|
368
|
+
</td>
|
369
|
+
</tr>
|
370
|
+
</table>
|
371
|
+
</body>
|
372
|
+
</html>
|
@@ -0,0 +1,398 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
+
<meta name="generator" content="AsciiDoc 8.2.7" />
|
7
|
+
<meta name="description" content="Text based document generation" />
|
8
|
+
<meta name="keywords" content="text to HTML, text to DocBook, text to XML, AsciiDoc" />
|
9
|
+
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
10
|
+
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
11
|
+
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
/*<![CDATA[*/
|
14
|
+
window.onload = function(){generateToc(1)}
|
15
|
+
/*]]>*/
|
16
|
+
</script>
|
17
|
+
<script type="text/javascript" src="./toc.js"></script>
|
18
|
+
<title>AsciiDoc Home Page</title>
|
19
|
+
</head>
|
20
|
+
<body>
|
21
|
+
<div id="layout-banner">
|
22
|
+
<div id="layout-title">AsciiDoc</div>
|
23
|
+
<div id="layout-description">Text based document generation</div>
|
24
|
+
</div>
|
25
|
+
<table>
|
26
|
+
<tr valign="top">
|
27
|
+
<td id="layout-menu">
|
28
|
+
<div>»<a href="index.html">Home</a></div>
|
29
|
+
<div>»<a href="manpage.html">Man Page</a></div>
|
30
|
+
<div>»<a href="userguide.html">User Guide</a></div>
|
31
|
+
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
|
32
|
+
<div>»<a href="a2x.1.html">a2x</a></div>
|
33
|
+
<div>»<a href="README.html">README</a></div>
|
34
|
+
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
|
35
|
+
<div>»<a href="INSTALL.html">Installation</a></div>
|
36
|
+
<div>»<a href="downloads.html">Downloads</a></div>
|
37
|
+
<div>»<a href="faq.html">FAQ</a></div>
|
38
|
+
<div>»<a href="support.html">Support</a></div>
|
39
|
+
<div id="page-source">»<a href="index.txt">Page Source</a></div>
|
40
|
+
</td>
|
41
|
+
<td>
|
42
|
+
<div id="layout-content">
|
43
|
+
<div id="header">
|
44
|
+
<h1>AsciiDoc Home Page</h1>
|
45
|
+
</div>
|
46
|
+
<div id="toc">
|
47
|
+
<div id="toctitle">Table of Contents</div>
|
48
|
+
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
|
49
|
+
</div>
|
50
|
+
<div id="preamble">
|
51
|
+
<div class="sectionbody">
|
52
|
+
<div class="sidebarblock">
|
53
|
+
<div class="sidebar-content">
|
54
|
+
<div class="sidebar-title">4 July 2008: AsciiDoc 8.2.7 Released</div>
|
55
|
+
<div class="para"><p>Useful additions include:</p></div>
|
56
|
+
<div class="ilist"><ul>
|
57
|
+
<li>
|
58
|
+
<p>
|
59
|
+
<a href="http://dblatex.sourceforge.net/">dblatex</a> is now fully supported by
|
60
|
+
<tt>a2x(1)</tt> and is the default <tt>a2x(1)</tt> PDF generator.
|
61
|
+
</p>
|
62
|
+
</li>
|
63
|
+
<li>
|
64
|
+
<p>
|
65
|
+
Added <tt>dvi</tt>, <tt>ps</tt> and <tt>tex</tt> output format options to <tt>a2x(1)</tt>
|
66
|
+
(courtesy of <tt>dblatex(1)</tt>).
|
67
|
+
</p>
|
68
|
+
</li>
|
69
|
+
<li>
|
70
|
+
<p>
|
71
|
+
URLs and email addresses are recognized without having to use the
|
72
|
+
macro syntax.
|
73
|
+
</p>
|
74
|
+
</li>
|
75
|
+
<li>
|
76
|
+
<p>
|
77
|
+
<a href="source-highlight-filter.html">Source code paragraphs</a> make small
|
78
|
+
code examples easier to enter.
|
79
|
+
</p>
|
80
|
+
</li>
|
81
|
+
</ul></div>
|
82
|
+
<div class="para"><p>Read the <a href="CHANGELOG.html">CHANGELOG</a> for a full description of all
|
83
|
+
the other additions and changes.</p></div>
|
84
|
+
<div class="para"><p><a href="mailto:srackham@gmail.com"><em>Stuart Rackham</em></a></p></div>
|
85
|
+
</div></div>
|
86
|
+
</div>
|
87
|
+
</div>
|
88
|
+
<h2 id="_introduction">Introduction</h2>
|
89
|
+
<div class="sectionbody">
|
90
|
+
<div class="para"><p><em>AsciiDoc</em> is a text document format for writing short documents,
|
91
|
+
articles, books and UNIX man pages. <em>AsciiDoc</em> files can be translated
|
92
|
+
to HTML and DocBook markups using the <tt>asciidoc(1)</tt> command.</p></div>
|
93
|
+
<div class="para"><p><em>AsciiDoc</em> is highly configurable: both the <em>AsciiDoc</em> source file syntax
|
94
|
+
and the backend output markups (which can be almost any type of
|
95
|
+
SGML/XML markup) can be customized and extended by the user.</p></div>
|
96
|
+
<div class="admonitionblock">
|
97
|
+
<table><tr>
|
98
|
+
<td class="icon">
|
99
|
+
<img src="./images/icons/tip.png" alt="Tip" />
|
100
|
+
</td>
|
101
|
+
<td class="content">The pages you are reading were written using <em>AsciiDoc</em>, to view
|
102
|
+
the corresponding <em>AsciiDoc</em> source click on the <strong>Page Source</strong> menu item
|
103
|
+
in the left hand margin.</td>
|
104
|
+
</tr></table>
|
105
|
+
</div>
|
106
|
+
</div>
|
107
|
+
<h2 id="_overview_and_examples">Overview and Examples</h2>
|
108
|
+
<div class="sectionbody">
|
109
|
+
<div class="para"><p>You write an <em>AsciiDoc</em> document the same way you would write a
|
110
|
+
normal text document, there are no markup tags or weird format
|
111
|
+
notations. <em>AsciiDoc</em> files are designed to be viewed, edited and
|
112
|
+
printed directly or translated to other presentation formats using
|
113
|
+
the <tt>asciidoc(1)</tt> command.</p></div>
|
114
|
+
<div class="para"><p>The <tt>asciidoc(1)</tt> command translates <em>AsciiDoc</em> files to HTML, XHTML and
|
115
|
+
DocBook markups. DocBook can be post-processed to presentation
|
116
|
+
formats such as HTML, PDF, DVI, LaTeX, roff, and Postscript using
|
117
|
+
readily available Open Source tools.</p></div>
|
118
|
+
<h3 id="_example_articles">Example Articles</h3><div style="clear:left"></div>
|
119
|
+
<div class="ilist"><ul>
|
120
|
+
<li>
|
121
|
+
<p>
|
122
|
+
This version of the
|
123
|
+
<a href="asciidoc.css-embedded.html"><em>AsciiDoc</em> User Guide</a>
|
124
|
+
was generated by <em>AsciiDoc</em> from
|
125
|
+
<a href="asciidoc.txt">this <em>AsciiDoc</em> file</a>.
|
126
|
+
</p>
|
127
|
+
</li>
|
128
|
+
<li>
|
129
|
+
<p>
|
130
|
+
Here's the <a href="asciidoc.html">same document</a> created by first
|
131
|
+
generating DocBook markup using <em>AsciiDoc</em> and then converting the
|
132
|
+
DocBook markup to HTML using <em>DocBook XSL Stylesheets</em>.
|
133
|
+
</p>
|
134
|
+
</li>
|
135
|
+
<li>
|
136
|
+
<p>
|
137
|
+
The User Guide again, this time a
|
138
|
+
<a href="chunked/index.html">chunked version</a>.
|
139
|
+
</p>
|
140
|
+
</li>
|
141
|
+
<li>
|
142
|
+
<p>
|
143
|
+
This <a href="article.txt"><em>AsciiDoc</em> article template</a> produced
|
144
|
+
this <a href="article.html">HTML file</a> and this
|
145
|
+
<a href="article.pdf">PDF file</a> via DocBook markup generated by <em>AsciiDoc</em>.
|
146
|
+
</p>
|
147
|
+
</li>
|
148
|
+
<li>
|
149
|
+
<p>
|
150
|
+
This <a href="asciidoc.pdf">PDF formatted User Guide</a> was generated from
|
151
|
+
<tt>asciidoc(1)</tt> DocBook output.
|
152
|
+
</p>
|
153
|
+
</li>
|
154
|
+
</ul></div>
|
155
|
+
<h3 id="_example_books">Example Books</h3><div style="clear:left"></div>
|
156
|
+
<div class="para"><p><em>AsciiDoc</em> markup supports all the standard DocBook frontmatter and
|
157
|
+
backmatter sections (dedication, preface, bibliography, glossary,
|
158
|
+
index, colophon) plus footnotes and index entries.</p></div>
|
159
|
+
<div class="vlist"><dl>
|
160
|
+
<dt>
|
161
|
+
Book
|
162
|
+
</dt>
|
163
|
+
<dd>
|
164
|
+
<p>
|
165
|
+
This <a href="book.txt"><em>AsciiDoc</em> book's</a> DocBook output
|
166
|
+
produced <a href="book.html">this HTML file</a> using the
|
167
|
+
<em>DocBook XSL Stylesheets</em>.
|
168
|
+
</p>
|
169
|
+
</dd>
|
170
|
+
<dt>
|
171
|
+
Multi-part book
|
172
|
+
</dt>
|
173
|
+
<dd>
|
174
|
+
<p>
|
175
|
+
This <a href="book-multi.txt">multi-part <em>AsciiDoc</em> book's</a>
|
176
|
+
DocBook output produced <a href="book-multi.html">this HTML file</a>
|
177
|
+
using the <em>DocBook XSL Stylesheets</em>.
|
178
|
+
</p>
|
179
|
+
</dd>
|
180
|
+
</dl></div>
|
181
|
+
<h3 id="_example_unix_man_pages">Example UNIX Man Pages</h3><div style="clear:left"></div>
|
182
|
+
<div class="para"><p>HTML formatted <em>AsciiDoc</em> man pages
|
183
|
+
<a href="asciidoc.1.css-embedded.html">with stylesheets</a> and
|
184
|
+
<a href="asciidoc.1.html">without stylesheets</a> were generated by <em>AsciiDoc</em>
|
185
|
+
from <a href="asciidoc.1.txt">this file</a>.</p></div>
|
186
|
+
<div class="para"><p>This <a href="asciidoc.1">roff formatted man page</a> was generated from
|
187
|
+
<tt>asciidoc(1)</tt> DocBook output using <tt>xsltproc(1)</tt> and DocBook XSL
|
188
|
+
Stylesheets.</p></div>
|
189
|
+
<h3 id="_example_web_site">Example Web Site</h3><div style="clear:left"></div>
|
190
|
+
<div class="para"><p>The <a href="README-website.html"><em>AsciiDoc</em> website</a> is included in the
|
191
|
+
<em>AsciiDoc</em> distribution (in <tt>./examples/website/</tt>) as example website
|
192
|
+
built using <em>AsciiDoc</em>. See <tt>./examples/website/README-website.txt</tt>.</p></div>
|
193
|
+
</div>
|
194
|
+
<h2 id="_music_filter">Music Filter</h2>
|
195
|
+
<div class="sectionbody">
|
196
|
+
<div class="para"><p>A <a href="music-filter.html">music filter</a> is included in the distribution
|
197
|
+
<tt>./filters/</tt> directory. It translates music in
|
198
|
+
<a href="http://lilypond.org/">LilyPond</a> or <a href="http://abcnotation.org.uk/">ABC</a>
|
199
|
+
notation to standard classical notation</p></div>
|
200
|
+
</div>
|
201
|
+
<h2 id="_source_code_highlight_filter">Source Code Highlight Filter</h2>
|
202
|
+
<div class="sectionbody">
|
203
|
+
<div class="para"><p>A <a href="source-highlight-filter.html">source code highlight filter</a> is
|
204
|
+
included in the distribution <tt>./filters/</tt> directory.</p></div>
|
205
|
+
</div>
|
206
|
+
<h2 id="X3">Mathematical Formulae</h2>
|
207
|
+
<div class="sectionbody">
|
208
|
+
<div class="para"><p>You can include mathematical formulae in your <em>AsciiDoc</em> documents using
|
209
|
+
<a href="asciimath.html">ASCIIMathML</a> or <a href="latexmath.html">LaTeXMathML</a>
|
210
|
+
notation.</p></div>
|
211
|
+
</div>
|
212
|
+
<h2 id="_vim_syntax_highlighter">Vim Syntax Highlighter</h2>
|
213
|
+
<div class="sectionbody">
|
214
|
+
<div class="para"><p>An <em>AsciiDoc</em> syntax highlighter for the Vim text editor is included in
|
215
|
+
the <em>AsciiDoc</em> distribution (see <em>Appendix F</em> of the <em><em>AsciiDoc</em> User
|
216
|
+
Guide</em> for details).</p></div>
|
217
|
+
<div class="imageblock">
|
218
|
+
<div class="content">
|
219
|
+
<a class="image" href="images/highlighter.png">
|
220
|
+
<img src="images/highlighter.png" alt="images/highlighter.png" height="250"/>
|
221
|
+
</a>
|
222
|
+
</div>
|
223
|
+
<div class="image-title">Syntax highlighter screenshot</div>
|
224
|
+
</div>
|
225
|
+
<div class="para"><p>Dag Wieers has implemented an alternative Vim syntax file for <em>AsciiDoc</em>
|
226
|
+
which can be found here
|
227
|
+
<a href="http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/">http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/</a>.</p></div>
|
228
|
+
</div>
|
229
|
+
<h2 id="X2">Resources</h2>
|
230
|
+
<div class="sectionbody">
|
231
|
+
<div class="ilist"><ul>
|
232
|
+
<li>
|
233
|
+
<p>
|
234
|
+
Check the <a href="downloads.html">Downloads page</a> for packaged versions
|
235
|
+
of <em>AsciiDoc</em>.
|
236
|
+
</p>
|
237
|
+
</li>
|
238
|
+
<li>
|
239
|
+
<p>
|
240
|
+
Alex Efros has written an HTML formatted
|
241
|
+
<a href="http://powerman.name/doc/asciidoc"><em>AsciiDoc</em> Cheatsheet</a> using
|
242
|
+
Asciidoc.
|
243
|
+
</p>
|
244
|
+
</li>
|
245
|
+
<li>
|
246
|
+
<p>
|
247
|
+
Thomas Berker has written an
|
248
|
+
<a href="http://liksom.info/blog/?q=node/114"><em>AsciiDoc</em> Cheatsheet</a> in Open
|
249
|
+
Document and PDF formats.
|
250
|
+
</p>
|
251
|
+
</li>
|
252
|
+
<li>
|
253
|
+
<p>
|
254
|
+
The <a href="http://www.wikimatrix.org/">WikiMatrix</a> website has an excellent
|
255
|
+
<a href="http://www.wikimatrix.org/syntax.php">web page</a> that compares the
|
256
|
+
various Wiki markup syntaxes. An interesting attempt at Wiki markup
|
257
|
+
standardization is <a href="http://www.wikicreole.org/">CREOLE</a>.
|
258
|
+
</p>
|
259
|
+
</li>
|
260
|
+
<li>
|
261
|
+
<p>
|
262
|
+
Terrence Brannon has written
|
263
|
+
<a href="http://www.metaperl.com/asciidoc-el/"><em>AsciiDoc</em> functions for Emacs</a>.
|
264
|
+
</p>
|
265
|
+
</li>
|
266
|
+
<li>
|
267
|
+
<p>
|
268
|
+
The <a href="http://xpt.sourceforge.net/">*Nix Power Tools project</a> has
|
269
|
+
released an <a href="http://xpt.sourceforge.net/tools/doc-mode/"><em>AsciiDoc</em>
|
270
|
+
syntax highlighter for Emacs</a>.
|
271
|
+
</p>
|
272
|
+
</li>
|
273
|
+
<li>
|
274
|
+
<p>
|
275
|
+
Franck Pommereau has written
|
276
|
+
<a href="http://www.univ-paris12.fr/lacl/pommereau/soft/asciidoctest.html">Asciidoctest</a>,
|
277
|
+
a program that doctests snippets of Python code within your Asciidoc
|
278
|
+
documents.
|
279
|
+
</p>
|
280
|
+
</li>
|
281
|
+
<li>
|
282
|
+
<p>
|
283
|
+
The <a href="http://remips.sourceforge.net/">ReMIPS</a> project website has been
|
284
|
+
built using <em>AsciiDoc</em>.
|
285
|
+
</p>
|
286
|
+
</li>
|
287
|
+
<li>
|
288
|
+
<p>
|
289
|
+
Here are some <a href="asciidoc-docbook-xsl.html">DocBook XSL Stylesheets
|
290
|
+
Notes</a>.
|
291
|
+
</p>
|
292
|
+
</li>
|
293
|
+
<li>
|
294
|
+
<p>
|
295
|
+
Karl Mowatt-Wilson has developed an <a href="http://ikiwiki.info/">ikiwiki</a>
|
296
|
+
plugin for <em>AsciiDoc</em> which he uses to render
|
297
|
+
<a href="http://mowson.org/karl">his website</a>. The plugin is available
|
298
|
+
<a href="http://www.mowson.org/karl/colophon/">here</a> and there is some
|
299
|
+
discussion of the ikiwiki integration
|
300
|
+
<a href="http://ikiwiki.info/users/KarlMW/discussion/">here</a>.
|
301
|
+
</p>
|
302
|
+
</li>
|
303
|
+
</ul></div>
|
304
|
+
</div>
|
305
|
+
<h2 id="_blogpost_weblog_client">Blogpost weblog client</h2>
|
306
|
+
<div class="sectionbody">
|
307
|
+
<div class="para"><p><a href="http://srackham.wordpress.com/blogpost-readme/">blogpost</a> is a
|
308
|
+
command-line weblog client for publishing <em>AsciiDoc</em> documents to
|
309
|
+
<a href="http://wordpress.org/">WordPress</a> blog hosts. It creates and updates
|
310
|
+
weblog posts and pages directly from <em>AsciiDoc</em> source documents.</p></div>
|
311
|
+
</div>
|
312
|
+
<h2 id="X1">LaTeX Backend</h2>
|
313
|
+
<div class="sectionbody">
|
314
|
+
<div class="para"><p>An experimental LaTeX backend has been written for <em>AsciiDoc</em> by
|
315
|
+
Benjamin Klum. Benjamin has done a superhuman job (I admit it, I
|
316
|
+
didn't think this was doable due to <em>AsciiDoc</em>'s SGML/XML bias).</p></div>
|
317
|
+
<div class="para"><p>Here's <a href="latex-backend.html">Benjamin's documentation</a>.</p></div>
|
318
|
+
</div>
|
319
|
+
<h2 id="_projects_using_asciidoc">Projects using AsciiDoc</h2>
|
320
|
+
<div class="sectionbody">
|
321
|
+
<div class="para"><p>Here are some projects I know of, if you know of more drop me a line
|
322
|
+
and I'll add them to the list.</p></div>
|
323
|
+
<div class="ilist"><ul>
|
324
|
+
<li>
|
325
|
+
<p>
|
326
|
+
The Linux kernel
|
327
|
+
<a href="http://www.kernel.org/pub/software/scm/git/docs/git.html">git source
|
328
|
+
code management system</a>.
|
329
|
+
</p>
|
330
|
+
</li>
|
331
|
+
<li>
|
332
|
+
<p>
|
333
|
+
Some documentation about git by Nico Schottelius (in German)
|
334
|
+
<a href="http://nico.schotteli.us/papers/linux/git-firmen/">http://nico.schotteli.us/papers/linux/git-firmen/</a>.
|
335
|
+
</p>
|
336
|
+
</li>
|
337
|
+
<li>
|
338
|
+
<p>
|
339
|
+
The <a href="http://www.netpromi.com/kirbybase_ruby.html">KirbyBase for Ruby</a>
|
340
|
+
database management system manual.
|
341
|
+
</p>
|
342
|
+
</li>
|
343
|
+
<li>
|
344
|
+
<p>
|
345
|
+
The <a href="http://www.selenic.com/mercurial/">Mercurial distributed SCM</a>
|
346
|
+
uses asciidoc for its man pages.
|
347
|
+
</p>
|
348
|
+
</li>
|
349
|
+
<li>
|
350
|
+
<p>
|
351
|
+
Pascal Rapaz has written a Python script to automate <em>AsciiDoc</em>
|
352
|
+
website generation. You can find it at
|
353
|
+
<a href="http://www.rapazp.ch/opensource/tools/asciidoc.html">http://www.rapazp.ch/opensource/tools/asciidoc.html</a>.
|
354
|
+
</p>
|
355
|
+
</li>
|
356
|
+
<li>
|
357
|
+
<p>
|
358
|
+
The <a href="http://xpt.sourceforge.net/">*Nix Power Tools project</a> uses
|
359
|
+
<em>AsciiDoc</em> for documentation and has released an Emacs syntax
|
360
|
+
highlighter (see <a href="#X2">Resources</a> above).
|
361
|
+
</p>
|
362
|
+
</li>
|
363
|
+
</ul></div>
|
364
|
+
</div>
|
365
|
+
<h2 id="_asciidoc_version_9">AsciiDoc version 9</h2>
|
366
|
+
<div class="sectionbody">
|
367
|
+
<div class="para"><p>The next version of <em>AsciiDoc</em> is underway — details
|
368
|
+
<a href="version9.html">here</a>.</p></div>
|
369
|
+
</div>
|
370
|
+
<div id="footer">
|
371
|
+
<div id="footer-text">
|
372
|
+
Version 8.2.7<br />
|
373
|
+
Last updated 2008-07-04 23:29:25 NZDT
|
374
|
+
</div>
|
375
|
+
<div id="footer-badges">
|
376
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
377
|
+
<img style="border:none; width:88px; height:31px;"
|
378
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
379
|
+
alt="Valid XHTML 1.1!" />
|
380
|
+
</a>
|
381
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
382
|
+
<img style="border:none; width:88px; height:31px;"
|
383
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
384
|
+
alt="Valid CSS!" />
|
385
|
+
</a>
|
386
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
387
|
+
<img style="border:none; width:110px; height:32px;"
|
388
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
389
|
+
alt="Get Firefox!" />
|
390
|
+
</a>
|
391
|
+
</div>
|
392
|
+
</div>
|
393
|
+
</div>
|
394
|
+
</td>
|
395
|
+
</tr>
|
396
|
+
</table>
|
397
|
+
</body>
|
398
|
+
</html>
|