mizuho 0.9.6
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 +61 -0
- data/Rakefile +41 -0
- data/asciidoc/BUGS +39 -0
- data/asciidoc/BUGS.txt +32 -0
- data/asciidoc/CHANGELOG +1796 -0
- data/asciidoc/CHANGELOG.txt +1810 -0
- data/asciidoc/COPYING +339 -0
- data/asciidoc/COPYRIGHT +18 -0
- data/asciidoc/INSTALL +76 -0
- data/asciidoc/INSTALL.txt +71 -0
- data/asciidoc/Makefile.in +161 -0
- data/asciidoc/README +46 -0
- data/asciidoc/README.txt +36 -0
- data/asciidoc/a2x +674 -0
- data/asciidoc/asciidoc.conf +455 -0
- data/asciidoc/asciidoc.py +4998 -0
- data/asciidoc/common.aap +9 -0
- data/asciidoc/configure +2840 -0
- data/asciidoc/configure.ac +11 -0
- data/asciidoc/dblatex/asciidoc-dblatex.sty +20 -0
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +32 -0
- data/asciidoc/dblatex/dblatex-readme.txt +39 -0
- data/asciidoc/doc/a2x.1 +257 -0
- data/asciidoc/doc/a2x.1.txt +204 -0
- data/asciidoc/doc/article.css-embedded.html +602 -0
- data/asciidoc/doc/article.html +46 -0
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +122 -0
- data/asciidoc/doc/asciidoc-revhistory.xml +27 -0
- data/asciidoc/doc/asciidoc.1 +155 -0
- data/asciidoc/doc/asciidoc.1.css-embedded.html +598 -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 +7853 -0
- data/asciidoc/doc/asciidoc.css.html +7416 -0
- data/asciidoc/doc/asciidoc.dict +733 -0
- data/asciidoc/doc/asciidoc.html +3339 -0
- data/asciidoc/doc/asciidoc.txt +4979 -0
- data/asciidoc/doc/asciimathml.txt +64 -0
- data/asciidoc/doc/book-multi.css-embedded.html +575 -0
- data/asciidoc/doc/book-multi.html +55 -0
- data/asciidoc/doc/book-multi.txt +155 -0
- data/asciidoc/doc/book.css-embedded.html +607 -0
- data/asciidoc/doc/book.html +43 -0
- data/asciidoc/doc/book.txt +131 -0
- data/asciidoc/doc/customers.csv +18 -0
- data/asciidoc/doc/docbook-xsl.css +272 -0
- data/asciidoc/doc/faq.txt +547 -0
- data/asciidoc/doc/latex-backend.html +117 -0
- data/asciidoc/doc/latex-backend.txt +191 -0
- data/asciidoc/doc/latexmath.txt +244 -0
- data/asciidoc/doc/latexmathml.txt +41 -0
- data/asciidoc/doc/main.aap +297 -0
- data/asciidoc/doc/music-filter.html +566 -0
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +158 -0
- data/asciidoc/doc/source-highlight-filter.html +214 -0
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +203 -0
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +43 -0
- data/asciidoc/docbook-xsl/chunked.xsl +19 -0
- data/asciidoc/docbook-xsl/common.xsl +67 -0
- data/asciidoc/docbook-xsl/fo.xsl +149 -0
- data/asciidoc/docbook-xsl/htmlhelp.xsl +17 -0
- data/asciidoc/docbook-xsl/manpage.xsl +31 -0
- data/asciidoc/docbook-xsl/text.xsl +50 -0
- data/asciidoc/docbook-xsl/xhtml.xsl +14 -0
- data/asciidoc/docbook.conf +721 -0
- data/asciidoc/examples/website/ASCIIMathML.js +938 -0
- data/asciidoc/examples/website/CHANGELOG.html +4389 -0
- data/asciidoc/examples/website/CHANGELOG.txt +1810 -0
- data/asciidoc/examples/website/INSTALL.html +161 -0
- data/asciidoc/examples/website/INSTALL.txt +71 -0
- data/asciidoc/examples/website/LaTeXMathML.js +1223 -0
- data/asciidoc/examples/website/README-website.html +118 -0
- data/asciidoc/examples/website/README-website.txt +29 -0
- data/asciidoc/examples/website/README.html +125 -0
- data/asciidoc/examples/website/README.txt +36 -0
- data/asciidoc/examples/website/a2x.1.html +419 -0
- data/asciidoc/examples/website/a2x.1.txt +204 -0
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +130 -0
- data/asciidoc/examples/website/asciidoc-docbook-xsl.txt +43 -0
- data/asciidoc/examples/website/asciidoc-graphviz-sample.txt +130 -0
- data/asciidoc/examples/website/asciimathml.txt +64 -0
- data/asciidoc/examples/website/build-website.sh +25 -0
- data/asciidoc/examples/website/customers.csv +18 -0
- data/asciidoc/examples/website/downloads.html +257 -0
- data/asciidoc/examples/website/downloads.txt +121 -0
- data/asciidoc/examples/website/faq.html +673 -0
- data/asciidoc/examples/website/faq.txt +547 -0
- data/asciidoc/examples/website/index.html +419 -0
- data/asciidoc/examples/website/index.txt +245 -0
- data/asciidoc/examples/website/latex-backend.html +535 -0
- data/asciidoc/examples/website/latex-backend.txt +191 -0
- data/asciidoc/examples/website/latexmathml.txt +41 -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/manpage.txt +118 -0
- data/asciidoc/examples/website/music-filter.html +242 -0
- data/asciidoc/examples/website/music-filter.txt +158 -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/newlists.txt +40 -0
- data/asciidoc/examples/website/newtables.txt +397 -0
- data/asciidoc/examples/website/sample1.png +0 -0
- data/asciidoc/examples/website/sample3.png +0 -0
- data/asciidoc/examples/website/sample4.png +0 -0
- data/asciidoc/examples/website/source-highlight-filter.html +286 -0
- data/asciidoc/examples/website/source-highlight-filter.txt +203 -0
- data/asciidoc/examples/website/support.html +78 -0
- data/asciidoc/examples/website/support.txt +5 -0
- data/asciidoc/examples/website/toc.js +69 -0
- data/asciidoc/examples/website/userguide.html +7460 -0
- data/asciidoc/examples/website/userguide.txt +4979 -0
- data/asciidoc/examples/website/version83.txt +37 -0
- data/asciidoc/examples/website/version9.html +143 -0
- data/asciidoc/examples/website/version9.txt +48 -0
- data/asciidoc/examples/website/xhtml11-manpage.css +18 -0
- data/asciidoc/examples/website/xhtml11-quirks.css +41 -0
- data/asciidoc/examples/website/xhtml11.css +328 -0
- data/asciidoc/filters/code/code-filter-readme.txt +37 -0
- data/asciidoc/filters/code/code-filter-test.txt +15 -0
- data/asciidoc/filters/code/code-filter.conf +8 -0
- data/asciidoc/filters/code/code-filter.py +239 -0
- data/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt +130 -0
- data/asciidoc/filters/graphviz/graphviz-filter.conf +39 -0
- data/asciidoc/filters/graphviz/graphviz2png.py +154 -0
- data/asciidoc/filters/music/music-filter-test.txt +40 -0
- data/asciidoc/filters/music/music-filter.conf +40 -0
- data/asciidoc/filters/music/music2png.py +189 -0
- data/asciidoc/filters/source/source-highlight-filter-test.txt +19 -0
- data/asciidoc/filters/source/source-highlight-filter.conf +108 -0
- data/asciidoc/help.conf +213 -0
- data/asciidoc/html4.conf +460 -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 +201 -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/stylesheets/docbook-xsl.css +272 -0
- data/asciidoc/stylesheets/xhtml11-manpage.css +18 -0
- data/asciidoc/stylesheets/xhtml11-quirks.css +41 -0
- data/asciidoc/stylesheets/xhtml11.css +328 -0
- data/asciidoc/text.conf +16 -0
- data/asciidoc/vim/ftdetect/asciidoc_filetype.vim +53 -0
- data/asciidoc/vim/syntax/asciidoc.vim +165 -0
- data/asciidoc/wordpress.conf +48 -0
- data/asciidoc/xhtml11-quirks.conf +57 -0
- data/asciidoc/xhtml11.conf +645 -0
- data/bin/mizuho +47 -0
- data/bin/mizuho-asciidoc +4 -0
- data/lib/mizuho.rb +10 -0
- data/lib/mizuho/chapter.rb +54 -0
- data/lib/mizuho/generator.rb +134 -0
- data/lib/mizuho/heading.rb +46 -0
- data/lib/mizuho/parser.rb +103 -0
- data/lib/mizuho/source_highlight.rb +2 -0
- data/lib/mizuho/template.rb +50 -0
- data/source-highlight/ada.lang +38 -0
- data/source-highlight/bib.lang +6 -0
- data/source-highlight/bison.lang +3 -0
- data/source-highlight/c.lang +41 -0
- data/source-highlight/c_comment.lang +27 -0
- data/source-highlight/c_string.lang +9 -0
- data/source-highlight/caml.lang +16 -0
- data/source-highlight/changelog.lang +8 -0
- data/source-highlight/clike_vardeclaration.lang +4 -0
- data/source-highlight/cpp.lang +15 -0
- data/source-highlight/csharp.lang +36 -0
- data/source-highlight/css.lang +14 -0
- data/source-highlight/css_common.outlang +26 -0
- data/source-highlight/darwin/source-highlight +0 -0
- data/source-highlight/default.css +51 -0
- data/source-highlight/default.lang +8 -0
- data/source-highlight/default.style +57 -0
- data/source-highlight/desktop.lang +7 -0
- data/source-highlight/diff.lang +32 -0
- data/source-highlight/docbook.outlang +36 -0
- data/source-highlight/esc.outlang +46 -0
- data/source-highlight/esc.style +35 -0
- data/source-highlight/extreme_comment.lang +5 -0
- data/source-highlight/extreme_comment2.lang +5 -0
- data/source-highlight/extreme_comment3.lang +15 -0
- data/source-highlight/fixed-fortran.lang +5 -0
- data/source-highlight/flex.lang +37 -0
- data/source-highlight/fortran.lang +57 -0
- data/source-highlight/function.lang +2 -0
- data/source-highlight/glsl.lang +86 -0
- data/source-highlight/haxe.lang +7 -0
- data/source-highlight/html.lang +7 -0
- data/source-highlight/html.outlang +25 -0
- data/source-highlight/html_common.outlang +35 -0
- data/source-highlight/html_notfixed.outlang +22 -0
- data/source-highlight/html_ref.outlang +6 -0
- data/source-highlight/htmlcss.outlang +28 -0
- data/source-highlight/htmltable.outlang +14 -0
- data/source-highlight/htmltablelinenum.outlang +26 -0
- data/source-highlight/java.lang +26 -0
- data/source-highlight/javadoc.outlang +24 -0
- data/source-highlight/javascript.lang +27 -0
- data/source-highlight/key_string.lang +4 -0
- data/source-highlight/lang.map +108 -0
- data/source-highlight/langdef.lang +21 -0
- data/source-highlight/latex.lang +52 -0
- data/source-highlight/latex.outlang +59 -0
- data/source-highlight/latexcolor.outlang +44 -0
- data/source-highlight/ldap.lang +10 -0
- data/source-highlight/log.lang +53 -0
- data/source-highlight/logtalk.lang +85 -0
- data/source-highlight/lsm.lang +7 -0
- data/source-highlight/lua.lang +27 -0
- data/source-highlight/m4.lang +27 -0
- data/source-highlight/makefile.lang +42 -0
- data/source-highlight/nohilite.lang +2 -0
- data/source-highlight/number.lang +3 -0
- data/source-highlight/outlang.lang +16 -0
- data/source-highlight/outlang.map +12 -0
- data/source-highlight/pascal.lang +20 -0
- data/source-highlight/perl.lang +134 -0
- data/source-highlight/php.lang +25 -0
- data/source-highlight/postscript.lang +42 -0
- data/source-highlight/prolog.lang +37 -0
- data/source-highlight/properties.lang +7 -0
- data/source-highlight/python.lang +26 -0
- data/source-highlight/ruby.lang +32 -0
- data/source-highlight/scala.lang +31 -0
- data/source-highlight/script_comment.lang +3 -0
- data/source-highlight/sh.lang +38 -0
- data/source-highlight/slang.lang +25 -0
- data/source-highlight/sml.lang +5 -0
- data/source-highlight/source-highlight +24 -0
- data/source-highlight/spec.lang +12 -0
- data/source-highlight/sql.lang +46 -0
- data/source-highlight/style.defaults +15 -0
- data/source-highlight/style.lang +16 -0
- data/source-highlight/style2.style +10 -0
- data/source-highlight/style3.style +10 -0
- data/source-highlight/symbols.lang +2 -0
- data/source-highlight/tcl.lang +35 -0
- data/source-highlight/texinfo.outlang +34 -0
- data/source-highlight/texinfo.style +20 -0
- data/source-highlight/url.lang +3 -0
- data/source-highlight/xhtml.outlang +25 -0
- data/source-highlight/xhtml_common.outlang +8 -0
- data/source-highlight/xhtml_notfixed.outlang +16 -0
- data/source-highlight/xhtmlcss.outlang +19 -0
- data/source-highlight/xhtmltable.outlang +7 -0
- data/source-highlight/xml.lang +17 -0
- data/source-highlight/xorg.lang +10 -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/generator_spec.rb +60 -0
- data/test/parser_spec.rb +239 -0
- data/test/spec_helper.rb +51 -0
- metadata +358 -0
|
@@ -0,0 +1,118 @@
|
|
|
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.3.3" />
|
|
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
|
+
<title>AsciiDoc Website</title>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<div id="layout-banner">
|
|
14
|
+
<div id="layout-title">AsciiDoc</div>
|
|
15
|
+
<div id="layout-description">Text based document generation</div>
|
|
16
|
+
</div>
|
|
17
|
+
<table>
|
|
18
|
+
<tr valign="top">
|
|
19
|
+
<td id="layout-menu">
|
|
20
|
+
<div>»<a href="index.html">Home</a></div>
|
|
21
|
+
<div>»<a href="manpage.html">Man Page</a></div>
|
|
22
|
+
<div>»<a href="userguide.html">User Guide</a></div>
|
|
23
|
+
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
|
|
24
|
+
<div>»<a href="a2x.1.html">a2x</a></div>
|
|
25
|
+
<div>»<a href="README.html">README</a></div>
|
|
26
|
+
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
|
|
27
|
+
<div>»<a href="INSTALL.html">Installation</a></div>
|
|
28
|
+
<div>»<a href="downloads.html">Downloads</a></div>
|
|
29
|
+
<div>»<a href="faq.html">FAQ</a></div>
|
|
30
|
+
<div>»<a href="support.html">Support</a></div>
|
|
31
|
+
<div id="page-source">»<a href="README-website.txt">Page Source</a></div>
|
|
32
|
+
</td>
|
|
33
|
+
<td>
|
|
34
|
+
<div id="layout-content">
|
|
35
|
+
<div id="header">
|
|
36
|
+
<h1>AsciiDoc Website</h1>
|
|
37
|
+
</div>
|
|
38
|
+
<div id="preamble">
|
|
39
|
+
<div class="sectionbody">
|
|
40
|
+
<div class="paragraph"><p>The <em>AsciiDoc</em> website source is included in the <em>AsciiDoc</em> distribution
|
|
41
|
+
(in <tt>./examples/website/</tt>) as an example of using <em>AsciiDoc</em> to build a
|
|
42
|
+
website.</p></div>
|
|
43
|
+
<div class="paragraph"><p>A simple shell script (<tt>./examples/website/build-website.sh</tt>) will
|
|
44
|
+
build the site’s web pages — just set the <tt>LAYOUT</tt> variable to the
|
|
45
|
+
desired layout.</p></div>
|
|
46
|
+
</div>
|
|
47
|
+
</div>
|
|
48
|
+
<h2 id="_website_layouts">Website Layouts</h2>
|
|
49
|
+
<div class="sectionbody">
|
|
50
|
+
<div class="paragraph"><p>The website layout is determined by the layout configuration file
|
|
51
|
+
(<tt>layout1.conf</tt> or <tt>layout2.conf</tt>) and corresponding layout CSS file
|
|
52
|
+
(<tt>layout1.css</tt> or <tt>layout2.css</tt>). The example website comes with the
|
|
53
|
+
following layouts:</p></div>
|
|
54
|
+
<div class="tableblock">
|
|
55
|
+
<table rules="all"
|
|
56
|
+
width="80%"
|
|
57
|
+
frame="border"
|
|
58
|
+
cellspacing="0" cellpadding="4">
|
|
59
|
+
<col width="20%" />
|
|
60
|
+
<col width="80%" />
|
|
61
|
+
<thead valign="top">
|
|
62
|
+
<tr>
|
|
63
|
+
<th align="left">Layout </th>
|
|
64
|
+
<th align="left"> Description</th>
|
|
65
|
+
</tr>
|
|
66
|
+
</thead>
|
|
67
|
+
<tbody valign="top">
|
|
68
|
+
<tr>
|
|
69
|
+
<td align="left"><p class="table">layout1</p></td>
|
|
70
|
+
<td align="left"><p class="table">Table based layout (this is the default layout)</p></td>
|
|
71
|
+
</tr>
|
|
72
|
+
<tr>
|
|
73
|
+
<td align="left"><p class="table">layout2</p></td>
|
|
74
|
+
<td align="left"><p class="table">CSS based simulated frames layout</p></td>
|
|
75
|
+
</tr>
|
|
76
|
+
</tbody>
|
|
77
|
+
</table>
|
|
78
|
+
</div>
|
|
79
|
+
<div class="paragraph"><p>The default tables based layout (layout1) works with most modern
|
|
80
|
+
browsers.</p></div>
|
|
81
|
+
<div class="admonitionblock">
|
|
82
|
+
<table><tr>
|
|
83
|
+
<td class="icon">
|
|
84
|
+
<img src="./images/icons/note.png" alt="Note" />
|
|
85
|
+
</td>
|
|
86
|
+
<td class="content">The simulated frames layout (layout2) does not work with IE6.</td>
|
|
87
|
+
</tr></table>
|
|
88
|
+
</div>
|
|
89
|
+
</div>
|
|
90
|
+
<div id="footer">
|
|
91
|
+
<div id="footer-text">
|
|
92
|
+
Version 8.3.3<br />
|
|
93
|
+
Last updated 2009-01-02 11:18:54 NZDT
|
|
94
|
+
</div>
|
|
95
|
+
<div id="footer-badges">
|
|
96
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
|
97
|
+
<img style="border:none; width:88px; height:31px;"
|
|
98
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
|
99
|
+
alt="Valid XHTML 1.1!" />
|
|
100
|
+
</a>
|
|
101
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
|
102
|
+
<img style="border:none; width:88px; height:31px;"
|
|
103
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
|
104
|
+
alt="Valid CSS!" />
|
|
105
|
+
</a>
|
|
106
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
|
107
|
+
<img style="border:none; width:110px; height:32px;"
|
|
108
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
|
109
|
+
alt="Get Firefox!" />
|
|
110
|
+
</a>
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
</div>
|
|
114
|
+
</td>
|
|
115
|
+
</tr>
|
|
116
|
+
</table>
|
|
117
|
+
</body>
|
|
118
|
+
</html>
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
AsciiDoc Website
|
|
2
|
+
================
|
|
3
|
+
|
|
4
|
+
The AsciiDoc website source is included in the AsciiDoc distribution
|
|
5
|
+
(in `./examples/website/`) as an example of using AsciiDoc to build a
|
|
6
|
+
website.
|
|
7
|
+
|
|
8
|
+
A simple shell script (`./examples/website/build-website.sh`) will
|
|
9
|
+
build the site's web pages -- just set the `LAYOUT` variable to the
|
|
10
|
+
desired layout.
|
|
11
|
+
|
|
12
|
+
Website Layouts
|
|
13
|
+
---------------
|
|
14
|
+
The website layout is determined by the layout configuration file
|
|
15
|
+
(`layout1.conf` or `layout2.conf`) and corresponding layout CSS file
|
|
16
|
+
(`layout1.css` or `layout2.css`). The example website comes with the
|
|
17
|
+
following layouts:
|
|
18
|
+
|
|
19
|
+
[width="80%",cols="1,4",options="header"]
|
|
20
|
+
|====================================================================
|
|
21
|
+
|Layout | Description
|
|
22
|
+
|layout1 | Table based layout (this is the default layout)
|
|
23
|
+
|layout2 | CSS based simulated frames layout
|
|
24
|
+
|====================================================================
|
|
25
|
+
|
|
26
|
+
The default tables based layout (layout1) works with most modern
|
|
27
|
+
browsers.
|
|
28
|
+
|
|
29
|
+
NOTE: The simulated frames layout (layout2) does not work with IE6.
|
|
@@ -0,0 +1,125 @@
|
|
|
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.3.3" />
|
|
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
|
+
<title>AsciiDoc README File</title>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<div id="layout-banner">
|
|
14
|
+
<div id="layout-title">AsciiDoc</div>
|
|
15
|
+
<div id="layout-description">Text based document generation</div>
|
|
16
|
+
</div>
|
|
17
|
+
<table>
|
|
18
|
+
<tr valign="top">
|
|
19
|
+
<td id="layout-menu">
|
|
20
|
+
<div>»<a href="index.html">Home</a></div>
|
|
21
|
+
<div>»<a href="manpage.html">Man Page</a></div>
|
|
22
|
+
<div>»<a href="userguide.html">User Guide</a></div>
|
|
23
|
+
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
|
|
24
|
+
<div>»<a href="a2x.1.html">a2x</a></div>
|
|
25
|
+
<div>»<a href="README.html">README</a></div>
|
|
26
|
+
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
|
|
27
|
+
<div>»<a href="INSTALL.html">Installation</a></div>
|
|
28
|
+
<div>»<a href="downloads.html">Downloads</a></div>
|
|
29
|
+
<div>»<a href="faq.html">FAQ</a></div>
|
|
30
|
+
<div>»<a href="support.html">Support</a></div>
|
|
31
|
+
<div id="page-source">»<a href="README.txt">Page Source</a></div>
|
|
32
|
+
</td>
|
|
33
|
+
<td>
|
|
34
|
+
<div id="layout-content">
|
|
35
|
+
<div id="header">
|
|
36
|
+
<h1>AsciiDoc README File</h1>
|
|
37
|
+
</div>
|
|
38
|
+
<h2 id="_prerequisites">Prerequisites</h2>
|
|
39
|
+
<div class="sectionbody">
|
|
40
|
+
<div class="paragraph"><p><em>AsciiDoc</em> is written in Python so you need a Python interpreter
|
|
41
|
+
(version 2.4 or later) to execute <tt>asciidoc(1)</tt>. Python is installed by
|
|
42
|
+
default in most Linux distributions. You can download Python from the
|
|
43
|
+
official Python website <a href="http://www.python.org">http://www.python.org</a>.</p></div>
|
|
44
|
+
</div>
|
|
45
|
+
<h2 id="_obtaining_asciidoc">Obtaining AsciiDoc</h2>
|
|
46
|
+
<div class="sectionbody">
|
|
47
|
+
<div class="paragraph"><p>The latest <em>AsciiDoc</em> version and online documentation can be found at
|
|
48
|
+
<a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a> and at the SourceForge
|
|
49
|
+
<a href="http://sourceforge.net/projects/asciidoc/">http://sourceforge.net/projects/asciidoc/</a>.</p></div>
|
|
50
|
+
</div>
|
|
51
|
+
<h2 id="_tools">Tools</h2>
|
|
52
|
+
<div class="sectionbody">
|
|
53
|
+
<div class="paragraph"><p>Current <em>AsciiDoc</em> version tested on Xubuntu Linux 8.04 with:</p></div>
|
|
54
|
+
<div class="ulist"><ul>
|
|
55
|
+
<li>
|
|
56
|
+
<p>
|
|
57
|
+
Python 2.5.2
|
|
58
|
+
</p>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<p>
|
|
62
|
+
bash 3.2.39
|
|
63
|
+
</p>
|
|
64
|
+
</li>
|
|
65
|
+
<li>
|
|
66
|
+
<p>
|
|
67
|
+
DocBook XSL Stylesheets 1.73.2
|
|
68
|
+
</p>
|
|
69
|
+
</li>
|
|
70
|
+
<li>
|
|
71
|
+
<p>
|
|
72
|
+
xsltproc (libxml 20631, libxslt 10122 and libexslt 813).
|
|
73
|
+
</p>
|
|
74
|
+
</li>
|
|
75
|
+
<li>
|
|
76
|
+
<p>
|
|
77
|
+
w3m 0.5.1
|
|
78
|
+
</p>
|
|
79
|
+
</li>
|
|
80
|
+
<li>
|
|
81
|
+
<p>
|
|
82
|
+
dblatex 0.2.9
|
|
83
|
+
</p>
|
|
84
|
+
</li>
|
|
85
|
+
<li>
|
|
86
|
+
<p>
|
|
87
|
+
FOP 0.95
|
|
88
|
+
</p>
|
|
89
|
+
</li>
|
|
90
|
+
</ul></div>
|
|
91
|
+
</div>
|
|
92
|
+
<h2 id="_copying">COPYING</h2>
|
|
93
|
+
<div class="sectionbody">
|
|
94
|
+
<div class="paragraph"><p>Copyright © 2002-2008 Stuart Rackham. Free use of this software
|
|
95
|
+
is granted under the terms of the GNU General Public License (GPL).</p></div>
|
|
96
|
+
</div>
|
|
97
|
+
<div id="footer">
|
|
98
|
+
<div id="footer-text">
|
|
99
|
+
Version 8.3.3<br />
|
|
100
|
+
Last updated 2009-01-02 11:18:53 NZDT
|
|
101
|
+
</div>
|
|
102
|
+
<div id="footer-badges">
|
|
103
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
|
104
|
+
<img style="border:none; width:88px; height:31px;"
|
|
105
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
|
106
|
+
alt="Valid XHTML 1.1!" />
|
|
107
|
+
</a>
|
|
108
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
|
109
|
+
<img style="border:none; width:88px; height:31px;"
|
|
110
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
|
111
|
+
alt="Valid CSS!" />
|
|
112
|
+
</a>
|
|
113
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
|
114
|
+
<img style="border:none; width:110px; height:32px;"
|
|
115
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
|
116
|
+
alt="Get Firefox!" />
|
|
117
|
+
</a>
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
</div>
|
|
121
|
+
</td>
|
|
122
|
+
</tr>
|
|
123
|
+
</table>
|
|
124
|
+
</body>
|
|
125
|
+
</html>
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
AsciiDoc README File
|
|
2
|
+
====================
|
|
3
|
+
|
|
4
|
+
Prerequisites
|
|
5
|
+
-------------
|
|
6
|
+
AsciiDoc is written in Python so you need a Python interpreter
|
|
7
|
+
(version 2.4 or later) to execute asciidoc(1). Python is installed by
|
|
8
|
+
default in most Linux distributions. You can download Python from the
|
|
9
|
+
official Python website http://www.python.org.
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
Obtaining AsciiDoc
|
|
13
|
+
------------------
|
|
14
|
+
The latest AsciiDoc version and online documentation can be found at
|
|
15
|
+
http://www.methods.co.nz/asciidoc/ and at the SourceForge
|
|
16
|
+
http://sourceforge.net/projects/asciidoc/.
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
Tools
|
|
20
|
+
-----
|
|
21
|
+
Current AsciiDoc version tested on Xubuntu Linux 8.04 with:
|
|
22
|
+
|
|
23
|
+
- Python 2.5.2
|
|
24
|
+
- bash 3.2.39
|
|
25
|
+
- DocBook XSL Stylesheets 1.73.2
|
|
26
|
+
- xsltproc (libxml 20631, libxslt 10122 and libexslt 813).
|
|
27
|
+
- w3m 0.5.1
|
|
28
|
+
- dblatex 0.2.9
|
|
29
|
+
- FOP 0.95
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
COPYING
|
|
33
|
+
-------
|
|
34
|
+
Copyright (C) 2002-2008 Stuart Rackham. Free use of this software
|
|
35
|
+
is granted under the terms of the GNU General Public License (GPL).
|
|
36
|
+
|
|
@@ -0,0 +1,419 @@
|
|
|
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.3.3" />
|
|
7
|
+
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
|
8
|
+
<link rel="stylesheet" href="./xhtml11-manpage.css" type="text/css" />
|
|
9
|
+
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
|
10
|
+
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
/*<![CDATA[*/
|
|
13
|
+
window.onload = function(){generateToc(1)}
|
|
14
|
+
/*]]>*/
|
|
15
|
+
</script>
|
|
16
|
+
<script type="text/javascript" src="./toc.js"></script>
|
|
17
|
+
<title>A2X(1)</title>
|
|
18
|
+
</head>
|
|
19
|
+
<body>
|
|
20
|
+
<div id="layout-banner">
|
|
21
|
+
<div id="layout-title">AsciiDoc</div>
|
|
22
|
+
<div id="layout-description">Text based document generation</div>
|
|
23
|
+
</div>
|
|
24
|
+
<table>
|
|
25
|
+
<tr valign="top">
|
|
26
|
+
<td id="layout-menu">
|
|
27
|
+
<div>»<a href="index.html">Home</a></div>
|
|
28
|
+
<div>»<a href="manpage.html">Man Page</a></div>
|
|
29
|
+
<div>»<a href="userguide.html">User Guide</a></div>
|
|
30
|
+
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
|
|
31
|
+
<div>»<a href="a2x.1.html">a2x</a></div>
|
|
32
|
+
<div>»<a href="README.html">README</a></div>
|
|
33
|
+
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
|
|
34
|
+
<div>»<a href="INSTALL.html">Installation</a></div>
|
|
35
|
+
<div>»<a href="downloads.html">Downloads</a></div>
|
|
36
|
+
<div>»<a href="faq.html">FAQ</a></div>
|
|
37
|
+
<div>»<a href="support.html">Support</a></div>
|
|
38
|
+
<div id="page-source">»<a href="a2x.1.txt">Page Source</a></div>
|
|
39
|
+
</td>
|
|
40
|
+
<td>
|
|
41
|
+
<div id="layout-content">
|
|
42
|
+
<div id="header">
|
|
43
|
+
<h1>
|
|
44
|
+
A2X(1) Manual Page
|
|
45
|
+
</h1>
|
|
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
|
+
<h2>NAME</h2>
|
|
51
|
+
<div class="sectionbody">
|
|
52
|
+
<p>a2x -
|
|
53
|
+
convert Asciidoc text file to PDF, XHTML, HTML Help, manpage or plain text
|
|
54
|
+
</p>
|
|
55
|
+
</div>
|
|
56
|
+
</div>
|
|
57
|
+
<h2>SYNOPSIS</h2>
|
|
58
|
+
<div class="sectionbody">
|
|
59
|
+
<div class="paragraph"><p><strong>a2x</strong> [<em>OPTIONS</em>] <em>FILE</em></p></div>
|
|
60
|
+
</div>
|
|
61
|
+
<h2 id="_description">DESCRIPTION</h2>
|
|
62
|
+
<div class="sectionbody">
|
|
63
|
+
<div class="paragraph"><p>A DocBook toolchain wrapper script that translates an <em>AsciiDoc</em> text
|
|
64
|
+
file <em>FILE</em> to PDF, DVI, PS, LaTeX, XHTML (single page or chunked),
|
|
65
|
+
man page, HTML Help or plain text formats. PDF, XHTML, man page and
|
|
66
|
+
HTML Help formats are are generated using the <tt>asciidoc(1)</tt>,
|
|
67
|
+
xsltproc(1), DocBook XSL Stylesheets, dblatex (or FOP) toolchain.
|
|
68
|
+
Plain text is produced by passing <tt>asciidoc(1)</tt> generated HTML through
|
|
69
|
+
lynx(1). The htmlhelp format option generates .hhp, .hhc and .html
|
|
70
|
+
files suitable for compilation to an HTML Help .chm file.</p></div>
|
|
71
|
+
</div>
|
|
72
|
+
<h2 id="_options">OPTIONS</h2>
|
|
73
|
+
<div class="sectionbody">
|
|
74
|
+
<div class="dlist"><dl>
|
|
75
|
+
<dt class="hdlist1">
|
|
76
|
+
<strong>-a, --attribute</strong>=<em>ATTRIBUTE</em>
|
|
77
|
+
</dt>
|
|
78
|
+
<dd>
|
|
79
|
+
<p>
|
|
80
|
+
Set <tt>asciidoc(1)</tt> attribute value (shortcut for <strong>--asciidoc-opts</strong>=<em>"-a
|
|
81
|
+
ATTRIBUTE"</em> option). This option may be specified more than once.
|
|
82
|
+
</p>
|
|
83
|
+
</dd>
|
|
84
|
+
<dt class="hdlist1">
|
|
85
|
+
<strong>--asciidoc-opts</strong>=<em>ASCIIDOC_OPTS</em>
|
|
86
|
+
</dt>
|
|
87
|
+
<dd>
|
|
88
|
+
<p>
|
|
89
|
+
Additional <tt>asciidoc(1)</tt> options. This option may be specified more
|
|
90
|
+
than once.
|
|
91
|
+
</p>
|
|
92
|
+
</dd>
|
|
93
|
+
<dt class="hdlist1">
|
|
94
|
+
<strong>--copy</strong>
|
|
95
|
+
</dt>
|
|
96
|
+
<dd>
|
|
97
|
+
<p>
|
|
98
|
+
Copy distributed docbook-xsl CSS stylesheet admonition and
|
|
99
|
+
navigation icons to their respective destinations. Applies to
|
|
100
|
+
<em>xhtml</em>, <em>chunked</em>, <em>htmlhelp</em> formats. The default behavior is to
|
|
101
|
+
suppress copying.
|
|
102
|
+
</p>
|
|
103
|
+
</dd>
|
|
104
|
+
<dt class="hdlist1">
|
|
105
|
+
<strong>-D, --destination-dir</strong>=<em>PATH</em>
|
|
106
|
+
</dt>
|
|
107
|
+
<dd>
|
|
108
|
+
<p>
|
|
109
|
+
Output directory. Defaults to source <em>FILE</em> directory.
|
|
110
|
+
</p>
|
|
111
|
+
</dd>
|
|
112
|
+
<dt class="hdlist1">
|
|
113
|
+
<strong>-d, --doctype</strong>=<em>DOCTYPE</em>
|
|
114
|
+
</dt>
|
|
115
|
+
<dd>
|
|
116
|
+
<p>
|
|
117
|
+
DocBook document type: <em>article</em>, <em>manpage</em> or <em>book</em>. Default
|
|
118
|
+
document type is <em>article</em> unless the format is <em>manpage</em> (in which
|
|
119
|
+
case it defaults to <em>manpage</em>).
|
|
120
|
+
</p>
|
|
121
|
+
</dd>
|
|
122
|
+
<dt class="hdlist1">
|
|
123
|
+
<strong>-f, --format</strong>=<em>FORMAT</em>
|
|
124
|
+
</dt>
|
|
125
|
+
<dd>
|
|
126
|
+
<p>
|
|
127
|
+
Output format: <em>chunked</em>, <em>dvi</em>, <em>htmlhelp</em>, <em>manpage</em>, <em>pdf</em>, <em>ps</em>,
|
|
128
|
+
<em>tex</em>, <em>text</em> or <em>xhtml</em>.
|
|
129
|
+
</p>
|
|
130
|
+
</dd>
|
|
131
|
+
<dt class="hdlist1">
|
|
132
|
+
<strong>-h, --help</strong>
|
|
133
|
+
</dt>
|
|
134
|
+
<dd>
|
|
135
|
+
<p>
|
|
136
|
+
Print command-line syntax and program options to stdout.
|
|
137
|
+
</p>
|
|
138
|
+
</dd>
|
|
139
|
+
<dt class="hdlist1">
|
|
140
|
+
<strong>--icons</strong>
|
|
141
|
+
</dt>
|
|
142
|
+
<dd>
|
|
143
|
+
<p>
|
|
144
|
+
Use admonition or navigation icon images in output documents. The
|
|
145
|
+
default behavior is to use text in place of icons.
|
|
146
|
+
</p>
|
|
147
|
+
</dd>
|
|
148
|
+
<dt class="hdlist1">
|
|
149
|
+
<strong>--icons-dir</strong>=<em>PATH</em>
|
|
150
|
+
</dt>
|
|
151
|
+
<dd>
|
|
152
|
+
<p>
|
|
153
|
+
A path (relative to destination HTML files) containing admonition
|
|
154
|
+
and navigation icons. Defaults to <em>./images/icons/</em>.
|
|
155
|
+
Applies to <em>xhtml</em>, <em>chunked</em>, <em>htmlhelp</em> formats.
|
|
156
|
+
</p>
|
|
157
|
+
</dd>
|
|
158
|
+
<dt class="hdlist1">
|
|
159
|
+
<strong>-L, --no-xmllint</strong>
|
|
160
|
+
</dt>
|
|
161
|
+
<dd>
|
|
162
|
+
<p>
|
|
163
|
+
Don’t check asciidoc output with <em>xmllint(1)</em>.
|
|
164
|
+
</p>
|
|
165
|
+
</dd>
|
|
166
|
+
<dt class="hdlist1">
|
|
167
|
+
<strong>-n, --dry-run</strong>
|
|
168
|
+
</dt>
|
|
169
|
+
<dd>
|
|
170
|
+
<p>
|
|
171
|
+
Don’t do anything just print what would have been done.
|
|
172
|
+
</p>
|
|
173
|
+
</dd>
|
|
174
|
+
<dt class="hdlist1">
|
|
175
|
+
<strong>-s, --skip-asciidoc</strong>
|
|
176
|
+
</dt>
|
|
177
|
+
<dd>
|
|
178
|
+
<p>
|
|
179
|
+
Skip asciidoc execution. This is useful for converting DocBook XML
|
|
180
|
+
files not derived from <em>AsciiDoc</em> sources. Ignored if <em>--format=text</em>.
|
|
181
|
+
</p>
|
|
182
|
+
</dd>
|
|
183
|
+
<dt class="hdlist1">
|
|
184
|
+
<strong>--stylesheet</strong>=<em>PATH</em>
|
|
185
|
+
</dt>
|
|
186
|
+
<dd>
|
|
187
|
+
<p>
|
|
188
|
+
A path (relative to destination HTML files) specifying the
|
|
189
|
+
docbook-xsl CSS stylesheet file. Defaults to <em>./docbook-xsl.css</em>.
|
|
190
|
+
Applies to <em>xhtml</em>, <em>chunked</em>, <em>htmlhelp</em> formats.
|
|
191
|
+
</p>
|
|
192
|
+
</dd>
|
|
193
|
+
<dt class="hdlist1">
|
|
194
|
+
<strong>-v, --verbose</strong>
|
|
195
|
+
</dt>
|
|
196
|
+
<dd>
|
|
197
|
+
<p>
|
|
198
|
+
Print operational details to stderr.
|
|
199
|
+
A second <strong>-v</strong> option applies the verbose option to toolchain commands.
|
|
200
|
+
</p>
|
|
201
|
+
</dd>
|
|
202
|
+
<dt class="hdlist1">
|
|
203
|
+
<strong>--version</strong>
|
|
204
|
+
</dt>
|
|
205
|
+
<dd>
|
|
206
|
+
<p>
|
|
207
|
+
Print program version to stdout.
|
|
208
|
+
</p>
|
|
209
|
+
</dd>
|
|
210
|
+
<dt class="hdlist1">
|
|
211
|
+
<strong>--xsltproc-opts</strong>=<em>XSLTPROC_OPTS</em>
|
|
212
|
+
</dt>
|
|
213
|
+
<dd>
|
|
214
|
+
<p>
|
|
215
|
+
Additional xsltproc(1) options. This option may be specified more
|
|
216
|
+
than once.
|
|
217
|
+
</p>
|
|
218
|
+
</dd>
|
|
219
|
+
<dt class="hdlist1">
|
|
220
|
+
<strong>--fop</strong>
|
|
221
|
+
</dt>
|
|
222
|
+
<dd>
|
|
223
|
+
<p>
|
|
224
|
+
Use FOP to generate PDFs.
|
|
225
|
+
</p>
|
|
226
|
+
</dd>
|
|
227
|
+
<dt class="hdlist1">
|
|
228
|
+
<strong>--fop-opts</strong>=<em>FOP_OPTS</em>
|
|
229
|
+
</dt>
|
|
230
|
+
<dd>
|
|
231
|
+
<p>
|
|
232
|
+
Additional fop options. This option may be specified more than
|
|
233
|
+
once. If this option is specified FOP is used to generate PDFs.
|
|
234
|
+
</p>
|
|
235
|
+
</dd>
|
|
236
|
+
<dt class="hdlist1">
|
|
237
|
+
<strong>--dblatex-opts</strong>=<em>DBLATEX_OPTS</em>
|
|
238
|
+
</dt>
|
|
239
|
+
<dd>
|
|
240
|
+
<p>
|
|
241
|
+
Additional dblatex options. This option may be specified more than once.
|
|
242
|
+
</p>
|
|
243
|
+
</dd>
|
|
244
|
+
</dl></div>
|
|
245
|
+
</div>
|
|
246
|
+
<h2 id="_output_files">OUTPUT FILES</h2>
|
|
247
|
+
<div class="sectionbody">
|
|
248
|
+
<div class="paragraph"><p>Output files are written to the directory specified by the
|
|
249
|
+
<strong>--destination-dir</strong> option. If no <strong>--destination-dir</strong> option is set
|
|
250
|
+
output files are written to the source FILE directory.</p></div>
|
|
251
|
+
<div class="paragraph"><p>Output files have the same name as the source <em>FILE</em> but with an
|
|
252
|
+
appropriate file name extension: .html for <em>xhtml</em>; .hhp for
|
|
253
|
+
<em>htmlhelp</em>; .pdf for <em>pdf</em>; .text for <em>text</em>. By convention manpages
|
|
254
|
+
have no .man extension (man page section number only). Chunked HTML
|
|
255
|
+
directory names have a .chunked extension; chunked HTML Help directory
|
|
256
|
+
names have a .htmlhelp extension.</p></div>
|
|
257
|
+
<div class="paragraph"><p>Same named existing files are overwritten.</p></div>
|
|
258
|
+
<div class="paragraph"><p>Intermediate output files are written to the source <em>FILE</em> directory
|
|
259
|
+
and are not automatically deleted.</p></div>
|
|
260
|
+
<div class="paragraph"><p>Intermediate DocBook XML files generated by <em>AsciiDoc</em> are only
|
|
261
|
+
regenerated if out of date with respect to the <em>AsciiDoc</em> source <em>FILE</em>.</p></div>
|
|
262
|
+
<div class="paragraph"><p>In addition to generating HTML files the <em>xhtml</em>, <em>chunked</em> and
|
|
263
|
+
<em>htmlhelp</em> formats copy the DocBook XSL stylesheet plus admonition and
|
|
264
|
+
navigation icons distributed with <em>AsciiDoc</em> to their respective
|
|
265
|
+
destination locations. Existing stylesheets and icons are only copied
|
|
266
|
+
if they are newer than the destination files or if the destination
|
|
267
|
+
files are missing.</p></div>
|
|
268
|
+
<div class="paragraph"><p>The <em>xhtml</em> format generates a single XHTML output page. The
|
|
269
|
+
<em>chunked</em> format writes multiple per-section HTML pages to a chunked
|
|
270
|
+
directory in the destination directory. The chunked directory has the
|
|
271
|
+
same name as the source <em>FILE</em> name plus a .chunked extension.</p></div>
|
|
272
|
+
</div>
|
|
273
|
+
<h2 id="_examples">EXAMPLES</h2>
|
|
274
|
+
<div class="sectionbody">
|
|
275
|
+
<div class="dlist"><dl>
|
|
276
|
+
<dt class="hdlist1">
|
|
277
|
+
<tt>a2x -f pdf doc/source-highlight-filter.txt</tt>
|
|
278
|
+
</dt>
|
|
279
|
+
<dd>
|
|
280
|
+
<p>
|
|
281
|
+
Generates doc/source-highlight-filter.pdf file.
|
|
282
|
+
</p>
|
|
283
|
+
</dd>
|
|
284
|
+
<dt class="hdlist1">
|
|
285
|
+
<tt>a2x -f chunked -D ../webpages guide.txt</tt>
|
|
286
|
+
</dt>
|
|
287
|
+
<dd>
|
|
288
|
+
<p>
|
|
289
|
+
Creates chunked directory <tt>../webpages/guide.chunked</tt> containing
|
|
290
|
+
chunked HTML files. Also copies <tt>docbook-xsl.css</tt> stylesheet to the
|
|
291
|
+
<tt>../webpages/guide.chunked</tt> directory plus admonition and navigation
|
|
292
|
+
icons to the <tt>../webpages/guide.chunked/images/icons</tt> directory.
|
|
293
|
+
</p>
|
|
294
|
+
</dd>
|
|
295
|
+
</dl></div>
|
|
296
|
+
</div>
|
|
297
|
+
<h2 id="_requisites">REQUISITES</h2>
|
|
298
|
+
<div class="sectionbody">
|
|
299
|
+
<div class="paragraph"><p>This script runs under the bash(1) shell and requires the following
|
|
300
|
+
programs (which may or may not be prepackaged with your Linux
|
|
301
|
+
distribution):</p></div>
|
|
302
|
+
<div class="dlist"><dl>
|
|
303
|
+
<dt class="hdlist1">
|
|
304
|
+
Asciidoc
|
|
305
|
+
</dt>
|
|
306
|
+
<dd>
|
|
307
|
+
<p>
|
|
308
|
+
<a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a>
|
|
309
|
+
</p>
|
|
310
|
+
</dd>
|
|
311
|
+
<dt class="hdlist1">
|
|
312
|
+
xsltproc
|
|
313
|
+
</dt>
|
|
314
|
+
<dd>
|
|
315
|
+
<p>
|
|
316
|
+
<a href="http://xmlsoft.org/XSLT/">http://xmlsoft.org/XSLT/</a>
|
|
317
|
+
</p>
|
|
318
|
+
</dd>
|
|
319
|
+
<dt class="hdlist1">
|
|
320
|
+
DocBook XSL Stylesheets
|
|
321
|
+
</dt>
|
|
322
|
+
<dd>
|
|
323
|
+
<p>
|
|
324
|
+
<a href="http://docbook.sourceforge.net/projects/xsl/">http://docbook.sourceforge.net/projects/xsl/</a>
|
|
325
|
+
</p>
|
|
326
|
+
</dd>
|
|
327
|
+
<dt class="hdlist1">
|
|
328
|
+
dblatex (for PDF, DVI, PostScript and LaTeX file generation)
|
|
329
|
+
</dt>
|
|
330
|
+
<dd>
|
|
331
|
+
<p>
|
|
332
|
+
<a href="http://dblatex.sourceforge.net/">http://dblatex.sourceforge.net/</a>
|
|
333
|
+
</p>
|
|
334
|
+
</dd>
|
|
335
|
+
<dt class="hdlist1">
|
|
336
|
+
FOP (alternative PDF file generation)
|
|
337
|
+
</dt>
|
|
338
|
+
<dd>
|
|
339
|
+
<p>
|
|
340
|
+
<a href="http://xmlgraphics.apache.org/fop/">http://xmlgraphics.apache.org/fop/</a>
|
|
341
|
+
</p>
|
|
342
|
+
</dd>
|
|
343
|
+
<dt class="hdlist1">
|
|
344
|
+
w3m (text file generation)
|
|
345
|
+
</dt>
|
|
346
|
+
<dd>
|
|
347
|
+
<p>
|
|
348
|
+
<a href="http://w3m.sourceforge.net/index.en.html">http://w3m.sourceforge.net/index.en.html</a>
|
|
349
|
+
</p>
|
|
350
|
+
</dd>
|
|
351
|
+
<dt class="hdlist1">
|
|
352
|
+
Lynx (used for text file generation if <tt>w3m(1)</tt> not installed)
|
|
353
|
+
</dt>
|
|
354
|
+
<dd>
|
|
355
|
+
<p>
|
|
356
|
+
<a href="http://lynx.isc.org/">http://lynx.isc.org/</a>
|
|
357
|
+
</p>
|
|
358
|
+
</dd>
|
|
359
|
+
</dl></div>
|
|
360
|
+
<div class="paragraph"><p>See also the latest README file.</p></div>
|
|
361
|
+
</div>
|
|
362
|
+
<h2 id="_bugs">BUGS</h2>
|
|
363
|
+
<div class="sectionbody">
|
|
364
|
+
<div class="ulist"><ul>
|
|
365
|
+
<li>
|
|
366
|
+
<p>
|
|
367
|
+
The odt output format is undocumented and experimental.
|
|
368
|
+
</p>
|
|
369
|
+
</li>
|
|
370
|
+
<li>
|
|
371
|
+
<p>
|
|
372
|
+
See also the <em>AsciiDoc</em> distribution BUGS file.
|
|
373
|
+
</p>
|
|
374
|
+
</li>
|
|
375
|
+
</ul></div>
|
|
376
|
+
</div>
|
|
377
|
+
<h2 id="_author">AUTHOR</h2>
|
|
378
|
+
<div class="sectionbody">
|
|
379
|
+
<div class="paragraph"><p>Written by Stuart Rackham, <<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>></p></div>
|
|
380
|
+
</div>
|
|
381
|
+
<h2 id="_resources">RESOURCES</h2>
|
|
382
|
+
<div class="sectionbody">
|
|
383
|
+
<div class="paragraph"><p>SourceForge: <a href="http://sourceforge.net/projects/asciidoc/">http://sourceforge.net/projects/asciidoc/</a></p></div>
|
|
384
|
+
<div class="paragraph"><p>Main web site: <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a></p></div>
|
|
385
|
+
</div>
|
|
386
|
+
<h2 id="_copying">COPYING</h2>
|
|
387
|
+
<div class="sectionbody">
|
|
388
|
+
<div class="paragraph"><p>Copyright (C) 2002-2008 Stuart Rackham. Free use of this software is
|
|
389
|
+
granted under the terms of the GNU General Public License (GPL).</p></div>
|
|
390
|
+
</div>
|
|
391
|
+
<div id="footer">
|
|
392
|
+
<div id="footer-text">
|
|
393
|
+
Version 8.3.3<br />
|
|
394
|
+
Last updated 2009-01-02 11:18:42 NZDT
|
|
395
|
+
</div>
|
|
396
|
+
<div id="footer-badges">
|
|
397
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
|
398
|
+
<img style="border:none; width:88px; height:31px;"
|
|
399
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
|
400
|
+
alt="Valid XHTML 1.1!" />
|
|
401
|
+
</a>
|
|
402
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
|
403
|
+
<img style="border:none; width:88px; height:31px;"
|
|
404
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
|
405
|
+
alt="Valid CSS!" />
|
|
406
|
+
</a>
|
|
407
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
|
408
|
+
<img style="border:none; width:110px; height:32px;"
|
|
409
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
|
410
|
+
alt="Get Firefox!" />
|
|
411
|
+
</a>
|
|
412
|
+
</div>
|
|
413
|
+
</div>
|
|
414
|
+
</div>
|
|
415
|
+
</td>
|
|
416
|
+
</tr>
|
|
417
|
+
</table>
|
|
418
|
+
</body>
|
|
419
|
+
</html>
|