FooBarWidget-mizuho 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. data/LICENSE.txt +20 -0
  2. data/README.markdown +68 -0
  3. data/Rakefile +9 -0
  4. data/asciidoc/BUGS +34 -0
  5. data/asciidoc/BUGS.txt +28 -0
  6. data/asciidoc/CHANGELOG +1585 -0
  7. data/asciidoc/CHANGELOG.txt +1595 -0
  8. data/asciidoc/COPYING +339 -0
  9. data/asciidoc/COPYRIGHT +18 -0
  10. data/asciidoc/INSTALL +82 -0
  11. data/asciidoc/INSTALL.txt +71 -0
  12. data/asciidoc/README +46 -0
  13. data/asciidoc/README.txt +36 -0
  14. data/asciidoc/a2x +641 -0
  15. data/asciidoc/asciidoc.conf +404 -0
  16. data/asciidoc/asciidoc.py +4255 -0
  17. data/asciidoc/common.aap +9 -0
  18. data/asciidoc/dblatex/asciidoc-dblatex.sty +18 -0
  19. data/asciidoc/dblatex/asciidoc-dblatex.xsl +17 -0
  20. data/asciidoc/dblatex/dblatex-readme.txt +22 -0
  21. data/asciidoc/doc/a2x.1 +246 -0
  22. data/asciidoc/doc/a2x.1.txt +195 -0
  23. data/asciidoc/doc/article.css-embedded.html +579 -0
  24. data/asciidoc/doc/article.html +62 -0
  25. data/asciidoc/doc/article.pdf +0 -0
  26. data/asciidoc/doc/article.txt +124 -0
  27. data/asciidoc/doc/asciidoc-revhistory.xml +27 -0
  28. data/asciidoc/doc/asciidoc.1 +161 -0
  29. data/asciidoc/doc/asciidoc.1.css-embedded.html +562 -0
  30. data/asciidoc/doc/asciidoc.1.css.html +212 -0
  31. data/asciidoc/doc/asciidoc.1.html +190 -0
  32. data/asciidoc/doc/asciidoc.1.txt +118 -0
  33. data/asciidoc/doc/asciidoc.conf +8 -0
  34. data/asciidoc/doc/asciidoc.css-embedded.html +7954 -0
  35. data/asciidoc/doc/asciidoc.css.html +7553 -0
  36. data/asciidoc/doc/asciidoc.dict +673 -0
  37. data/asciidoc/doc/asciidoc.html +3502 -0
  38. data/asciidoc/doc/asciidoc.txt +4757 -0
  39. data/asciidoc/doc/asciimath.txt +47 -0
  40. data/asciidoc/doc/book-multi.css-embedded.html +575 -0
  41. data/asciidoc/doc/book-multi.html +72 -0
  42. data/asciidoc/doc/book-multi.txt +159 -0
  43. data/asciidoc/doc/book.css-embedded.html +585 -0
  44. data/asciidoc/doc/book.html +60 -0
  45. data/asciidoc/doc/book.txt +133 -0
  46. data/asciidoc/doc/customers.csv +18 -0
  47. data/asciidoc/doc/faq.txt +262 -0
  48. data/asciidoc/doc/latex-backend.html +224 -0
  49. data/asciidoc/doc/latex-backend.txt +193 -0
  50. data/asciidoc/doc/latexmath.txt +35 -0
  51. data/asciidoc/doc/main.aap +293 -0
  52. data/asciidoc/doc/music-filter.html +513 -0
  53. data/asciidoc/doc/music-filter.pdf +0 -0
  54. data/asciidoc/doc/music-filter.txt +158 -0
  55. data/asciidoc/doc/source-highlight-filter.html +183 -0
  56. data/asciidoc/doc/source-highlight-filter.pdf +0 -0
  57. data/asciidoc/doc/source-highlight-filter.txt +174 -0
  58. data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +71 -0
  59. data/asciidoc/docbook-xsl/chunked.xsl +19 -0
  60. data/asciidoc/docbook-xsl/common.xsl +67 -0
  61. data/asciidoc/docbook-xsl/fo.xsl +117 -0
  62. data/asciidoc/docbook-xsl/htmlhelp.xsl +17 -0
  63. data/asciidoc/docbook-xsl/manpage.xsl +28 -0
  64. data/asciidoc/docbook-xsl/shaded-literallayout.patch +32 -0
  65. data/asciidoc/docbook-xsl/xhtml.xsl +14 -0
  66. data/asciidoc/docbook.conf +606 -0
  67. data/asciidoc/examples/website/CHANGELOG.html +3828 -0
  68. data/asciidoc/examples/website/INSTALL.html +163 -0
  69. data/asciidoc/examples/website/README-website.html +129 -0
  70. data/asciidoc/examples/website/README-website.txt +29 -0
  71. data/asciidoc/examples/website/README.html +125 -0
  72. data/asciidoc/examples/website/a2x.1.html +395 -0
  73. data/asciidoc/examples/website/asciidoc-docbook-xsl.html +165 -0
  74. data/asciidoc/examples/website/asciimath.html +157 -0
  75. data/asciidoc/examples/website/build-website.sh +25 -0
  76. data/asciidoc/examples/website/downloads.html +219 -0
  77. data/asciidoc/examples/website/downloads.txt +98 -0
  78. data/asciidoc/examples/website/faq.html +372 -0
  79. data/asciidoc/examples/website/index.html +398 -0
  80. data/asciidoc/examples/website/index.txt +222 -0
  81. data/asciidoc/examples/website/latex-backend.html +640 -0
  82. data/asciidoc/examples/website/latexmath.html +119 -0
  83. data/asciidoc/examples/website/layout1.conf +161 -0
  84. data/asciidoc/examples/website/layout1.css +65 -0
  85. data/asciidoc/examples/website/layout2.conf +158 -0
  86. data/asciidoc/examples/website/layout2.css +93 -0
  87. data/asciidoc/examples/website/manpage.html +266 -0
  88. data/asciidoc/examples/website/music-filter.html +242 -0
  89. data/asciidoc/examples/website/music1.abc +12 -0
  90. data/asciidoc/examples/website/music1.png +0 -0
  91. data/asciidoc/examples/website/music2.ly +9 -0
  92. data/asciidoc/examples/website/music2.png +0 -0
  93. data/asciidoc/examples/website/source-highlight-filter.html +251 -0
  94. data/asciidoc/examples/website/support.html +78 -0
  95. data/asciidoc/examples/website/support.txt +5 -0
  96. data/asciidoc/examples/website/userguide.html +7597 -0
  97. data/asciidoc/examples/website/version9.html +143 -0
  98. data/asciidoc/examples/website/version9.txt +48 -0
  99. data/asciidoc/filters/code-filter-readme.txt +37 -0
  100. data/asciidoc/filters/code-filter-test-c++.txt +7 -0
  101. data/asciidoc/filters/code-filter-test.txt +15 -0
  102. data/asciidoc/filters/code-filter.conf +8 -0
  103. data/asciidoc/filters/code-filter.py +239 -0
  104. data/asciidoc/filters/music-filter-test.txt +40 -0
  105. data/asciidoc/filters/music-filter.conf +40 -0
  106. data/asciidoc/filters/music2png.py +189 -0
  107. data/asciidoc/filters/source-highlight-filter-test.txt +19 -0
  108. data/asciidoc/filters/source-highlight-filter.conf +100 -0
  109. data/asciidoc/help.conf +213 -0
  110. data/asciidoc/html4.conf +363 -0
  111. data/asciidoc/images/highlighter.png +0 -0
  112. data/asciidoc/images/icons/README +5 -0
  113. data/asciidoc/images/icons/callouts/1.png +0 -0
  114. data/asciidoc/images/icons/callouts/10.png +0 -0
  115. data/asciidoc/images/icons/callouts/11.png +0 -0
  116. data/asciidoc/images/icons/callouts/12.png +0 -0
  117. data/asciidoc/images/icons/callouts/13.png +0 -0
  118. data/asciidoc/images/icons/callouts/14.png +0 -0
  119. data/asciidoc/images/icons/callouts/15.png +0 -0
  120. data/asciidoc/images/icons/callouts/2.png +0 -0
  121. data/asciidoc/images/icons/callouts/3.png +0 -0
  122. data/asciidoc/images/icons/callouts/4.png +0 -0
  123. data/asciidoc/images/icons/callouts/5.png +0 -0
  124. data/asciidoc/images/icons/callouts/6.png +0 -0
  125. data/asciidoc/images/icons/callouts/7.png +0 -0
  126. data/asciidoc/images/icons/callouts/8.png +0 -0
  127. data/asciidoc/images/icons/callouts/9.png +0 -0
  128. data/asciidoc/images/icons/caution.png +0 -0
  129. data/asciidoc/images/icons/example.png +0 -0
  130. data/asciidoc/images/icons/home.png +0 -0
  131. data/asciidoc/images/icons/important.png +0 -0
  132. data/asciidoc/images/icons/next.png +0 -0
  133. data/asciidoc/images/icons/note.png +0 -0
  134. data/asciidoc/images/icons/prev.png +0 -0
  135. data/asciidoc/images/icons/tip.png +0 -0
  136. data/asciidoc/images/icons/up.png +0 -0
  137. data/asciidoc/images/icons/warning.png +0 -0
  138. data/asciidoc/images/smallnew.png +0 -0
  139. data/asciidoc/images/tiger.png +0 -0
  140. data/asciidoc/install.sh +55 -0
  141. data/asciidoc/javascripts/ASCIIMathML.js +938 -0
  142. data/asciidoc/javascripts/LaTeXMathML.js +1223 -0
  143. data/asciidoc/javascripts/toc.js +69 -0
  144. data/asciidoc/lang-es.conf +15 -0
  145. data/asciidoc/latex.conf +663 -0
  146. data/asciidoc/linuxdoc.conf +285 -0
  147. data/asciidoc/math.conf +50 -0
  148. data/asciidoc/stylesheets/docbook-xsl.css +271 -0
  149. data/asciidoc/stylesheets/xhtml-deprecated-manpage.css +21 -0
  150. data/asciidoc/stylesheets/xhtml-deprecated.css +247 -0
  151. data/asciidoc/stylesheets/xhtml11-manpage.css +18 -0
  152. data/asciidoc/stylesheets/xhtml11-quirks.css +49 -0
  153. data/asciidoc/stylesheets/xhtml11.css +284 -0
  154. data/asciidoc/t.conf +20 -0
  155. data/asciidoc/text.conf +16 -0
  156. data/asciidoc/vim/ftdetect/asciidoc_filetype.vim +53 -0
  157. data/asciidoc/vim/syntax/asciidoc.vim +139 -0
  158. data/asciidoc/xhtml-deprecated-css.conf +235 -0
  159. data/asciidoc/xhtml-deprecated.conf +351 -0
  160. data/asciidoc/xhtml11-quirks.conf +57 -0
  161. data/asciidoc/xhtml11.conf +514 -0
  162. data/bin/mizuho +40 -0
  163. data/lib/mizuho/chapter.rb +54 -0
  164. data/lib/mizuho/generator.rb +106 -0
  165. data/lib/mizuho/heading.rb +46 -0
  166. data/lib/mizuho/parser.rb +99 -0
  167. data/lib/mizuho/template.rb +50 -0
  168. data/mizuho.gemspec +34 -0
  169. data/templates/asciidoc.css +358 -0
  170. data/templates/asciidoc.html.erb +86 -0
  171. data/templates/manualsonrails.css +165 -0
  172. data/templates/manualsonrails.html.erb +97 -0
  173. data/test/parser_spec.rb +190 -0
  174. data/test/spec_helper.rb +43 -0
  175. metadata +234 -0
@@ -0,0 +1,9 @@
1
+ #
2
+ # Executed by all main.aap's before anything else.
3
+ #
4
+
5
+ _parent.VERS = 8.2.7
6
+ _parent.DATE = 4 July 2008
7
+
8
+ all:
9
+ :pass
@@ -0,0 +1,18 @@
1
+ %%
2
+ %% This style is derived from the docbook one.
3
+ %%
4
+ \NeedsTeXFormat{LaTeX2e}
5
+ \ProvidesPackage{asciidoc}[2008/06/05 AsciiDoc DocBook Style]
6
+ %% Just use the original package and pass the options.
7
+ \RequirePackageWithOptions{docbook}
8
+
9
+ % Sidebar is a boxed minipage that can contain verbatim.
10
+ % Changed shadow box to double box.
11
+ \renewenvironment{sidebar}[1][0.95\textwidth]{
12
+ \hspace{0mm}\newline%
13
+ \noindent\begin{Sbox}\begin{minipage}{#1}%
14
+ \setlength\parskip{\medskipamount}%
15
+ }{
16
+ \end{minipage}\end{Sbox}\doublebox{\TheSbox}%
17
+ }
18
+
@@ -0,0 +1,17 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!--
3
+ dblatex(1) XSL user stylesheet for asciidoc(1).
4
+ See dblatex(1) -p option.
5
+ -->
6
+ <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
7
+ <!-- TOC links in the titles, and in blue. -->
8
+ <xsl:param name="latex.hyperparam">colorlinks,linkcolor=blue,pdfstartview=FitH</xsl:param>
9
+ <xsl:param name="doc.publisher.show">1</xsl:param>
10
+ <xsl:param name="doc.lot.show"></xsl:param>
11
+ <xsl:param name="term.breakline">1</xsl:param>
12
+ <xsl:param name="doc.collab.show">0</xsl:param>
13
+ <xsl:param name="doc.section.depth">3</xsl:param>
14
+ <xsl:param name="table.in.float">0</xsl:param>
15
+ <xsl:param name="monoseq.hyphenation">0</xsl:param>
16
+ </xsl:stylesheet>
17
+
@@ -0,0 +1,22 @@
1
+ AsciiDoc dblatex README
2
+ =======================
3
+
4
+ Customization
5
+ -------------
6
+ The `./dblatex` directory contains:
7
+
8
+ `./dblatex/asciidoc-dblatex.xsl`:: Optional dblatex XSL parameter
9
+ customization.
10
+
11
+ `./dblatex/asciidoc-dblatex.sty`:: Optional customized LaTeX styles.
12
+
13
+ Use these files with dblatex(1) `-p` and `-s` options, for example:
14
+
15
+ dblatex -p ../dblatex/asciidoc-dblatex.xsl \
16
+ -s ../dblatex/asciidoc-dblatex.sty article.xml
17
+
18
+
19
+ Limitations
20
+ -----------
21
+ - As of 'dblatex' version 0.2.8 callouts are limited to images and
22
+ program listings and therefore aren't useful in AsciiDoc documents.
@@ -0,0 +1,246 @@
1
+ .\" Title: a2x
2
+ .\" Author:
3
+ .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
4
+ .\" Date: 07/04/2008
5
+ .\" Manual:
6
+ .\" Source:
7
+ .\"
8
+ .TH "A2X" "1" "07/04/2008" "" ""
9
+ .\" disable hyphenation
10
+ .nh
11
+ .\" disable justification (adjust text to left margin only)
12
+ .ad l
13
+ .SH "NAME"
14
+ a2x \- convert Asciidoc text file to PDF, XHTML, HTML Help, manpage or plain text
15
+ .SH "SYNOPSIS"
16
+ \fBa2x\fR [\fIOPTIONS\fR] \fIFILE\fR
17
+ .sp
18
+ .SH "DESCRIPTION"
19
+ A DocBook toolchain wrapper script that translates an AsciiDoc text file \fIFILE\fR to PDF, DVI, PS, LaTeX, XHTML (single page or chunked), man page, HTML Help or plain text formats. PDF, XHTML, man page and HTML Help formats are are generated using the asciidoc(1), xsltproc(1), DocBook XSL Stylesheets, dblatex (or FOP) toolchain. Plain text is produced by passing asciidoc(1) generated HTML through lynx(1). The htmlhelp format option generates .hhp, .hhc and .html files suitable for compilation to an HTML Help .chm file.
20
+ .sp
21
+ .SH "OPTIONS"
22
+ .PP
23
+ \fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR
24
+ .RS 4
25
+ Set asciidoc(1) attribute value (shortcut for
26
+ \fB\-\-asciidoc\-opts\fR=\fI"\-a ATTRIBUTE"\fR
27
+ option). This option may be specified more than once.
28
+ .RE
29
+ .PP
30
+ \fB\-\-asciidoc\-opts\fR=\fIASCIIDOC_OPTS\fR
31
+ .RS 4
32
+ Additional asciidoc(1) options. This option may be specified more than once.
33
+ .RE
34
+ .PP
35
+ \fB\-\-copy\fR
36
+ .RS 4
37
+ Copy distributed docbook\-xsl CSS stylesheet admonition and navigation icons to their respective destinations. Applies to
38
+ \fIxhtml\fR,
39
+ \fIchunked\fR,
40
+ \fIhtmlhelp\fR
41
+ formats. The default behavior is to suppress copying.
42
+ .RE
43
+ .PP
44
+ \fB\-D, \-\-destination\-dir\fR=\fIPATH\fR
45
+ .RS 4
46
+ Output directory. Defaults to source
47
+ \fIFILE\fR
48
+ directory.
49
+ .RE
50
+ .PP
51
+ \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR
52
+ .RS 4
53
+ DocBook document type:
54
+ \fIarticle\fR,
55
+ \fImanpage\fR
56
+ or
57
+ \fIbook\fR. Default document type is
58
+ \fIarticle\fR
59
+ unless the format is
60
+ \fImanpage\fR
61
+ (in which case it defaults to
62
+ \fImanpage\fR).
63
+ .RE
64
+ .PP
65
+ \fB\-f, \-\-format\fR=\fIFORMAT\fR
66
+ .RS 4
67
+ Output format:
68
+ \fIchunked\fR,
69
+ \fIdvi\fR,
70
+ \fIhtmlhelp\fR,
71
+ \fImanpage\fR,
72
+ \fIpdf\fR,
73
+ \fIps\fR,
74
+ \fItex\fR,
75
+ \fItext\fR
76
+ or
77
+ \fIxhtml\fR.
78
+ .RE
79
+ .PP
80
+ \fB\-h, \-\-help\fR
81
+ .RS 4
82
+ Print command\-line syntax and program options to stdout.
83
+ .RE
84
+ .PP
85
+ \fB\-\-icons\fR
86
+ .RS 4
87
+ Use admonition or navigation icon images in output documents. The default behavior is to use text in place of icons.
88
+ .RE
89
+ .PP
90
+ \fB\-\-icons\-dir\fR=\fIPATH\fR
91
+ .RS 4
92
+ A path (relative to destination HTML files) containing admonition and navigation icons. Defaults to
93
+ \fI./images/icons/\fR. Applies to
94
+ \fIxhtml\fR,
95
+ \fIchunked\fR,
96
+ \fIhtmlhelp\fR
97
+ formats.
98
+ .RE
99
+ .PP
100
+ \fB\-n, \-\-dry\-run\fR
101
+ .RS 4
102
+ Don't do anything just print what would have been done.
103
+ .RE
104
+ .PP
105
+ \fB\-s, \-\-skip\-asciidoc\fR
106
+ .RS 4
107
+ Skip asciidoc execution. This is useful for converting DocBook XML files not derived from AsciiDoc sources. Ignored if \-\-format*=\fItext\fR.
108
+ .RE
109
+ .PP
110
+ \fB\-\-stylesheet\fR=\fIPATH\fR
111
+ .RS 4
112
+ A path (relative to destination HTML files) specifying the docbook\-xsl CSS stylesheet file. Defaults to
113
+ \fI./docbook\-xsl.css\fR. Applies to
114
+ \fIxhtml\fR,
115
+ \fIchunked\fR,
116
+ \fIhtmlhelp\fR
117
+ formats.
118
+ .RE
119
+ .PP
120
+ \fB\-v, \-\-verbose\fR
121
+ .RS 4
122
+ Print operational details to stderr. A second
123
+ \fB\-v\fR
124
+ option applies the verbose option to toolchain commands.
125
+ .RE
126
+ .PP
127
+ \fB\-\-version\fR
128
+ .RS 4
129
+ Print program version to stdout.
130
+ .RE
131
+ .PP
132
+ \fB\-\-xsltproc\-opts\fR=\fIXSLTPROC_OPTS\fR
133
+ .RS 4
134
+ Additional xsltproc(1) options. This option may be specified more than once.
135
+ .RE
136
+ .PP
137
+ \fB\-\-fop\-opts\fR=\fIFOP_OPTS\fR
138
+ .RS 4
139
+ Additional fop options. This option may be specified more than once. If this option is specified fop is used to generate PDFs.
140
+ .RE
141
+ .PP
142
+ \fB\-\-dblatex\-opts\fR=\fIDBLATEX_OPTS\fR
143
+ .RS 4
144
+ Additional dblatex options. This option may be specified more than once.
145
+ .RE
146
+ .SH "OUTPUT FILES"
147
+ Output files are written to the directory specified by the \fB\-\-destination\-dir\fR option. If no \fB\-\-destination\-dir\fR option is set output files are written to the source FILE directory.
148
+ .sp
149
+ Output files have the same name as the source \fIFILE\fR but with an appropriate file name extension: .html for \fIxhtml\fR; .hhp for \fIhtmlhelp\fR; .pdf for \fIpdf\fR; .text for \fItext\fR. By convention manpages have no .man extension (man page section number only). Chunked HTML directory names have a .chunked extension; chunked HTML Help directory names have a .htmlhelp extension.
150
+ .sp
151
+ Same named existing files are overwritten.
152
+ .sp
153
+ Intermediate output files are written to the source \fIFILE\fR directory and are not automatically deleted.
154
+ .sp
155
+ Intermediate DocBook XML files generated by AsciiDoc are only regenerated if out of date with respect to the AsciiDoc source \fIFILE\fR.
156
+ .sp
157
+ In addition to generating HTML files the \fIxhtml\fR, \fIchunked\fR and \fIhtmlhelp\fR formats copy the DocBook XSL stylesheet plus admonition and navigation icons distributed with AsciiDoc to their respective destination locations. Existing stylesheets and icons are only copied if they are newer than the destination files or if the destination files are missing.
158
+ .sp
159
+ The \fIxhtml\fR format generates a single XHTML output page. The \fIchunked\fR format writes multiple per\-section HTML pages to a chunked directory in the destination directory. The chunked directory has the same name as the source \fIFILE\fR name plus a .chunked extension.
160
+ .sp
161
+ .SH "EXAMPLES"
162
+ .PP
163
+ a2x \-f pdf doc/source\-highlight\-filter.txt
164
+ .RS 4
165
+ Generates doc/source\-highlight\-filter.pdf file.
166
+ .RE
167
+ .PP
168
+ a2x \-f chunked \-D ../webpages guide.txt
169
+ .RS 4
170
+ Creates chunked directory
171
+ \&../webpages/guide.chunked
172
+ containing chunked HTML files. Also copies
173
+ docbook\-xsl.css
174
+ stylesheet to the
175
+ \&../webpages/guide.chunked
176
+ directory plus admonition and navigation icons to the
177
+ \&../webpages/guide.chunked/images/icons
178
+ directory.
179
+ .RE
180
+ .SH "REQUISITES"
181
+ This script runs under the bash(1) shell and requires the following programs (which may or may not be prepackaged with your Linux distribution):
182
+ .sp
183
+ .PP
184
+ Asciidoc
185
+ .RS 4
186
+
187
+ http://www.methods.co.nz/asciidoc/
188
+ .RE
189
+ .PP
190
+ xsltproc
191
+ .RS 4
192
+
193
+ http://xmlsoft.org/XSLT/
194
+ .RE
195
+ .PP
196
+ DocBook XSL Stylesheets
197
+ .RS 4
198
+
199
+ http://docbook.sourceforge.net/projects/xsl/
200
+ .RE
201
+ .PP
202
+ dblatex (for PDF, DVI, PostScript and LaTeX file generation)
203
+ .RS 4
204
+
205
+ http://dblatex.sourceforge.net/
206
+ .RE
207
+ .PP
208
+ FOP (alternative PDF file generation)
209
+ .RS 4
210
+
211
+ http://xmlgraphics.apache.org/fop/
212
+ .RE
213
+ .PP
214
+ Lynx (for text file generation)
215
+ .RS 4
216
+
217
+ http://lynx.isc.org/
218
+ .RE
219
+ See also the latest README file.
220
+ .sp
221
+ .SH "BUGS"
222
+ .sp
223
+ .RS 4
224
+ \h'-04'\(bu\h'+03'The odt output format is undocumented and experimental.
225
+ .RE
226
+ .sp
227
+ .RS 4
228
+ \h'-04'\(bu\h'+03'See also the AsciiDoc distribution BUGS file.
229
+ .RE
230
+ .SH "AUTHOR"
231
+ Written by Stuart Rackham, <srackham@gmail.com>
232
+ .sp
233
+ .SH "RESOURCES"
234
+ SourceForge: http://sourceforge.net/projects/asciidoc/
235
+ .sp
236
+ Main web site: http://www.methods.co.nz/asciidoc/
237
+ .sp
238
+ .SH "COPYING"
239
+ Copyright (C) 2002\-2008 Stuart Rackham. Free use of this software is granted under the terms of the GNU General Public License (GPL).
240
+ .sp
241
+ .SH "REFERENCES"
242
+ .IP " 1." 4
243
+ srackham@gmail.com
244
+ .RS 4
245
+ \%mailto:srackham@gmail.com
246
+ .RE
@@ -0,0 +1,195 @@
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
+ *-n, --dry-run*::
70
+ Don't do anything just print what would have been done.
71
+
72
+ *-s, --skip-asciidoc*::
73
+ Skip asciidoc execution. This is useful for converting DocBook XML
74
+ files not derived from AsciiDoc sources. Ignored if --format*='text'.
75
+
76
+ *--stylesheet*='PATH'::
77
+ A path (relative to destination HTML files) specifying the
78
+ docbook-xsl CSS stylesheet file. Defaults to './docbook-xsl.css'.
79
+ Applies to 'xhtml', 'chunked', 'htmlhelp' formats.
80
+
81
+ *-v, --verbose*::
82
+ Print operational details to stderr.
83
+ A second *-v* option applies the verbose option to toolchain commands.
84
+
85
+ *--version*::
86
+ Print program version to stdout.
87
+
88
+ *--xsltproc-opts*='XSLTPROC_OPTS'::
89
+ Additional xsltproc(1) options. This option may be specified more
90
+ than once.
91
+
92
+ *--fop-opts*='FOP_OPTS'::
93
+ Additional fop options. This option may be specified more than
94
+ once. If this option is specified fop is used to generate PDFs.
95
+
96
+ *--dblatex-opts*='DBLATEX_OPTS'::
97
+ Additional dblatex options. This option may be specified more than once.
98
+
99
+
100
+ OUTPUT FILES
101
+ ------------
102
+ Output files are written to the directory specified by the
103
+ *--destination-dir* option. If no *--destination-dir* option is set
104
+ output files are written to the source FILE directory.
105
+
106
+ Output files have the same name as the source 'FILE' but with an
107
+ appropriate file name extension: .html for 'xhtml'; .hhp for
108
+ 'htmlhelp'; .pdf for 'pdf'; .text for 'text'. By convention manpages
109
+ have no .man extension (man page section number only). Chunked HTML
110
+ directory names have a .chunked extension; chunked HTML Help directory
111
+ names have a .htmlhelp extension.
112
+
113
+ Same named existing files are overwritten.
114
+
115
+ Intermediate output files are written to the source 'FILE' directory
116
+ and are not automatically deleted.
117
+
118
+ Intermediate DocBook XML files generated by AsciiDoc are only
119
+ regenerated if out of date with respect to the AsciiDoc source 'FILE'.
120
+
121
+ In addition to generating HTML files the 'xhtml', 'chunked' and
122
+ 'htmlhelp' formats copy the DocBook XSL stylesheet plus admonition and
123
+ navigation icons distributed with AsciiDoc to their respective
124
+ destination locations. Existing stylesheets and icons are only copied
125
+ if they are newer than the destination files or if the destination
126
+ files are missing.
127
+
128
+ The 'xhtml' format generates a single XHTML output page. The
129
+ 'chunked' format writes multiple per-section HTML pages to a chunked
130
+ directory in the destination directory. The chunked directory has the
131
+ same name as the source 'FILE' name plus a .chunked extension.
132
+
133
+
134
+ EXAMPLES
135
+ --------
136
+ `a2x -f pdf doc/source-highlight-filter.txt`::
137
+ Generates doc/source-highlight-filter.pdf file.
138
+
139
+ `a2x -f chunked -D ../webpages guide.txt`::
140
+ Creates chunked directory `../webpages/guide.chunked` containing
141
+ chunked HTML files. Also copies `docbook-xsl.css` stylesheet to the
142
+ `../webpages/guide.chunked` directory plus admonition and navigation
143
+ icons to the `../webpages/guide.chunked/images/icons` directory.
144
+
145
+
146
+ REQUISITES
147
+ ----------
148
+ This script runs under the bash(1) shell and requires the following
149
+ programs (which may or may not be prepackaged with your Linux
150
+ distribution):
151
+
152
+ Asciidoc::
153
+ http://www.methods.co.nz/asciidoc/
154
+
155
+ xsltproc::
156
+ http://xmlsoft.org/XSLT/
157
+
158
+ DocBook XSL Stylesheets::
159
+ http://docbook.sourceforge.net/projects/xsl/
160
+
161
+ dblatex (for PDF, DVI, PostScript and LaTeX file generation)::
162
+ http://dblatex.sourceforge.net/
163
+
164
+ FOP (alternative PDF file generation)::
165
+ http://xmlgraphics.apache.org/fop/
166
+
167
+ Lynx (for text file generation)::
168
+ http://lynx.isc.org/
169
+
170
+ See also the latest README file.
171
+
172
+
173
+ BUGS
174
+ ----
175
+ - The odt output format is undocumented and experimental.
176
+ - See also the AsciiDoc distribution BUGS file.
177
+
178
+
179
+ AUTHOR
180
+ ------
181
+ Written by Stuart Rackham, <srackham@gmail.com>
182
+
183
+
184
+ RESOURCES
185
+ ---------
186
+ SourceForge: http://sourceforge.net/projects/asciidoc/
187
+
188
+ Main web site: http://www.methods.co.nz/asciidoc/
189
+
190
+
191
+ COPYING
192
+ -------
193
+ Copyright \(C) 2002-2008 Stuart Rackham. Free use of this software is
194
+ granted under the terms of the GNU General Public License (GPL).
195
+