mizuho 0.9.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,204 @@
|
|
1
|
+
A2X(1)
|
2
|
+
======
|
3
|
+
Stuart Rackham <srackham@gmail.com>
|
4
|
+
|
5
|
+
|
6
|
+
NAME
|
7
|
+
----
|
8
|
+
a2x - convert Asciidoc text file to PDF, XHTML, HTML Help, manpage or
|
9
|
+
plain text
|
10
|
+
|
11
|
+
|
12
|
+
SYNOPSIS
|
13
|
+
--------
|
14
|
+
*a2x* ['OPTIONS'] 'FILE'
|
15
|
+
|
16
|
+
|
17
|
+
DESCRIPTION
|
18
|
+
-----------
|
19
|
+
A DocBook toolchain wrapper script that translates an AsciiDoc text
|
20
|
+
file 'FILE' to PDF, DVI, PS, LaTeX, XHTML (single page or chunked),
|
21
|
+
man page, HTML Help or plain text formats. PDF, XHTML, man page and
|
22
|
+
HTML Help formats are are generated using the asciidoc(1),
|
23
|
+
xsltproc(1), DocBook XSL Stylesheets, dblatex (or FOP) toolchain.
|
24
|
+
Plain text is produced by passing asciidoc(1) generated HTML through
|
25
|
+
lynx(1). The htmlhelp format option generates .hhp, .hhc and .html
|
26
|
+
files suitable for compilation to an HTML Help .chm file.
|
27
|
+
|
28
|
+
|
29
|
+
OPTIONS
|
30
|
+
-------
|
31
|
+
*-a, --attribute*='ATTRIBUTE'::
|
32
|
+
Set asciidoc(1) attribute value (shortcut for *--asciidoc-opts*='"-a
|
33
|
+
ATTRIBUTE"' option). This option may be specified more than once.
|
34
|
+
|
35
|
+
*--asciidoc-opts*='ASCIIDOC_OPTS'::
|
36
|
+
Additional asciidoc(1) options. This option may be specified more
|
37
|
+
than once.
|
38
|
+
|
39
|
+
*--copy*::
|
40
|
+
Copy distributed docbook-xsl CSS stylesheet admonition and
|
41
|
+
navigation icons to their respective destinations. Applies to
|
42
|
+
'xhtml', 'chunked', 'htmlhelp' formats. The default behavior is to
|
43
|
+
suppress copying.
|
44
|
+
|
45
|
+
*-D, --destination-dir*='PATH'::
|
46
|
+
Output directory. Defaults to source 'FILE' directory.
|
47
|
+
|
48
|
+
*-d, --doctype*='DOCTYPE'::
|
49
|
+
DocBook document type: 'article', 'manpage' or 'book'. Default
|
50
|
+
document type is 'article' unless the format is 'manpage' (in which
|
51
|
+
case it defaults to 'manpage').
|
52
|
+
|
53
|
+
*-f, --format*='FORMAT'::
|
54
|
+
Output format: 'chunked', 'dvi', 'htmlhelp', 'manpage', 'pdf', 'ps',
|
55
|
+
'tex', 'text' or 'xhtml'.
|
56
|
+
|
57
|
+
*-h, --help*::
|
58
|
+
Print command-line syntax and program options to stdout.
|
59
|
+
|
60
|
+
*--icons*::
|
61
|
+
Use admonition or navigation icon images in output documents. The
|
62
|
+
default behavior is to use text in place of icons.
|
63
|
+
|
64
|
+
*--icons-dir*='PATH'::
|
65
|
+
A path (relative to destination HTML files) containing admonition
|
66
|
+
and navigation icons. Defaults to './images/icons/'.
|
67
|
+
Applies to 'xhtml', 'chunked', 'htmlhelp' formats.
|
68
|
+
|
69
|
+
*-L, --no-xmllint*::
|
70
|
+
Don't check asciidoc output with 'xmllint(1)'.
|
71
|
+
|
72
|
+
*-n, --dry-run*::
|
73
|
+
Don't do anything just print what would have been done.
|
74
|
+
|
75
|
+
*-s, --skip-asciidoc*::
|
76
|
+
Skip asciidoc execution. This is useful for converting DocBook XML
|
77
|
+
files not derived from AsciiDoc sources. Ignored if '--format=text'.
|
78
|
+
|
79
|
+
*--stylesheet*='PATH'::
|
80
|
+
A path (relative to destination HTML files) specifying the
|
81
|
+
docbook-xsl CSS stylesheet file. Defaults to './docbook-xsl.css'.
|
82
|
+
Applies to 'xhtml', 'chunked', 'htmlhelp' formats.
|
83
|
+
|
84
|
+
*-v, --verbose*::
|
85
|
+
Print operational details to stderr.
|
86
|
+
A second *-v* option applies the verbose option to toolchain commands.
|
87
|
+
|
88
|
+
*--version*::
|
89
|
+
Print program version to stdout.
|
90
|
+
|
91
|
+
*--xsltproc-opts*='XSLTPROC_OPTS'::
|
92
|
+
Additional xsltproc(1) options. This option may be specified more
|
93
|
+
than once.
|
94
|
+
|
95
|
+
*--fop*::
|
96
|
+
Use FOP to generate PDFs.
|
97
|
+
|
98
|
+
*--fop-opts*='FOP_OPTS'::
|
99
|
+
Additional fop options. This option may be specified more than
|
100
|
+
once. If this option is specified FOP is used to generate PDFs.
|
101
|
+
|
102
|
+
*--dblatex-opts*='DBLATEX_OPTS'::
|
103
|
+
Additional dblatex options. This option may be specified more than once.
|
104
|
+
|
105
|
+
|
106
|
+
OUTPUT FILES
|
107
|
+
------------
|
108
|
+
Output files are written to the directory specified by the
|
109
|
+
*--destination-dir* option. If no *--destination-dir* option is set
|
110
|
+
output files are written to the source FILE directory.
|
111
|
+
|
112
|
+
Output files have the same name as the source 'FILE' but with an
|
113
|
+
appropriate file name extension: .html for 'xhtml'; .hhp for
|
114
|
+
'htmlhelp'; .pdf for 'pdf'; .text for 'text'. By convention manpages
|
115
|
+
have no .man extension (man page section number only). Chunked HTML
|
116
|
+
directory names have a .chunked extension; chunked HTML Help directory
|
117
|
+
names have a .htmlhelp extension.
|
118
|
+
|
119
|
+
Same named existing files are overwritten.
|
120
|
+
|
121
|
+
Intermediate output files are written to the source 'FILE' directory
|
122
|
+
and are not automatically deleted.
|
123
|
+
|
124
|
+
Intermediate DocBook XML files generated by AsciiDoc are only
|
125
|
+
regenerated if out of date with respect to the AsciiDoc source 'FILE'.
|
126
|
+
|
127
|
+
In addition to generating HTML files the 'xhtml', 'chunked' and
|
128
|
+
'htmlhelp' formats copy the DocBook XSL stylesheet plus admonition and
|
129
|
+
navigation icons distributed with AsciiDoc to their respective
|
130
|
+
destination locations. Existing stylesheets and icons are only copied
|
131
|
+
if they are newer than the destination files or if the destination
|
132
|
+
files are missing.
|
133
|
+
|
134
|
+
The 'xhtml' format generates a single XHTML output page. The
|
135
|
+
'chunked' format writes multiple per-section HTML pages to a chunked
|
136
|
+
directory in the destination directory. The chunked directory has the
|
137
|
+
same name as the source 'FILE' name plus a .chunked extension.
|
138
|
+
|
139
|
+
|
140
|
+
EXAMPLES
|
141
|
+
--------
|
142
|
+
`a2x -f pdf doc/source-highlight-filter.txt`::
|
143
|
+
Generates doc/source-highlight-filter.pdf file.
|
144
|
+
|
145
|
+
`a2x -f chunked -D ../webpages guide.txt`::
|
146
|
+
Creates chunked directory `../webpages/guide.chunked` containing
|
147
|
+
chunked HTML files. Also copies `docbook-xsl.css` stylesheet to the
|
148
|
+
`../webpages/guide.chunked` directory plus admonition and navigation
|
149
|
+
icons to the `../webpages/guide.chunked/images/icons` directory.
|
150
|
+
|
151
|
+
|
152
|
+
REQUISITES
|
153
|
+
----------
|
154
|
+
This script runs under the bash(1) shell and requires the following
|
155
|
+
programs (which may or may not be prepackaged with your Linux
|
156
|
+
distribution):
|
157
|
+
|
158
|
+
Asciidoc::
|
159
|
+
http://www.methods.co.nz/asciidoc/
|
160
|
+
|
161
|
+
xsltproc::
|
162
|
+
http://xmlsoft.org/XSLT/
|
163
|
+
|
164
|
+
DocBook XSL Stylesheets::
|
165
|
+
http://docbook.sourceforge.net/projects/xsl/
|
166
|
+
|
167
|
+
dblatex (for PDF, DVI, PostScript and LaTeX file generation)::
|
168
|
+
http://dblatex.sourceforge.net/
|
169
|
+
|
170
|
+
FOP (alternative PDF file generation)::
|
171
|
+
http://xmlgraphics.apache.org/fop/
|
172
|
+
|
173
|
+
w3m (text file generation)::
|
174
|
+
http://w3m.sourceforge.net/index.en.html
|
175
|
+
|
176
|
+
Lynx (used for text file generation if `w3m(1)` not installed)::
|
177
|
+
http://lynx.isc.org/
|
178
|
+
|
179
|
+
See also the latest README file.
|
180
|
+
|
181
|
+
|
182
|
+
BUGS
|
183
|
+
----
|
184
|
+
- The odt output format is undocumented and experimental.
|
185
|
+
- See also the AsciiDoc distribution BUGS file.
|
186
|
+
|
187
|
+
|
188
|
+
AUTHOR
|
189
|
+
------
|
190
|
+
Written by Stuart Rackham, <srackham@gmail.com>
|
191
|
+
|
192
|
+
|
193
|
+
RESOURCES
|
194
|
+
---------
|
195
|
+
SourceForge: http://sourceforge.net/projects/asciidoc/
|
196
|
+
|
197
|
+
Main web site: http://www.methods.co.nz/asciidoc/
|
198
|
+
|
199
|
+
|
200
|
+
COPYING
|
201
|
+
-------
|
202
|
+
Copyright \(C) 2002-2008 Stuart Rackham. Free use of this software is
|
203
|
+
granted under the terms of the GNU General Public License (GPL).
|
204
|
+
|
@@ -0,0 +1,130 @@
|
|
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 DocBook XSL Stylesheets Notes</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="asciidoc-docbook-xsl.txt">Page Source</a></div>
|
32
|
+
</td>
|
33
|
+
<td>
|
34
|
+
<div id="layout-content">
|
35
|
+
<div id="header">
|
36
|
+
<h1>AsciiDoc DocBook XSL Stylesheets Notes</h1>
|
37
|
+
</div>
|
38
|
+
<div id="preamble">
|
39
|
+
<div class="sectionbody">
|
40
|
+
<div class="paragraph"><p>PDF generation from <em>AsciiDoc</em> generated DocBook using FOP plus DocBook XSL
|
41
|
+
Stylesheets.</p></div>
|
42
|
+
<div class="ulist"><ul>
|
43
|
+
<li>
|
44
|
+
<p>
|
45
|
+
FOP 0.95beta.
|
46
|
+
</p>
|
47
|
+
</li>
|
48
|
+
<li>
|
49
|
+
<p>
|
50
|
+
DocBook XSL Stylesheets version 1.74.0.
|
51
|
+
</p>
|
52
|
+
</li>
|
53
|
+
</ul></div>
|
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
|
+
confine it to the separate XSL driver files in the distribution
|
57
|
+
<tt>./docbook-xsl/</tt> directory (see the User Guide for details).</p></div>
|
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
|
+
and included in the distribution <tt>./docbook-xsl/</tt> directory.</p></div>
|
61
|
+
</div>
|
62
|
+
</div>
|
63
|
+
<h2 id="_manually_upgrading_debian_to_the_latest_docbook_xsl_stylesheets">Manually upgrading Debian to the latest DocBook XSL stylesheets</h2>
|
64
|
+
<div class="sectionbody">
|
65
|
+
<div class="paragraph"><p>The DocBook XSL Stylesheets distribution is just a directory full of
|
66
|
+
text files and you can switch between releases by changing the
|
67
|
+
directory name in the system XML catalog.</p></div>
|
68
|
+
<div class="paragraph"><p>To upgrade to the latest docbook-xsl stylesheets without having to
|
69
|
+
wait for the Debian <tt>docbook-xsl</tt> package:</p></div>
|
70
|
+
<div class="ulist"><ul>
|
71
|
+
<li>
|
72
|
+
<p>
|
73
|
+
Download the latest docbook-xsl tarball from
|
74
|
+
<a href="http://sourceforge.net/projects/docbook/">http://sourceforge.net/projects/docbook/</a>.
|
75
|
+
</p>
|
76
|
+
</li>
|
77
|
+
<li>
|
78
|
+
<p>
|
79
|
+
Unzip the tarball to <tt>/usr/share/xml/docbook/stylesheet/</tt>:
|
80
|
+
</p>
|
81
|
+
<div class="literalblock">
|
82
|
+
<div class="content">
|
83
|
+
<pre><tt>$ cd /usr/share/xml/docbook/stylesheet
|
84
|
+
$ sudo tar -xzf /tmp/docbook-xsl-1.72.0.tar.gz</tt></pre>
|
85
|
+
</div></div>
|
86
|
+
</li>
|
87
|
+
<li>
|
88
|
+
<p>
|
89
|
+
Edit <tt>/etc/xml/docbook-xsl.xml</tt> catalog and replace occurences of
|
90
|
+
the current stylesheets directory with the new one (in our example
|
91
|
+
it would be <tt>/usr/share/xml/docbook/stylesheet/docbook-xsl-1.72.0</tt>.
|
92
|
+
</p>
|
93
|
+
<div class="literalblock">
|
94
|
+
<div class="content">
|
95
|
+
<pre><tt>$ cd /etc/xml/
|
96
|
+
$ sudo cp -p docbook-xsl.xml docbook-xsl.xml.ORIG
|
97
|
+
$ sudo vi docbook-xsl.xml</tt></pre>
|
98
|
+
</div></div>
|
99
|
+
</li>
|
100
|
+
</ul></div>
|
101
|
+
</div>
|
102
|
+
<div id="footer">
|
103
|
+
<div id="footer-text">
|
104
|
+
Version 8.3.3<br />
|
105
|
+
Last updated 2009-01-02 11:18:43 NZDT
|
106
|
+
</div>
|
107
|
+
<div id="footer-badges">
|
108
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
109
|
+
<img style="border:none; width:88px; height:31px;"
|
110
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
111
|
+
alt="Valid XHTML 1.1!" />
|
112
|
+
</a>
|
113
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
114
|
+
<img style="border:none; width:88px; height:31px;"
|
115
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
116
|
+
alt="Valid CSS!" />
|
117
|
+
</a>
|
118
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
119
|
+
<img style="border:none; width:110px; height:32px;"
|
120
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
121
|
+
alt="Get Firefox!" />
|
122
|
+
</a>
|
123
|
+
</div>
|
124
|
+
</div>
|
125
|
+
</div>
|
126
|
+
</td>
|
127
|
+
</tr>
|
128
|
+
</table>
|
129
|
+
</body>
|
130
|
+
</html>
|
@@ -0,0 +1,43 @@
|
|
1
|
+
AsciiDoc DocBook XSL Stylesheets Notes
|
2
|
+
======================================
|
3
|
+
|
4
|
+
PDF generation from AsciiDoc generated DocBook using FOP plus DocBook XSL
|
5
|
+
Stylesheets.
|
6
|
+
|
7
|
+
- FOP 0.95beta.
|
8
|
+
- DocBook XSL Stylesheets version 1.74.0.
|
9
|
+
|
10
|
+
Output file customisation is achieved by tweaking the DocBook XSL
|
11
|
+
stylesheets. I've tried to keep customization to a minimum and
|
12
|
+
confine it to the separate XSL driver files in the distribution
|
13
|
+
`./docbook-xsl/` directory (see the User Guide for details).
|
14
|
+
|
15
|
+
To polish some rough edges I've written some patches for the DocBook
|
16
|
+
XSL stylesheets -- you don't need them but they're documented below
|
17
|
+
and included in the distribution `./docbook-xsl/` directory.
|
18
|
+
|
19
|
+
|
20
|
+
Manually upgrading Debian to the latest DocBook XSL stylesheets
|
21
|
+
---------------------------------------------------------------
|
22
|
+
The DocBook XSL Stylesheets distribution is just a directory full of
|
23
|
+
text files and you can switch between releases by changing the
|
24
|
+
directory name in the system XML catalog.
|
25
|
+
|
26
|
+
To upgrade to the latest docbook-xsl stylesheets without having to
|
27
|
+
wait for the Debian `docbook-xsl` package:
|
28
|
+
|
29
|
+
- Download the latest docbook-xsl tarball from
|
30
|
+
http://sourceforge.net/projects/docbook/.
|
31
|
+
|
32
|
+
- Unzip the tarball to `/usr/share/xml/docbook/stylesheet/`:
|
33
|
+
|
34
|
+
$ cd /usr/share/xml/docbook/stylesheet
|
35
|
+
$ sudo tar -xzf /tmp/docbook-xsl-1.72.0.tar.gz
|
36
|
+
|
37
|
+
- Edit `/etc/xml/docbook-xsl.xml` catalog and replace occurences of
|
38
|
+
the current stylesheets directory with the new one (in our example
|
39
|
+
it would be `/usr/share/xml/docbook/stylesheet/docbook-xsl-1.72.0`.
|
40
|
+
|
41
|
+
$ cd /etc/xml/
|
42
|
+
$ sudo cp -p docbook-xsl.xml docbook-xsl.xml.ORIG
|
43
|
+
$ sudo vi docbook-xsl.xml
|
@@ -0,0 +1,130 @@
|
|
1
|
+
= Graphviz filter for AsciiDoc =
|
2
|
+
|
3
|
+
Author: Gouichi Iisaka
|
4
|
+
|
5
|
+
Version: 1.0
|
6
|
+
|
7
|
+
== Introduction ==
|
8
|
+
|
9
|
+
Graph visualization is a way of representing structural information
|
10
|
+
as diagrams of abstract graphs and networks.
|
11
|
+
|
12
|
+
AsciiDoc can external shell commands used to process Paragraph and
|
13
|
+
DelimitedBlock content by Filter.
|
14
|
+
|
15
|
+
|
16
|
+
== Simple Example ==
|
17
|
+
|
18
|
+
--------------------------------------------------------------------
|
19
|
+
["graphviz", "sample1.png"]
|
20
|
+
---------------------------------------------------------------------
|
21
|
+
digraph G { rankdir=LR; Graphviz->AsciiDoc->HTML}
|
22
|
+
---------------------------------------------------------------------
|
23
|
+
--------------------------------------------------------------------
|
24
|
+
|
25
|
+
["graphviz", "sample1.png"]
|
26
|
+
---------------------------------------------------------------------
|
27
|
+
digraph G { rankdir=LR; Graphviz->AsciiDoc->HTML}
|
28
|
+
---------------------------------------------------------------------
|
29
|
+
|
30
|
+
---------------------------------------------------------------------
|
31
|
+
["graphviz", "sample2.png"]
|
32
|
+
---------------------------------------------------------------------
|
33
|
+
digraph automata_0 {
|
34
|
+
size ="8.5, 11";
|
35
|
+
node [shape = circle];
|
36
|
+
0 [ style = filled, color=lightgrey ];
|
37
|
+
2 [ shape = doublecircle ];
|
38
|
+
0 -> 2 [ label = "a " ];
|
39
|
+
0 -> 1 [ label = "other " ];
|
40
|
+
1 -> 2 [ label = "a " ];
|
41
|
+
1 -> 1 [ label = "other " ];
|
42
|
+
2 -> 2 [ label = "a " ];
|
43
|
+
2 -> 1 [ label = "other " ];
|
44
|
+
"Machine: a" [ shape = plaintext ];
|
45
|
+
}
|
46
|
+
---------------------------------------------------------------------
|
47
|
+
---------------------------------------------------------------------
|
48
|
+
|
49
|
+
["graphviz", "sample3.png"]
|
50
|
+
---------------------------------------------------------------------
|
51
|
+
digraph automata_0 {
|
52
|
+
size ="8.5, 11";
|
53
|
+
node [shape = circle];
|
54
|
+
0 [ style = filled, color=lightgrey ];
|
55
|
+
2 [ shape = doublecircle ];
|
56
|
+
0 -> 2 [ label = "a " ];
|
57
|
+
0 -> 1 [ label = "other " ];
|
58
|
+
1 -> 2 [ label = "a " ];
|
59
|
+
1 -> 1 [ label = "other " ];
|
60
|
+
2 -> 2 [ label = "a " ];
|
61
|
+
2 -> 1 [ label = "other " ];
|
62
|
+
"Machine: a" [ shape = plaintext ];
|
63
|
+
}
|
64
|
+
---------------------------------------------------------------------
|
65
|
+
|
66
|
+
|
67
|
+
--------------------------------------------------------------------
|
68
|
+
["graphviz", "sample4.png", "dot"]
|
69
|
+
---------------------------------------------------------------------
|
70
|
+
digraph finite_state_machine {
|
71
|
+
rankdir=LR;
|
72
|
+
size="8,5"
|
73
|
+
node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
|
74
|
+
node [shape = circle];
|
75
|
+
LR_0 -> LR_2 [ label = "SS(B)" ];
|
76
|
+
LR_0 -> LR_1 [ label = "SS(S)" ];
|
77
|
+
LR_1 -> LR_3 [ label = "S($end)" ];
|
78
|
+
LR_2 -> LR_6 [ label = "SS(b)" ];
|
79
|
+
LR_2 -> LR_5 [ label = "SS(a)" ];
|
80
|
+
LR_2 -> LR_4 [ label = "S(A)" ];
|
81
|
+
LR_5 -> LR_7 [ label = "S(b)" ];
|
82
|
+
LR_5 -> LR_5 [ label = "S(a)" ];
|
83
|
+
LR_6 -> LR_6 [ label = "S(b)" ];
|
84
|
+
LR_6 -> LR_5 [ label = "S(a)" ];
|
85
|
+
LR_7 -> LR_8 [ label = "S(b)" ];
|
86
|
+
LR_7 -> LR_5 [ label = "S(a)" ];
|
87
|
+
LR_8 -> LR_6 [ label = "S(b)" ];
|
88
|
+
LR_8 -> LR_5 [ label = "S(a)" ];
|
89
|
+
}
|
90
|
+
---------------------------------------------------------------------
|
91
|
+
--------------------------------------------------------------------
|
92
|
+
|
93
|
+
.Example for `dot':
|
94
|
+
["graphviz", "sample4.png", "dot"]
|
95
|
+
---------------------------------------------------------------------
|
96
|
+
digraph finite_state_machine {
|
97
|
+
rankdir=LR;
|
98
|
+
size="8,5"
|
99
|
+
node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
|
100
|
+
node [shape = circle];
|
101
|
+
LR_0 -> LR_2 [ label = "SS(B)" ];
|
102
|
+
LR_0 -> LR_1 [ label = "SS(S)" ];
|
103
|
+
LR_1 -> LR_3 [ label = "S($end)" ];
|
104
|
+
LR_2 -> LR_6 [ label = "SS(b)" ];
|
105
|
+
LR_2 -> LR_5 [ label = "SS(a)" ];
|
106
|
+
LR_2 -> LR_4 [ label = "S(A)" ];
|
107
|
+
LR_5 -> LR_7 [ label = "S(b)" ];
|
108
|
+
LR_5 -> LR_5 [ label = "S(a)" ];
|
109
|
+
LR_6 -> LR_6 [ label = "S(b)" ];
|
110
|
+
LR_6 -> LR_5 [ label = "S(a)" ];
|
111
|
+
LR_7 -> LR_8 [ label = "S(b)" ];
|
112
|
+
LR_7 -> LR_5 [ label = "S(a)" ];
|
113
|
+
LR_8 -> LR_6 [ label = "S(b)" ];
|
114
|
+
LR_8 -> LR_5 [ label = "S(a)" ];
|
115
|
+
}
|
116
|
+
---------------------------------------------------------------------
|
117
|
+
|
118
|
+
|
119
|
+
== Layout ==
|
120
|
+
|
121
|
+
layout for graphviz as follows.
|
122
|
+
|
123
|
+
* dot:: filter for drawing directed graphs
|
124
|
+
* neato:: filter for drawing undirected graphs
|
125
|
+
* twopi:: filter for radial layouts of graphs
|
126
|
+
* circo:: filter for circular layout of graphs
|
127
|
+
* fdp:: filter for drawing undirected graphs
|
128
|
+
|
129
|
+
default is `dot'.
|
130
|
+
|