mizuho 0.9.6 → 0.9.8

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.
Files changed (222) hide show
  1. data/README.markdown +4 -2
  2. data/Rakefile +0 -37
  3. data/asciidoc/BUGS +9 -18
  4. data/asciidoc/BUGS.txt +5 -14
  5. data/asciidoc/CHANGELOG +1433 -266
  6. data/asciidoc/CHANGELOG.txt +2821 -1810
  7. data/asciidoc/COPYING +339 -339
  8. data/asciidoc/COPYRIGHT +18 -18
  9. data/asciidoc/INSTALL +189 -30
  10. data/asciidoc/INSTALL.txt +175 -19
  11. data/asciidoc/MANIFEST +88 -0
  12. data/asciidoc/Makefile.in +29 -13
  13. data/asciidoc/README +16 -17
  14. data/asciidoc/README.txt +35 -36
  15. data/asciidoc/a2x.py +902 -0
  16. data/asciidoc/asciidoc.conf +610 -455
  17. data/asciidoc/asciidoc.py +1965 -1061
  18. data/asciidoc/asciidocapi.py +257 -0
  19. data/asciidoc/common.aap +2 -2
  20. data/asciidoc/configure +1170 -1023
  21. data/asciidoc/configure.ac +1 -1
  22. data/asciidoc/dblatex/asciidoc-dblatex.xsl +42 -0
  23. data/asciidoc/doc/a2x.1 +559 -102
  24. data/asciidoc/doc/a2x.1.txt +233 -91
  25. data/asciidoc/doc/article-docinfo.xml +87 -0
  26. data/asciidoc/doc/article.pdf +0 -0
  27. data/asciidoc/doc/article.txt +139 -122
  28. data/asciidoc/doc/asciidoc.1 +157 -46
  29. data/asciidoc/doc/asciidoc.1.txt +171 -118
  30. data/asciidoc/doc/asciidoc.conf +7 -8
  31. data/asciidoc/doc/asciidoc.dict +960 -635
  32. data/asciidoc/doc/asciidoc.txt +2335 -1464
  33. data/asciidoc/doc/asciidocapi.txt +189 -0
  34. data/asciidoc/doc/asciimathml.txt +14 -17
  35. data/asciidoc/doc/book-multi.txt +181 -155
  36. data/asciidoc/doc/book.epub +0 -0
  37. data/asciidoc/doc/book.txt +156 -131
  38. data/asciidoc/doc/customers.csv +18 -18
  39. data/asciidoc/doc/epub-notes.txt +210 -0
  40. data/asciidoc/doc/faq.txt +1122 -547
  41. data/asciidoc/doc/latex-backend.txt +192 -191
  42. data/asciidoc/doc/latex-bugs.txt +134 -0
  43. data/asciidoc/doc/latex-filter.pdf +0 -0
  44. data/asciidoc/doc/latex-filter.txt +196 -0
  45. data/asciidoc/doc/latexmath.txt +13 -136
  46. data/asciidoc/doc/latexmathml.txt +2 -2
  47. data/asciidoc/doc/main.aap +233 -297
  48. data/asciidoc/doc/music-filter.pdf +0 -0
  49. data/asciidoc/doc/music-filter.txt +55 -65
  50. data/asciidoc/doc/publishing-ebooks-with-asciidoc.txt +398 -0
  51. data/asciidoc/doc/slidy-example.txt +167 -0
  52. data/asciidoc/doc/slidy.txt +113 -0
  53. data/asciidoc/doc/source-highlight-filter.pdf +0 -0
  54. data/asciidoc/doc/source-highlight-filter.txt +45 -20
  55. data/asciidoc/doc/testasciidoc.txt +231 -0
  56. data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +30 -8
  57. data/asciidoc/docbook-xsl/chunked.xsl +17 -19
  58. data/asciidoc/docbook-xsl/common.xsl +106 -67
  59. data/asciidoc/docbook-xsl/epub.xsl +35 -0
  60. data/asciidoc/docbook-xsl/fo.xsl +3 -0
  61. data/asciidoc/docbook-xsl/htmlhelp.xsl +16 -17
  62. data/asciidoc/docbook-xsl/manpage.xsl +31 -31
  63. data/asciidoc/docbook-xsl/text.xsl +6 -1
  64. data/asciidoc/docbook-xsl/xhtml.xsl +14 -14
  65. data/asciidoc/docbook45.conf +759 -0
  66. data/asciidoc/filters/code/code-filter-readme.txt +37 -37
  67. data/asciidoc/filters/code/code-filter-test.txt +15 -15
  68. data/asciidoc/filters/code/code-filter.conf +8 -8
  69. data/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt +104 -64
  70. data/asciidoc/filters/graphviz/graphviz-filter.conf +20 -16
  71. data/asciidoc/filters/graphviz/graphviz2png.py +54 -39
  72. data/asciidoc/filters/latex/latex-filter.conf +18 -0
  73. data/asciidoc/filters/latex/latex2png.py +216 -0
  74. data/asciidoc/filters/music/music-filter.conf +8 -17
  75. data/asciidoc/filters/music/music2png.py +40 -32
  76. data/asciidoc/filters/source/source-highlight-filter.conf +40 -34
  77. data/asciidoc/help.conf +261 -96
  78. data/asciidoc/html4.conf +505 -460
  79. data/asciidoc/html5.conf +686 -0
  80. data/asciidoc/images/highlighter.png +0 -0
  81. data/asciidoc/images/icons/caution.png +0 -0
  82. data/asciidoc/images/icons/example.png +0 -0
  83. data/asciidoc/images/icons/important.png +0 -0
  84. data/asciidoc/images/icons/note.png +0 -0
  85. data/asciidoc/images/icons/tip.png +0 -0
  86. data/asciidoc/images/icons/warning.png +0 -0
  87. data/asciidoc/images/smallnew.png +0 -0
  88. data/asciidoc/javascripts/asciidoc.js +189 -0
  89. data/asciidoc/javascripts/slidy.js +2845 -0
  90. data/asciidoc/javascripts/toc.js +8 -0
  91. data/asciidoc/lang-de.conf +57 -0
  92. data/asciidoc/lang-en.conf +54 -0
  93. data/asciidoc/lang-es.conf +49 -9
  94. data/asciidoc/lang-fr.conf +59 -0
  95. data/asciidoc/lang-hu.conf +55 -0
  96. data/asciidoc/lang-it.conf +55 -0
  97. data/asciidoc/lang-nl.conf +57 -0
  98. data/asciidoc/lang-pt-BR.conf +56 -0
  99. data/asciidoc/lang-ru.conf +60 -0
  100. data/asciidoc/lang-uk.conf +60 -0
  101. data/asciidoc/latex.conf +700 -663
  102. data/asciidoc/main.aap +77 -0
  103. data/asciidoc/slidy.conf +136 -0
  104. data/asciidoc/{examples/website/xhtml11-manpage.css → stylesheets/asciidoc-manpage.css} +1 -1
  105. data/asciidoc/stylesheets/asciidoc.css +508 -0
  106. data/asciidoc/stylesheets/docbook-xsl.css +322 -272
  107. data/asciidoc/stylesheets/flask-manpage.css +1 -0
  108. data/asciidoc/stylesheets/flask.css +584 -0
  109. data/asciidoc/stylesheets/pygments.css +66 -0
  110. data/asciidoc/stylesheets/slidy.css +445 -0
  111. data/asciidoc/stylesheets/toc2.css +33 -0
  112. data/asciidoc/stylesheets/volnitsky-manpage.css +1 -0
  113. data/asciidoc/stylesheets/volnitsky.css +435 -0
  114. data/asciidoc/stylesheets/xhtml11-quirks.css +5 -3
  115. data/asciidoc/tests/asciidocapi.py +257 -0
  116. data/asciidoc/tests/data/deprecated-quotes.txt +12 -0
  117. data/asciidoc/tests/data/filters-test.txt +90 -0
  118. data/asciidoc/tests/data/lang-de-test.txt +106 -0
  119. data/asciidoc/tests/data/lang-en-test.txt +114 -0
  120. data/asciidoc/tests/data/lang-es-test.txt +106 -0
  121. data/asciidoc/tests/data/lang-fr-test.txt +106 -0
  122. data/asciidoc/tests/data/lang-hu-test.txt +106 -0
  123. data/asciidoc/tests/data/lang-nl-test.txt +94 -0
  124. data/asciidoc/tests/data/lang-pt-BR-test.txt +106 -0
  125. data/asciidoc/tests/data/lang-ru-test.txt +106 -0
  126. data/asciidoc/tests/data/lang-uk-test.txt +106 -0
  127. data/asciidoc/tests/data/oldtables.txt +64 -0
  128. data/asciidoc/tests/data/rcs-id-marker-test.txt +6 -0
  129. data/asciidoc/tests/data/testcases.conf +2 -0
  130. data/asciidoc/tests/data/testcases.txt +740 -0
  131. data/asciidoc/tests/data/utf8-bom-test.txt +9 -0
  132. data/asciidoc/tests/data/utf8-examples.txt +217 -0
  133. data/asciidoc/tests/testasciidoc.conf +520 -0
  134. data/asciidoc/tests/testasciidoc.py +411 -0
  135. data/asciidoc/text.conf +16 -16
  136. data/asciidoc/vim/syntax/asciidoc.vim +99 -91
  137. data/asciidoc/wordpress.conf +43 -3
  138. data/asciidoc/xhtml11-quirks.conf +61 -57
  139. data/asciidoc/xhtml11.conf +684 -645
  140. data/lib/mizuho.rb +2 -0
  141. data/lib/mizuho/generator.rb +2 -2
  142. data/test/generator_spec.rb +1 -1
  143. data/test/parser_spec.rb +1 -1
  144. data/test/spec_helper.rb +3 -4
  145. metadata +87 -88
  146. data/asciidoc/a2x +0 -674
  147. data/asciidoc/doc/article.css-embedded.html +0 -602
  148. data/asciidoc/doc/article.html +0 -46
  149. data/asciidoc/doc/asciidoc-revhistory.xml +0 -27
  150. data/asciidoc/doc/asciidoc.1.css-embedded.html +0 -598
  151. data/asciidoc/doc/asciidoc.1.css.html +0 -212
  152. data/asciidoc/doc/asciidoc.1.html +0 -190
  153. data/asciidoc/doc/asciidoc.css-embedded.html +0 -7853
  154. data/asciidoc/doc/asciidoc.css.html +0 -7416
  155. data/asciidoc/doc/asciidoc.html +0 -3339
  156. data/asciidoc/doc/book-multi.css-embedded.html +0 -575
  157. data/asciidoc/doc/book-multi.html +0 -55
  158. data/asciidoc/doc/book.css-embedded.html +0 -607
  159. data/asciidoc/doc/book.html +0 -43
  160. data/asciidoc/doc/docbook-xsl.css +0 -272
  161. data/asciidoc/doc/latex-backend.html +0 -117
  162. data/asciidoc/doc/music-filter.html +0 -566
  163. data/asciidoc/doc/source-highlight-filter.html +0 -214
  164. data/asciidoc/docbook.conf +0 -721
  165. data/asciidoc/examples/website/ASCIIMathML.js +0 -938
  166. data/asciidoc/examples/website/CHANGELOG.html +0 -4389
  167. data/asciidoc/examples/website/CHANGELOG.txt +0 -1810
  168. data/asciidoc/examples/website/INSTALL.html +0 -161
  169. data/asciidoc/examples/website/INSTALL.txt +0 -71
  170. data/asciidoc/examples/website/LaTeXMathML.js +0 -1223
  171. data/asciidoc/examples/website/README-website.html +0 -118
  172. data/asciidoc/examples/website/README-website.txt +0 -29
  173. data/asciidoc/examples/website/README.html +0 -125
  174. data/asciidoc/examples/website/README.txt +0 -36
  175. data/asciidoc/examples/website/a2x.1.html +0 -419
  176. data/asciidoc/examples/website/a2x.1.txt +0 -204
  177. data/asciidoc/examples/website/asciidoc-docbook-xsl.html +0 -130
  178. data/asciidoc/examples/website/asciidoc-docbook-xsl.txt +0 -43
  179. data/asciidoc/examples/website/asciidoc-graphviz-sample.txt +0 -130
  180. data/asciidoc/examples/website/asciimathml.txt +0 -64
  181. data/asciidoc/examples/website/build-website.sh +0 -25
  182. data/asciidoc/examples/website/customers.csv +0 -18
  183. data/asciidoc/examples/website/downloads.html +0 -257
  184. data/asciidoc/examples/website/downloads.txt +0 -121
  185. data/asciidoc/examples/website/faq.html +0 -673
  186. data/asciidoc/examples/website/faq.txt +0 -547
  187. data/asciidoc/examples/website/index.html +0 -419
  188. data/asciidoc/examples/website/index.txt +0 -245
  189. data/asciidoc/examples/website/latex-backend.html +0 -535
  190. data/asciidoc/examples/website/latex-backend.txt +0 -191
  191. data/asciidoc/examples/website/latexmathml.txt +0 -41
  192. data/asciidoc/examples/website/layout1.conf +0 -161
  193. data/asciidoc/examples/website/layout1.css +0 -65
  194. data/asciidoc/examples/website/layout2.conf +0 -158
  195. data/asciidoc/examples/website/layout2.css +0 -93
  196. data/asciidoc/examples/website/manpage.html +0 -266
  197. data/asciidoc/examples/website/manpage.txt +0 -118
  198. data/asciidoc/examples/website/music-filter.html +0 -242
  199. data/asciidoc/examples/website/music-filter.txt +0 -158
  200. data/asciidoc/examples/website/music1.abc +0 -12
  201. data/asciidoc/examples/website/music1.png +0 -0
  202. data/asciidoc/examples/website/music2.ly +0 -9
  203. data/asciidoc/examples/website/music2.png +0 -0
  204. data/asciidoc/examples/website/newlists.txt +0 -40
  205. data/asciidoc/examples/website/newtables.txt +0 -397
  206. data/asciidoc/examples/website/sample1.png +0 -0
  207. data/asciidoc/examples/website/sample3.png +0 -0
  208. data/asciidoc/examples/website/sample4.png +0 -0
  209. data/asciidoc/examples/website/source-highlight-filter.html +0 -286
  210. data/asciidoc/examples/website/source-highlight-filter.txt +0 -203
  211. data/asciidoc/examples/website/support.html +0 -78
  212. data/asciidoc/examples/website/support.txt +0 -5
  213. data/asciidoc/examples/website/toc.js +0 -69
  214. data/asciidoc/examples/website/userguide.html +0 -7460
  215. data/asciidoc/examples/website/userguide.txt +0 -4979
  216. data/asciidoc/examples/website/version83.txt +0 -37
  217. data/asciidoc/examples/website/version9.html +0 -143
  218. data/asciidoc/examples/website/version9.txt +0 -48
  219. data/asciidoc/examples/website/xhtml11-quirks.css +0 -41
  220. data/asciidoc/examples/website/xhtml11.css +0 -328
  221. data/asciidoc/stylesheets/xhtml11-manpage.css +0 -18
  222. data/asciidoc/stylesheets/xhtml11.css +0 -328
@@ -1,419 +0,0 @@
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
- <meta name="description" content="Text based document generation" />
8
- <meta name="keywords" content="text to HTML, text to DocBook, text to XML, AsciiDoc" />
9
- <link rel="stylesheet" href="./xhtml11.css" type="text/css" />
10
- <link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
11
- <link rel="stylesheet" href="./layout1.css" type="text/css" />
12
- <script type="text/javascript">
13
- /*<![CDATA[*/
14
- window.onload = function(){generateToc(1)}
15
- /*]]>*/
16
- </script>
17
- <script type="text/javascript" src="./toc.js"></script>
18
- <title>AsciiDoc Home Page</title>
19
- </head>
20
- <body>
21
- <div id="layout-banner">
22
- <div id="layout-title">AsciiDoc</div>
23
- <div id="layout-description">Text based document generation</div>
24
- </div>
25
- <table>
26
- <tr valign="top">
27
- <td id="layout-menu">
28
- <div>&#187;<a href="index.html">Home</a></div>
29
- <div>&#187;<a href="manpage.html">Man&nbsp;Page</a></div>
30
- <div>&#187;<a href="userguide.html">User&nbsp;Guide</a></div>
31
- <div>&#187;<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
32
- <div>&#187;<a href="a2x.1.html">a2x</a></div>
33
- <div>&#187;<a href="README.html">README</a></div>
34
- <div>&#187;<a href="CHANGELOG.html">ChangeLog</a></div>
35
- <div>&#187;<a href="INSTALL.html">Installation</a></div>
36
- <div>&#187;<a href="downloads.html">Downloads</a></div>
37
- <div>&#187;<a href="faq.html">FAQ</a></div>
38
- <div>&#187;<a href="support.html">Support</a></div>
39
- <div id="page-source">&#187;<a href="index.txt">Page&nbsp;Source</a></div>
40
- </td>
41
- <td>
42
- <div id="layout-content">
43
- <div id="header">
44
- <h1>AsciiDoc Home Page</h1>
45
- </div>
46
- <div id="toc">
47
- <div id="toctitle">Table of Contents</div>
48
- <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
49
- </div>
50
- <div id="preamble">
51
- <div class="sectionbody">
52
- <div class="sidebarblock">
53
- <div class="sidebar-content">
54
- <div class="sidebar-title">2 January 2009: AsciiDoc 8.3.3 Released</div>
55
- <div class="paragraph"><p>Two significant changes in this release:</p></div>
56
- <div class="ulist"><ul>
57
- <li>
58
- <p>
59
- Included Gouichi Iisaka&#8217;s <a href="#X4">Graphviz filter</a> in the <em>AsciiDoc</em>
60
- distribution.
61
- </p>
62
- </li>
63
- <li>
64
- <p>
65
- You can now set the numbered list number style (<em>arabic</em>,
66
- <em>loweralpha</em>, <em>upperalpha</em>, <em>lowerroman</em>, <em>upperroman</em>) or let
67
- <em>AsciiDoc</em> guess the style of the first numbered item.
68
- </p>
69
- </li>
70
- </ul></div>
71
- <div class="paragraph"><p>Plus a number of smaller additions along with the usual documentation
72
- polishing. Read the <a href="CHANGELOG.html">CHANGELOG</a> for a full list of
73
- all additions and changes.</p></div>
74
- <div class="paragraph"><p>One final note: if you are upgrading from version 8.2.7 or less please
75
- read about possible <a href="CHANGELOG.html#X1">compatibility issues</a>
76
- first.</p></div>
77
- <div class="paragraph"><p><a href="mailto:srackham@gmail.com"><em>Stuart Rackham</em></a></p></div>
78
- </div></div>
79
- </div>
80
- </div>
81
- <h2 id="_introduction">Introduction</h2>
82
- <div class="sectionbody">
83
- <div class="paragraph"><p><em>AsciiDoc</em> is a text document format for writing short documents,
84
- articles, books and UNIX man pages. <em>AsciiDoc</em> files can be translated
85
- to HTML and DocBook markups using the <tt>asciidoc(1)</tt> command.</p></div>
86
- <div class="paragraph"><p><em>AsciiDoc</em> is highly configurable: both the <em>AsciiDoc</em> source file syntax
87
- and the backend output markups (which can be almost any type of
88
- SGML/XML markup) can be customized and extended by the user.</p></div>
89
- <div class="admonitionblock">
90
- <table><tr>
91
- <td class="icon">
92
- <img src="./images/icons/tip.png" alt="Tip" />
93
- </td>
94
- <td class="content">The pages you are reading were written using <em>AsciiDoc</em>, to view
95
- the corresponding <em>AsciiDoc</em> source click on the <strong>Page Source</strong> menu item
96
- in the left hand margin.</td>
97
- </tr></table>
98
- </div>
99
- </div>
100
- <h2 id="_overview_and_examples">Overview and Examples</h2>
101
- <div class="sectionbody">
102
- <div class="paragraph"><p>You write an <em>AsciiDoc</em> document the same way you would write a
103
- normal text document, there are no markup tags or weird format
104
- notations. <em>AsciiDoc</em> files are designed to be viewed, edited and
105
- printed directly or translated to other presentation formats using
106
- the <tt>asciidoc(1)</tt> command.</p></div>
107
- <div class="paragraph"><p>The <tt>asciidoc(1)</tt> command translates <em>AsciiDoc</em> files to HTML, XHTML and
108
- DocBook markups. DocBook can be post-processed to presentation
109
- formats such as HTML, PDF, DVI, LaTeX, roff, and Postscript using
110
- readily available Open Source tools.</p></div>
111
- <h3 id="_example_articles">Example Articles</h3><div style="clear:left"></div>
112
- <div class="ulist"><ul>
113
- <li>
114
- <p>
115
- This version of the
116
- <a href="asciidoc.css-embedded.html"><em>AsciiDoc</em> User Guide</a>
117
- was generated by <em>AsciiDoc</em> from
118
- <a href="asciidoc.txt">this <em>AsciiDoc</em> file</a>.
119
- </p>
120
- </li>
121
- <li>
122
- <p>
123
- Here&#8217;s the <a href="asciidoc.html">same document</a> created by first
124
- generating DocBook markup using <em>AsciiDoc</em> and then converting the
125
- DocBook markup to HTML using <em>DocBook XSL Stylesheets</em>.
126
- </p>
127
- </li>
128
- <li>
129
- <p>
130
- The User Guide again, this time a
131
- <a href="chunked/index.html">chunked version</a>.
132
- </p>
133
- </li>
134
- <li>
135
- <p>
136
- This <a href="article.txt"><em>AsciiDoc</em> article template</a> produced
137
- this <a href="article.html">HTML file</a> and this
138
- <a href="article.pdf">PDF file</a> via DocBook markup generated by <em>AsciiDoc</em>.
139
- </p>
140
- </li>
141
- <li>
142
- <p>
143
- This <a href="asciidoc.pdf">PDF formatted User Guide</a> was generated from
144
- <tt>asciidoc(1)</tt> DocBook output.
145
- </p>
146
- </li>
147
- </ul></div>
148
- <h3 id="_example_books">Example Books</h3><div style="clear:left"></div>
149
- <div class="paragraph"><p><em>AsciiDoc</em> markup supports all the standard DocBook frontmatter and
150
- backmatter sections (dedication, preface, bibliography, glossary,
151
- index, colophon) plus footnotes and index entries.</p></div>
152
- <div class="dlist"><dl>
153
- <dt class="hdlist1">
154
- Book
155
- </dt>
156
- <dd>
157
- <p>
158
- This <a href="book.txt"><em>AsciiDoc</em> book&#8217;s</a> DocBook output
159
- produced <a href="book.html">this HTML file</a> using the
160
- <em>DocBook XSL Stylesheets</em>.
161
- </p>
162
- </dd>
163
- <dt class="hdlist1">
164
- Multi-part book
165
- </dt>
166
- <dd>
167
- <p>
168
- This <a href="book-multi.txt">multi-part <em>AsciiDoc</em> book&#8217;s</a>
169
- DocBook output produced <a href="book-multi.html">this HTML file</a>
170
- using the <em>DocBook XSL Stylesheets</em>.
171
- </p>
172
- </dd>
173
- </dl></div>
174
- <h3 id="_example_unix_man_pages">Example UNIX Man Pages</h3><div style="clear:left"></div>
175
- <div class="paragraph"><p>HTML formatted <em>AsciiDoc</em> man pages
176
- <a href="asciidoc.1.css-embedded.html">with stylesheets</a> and
177
- <a href="asciidoc.1.html">without stylesheets</a> were generated by <em>AsciiDoc</em>
178
- from <a href="asciidoc.1.txt">this file</a>.</p></div>
179
- <div class="paragraph"><p>This <a href="asciidoc.1">roff formatted man page</a> was generated from
180
- <tt>asciidoc(1)</tt> DocBook output using <tt>xsltproc(1)</tt> and DocBook XSL
181
- Stylesheets.</p></div>
182
- <h3 id="_example_web_site">Example Web Site</h3><div style="clear:left"></div>
183
- <div class="paragraph"><p>The <a href="README-website.html"><em>AsciiDoc</em> website</a> is included in the
184
- <em>AsciiDoc</em> distribution (in <tt>./examples/website/</tt>) as example website
185
- built using <em>AsciiDoc</em>. See <tt>./examples/website/README-website.txt</tt>.</p></div>
186
- </div>
187
- <h2 id="_music_filter">Music Filter</h2>
188
- <div class="sectionbody">
189
- <div class="paragraph"><p>A <a href="music-filter.html">music filter</a> is included in the distribution
190
- <tt>./filters/</tt> directory. It translates music in
191
- <a href="http://lilypond.org/">LilyPond</a> or <a href="http://abcnotation.org.uk/">ABC</a>
192
- notation to standard classical notation</p></div>
193
- </div>
194
- <h2 id="_source_code_highlight_filter">Source Code Highlight Filter</h2>
195
- <div class="sectionbody">
196
- <div class="paragraph"><p>A <a href="source-highlight-filter.html">source code highlight filter</a> is
197
- included in the distribution <tt>./filters/</tt> directory.</p></div>
198
- </div>
199
- <h2 id="X4">Graphviz Filter</h2>
200
- <div class="sectionbody">
201
- <div class="paragraph"><p>Gouichi Iisaka has written a <a href="http://www.graphviz.org/">Graphviz</a> filter
202
- for <em>AsciiDoc</em>. Graphviz generates diagrams from a textual
203
- specification. Gouichi Iisaka&#8217;s Graphviz filter is included in the
204
- <em>AsciiDoc</em> distribution. Here are some
205
- <a href="asciidoc-graphviz-sample.html"><em>AsciiDoc</em> Graphviz examples</a>.</p></div>
206
- </div>
207
- <h2 id="X3">Mathematical Formulae</h2>
208
- <div class="sectionbody">
209
- <div class="paragraph"><p>You can include mathematical formulae in <em>AsciiDoc</em> XHTML documents using
210
- <a href="asciimathml.html">ASCIIMathML</a> or <a href="latexmathml.html">LaTeXMathML</a>
211
- notation.</p></div>
212
- <div class="paragraph"><p><a href="latexmath.pdf">LaTeX Math</a> can be included in <em>AsciiDoc</em>
213
- documents processed by <tt>dblatex(1)</tt>.</p></div>
214
- </div>
215
- <h2 id="_vim_syntax_highlighter">Vim Syntax Highlighter</h2>
216
- <div class="sectionbody">
217
- <div class="paragraph"><p>An <em>AsciiDoc</em> syntax highlighter for the Vim text editor is included in
218
- the <em>AsciiDoc</em> distribution (see <em>Appendix F</em> of the <em><em>AsciiDoc</em> User
219
- Guide</em> for details).</p></div>
220
- <div class="imageblock">
221
- <div class="content">
222
- <a class="image" href="images/highlighter.png">
223
- <img src="images/highlighter.png" alt="images/highlighter.png" height="250"/>
224
- </a>
225
- </div>
226
- <div class="image-title">Syntax highlighter screenshot</div>
227
- </div>
228
- <div class="paragraph"><p>Dag Wieers has implemented an alternative Vim syntax file for <em>AsciiDoc</em>
229
- which can be found here
230
- <a href="http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/">http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/</a>.</p></div>
231
- </div>
232
- <h2 id="X2">Resources</h2>
233
- <div class="sectionbody">
234
- <div class="ulist"><ul>
235
- <li>
236
- <p>
237
- Check the <a href="downloads.html">Downloads page</a> for packaged versions
238
- of <em>AsciiDoc</em>.
239
- </p>
240
- </li>
241
- <li>
242
- <p>
243
- Alex Efros has written an HTML formatted
244
- <a href="http://powerman.name/doc/asciidoc"><em>AsciiDoc</em> Cheatsheet</a> using
245
- Asciidoc.
246
- </p>
247
- </li>
248
- <li>
249
- <p>
250
- Thomas Berker has written an
251
- <a href="http://liksom.info/blog/?q=node/114"><em>AsciiDoc</em> Cheatsheet</a> in Open
252
- Document and PDF formats.
253
- </p>
254
- </li>
255
- <li>
256
- <p>
257
- The <a href="http://www.wikimatrix.org/">WikiMatrix</a> website has an excellent
258
- <a href="http://www.wikimatrix.org/syntax.php">web page</a> that compares the
259
- various Wiki markup syntaxes. An interesting attempt at Wiki markup
260
- standardization is <a href="http://www.wikicreole.org/">CREOLE</a>.
261
- </p>
262
- </li>
263
- <li>
264
- <p>
265
- Terrence Brannon has written
266
- <a href="http://www.metaperl.com/asciidoc-el/"><em>AsciiDoc</em> functions for Emacs</a>.
267
- </p>
268
- </li>
269
- <li>
270
- <p>
271
- The <a href="http://xpt.sourceforge.net/">*Nix Power Tools project</a> has
272
- released an <a href="http://xpt.sourceforge.net/tools/doc-mode/"><em>AsciiDoc</em>
273
- syntax highlighter for Emacs</a>.
274
- </p>
275
- </li>
276
- <li>
277
- <p>
278
- Franck Pommereau has written
279
- <a href="http://www.univ-paris12.fr/lacl/pommereau/soft/asciidoctest.html">Asciidoctest</a>,
280
- a program that doctests snippets of Python code within your Asciidoc
281
- documents.
282
- </p>
283
- </li>
284
- <li>
285
- <p>
286
- The <a href="http://remips.sourceforge.net/">ReMIPS</a> project website has been
287
- built using <em>AsciiDoc</em>.
288
- </p>
289
- </li>
290
- <li>
291
- <p>
292
- Here are some <a href="asciidoc-docbook-xsl.html">DocBook XSL Stylesheets
293
- Notes</a>.
294
- </p>
295
- </li>
296
- <li>
297
- <p>
298
- Karl Mowatt-Wilson has developed an <a href="http://ikiwiki.info/">ikiwiki</a>
299
- plugin for <em>AsciiDoc</em> which he uses to render
300
- <a href="http://mowson.org/karl">his website</a>. The plugin is available
301
- <a href="http://www.mowson.org/karl/colophon/">here</a> and there is some
302
- discussion of the ikiwiki integration
303
- <a href="http://ikiwiki.info/users/KarlMW/discussion/">here</a>.
304
- </p>
305
- </li>
306
- </ul></div>
307
- </div>
308
- <h2 id="_blogpost_weblog_client">Blogpost weblog client</h2>
309
- <div class="sectionbody">
310
- <div class="paragraph"><p><a href="http://srackham.wordpress.com/blogpost-readme/">blogpost</a> is a
311
- command-line weblog client for publishing <em>AsciiDoc</em> documents to
312
- <a href="http://wordpress.org/">WordPress</a> blog hosts. It creates and updates
313
- weblog posts and pages directly from <em>AsciiDoc</em> source documents.</p></div>
314
- </div>
315
- <h2 id="X1">LaTeX Backend</h2>
316
- <div class="sectionbody">
317
- <div class="paragraph"><p>An experimental LaTeX backend has been written for <em>AsciiDoc</em> by
318
- Benjamin Klum. Benjamin has done a superhuman job (I admit it, I
319
- didn&#8217;t think this was doable due to <em>AsciiDoc</em>'s SGML/XML bias).</p></div>
320
- <div class="paragraph"><p>Here&#8217;s <a href="latex-backend.html">Benjamin&#8217;s documentation</a>.</p></div>
321
- <div class="admonitionblock">
322
- <table><tr>
323
- <td class="icon">
324
- <img src="./images/icons/note.png" alt="Note" />
325
- </td>
326
- <td class="content">Owning to to other commitments, Benjamin is unable to maintain
327
- this backend. I don&#8217;t have the expertise or time to take this on
328
- consequently the LaTeX backend has not been tested or updated since
329
- <em>AsciiDoc</em> version 8.2.7 and is currently unsupported.</td>
330
- </tr></table>
331
- </div>
332
- </div>
333
- <h2 id="_projects_using_asciidoc">Projects using AsciiDoc</h2>
334
- <div class="sectionbody">
335
- <div class="paragraph"><p>Here are some projects I know of, if you know of more drop me a line
336
- and I&#8217;ll add them to the list.</p></div>
337
- <div class="ulist"><ul>
338
- <li>
339
- <p>
340
- The Linux kernel
341
- <a href="http://www.kernel.org/pub/software/scm/git/docs/git.html">git source
342
- code management system</a>.
343
- </p>
344
- </li>
345
- <li>
346
- <p>
347
- Some documentation about git by Nico Schottelius (in German)
348
- <a href="http://nico.schotteli.us/papers/linux/git-firmen/">http://nico.schotteli.us/papers/linux/git-firmen/</a>.
349
- </p>
350
- </li>
351
- <li>
352
- <p>
353
- The <a href="http://www.netpromi.com/kirbybase_ruby.html">KirbyBase for Ruby</a>
354
- database management system manual.
355
- </p>
356
- </li>
357
- <li>
358
- <p>
359
- The <a href="http://www.selenic.com/mercurial/">Mercurial distributed SCM</a>
360
- uses asciidoc for its man pages.
361
- </p>
362
- </li>
363
- <li>
364
- <p>
365
- Pascal Rapaz has written a Python script to automate <em>AsciiDoc</em>
366
- website generation. You can find it at
367
- <a href="http://www.rapazp.ch/opensource/tools/asciidoc.html">http://www.rapazp.ch/opensource/tools/asciidoc.html</a>.
368
- </p>
369
- </li>
370
- <li>
371
- <p>
372
- The <a href="http://xpt.sourceforge.net/">*Nix Power Tools project</a> uses
373
- <em>AsciiDoc</em> for documentation and has released an Emacs syntax
374
- highlighter (see <a href="#X2">Resources</a> above).
375
- </p>
376
- </li>
377
- <li>
378
- <p>
379
- The <a href="http://www.wesnoth.org/">Battle for Wesnoth</a> project uses
380
- <em>AsciiDoc</em> for it&#8217;s <a href="http://www.wesnoth.org/wiki/WesnothManual">Manual</a>
381
- in a number of different languages.
382
- </p>
383
- </li>
384
- </ul></div>
385
- </div>
386
- <h2 id="_asciidoc_version_9">AsciiDoc version 9</h2>
387
- <div class="sectionbody">
388
- <div class="paragraph"><p>The next version of <em>AsciiDoc</em> is underway&#8201;&#8212;&#8201;details
389
- <a href="version9.html">here</a>.</p></div>
390
- </div>
391
- <div id="footer">
392
- <div id="footer-text">
393
- Version 8.3.3<br />
394
- Last updated 2009-01-02 13:10:49 NZDT
395
- </div>
396
- <div id="footer-badges">
397
- <a href="http://validator.w3.org/check?uri=referer">
398
- <img style="border:none; width:88px; height:31px;"
399
- src="http://www.w3.org/Icons/valid-xhtml11"
400
- alt="Valid XHTML 1.1!" />
401
- </a>
402
- <a href="http://jigsaw.w3.org/css-validator/check/referer">
403
- <img style="border:none; width:88px; height:31px;"
404
- src="http://jigsaw.w3.org/css-validator/images/vcss"
405
- alt="Valid CSS!" />
406
- </a>
407
- <a href="http://www.mozilla.org/products/firefox/">
408
- <img style="border:none; width:110px; height:32px;"
409
- src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
410
- alt="Get Firefox!" />
411
- </a>
412
- </div>
413
- </div>
414
- </div>
415
- </td>
416
- </tr>
417
- </table>
418
- </body>
419
- </html>
@@ -1,245 +0,0 @@
1
- AsciiDoc Home Page
2
- ==================
3
-
4
- .{date}: AsciiDoc {revision} Released
5
- ************************************************************************
6
- Two significant changes in this release:
7
-
8
- - Included Gouichi Iisaka's <<X4,Graphviz filter>> in the AsciiDoc
9
- distribution.
10
- - You can now set the numbered list number style ('arabic',
11
- 'loweralpha', 'upperalpha', 'lowerroman', 'upperroman') or let
12
- AsciiDoc guess the style of the first numbered item.
13
-
14
- Plus a number of smaller additions along with the usual documentation
15
- polishing. Read the link:CHANGELOG.html[CHANGELOG] for a full list of
16
- all additions and changes.
17
-
18
- One final note: if you are upgrading from version 8.2.7 or less please
19
- read about possible link:CHANGELOG.html#X1[compatibility issues]
20
- first.
21
-
22
- mailto:srackham@gmail.com['Stuart Rackham']
23
- ************************************************************************
24
-
25
- Introduction
26
- ------------
27
- AsciiDoc is a text document format for writing short documents,
28
- articles, books and UNIX man pages. AsciiDoc files can be translated
29
- to HTML and DocBook markups using the asciidoc(1) command.
30
-
31
- AsciiDoc is highly configurable: both the AsciiDoc source file syntax
32
- and the backend output markups (which can be almost any type of
33
- SGML/XML markup) can be customized and extended by the user.
34
-
35
- TIP: The pages you are reading were written using AsciiDoc, to view
36
- the corresponding AsciiDoc source click on the *Page Source* menu item
37
- in the left hand margin.
38
-
39
-
40
- Overview and Examples
41
- ---------------------
42
- You write an AsciiDoc document the same way you would write a
43
- normal text document, there are no markup tags or weird format
44
- notations. AsciiDoc files are designed to be viewed, edited and
45
- printed directly or translated to other presentation formats using
46
- the asciidoc(1) command.
47
-
48
- The asciidoc(1) command translates AsciiDoc files to HTML, XHTML and
49
- DocBook markups. DocBook can be post-processed to presentation
50
- formats such as HTML, PDF, DVI, LaTeX, roff, and Postscript using
51
- readily available Open Source tools.
52
-
53
- Example Articles
54
- ~~~~~~~~~~~~~~~~
55
- - This version of the
56
- link:asciidoc.css-embedded.html[AsciiDoc User Guide]
57
- was generated by AsciiDoc from
58
- link:asciidoc.txt[this AsciiDoc file].
59
-
60
- - Here's the link:asciidoc.html[same document] created by first
61
- generating DocBook markup using AsciiDoc and then converting the
62
- DocBook markup to HTML using 'DocBook XSL Stylesheets'.
63
-
64
- - The User Guide again, this time a
65
- link:chunked/index.html[chunked version].
66
-
67
- - This link:article.txt[AsciiDoc article template] produced
68
- this link:article.html[HTML file] and this
69
- link:article.pdf[PDF file] via DocBook markup generated by AsciiDoc.
70
-
71
- - This link:asciidoc.pdf[PDF formatted User Guide] was generated from
72
- asciidoc(1) DocBook output.
73
-
74
- Example Books
75
- ~~~~~~~~~~~~~
76
- AsciiDoc markup supports all the standard DocBook frontmatter and
77
- backmatter sections (dedication, preface, bibliography, glossary,
78
- index, colophon) plus footnotes and index entries.
79
-
80
- Book::
81
- This link:book.txt[AsciiDoc book's] DocBook output
82
- produced link:book.html[this HTML file] using the
83
- 'DocBook XSL Stylesheets'.
84
-
85
- Multi-part book::
86
- This link:book-multi.txt[multi-part AsciiDoc book's]
87
- DocBook output produced link:book-multi.html[this HTML file]
88
- using the 'DocBook XSL Stylesheets'.
89
-
90
- Example UNIX Man Pages
91
- ~~~~~~~~~~~~~~~~~~~~~~
92
- HTML formatted AsciiDoc man pages
93
- link:asciidoc.1.css-embedded.html[with stylesheets] and
94
- link:asciidoc.1.html[without stylesheets] were generated by AsciiDoc
95
- from link:asciidoc.1.txt[this file].
96
-
97
- This link:asciidoc.1[roff formatted man page] was generated from
98
- asciidoc(1) DocBook output using `xsltproc(1)` and DocBook XSL
99
- Stylesheets.
100
-
101
- Example Web Site
102
- ~~~~~~~~~~~~~~~~
103
- The link:README-website.html[AsciiDoc website] is included in the
104
- AsciiDoc distribution (in `./examples/website/`) as example website
105
- built using AsciiDoc. See `./examples/website/README-website.txt`.
106
-
107
-
108
- Music Filter
109
- ------------
110
- A link:music-filter.html[music filter] is included in the distribution
111
- `./filters/` directory. It translates music in
112
- http://lilypond.org/[LilyPond] or http://abcnotation.org.uk/[ABC]
113
- notation to standard classical notation
114
-
115
-
116
- Source Code Highlight Filter
117
- ----------------------------
118
- A link:source-highlight-filter.html[source code highlight filter] is
119
- included in the distribution `./filters/` directory.
120
-
121
-
122
- [[X4]]
123
- Graphviz Filter
124
- ---------------
125
- Gouichi Iisaka has written a http://www.graphviz.org/[Graphviz] filter
126
- for AsciiDoc. Graphviz generates diagrams from a textual
127
- specification. Gouichi Iisaka's Graphviz filter is included in the
128
- AsciiDoc distribution. Here are some
129
- link:asciidoc-graphviz-sample.html[AsciiDoc Graphviz examples].
130
-
131
-
132
- [[X3]]
133
- Mathematical Formulae
134
- ---------------------
135
- You can include mathematical formulae in AsciiDoc XHTML documents using
136
- link:asciimathml.html[ASCIIMathML] or link:latexmathml.html[LaTeXMathML]
137
- notation.
138
-
139
- link:latexmath.pdf[LaTeX Math] can be included in AsciiDoc
140
- documents processed by `dblatex(1)`.
141
-
142
-
143
- Vim Syntax Highlighter
144
- ----------------------
145
- An AsciiDoc syntax highlighter for the Vim text editor is included in
146
- the AsciiDoc distribution (see 'Appendix F' of the 'AsciiDoc User
147
- Guide' for details).
148
-
149
- .Syntax highlighter screenshot
150
- image::images/highlighter.png[height=250,caption="",link="images/highlighter.png"]
151
-
152
- Dag Wieers has implemented an alternative Vim syntax file for AsciiDoc
153
- which can be found here
154
- http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/.
155
-
156
-
157
- [[X2]]
158
- Resources
159
- ---------
160
- - Check the link:downloads.html[Downloads page] for packaged versions
161
- of AsciiDoc.
162
- - Alex Efros has written an HTML formatted
163
- http://powerman.name/doc/asciidoc[AsciiDoc Cheatsheet] using
164
- Asciidoc.
165
- - Thomas Berker has written an
166
- http://liksom.info/blog/?q=node/114[AsciiDoc Cheatsheet] in Open
167
- Document and PDF formats.
168
- - The http://www.wikimatrix.org/[WikiMatrix] website has an excellent
169
- http://www.wikimatrix.org/syntax.php[web page] that compares the
170
- various Wiki markup syntaxes. An interesting attempt at Wiki markup
171
- standardization is http://www.wikicreole.org/[CREOLE].
172
- - Terrence Brannon has written
173
- http://www.metaperl.com/asciidoc-el/[AsciiDoc functions for Emacs].
174
- - The http://xpt.sourceforge.net/[*Nix Power Tools project] has
175
- released an http://xpt.sourceforge.net/tools/doc-mode/[AsciiDoc
176
- syntax highlighter for Emacs].
177
-
178
- - Franck Pommereau has written
179
- http://www.univ-paris12.fr/lacl/pommereau/soft/asciidoctest.html[Asciidoctest],
180
- a program that doctests snippets of Python code within your Asciidoc
181
- documents.
182
- - The http://remips.sourceforge.net/[ReMIPS] project website has been
183
- built using AsciiDoc.
184
- - Here are some link:asciidoc-docbook-xsl.html[DocBook XSL Stylesheets
185
- Notes].
186
- - Karl Mowatt-Wilson has developed an http://ikiwiki.info/[ikiwiki]
187
- plugin for AsciiDoc which he uses to render
188
- http://mowson.org/karl[his website]. The plugin is available
189
- http://www.mowson.org/karl/colophon/[here] and there is some
190
- discussion of the ikiwiki integration
191
- http://ikiwiki.info/users/KarlMW/discussion/[here].
192
-
193
-
194
- Blogpost weblog client
195
- ----------------------
196
- http://srackham.wordpress.com/blogpost-readme/[blogpost] is a
197
- command-line weblog client for publishing AsciiDoc documents to
198
- http://wordpress.org/[WordPress] blog hosts. It creates and updates
199
- weblog posts and pages directly from AsciiDoc source documents.
200
-
201
-
202
- [[X1]]
203
- LaTeX Backend
204
- -------------
205
- An experimental LaTeX backend has been written for AsciiDoc by
206
- Benjamin Klum. Benjamin has done a superhuman job (I admit it, I
207
- didn't think this was doable due to AsciiDoc's SGML/XML bias).
208
-
209
- Here's link:latex-backend.html[Benjamin's documentation].
210
-
211
- NOTE: Owning to to other commitments, Benjamin is unable to maintain
212
- this backend. I don't have the expertise or time to take this on
213
- consequently the LaTeX backend has not been tested or updated since
214
- AsciiDoc version 8.2.7 and is currently unsupported.
215
-
216
-
217
- Projects using AsciiDoc
218
- -----------------------
219
- Here are some projects I know of, if you know of more drop me a line
220
- and I'll add them to the list.
221
-
222
- - The Linux kernel
223
- http://www.kernel.org/pub/software/scm/git/docs/git.html[git source
224
- code management system].
225
- - Some documentation about git by Nico Schottelius (in German)
226
- http://nico.schotteli.us/papers/linux/git-firmen/.
227
- - The http://www.netpromi.com/kirbybase_ruby.html[KirbyBase for Ruby]
228
- database management system manual.
229
- - The http://www.selenic.com/mercurial/[Mercurial distributed SCM]
230
- uses asciidoc for its man pages.
231
- - Pascal Rapaz has written a Python script to automate AsciiDoc
232
- website generation. You can find it at
233
- http://www.rapazp.ch/opensource/tools/asciidoc.html.
234
- - The http://xpt.sourceforge.net/[*Nix Power Tools project] uses
235
- AsciiDoc for documentation and has released an Emacs syntax
236
- highlighter (see <<X2,Resources>> above).
237
- - The http://www.wesnoth.org/[Battle for Wesnoth] project uses
238
- AsciiDoc for it's http://www.wesnoth.org/wiki/WesnothManual[Manual]
239
- in a number of different languages.
240
-
241
-
242
- AsciiDoc version 9
243
- -----------------
244
- The next version of AsciiDoc is underway -- details
245
- link:version9.html[here].