mizuho 0.9.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (295) hide show
  1. data/LICENSE.txt +20 -0
  2. data/README.markdown +61 -0
  3. data/Rakefile +41 -0
  4. data/asciidoc/BUGS +39 -0
  5. data/asciidoc/BUGS.txt +32 -0
  6. data/asciidoc/CHANGELOG +1796 -0
  7. data/asciidoc/CHANGELOG.txt +1810 -0
  8. data/asciidoc/COPYING +339 -0
  9. data/asciidoc/COPYRIGHT +18 -0
  10. data/asciidoc/INSTALL +76 -0
  11. data/asciidoc/INSTALL.txt +71 -0
  12. data/asciidoc/Makefile.in +161 -0
  13. data/asciidoc/README +46 -0
  14. data/asciidoc/README.txt +36 -0
  15. data/asciidoc/a2x +674 -0
  16. data/asciidoc/asciidoc.conf +455 -0
  17. data/asciidoc/asciidoc.py +4998 -0
  18. data/asciidoc/common.aap +9 -0
  19. data/asciidoc/configure +2840 -0
  20. data/asciidoc/configure.ac +11 -0
  21. data/asciidoc/dblatex/asciidoc-dblatex.sty +20 -0
  22. data/asciidoc/dblatex/asciidoc-dblatex.xsl +32 -0
  23. data/asciidoc/dblatex/dblatex-readme.txt +39 -0
  24. data/asciidoc/doc/a2x.1 +257 -0
  25. data/asciidoc/doc/a2x.1.txt +204 -0
  26. data/asciidoc/doc/article.css-embedded.html +602 -0
  27. data/asciidoc/doc/article.html +46 -0
  28. data/asciidoc/doc/article.pdf +0 -0
  29. data/asciidoc/doc/article.txt +122 -0
  30. data/asciidoc/doc/asciidoc-revhistory.xml +27 -0
  31. data/asciidoc/doc/asciidoc.1 +155 -0
  32. data/asciidoc/doc/asciidoc.1.css-embedded.html +598 -0
  33. data/asciidoc/doc/asciidoc.1.css.html +212 -0
  34. data/asciidoc/doc/asciidoc.1.html +190 -0
  35. data/asciidoc/doc/asciidoc.1.txt +118 -0
  36. data/asciidoc/doc/asciidoc.conf +8 -0
  37. data/asciidoc/doc/asciidoc.css-embedded.html +7853 -0
  38. data/asciidoc/doc/asciidoc.css.html +7416 -0
  39. data/asciidoc/doc/asciidoc.dict +733 -0
  40. data/asciidoc/doc/asciidoc.html +3339 -0
  41. data/asciidoc/doc/asciidoc.txt +4979 -0
  42. data/asciidoc/doc/asciimathml.txt +64 -0
  43. data/asciidoc/doc/book-multi.css-embedded.html +575 -0
  44. data/asciidoc/doc/book-multi.html +55 -0
  45. data/asciidoc/doc/book-multi.txt +155 -0
  46. data/asciidoc/doc/book.css-embedded.html +607 -0
  47. data/asciidoc/doc/book.html +43 -0
  48. data/asciidoc/doc/book.txt +131 -0
  49. data/asciidoc/doc/customers.csv +18 -0
  50. data/asciidoc/doc/docbook-xsl.css +272 -0
  51. data/asciidoc/doc/faq.txt +547 -0
  52. data/asciidoc/doc/latex-backend.html +117 -0
  53. data/asciidoc/doc/latex-backend.txt +191 -0
  54. data/asciidoc/doc/latexmath.txt +244 -0
  55. data/asciidoc/doc/latexmathml.txt +41 -0
  56. data/asciidoc/doc/main.aap +297 -0
  57. data/asciidoc/doc/music-filter.html +566 -0
  58. data/asciidoc/doc/music-filter.pdf +0 -0
  59. data/asciidoc/doc/music-filter.txt +158 -0
  60. data/asciidoc/doc/source-highlight-filter.html +214 -0
  61. data/asciidoc/doc/source-highlight-filter.pdf +0 -0
  62. data/asciidoc/doc/source-highlight-filter.txt +203 -0
  63. data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +43 -0
  64. data/asciidoc/docbook-xsl/chunked.xsl +19 -0
  65. data/asciidoc/docbook-xsl/common.xsl +67 -0
  66. data/asciidoc/docbook-xsl/fo.xsl +149 -0
  67. data/asciidoc/docbook-xsl/htmlhelp.xsl +17 -0
  68. data/asciidoc/docbook-xsl/manpage.xsl +31 -0
  69. data/asciidoc/docbook-xsl/text.xsl +50 -0
  70. data/asciidoc/docbook-xsl/xhtml.xsl +14 -0
  71. data/asciidoc/docbook.conf +721 -0
  72. data/asciidoc/examples/website/ASCIIMathML.js +938 -0
  73. data/asciidoc/examples/website/CHANGELOG.html +4389 -0
  74. data/asciidoc/examples/website/CHANGELOG.txt +1810 -0
  75. data/asciidoc/examples/website/INSTALL.html +161 -0
  76. data/asciidoc/examples/website/INSTALL.txt +71 -0
  77. data/asciidoc/examples/website/LaTeXMathML.js +1223 -0
  78. data/asciidoc/examples/website/README-website.html +118 -0
  79. data/asciidoc/examples/website/README-website.txt +29 -0
  80. data/asciidoc/examples/website/README.html +125 -0
  81. data/asciidoc/examples/website/README.txt +36 -0
  82. data/asciidoc/examples/website/a2x.1.html +419 -0
  83. data/asciidoc/examples/website/a2x.1.txt +204 -0
  84. data/asciidoc/examples/website/asciidoc-docbook-xsl.html +130 -0
  85. data/asciidoc/examples/website/asciidoc-docbook-xsl.txt +43 -0
  86. data/asciidoc/examples/website/asciidoc-graphviz-sample.txt +130 -0
  87. data/asciidoc/examples/website/asciimathml.txt +64 -0
  88. data/asciidoc/examples/website/build-website.sh +25 -0
  89. data/asciidoc/examples/website/customers.csv +18 -0
  90. data/asciidoc/examples/website/downloads.html +257 -0
  91. data/asciidoc/examples/website/downloads.txt +121 -0
  92. data/asciidoc/examples/website/faq.html +673 -0
  93. data/asciidoc/examples/website/faq.txt +547 -0
  94. data/asciidoc/examples/website/index.html +419 -0
  95. data/asciidoc/examples/website/index.txt +245 -0
  96. data/asciidoc/examples/website/latex-backend.html +535 -0
  97. data/asciidoc/examples/website/latex-backend.txt +191 -0
  98. data/asciidoc/examples/website/latexmathml.txt +41 -0
  99. data/asciidoc/examples/website/layout1.conf +161 -0
  100. data/asciidoc/examples/website/layout1.css +65 -0
  101. data/asciidoc/examples/website/layout2.conf +158 -0
  102. data/asciidoc/examples/website/layout2.css +93 -0
  103. data/asciidoc/examples/website/manpage.html +266 -0
  104. data/asciidoc/examples/website/manpage.txt +118 -0
  105. data/asciidoc/examples/website/music-filter.html +242 -0
  106. data/asciidoc/examples/website/music-filter.txt +158 -0
  107. data/asciidoc/examples/website/music1.abc +12 -0
  108. data/asciidoc/examples/website/music1.png +0 -0
  109. data/asciidoc/examples/website/music2.ly +9 -0
  110. data/asciidoc/examples/website/music2.png +0 -0
  111. data/asciidoc/examples/website/newlists.txt +40 -0
  112. data/asciidoc/examples/website/newtables.txt +397 -0
  113. data/asciidoc/examples/website/sample1.png +0 -0
  114. data/asciidoc/examples/website/sample3.png +0 -0
  115. data/asciidoc/examples/website/sample4.png +0 -0
  116. data/asciidoc/examples/website/source-highlight-filter.html +286 -0
  117. data/asciidoc/examples/website/source-highlight-filter.txt +203 -0
  118. data/asciidoc/examples/website/support.html +78 -0
  119. data/asciidoc/examples/website/support.txt +5 -0
  120. data/asciidoc/examples/website/toc.js +69 -0
  121. data/asciidoc/examples/website/userguide.html +7460 -0
  122. data/asciidoc/examples/website/userguide.txt +4979 -0
  123. data/asciidoc/examples/website/version83.txt +37 -0
  124. data/asciidoc/examples/website/version9.html +143 -0
  125. data/asciidoc/examples/website/version9.txt +48 -0
  126. data/asciidoc/examples/website/xhtml11-manpage.css +18 -0
  127. data/asciidoc/examples/website/xhtml11-quirks.css +41 -0
  128. data/asciidoc/examples/website/xhtml11.css +328 -0
  129. data/asciidoc/filters/code/code-filter-readme.txt +37 -0
  130. data/asciidoc/filters/code/code-filter-test.txt +15 -0
  131. data/asciidoc/filters/code/code-filter.conf +8 -0
  132. data/asciidoc/filters/code/code-filter.py +239 -0
  133. data/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt +130 -0
  134. data/asciidoc/filters/graphviz/graphviz-filter.conf +39 -0
  135. data/asciidoc/filters/graphviz/graphviz2png.py +154 -0
  136. data/asciidoc/filters/music/music-filter-test.txt +40 -0
  137. data/asciidoc/filters/music/music-filter.conf +40 -0
  138. data/asciidoc/filters/music/music2png.py +189 -0
  139. data/asciidoc/filters/source/source-highlight-filter-test.txt +19 -0
  140. data/asciidoc/filters/source/source-highlight-filter.conf +108 -0
  141. data/asciidoc/help.conf +213 -0
  142. data/asciidoc/html4.conf +460 -0
  143. data/asciidoc/images/highlighter.png +0 -0
  144. data/asciidoc/images/icons/README +5 -0
  145. data/asciidoc/images/icons/callouts/1.png +0 -0
  146. data/asciidoc/images/icons/callouts/10.png +0 -0
  147. data/asciidoc/images/icons/callouts/11.png +0 -0
  148. data/asciidoc/images/icons/callouts/12.png +0 -0
  149. data/asciidoc/images/icons/callouts/13.png +0 -0
  150. data/asciidoc/images/icons/callouts/14.png +0 -0
  151. data/asciidoc/images/icons/callouts/15.png +0 -0
  152. data/asciidoc/images/icons/callouts/2.png +0 -0
  153. data/asciidoc/images/icons/callouts/3.png +0 -0
  154. data/asciidoc/images/icons/callouts/4.png +0 -0
  155. data/asciidoc/images/icons/callouts/5.png +0 -0
  156. data/asciidoc/images/icons/callouts/6.png +0 -0
  157. data/asciidoc/images/icons/callouts/7.png +0 -0
  158. data/asciidoc/images/icons/callouts/8.png +0 -0
  159. data/asciidoc/images/icons/callouts/9.png +0 -0
  160. data/asciidoc/images/icons/caution.png +0 -0
  161. data/asciidoc/images/icons/example.png +0 -0
  162. data/asciidoc/images/icons/home.png +0 -0
  163. data/asciidoc/images/icons/important.png +0 -0
  164. data/asciidoc/images/icons/next.png +0 -0
  165. data/asciidoc/images/icons/note.png +0 -0
  166. data/asciidoc/images/icons/prev.png +0 -0
  167. data/asciidoc/images/icons/tip.png +0 -0
  168. data/asciidoc/images/icons/up.png +0 -0
  169. data/asciidoc/images/icons/warning.png +0 -0
  170. data/asciidoc/images/smallnew.png +0 -0
  171. data/asciidoc/images/tiger.png +0 -0
  172. data/asciidoc/install-sh +201 -0
  173. data/asciidoc/javascripts/ASCIIMathML.js +938 -0
  174. data/asciidoc/javascripts/LaTeXMathML.js +1223 -0
  175. data/asciidoc/javascripts/toc.js +69 -0
  176. data/asciidoc/lang-es.conf +15 -0
  177. data/asciidoc/latex.conf +663 -0
  178. data/asciidoc/stylesheets/docbook-xsl.css +272 -0
  179. data/asciidoc/stylesheets/xhtml11-manpage.css +18 -0
  180. data/asciidoc/stylesheets/xhtml11-quirks.css +41 -0
  181. data/asciidoc/stylesheets/xhtml11.css +328 -0
  182. data/asciidoc/text.conf +16 -0
  183. data/asciidoc/vim/ftdetect/asciidoc_filetype.vim +53 -0
  184. data/asciidoc/vim/syntax/asciidoc.vim +165 -0
  185. data/asciidoc/wordpress.conf +48 -0
  186. data/asciidoc/xhtml11-quirks.conf +57 -0
  187. data/asciidoc/xhtml11.conf +645 -0
  188. data/bin/mizuho +47 -0
  189. data/bin/mizuho-asciidoc +4 -0
  190. data/lib/mizuho.rb +10 -0
  191. data/lib/mizuho/chapter.rb +54 -0
  192. data/lib/mizuho/generator.rb +134 -0
  193. data/lib/mizuho/heading.rb +46 -0
  194. data/lib/mizuho/parser.rb +103 -0
  195. data/lib/mizuho/source_highlight.rb +2 -0
  196. data/lib/mizuho/template.rb +50 -0
  197. data/source-highlight/ada.lang +38 -0
  198. data/source-highlight/bib.lang +6 -0
  199. data/source-highlight/bison.lang +3 -0
  200. data/source-highlight/c.lang +41 -0
  201. data/source-highlight/c_comment.lang +27 -0
  202. data/source-highlight/c_string.lang +9 -0
  203. data/source-highlight/caml.lang +16 -0
  204. data/source-highlight/changelog.lang +8 -0
  205. data/source-highlight/clike_vardeclaration.lang +4 -0
  206. data/source-highlight/cpp.lang +15 -0
  207. data/source-highlight/csharp.lang +36 -0
  208. data/source-highlight/css.lang +14 -0
  209. data/source-highlight/css_common.outlang +26 -0
  210. data/source-highlight/darwin/source-highlight +0 -0
  211. data/source-highlight/default.css +51 -0
  212. data/source-highlight/default.lang +8 -0
  213. data/source-highlight/default.style +57 -0
  214. data/source-highlight/desktop.lang +7 -0
  215. data/source-highlight/diff.lang +32 -0
  216. data/source-highlight/docbook.outlang +36 -0
  217. data/source-highlight/esc.outlang +46 -0
  218. data/source-highlight/esc.style +35 -0
  219. data/source-highlight/extreme_comment.lang +5 -0
  220. data/source-highlight/extreme_comment2.lang +5 -0
  221. data/source-highlight/extreme_comment3.lang +15 -0
  222. data/source-highlight/fixed-fortran.lang +5 -0
  223. data/source-highlight/flex.lang +37 -0
  224. data/source-highlight/fortran.lang +57 -0
  225. data/source-highlight/function.lang +2 -0
  226. data/source-highlight/glsl.lang +86 -0
  227. data/source-highlight/haxe.lang +7 -0
  228. data/source-highlight/html.lang +7 -0
  229. data/source-highlight/html.outlang +25 -0
  230. data/source-highlight/html_common.outlang +35 -0
  231. data/source-highlight/html_notfixed.outlang +22 -0
  232. data/source-highlight/html_ref.outlang +6 -0
  233. data/source-highlight/htmlcss.outlang +28 -0
  234. data/source-highlight/htmltable.outlang +14 -0
  235. data/source-highlight/htmltablelinenum.outlang +26 -0
  236. data/source-highlight/java.lang +26 -0
  237. data/source-highlight/javadoc.outlang +24 -0
  238. data/source-highlight/javascript.lang +27 -0
  239. data/source-highlight/key_string.lang +4 -0
  240. data/source-highlight/lang.map +108 -0
  241. data/source-highlight/langdef.lang +21 -0
  242. data/source-highlight/latex.lang +52 -0
  243. data/source-highlight/latex.outlang +59 -0
  244. data/source-highlight/latexcolor.outlang +44 -0
  245. data/source-highlight/ldap.lang +10 -0
  246. data/source-highlight/log.lang +53 -0
  247. data/source-highlight/logtalk.lang +85 -0
  248. data/source-highlight/lsm.lang +7 -0
  249. data/source-highlight/lua.lang +27 -0
  250. data/source-highlight/m4.lang +27 -0
  251. data/source-highlight/makefile.lang +42 -0
  252. data/source-highlight/nohilite.lang +2 -0
  253. data/source-highlight/number.lang +3 -0
  254. data/source-highlight/outlang.lang +16 -0
  255. data/source-highlight/outlang.map +12 -0
  256. data/source-highlight/pascal.lang +20 -0
  257. data/source-highlight/perl.lang +134 -0
  258. data/source-highlight/php.lang +25 -0
  259. data/source-highlight/postscript.lang +42 -0
  260. data/source-highlight/prolog.lang +37 -0
  261. data/source-highlight/properties.lang +7 -0
  262. data/source-highlight/python.lang +26 -0
  263. data/source-highlight/ruby.lang +32 -0
  264. data/source-highlight/scala.lang +31 -0
  265. data/source-highlight/script_comment.lang +3 -0
  266. data/source-highlight/sh.lang +38 -0
  267. data/source-highlight/slang.lang +25 -0
  268. data/source-highlight/sml.lang +5 -0
  269. data/source-highlight/source-highlight +24 -0
  270. data/source-highlight/spec.lang +12 -0
  271. data/source-highlight/sql.lang +46 -0
  272. data/source-highlight/style.defaults +15 -0
  273. data/source-highlight/style.lang +16 -0
  274. data/source-highlight/style2.style +10 -0
  275. data/source-highlight/style3.style +10 -0
  276. data/source-highlight/symbols.lang +2 -0
  277. data/source-highlight/tcl.lang +35 -0
  278. data/source-highlight/texinfo.outlang +34 -0
  279. data/source-highlight/texinfo.style +20 -0
  280. data/source-highlight/url.lang +3 -0
  281. data/source-highlight/xhtml.outlang +25 -0
  282. data/source-highlight/xhtml_common.outlang +8 -0
  283. data/source-highlight/xhtml_notfixed.outlang +16 -0
  284. data/source-highlight/xhtmlcss.outlang +19 -0
  285. data/source-highlight/xhtmltable.outlang +7 -0
  286. data/source-highlight/xml.lang +17 -0
  287. data/source-highlight/xorg.lang +10 -0
  288. data/templates/asciidoc.css +358 -0
  289. data/templates/asciidoc.html.erb +86 -0
  290. data/templates/manualsonrails.css +165 -0
  291. data/templates/manualsonrails.html.erb +97 -0
  292. data/test/generator_spec.rb +60 -0
  293. data/test/parser_spec.rb +239 -0
  294. data/test/spec_helper.rb +51 -0
  295. metadata +358 -0
@@ -0,0 +1,11 @@
1
+ AC_INIT(asciidoc, 8.3.1)
2
+
3
+ AC_CONFIG_FILES(Makefile)
4
+
5
+ AC_PROG_SED
6
+
7
+ AC_PROG_LN_S
8
+
9
+ AC_PROG_INSTALL
10
+
11
+ AC_OUTPUT
@@ -0,0 +1,20 @@
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
+
19
+ % For DocBook literallayout elements, see `./dblatex/dblatex-readme.txt`.
20
+ \usepackage{alltt}
@@ -0,0 +1,32 @@
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
+
8
+ <!-- TOC links in the titles, and in blue. -->
9
+ <xsl:param name="latex.hyperparam">colorlinks,linkcolor=blue,pdfstartview=FitH</xsl:param>
10
+ <xsl:param name="doc.publisher.show">1</xsl:param>
11
+ <xsl:param name="doc.lot.show"></xsl:param>
12
+ <xsl:param name="term.breakline">1</xsl:param>
13
+ <xsl:param name="doc.collab.show">0</xsl:param>
14
+ <xsl:param name="doc.section.depth">3</xsl:param>
15
+ <xsl:param name="table.in.float">0</xsl:param>
16
+ <xsl:param name="monoseq.hyphenation">0</xsl:param>
17
+ <xsl:param name="latex.output.revhistory">1</xsl:param>
18
+ <xsl:param name="doc.toc.show">1</xsl:param>
19
+
20
+ <!--
21
+ Override default literallayout template.
22
+ See `./dblatex/dblatex-readme.txt`.
23
+ -->
24
+ <xsl:template match="address|literallayout[@class!='monospaced']">
25
+ <xsl:text>\begin{alltt}</xsl:text>
26
+ <xsl:text>&#10;\normalfont{}&#10;</xsl:text>
27
+ <xsl:apply-templates/>
28
+ <xsl:text>&#10;\end{alltt}</xsl:text>
29
+ </xsl:template>
30
+
31
+ </xsl:stylesheet>
32
+
@@ -0,0 +1,39 @@
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
+ Observed in dblatex 0.2.8.
22
+
23
+ - dblatex doesn't seem to process the DocBook 'literallayout' element
24
+ correctly: it is rendered in a monospaced font and no inline
25
+ elements are processed. By default the normal font should be used
26
+ and almost all DocBook inline elements should be processed
27
+ (http://www.docbook.org/tdg/en/html/literallayout.html). I almost
28
+ fixed this by overriding the default dblatex literallayout template
29
+ (in `./dblatex/asciidoc-dblatex.xsl`) and using the LaTeX 'alltt'
30
+ package, but there are remaining problems:
31
+
32
+ * Blank lines are replaced by a single space.
33
+ * The 'literallayout' element incorrectly wraps text when rendered
34
+ inside a table.
35
+
36
+ - Callouts do not work inside DocBook 'literallayout' elements which
37
+ means callouts are not displayed inside AsciiDoc literal blocks. A
38
+ workaround is to change the AsciiDoc literal block to a listing
39
+ block.
@@ -0,0 +1,257 @@
1
+ .\" Title: a2x
2
+ .\" Author:
3
+ .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4
+ .\" Date: 01/02/2009
5
+ .\" Manual:
6
+ .\" Source:
7
+ .\"
8
+ .TH "A2X" "1" "01/02/2009" "" ""
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\-L, \-\-no\-xmllint\fR
101
+ .RS 4
102
+ Don\(cqt check asciidoc output with
103
+ \fIxmllint(1)\fR\.
104
+ .RE
105
+ .PP
106
+ \fB\-n, \-\-dry\-run\fR
107
+ .RS 4
108
+ Don\(cqt do anything just print what would have been done\.
109
+ .RE
110
+ .PP
111
+ \fB\-s, \-\-skip\-asciidoc\fR
112
+ .RS 4
113
+ Skip asciidoc execution\. This is useful for converting DocBook XML files not derived from AsciiDoc sources\. Ignored if
114
+ \fI\-\-format=text\fR\.
115
+ .RE
116
+ .PP
117
+ \fB\-\-stylesheet\fR=\fIPATH\fR
118
+ .RS 4
119
+ A path (relative to destination HTML files) specifying the docbook\-xsl CSS stylesheet file\. Defaults to
120
+ \fI\./docbook\-xsl\.css\fR\. Applies to
121
+ \fIxhtml\fR,
122
+ \fIchunked\fR,
123
+ \fIhtmlhelp\fR
124
+ formats\.
125
+ .RE
126
+ .PP
127
+ \fB\-v, \-\-verbose\fR
128
+ .RS 4
129
+ Print operational details to stderr\. A second
130
+ \fB\-v\fR
131
+ option applies the verbose option to toolchain commands\.
132
+ .RE
133
+ .PP
134
+ \fB\-\-version\fR
135
+ .RS 4
136
+ Print program version to stdout\.
137
+ .RE
138
+ .PP
139
+ \fB\-\-xsltproc\-opts\fR=\fIXSLTPROC_OPTS\fR
140
+ .RS 4
141
+ Additional xsltproc(1) options\. This option may be specified more than once\.
142
+ .RE
143
+ .PP
144
+ \fB\-\-fop\fR
145
+ .RS 4
146
+ Use FOP to generate PDFs\.
147
+ .RE
148
+ .PP
149
+ \fB\-\-fop\-opts\fR=\fIFOP_OPTS\fR
150
+ .RS 4
151
+ Additional fop options\. This option may be specified more than once\. If this option is specified FOP is used to generate PDFs\.
152
+ .RE
153
+ .PP
154
+ \fB\-\-dblatex\-opts\fR=\fIDBLATEX_OPTS\fR
155
+ .RS 4
156
+ Additional dblatex options\. This option may be specified more than once\.
157
+ .RE
158
+ .SH "OUTPUT FILES"
159
+ 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\.
160
+ .sp
161
+ 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\.
162
+ .sp
163
+ Same named existing files are overwritten\.
164
+ .sp
165
+ Intermediate output files are written to the source \fIFILE\fR directory and are not automatically deleted\.
166
+ .sp
167
+ Intermediate DocBook XML files generated by AsciiDoc are only regenerated if out of date with respect to the AsciiDoc source \fIFILE\fR\.
168
+ .sp
169
+ 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\.
170
+ .sp
171
+ 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\.
172
+ .sp
173
+ .SH "EXAMPLES"
174
+ .PP
175
+ a2x \-f pdf doc/source\-highlight\-filter\.txt
176
+ .RS 4
177
+ Generates doc/source\-highlight\-filter\.pdf file\.
178
+ .RE
179
+ .PP
180
+ a2x \-f chunked \-D \.\./webpages guide\.txt
181
+ .RS 4
182
+ Creates chunked directory
183
+ \.\./webpages/guide\.chunked
184
+ containing chunked HTML files\. Also copies
185
+ docbook\-xsl\.css
186
+ stylesheet to the
187
+ \.\./webpages/guide\.chunked
188
+ directory plus admonition and navigation icons to the
189
+ \.\./webpages/guide\.chunked/images/icons
190
+ directory\.
191
+ .RE
192
+ .SH "REQUISITES"
193
+ This script runs under the bash(1) shell and requires the following programs (which may or may not be prepackaged with your Linux distribution):
194
+ .PP
195
+ Asciidoc
196
+ .RS 4
197
+
198
+ http://www\.methods\.co\.nz/asciidoc/
199
+ .RE
200
+ .PP
201
+ xsltproc
202
+ .RS 4
203
+
204
+ http://xmlsoft\.org/XSLT/
205
+ .RE
206
+ .PP
207
+ DocBook XSL Stylesheets
208
+ .RS 4
209
+
210
+ http://docbook\.sourceforge\.net/projects/xsl/
211
+ .RE
212
+ .PP
213
+ dblatex (for PDF, DVI, PostScript and LaTeX file generation)
214
+ .RS 4
215
+
216
+ http://dblatex\.sourceforge\.net/
217
+ .RE
218
+ .PP
219
+ FOP (alternative PDF file generation)
220
+ .RS 4
221
+
222
+ http://xmlgraphics\.apache\.org/fop/
223
+ .RE
224
+ .PP
225
+ w3m (text file generation)
226
+ .RS 4
227
+
228
+ http://w3m\.sourceforge\.net/index\.en\.html
229
+ .RE
230
+ .PP
231
+ Lynx (used for text file generation if w3m(1) not installed)
232
+ .RS 4
233
+
234
+ http://lynx\.isc\.org/
235
+ .RE
236
+ See also the latest README file\.
237
+ .sp
238
+ .SH "BUGS"
239
+ .sp
240
+ .RS 4
241
+ \h'-04'\(bu\h'+03'The odt output format is undocumented and experimental\.
242
+ .RE
243
+ .sp
244
+ .RS 4
245
+ \h'-04'\(bu\h'+03'See also the AsciiDoc distribution BUGS file\.
246
+ .RE
247
+ .SH "AUTHOR"
248
+ Written by Stuart Rackham, <srackham@gmail\.com>
249
+ .sp
250
+ .SH "RESOURCES"
251
+ SourceForge: http://sourceforge\.net/projects/asciidoc/
252
+ .sp
253
+ Main web site: http://www\.methods\.co\.nz/asciidoc/
254
+ .sp
255
+ .SH "COPYING"
256
+ Copyright (C) 2002\-2008 Stuart Rackham\. Free use of this software is granted under the terms of the GNU General Public License (GPL)\.
257
+ .sp
@@ -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
+