mizuho 0.9.6 → 0.9.8

Sign up to get free protection for your applications and to get access to all the features.
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,18 +1,18 @@
1
- Copyright (C) 2000-2007 Stuart Rackham
2
-
3
- Email: srackham@gmail.com
4
-
5
- This program is free software; you can redistribute it and/or modify
6
- it under the terms of the GNU General Public License as published by
7
- the Free Software Foundation; either version 2 of the License, or (at
8
- your option) any later version.
9
-
10
- This program is distributed in the hope that it will be useful, but
11
- WITHOUT ANY WARRANTY; without even the implied warranty of
12
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
- General Public License for more details.
14
-
15
- You should have received a copy of the GNU General Public License
16
- along with this program; if not, write to the Free Software
17
- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
18
- USA.
1
+ Copyright (C) 2000-2007 Stuart Rackham
2
+
3
+ Email: srackham@gmail.com
4
+
5
+ This program is free software; you can redistribute it and/or modify
6
+ it under the terms of the GNU General Public License as published by
7
+ the Free Software Foundation; either version 2 of the License, or (at
8
+ your option) any later version.
9
+
10
+ This program is distributed in the hope that it will be useful, but
11
+ WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
+ General Public License for more details.
14
+
15
+ You should have received a copy of the GNU General Public License
16
+ along with this program; if not, write to the Free Software
17
+ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
18
+ USA.
@@ -1,24 +1,71 @@
1
1
  AsciiDoc Installation
2
2
 
3
- version 8.3.3, 2 January 2009
3
+ version 8.6.5, 20 May 2011
4
4
 
5
- Note: The current version of AsciiDoc requires Python 2.4 or newer to
6
- run. If you don't already have an up-to-date version of Python
7
- installed it can be downloaded from the official Python website
8
- [1]http://www.python.org/.
5
+ Note
6
+ The current version of AsciiDoc requires Python 2.4 or newer to run. If
7
+ you don’t already have an up-to-date version of Python installed it can
8
+ be downloaded from the official Python website
9
+ [1]http://www.python.org/.
10
+ __________________________________________________________________
11
+
12
+ 1. Prerequisites
9
13
 
10
- The latest AsciiDoc downloads can be found on the AsciiDoc website
11
- [2]http://www.methods.co.nz/asciidoc/downloads.html and at the
12
- SourceForge [3]http://sourceforge.net/projects/asciidoc/.
14
+ See the [2]README page.
13
15
  __________________________________________________________________
14
16
 
15
- 1. Prepackaged AsciiDoc installation
17
+ 2. Installing from the Mercurial repository
18
+
19
+ The AsciiDoc [3]Mercurial repository is hosted by [4]Google Code. To
20
+ browse the repository go to
21
+ [5]http://code.google.com/p/asciidoc/source/browse/. You can install
22
+ AsciiDoc from the repository if you don’t have an up to date packaged
23
+ version or want to get the latest version from the trunk:
24
+ * Make sure you have [6]Mercurial installed, you can check with:
25
+ $ hg --version
26
+ * Go to the directory you want to install AsciiDoc into and download
27
+ the repository. This example gets the 8.6.5 tagged release:
28
+ $ cd ~/bin
29
+ $ hg clone -r 8.6.5 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.5
30
+
31
+ You now have two choices: you can run asciidoc locally from your
32
+ repository or you can use autoconf(1) and make(1) to perform a
33
+ system-wide install.
34
+
35
+ 2.1. Running asciidoc from your local copy
36
+
37
+ Create a symlink to the AsciiDoc script in a search PATH directory so
38
+ it’s easy to execute asciidoc from the command-line, for example:
39
+ $ ln -s ~/bin/asciidoc-8.6.5/asciidoc.py ~/bin/asciidoc
40
+ $ ln -s ~/bin/asciidoc-8.6.5/a2x.py ~/bin/a2x
41
+
42
+ Use the Mercurial pull command to update your local AsciiDoc
43
+ repository.
44
+
45
+ 2.2. Installing asciidoc for all users
46
+
47
+ Create configure using autoconf(1); use configure to create the
48
+ Makefile; run make(1); build the man pages; install:
49
+
50
+ $ autoconf
51
+ $ ./configure
52
+ $ make
53
+ $ sudo make install
16
54
 
17
- The AsciiDoc [4]downloads page lists AsciiDoc packages for various
18
- Linux distributions.
55
+ To uninstall:
56
+
57
+ $ sudo make uninstall
19
58
  __________________________________________________________________
20
59
 
21
- 2. Distribution tarball installation
60
+ 3. Distribution tarball installation
61
+
62
+ The distribution source tarballs can be downloaded from the SourceForge
63
+ [7]http://sourceforge.net/projects/asciidoc/.
64
+
65
+ Note
66
+ Unless you are [8]installing on Microsoft Windows you should use the
67
+ tarball and not the zip file to install the the distribution (the
68
+ tarball contains symlinks).
22
69
 
23
70
  If your flavor or UNIX or Linux does not have a packaged AsciiDoc
24
71
  distribution or if you prefer to install the latest AsciiDoc version
@@ -27,10 +74,9 @@
27
74
 
28
75
  The autoconf(1) generated configure script creates a make file that is
29
76
  tailored for your system. To install:
30
- $ tar -xzf asciidoc-8.3.3.tar.gz
31
- $ cd asciidoc-8.3.3
77
+ $ tar -xzf asciidoc-8.6.5.tar.gz
78
+ $ cd asciidoc-8.6.5
32
79
  $ ./configure
33
- $ make
34
80
  $ sudo make install
35
81
 
36
82
  To install the documentation:
@@ -45,32 +91,145 @@
45
91
  asciidoc_filetype.vim in the ftdetect directory).
46
92
  __________________________________________________________________
47
93
 
48
- 3. Microsoft Windows installation
94
+ 4. Microsoft Windows installation
95
+
96
+ AsciiDoc is developed and tested on Linux but there seem to be quite a
97
+ few people using it on Windows. To install AsciiDoc on Windows unzip
98
+ the distribution Zip file contents:
99
+ $ unzip asciidoc-8.6.5.zip
100
+
101
+ This will create the folder asciidoc-8.6.5 containing the asciidoc.py
102
+ and a2x.py executables along with configuration files and
103
+ documentation.
49
104
 
50
- To install the zip formatted distribution just unzip the contents to a
51
- new folder:
52
- $ mkdir asciidoc
53
- $ cd asciidoc
54
- $ unzip ../asciidoc-8.3.3.zip
105
+ To generate DocBook based outputs (e.g. PDFs) you will also need a
106
+ working DocBook toolchain. Installing and configuring a DocBook
107
+ toolchain on Windows can be a challenge — this blog post explains
108
+ [9]How to Create Handsome PDF Documents Without Frustration using
109
+ [10]Cygwin, [11]dblatex and AsciiDoc.
55
110
  __________________________________________________________________
56
111
 
57
- 4. Testing your installation
112
+ 5. Testing your installation
58
113
 
59
114
  Test out asciidoc by changing to the AsciiDoc application directory and
60
115
  convert the User Guide document (./doc/asciidoc.txt) to XHTML
61
116
  (./doc/asciidoc.html):
62
- $ asciidoc doc/asciidoc.txt
117
+ $ python asciidoc.py doc/asciidoc.txt
118
+
119
+ [12]testasciidoc offers a more extensive set of conformance tests,
120
+ though you do need to create the test data before running the tests
121
+ (this in itself is a good post-install test):
122
+ $ python ./tests/testasciidoc.py update
123
+
124
+ Now you can run the tests by executing this command:
125
+ $ python ./tests/testasciidoc.py run
126
+
127
+ A full battery of tests can be run from the main.aap script in the
128
+ distribution root directory:
129
+ $ aap test
130
+ __________________________________________________________________
131
+
132
+ 6. Building the distribution
133
+
134
+ The AsciiDoc distribution is built using [13]A-A-P (a software build
135
+ system written by Bram Moolenaar). The AsciiDoc A-A-P scripts are:
136
+
137
+ ./main.aap
138
+ Builds the distribution tarball and zip files, documentation and
139
+ example website.
140
+
141
+ ./doc/main.aap
142
+ Builds distribution documentation.
143
+
144
+ ./examples/website/main.aap
145
+ Builds AsciiDoc website.
146
+
147
+ ./common.aap
148
+ Included in all scripts.
149
+
150
+ To build the distribution tarball and zip files, documentation and
151
+ example website run A-A-P from the distribution root directory:
152
+ $ aap
153
+ __________________________________________________________________
154
+
155
+ 7. Prepackaged AsciiDoc installation
156
+
157
+ The following platform specific AsciiDoc packages are available:
158
+
159
+ Debian GNU/Linux
160
+ If you use Debian or a Debian based distribution there’s an
161
+ [14]AsciiDoc Debian package available. Thanks to [15]Fredrik
162
+ Steen who built and maintains the Debian AsciiDoc package.
163
+
164
+ Gentoo Linux
165
+ If you use Gentoo Linux there’s a [16]Gentoo AsciiDoc package
166
+ available. Thanks to [17]Brandon Philips for writing the ebuild.
167
+
168
+ Fedora Linux
169
+ With help from Terje Røsten, Chris Wright added asciidoc to
170
+ Fedora Extras which is available in the default installation. To
171
+ install asciidoc execute the following command:
172
+
173
+ $ yum install asciidoc
174
+
175
+ Slackware Linux
176
+ John Calixto has created a Slackware package for AsciiDoc which
177
+ can be downloaded from [18]http://linuxpackages.net/.
178
+
179
+ Ark Linux
180
+ [19]Bernhard Rosenkraenzer added AsciiDoc to Ark Linux — the
181
+ package is available from the Ark Linux repository at
182
+ [20]http://arklinux.osuosl.org/dockyard-devel/, so Ark Linux
183
+ users should just run apt-get install asciidoc.
184
+
185
+ T2 Linux
186
+ [21]Christian Wiese added AsciiDoc to the [22]T2 Linux
187
+ repository at
188
+ [23]http://svn.exactcode.de/t2/trunk/package/textproc/asciidoc/.
189
+ To build and install the package on a T2 system, run
190
+ ./scripts/Emerge-Pkg asciidoc from within your T2 source
191
+ directory (default: /usr/src/t2-src).
192
+
193
+ Red Hat Enterprise Linux, Fedora and CentOS packages
194
+ Dag Wieers has built AsciiDoc RPMs for a number of Red Hat based
195
+ distributions, they can be downloaded from
196
+ [24]http://dag.wieers.com/rpm/packages/asciidoc/.
197
+
198
+ CSW Package for Sun Solaris
199
+ Ben Walton has created a CSW package for AsciiDoc, you can find
200
+ it here: [25]http://opencsw.org/packages/asciidoc.
63
201
 
64
- Note: Windows users will need to execute the asciidoc.py script
65
- directly or create a suitable asciidoc.bat file.
202
+ See also [26]Packager Notes in the AsciiDoc User Guide.
66
203
  __________________________________________________________________
67
204
 
68
- Version 8.3.3
69
- Last updated 2009-01-02 12:45:19 NZDT
205
+ Version 8.6.5
206
+ Last updated 2010-11-15 08:44:54 NZDT
70
207
 
71
208
  References
72
209
 
73
210
  1. http://www.python.org/
74
- 2. http://www.methods.co.nz/asciidoc/downloads.html
75
- 3. http://sourceforge.net/projects/asciidoc/
76
- 4. http://www.methods.co.nz/asciidoc/downloads.html
211
+ 2. file://localhost/tmp/lynxXXXXrHyhys/README.html
212
+ 3. http://www.selenic.com/mercurial/
213
+ 4. http://code.google.com/
214
+ 5. http://code.google.com/p/asciidoc/source/browse/
215
+ 6. http://www.selenic.com/mercurial/
216
+ 7. http://sourceforge.net/projects/asciidoc/
217
+ 8. file://localhost/tmp/lynxXXXXrHyhys/L3934-4626TMP.html#X3
218
+ 9. http://blog.rainwebs.net/2010/02/25/how-to-create-handsome-pdf-documents-without-frustration/
219
+ 10. http://www.cygwin.com/
220
+ 11. http://dblatex.sourceforge.net/
221
+ 12. file://localhost/tmp/lynxXXXXrHyhys/testasciidoc.html
222
+ 13. http://www.a-a-p.org/
223
+ 14. http://packages.debian.org/asciidoc
224
+ 15. mailto:stone@debian.org
225
+ 16. http://packages.gentoo.org/package/app-text/asciidoc
226
+ 17. mailto:brandon@ifup.org
227
+ 18. http://linuxpackages.net/
228
+ 19. mailto:bero@arklinux.org
229
+ 20. http://arklinux.osuosl.org/dockyard-devel/
230
+ 21. mailto:cw@ixplanet.de
231
+ 22. http://www.t2-project.org/
232
+ 23. http://svn.exactcode.de/t2/trunk/package/textproc/asciidoc/
233
+ 24. http://dag.wieers.com/rpm/packages/asciidoc/
234
+ 25. http://opencsw.org/packages/asciidoc
235
+ 26. file://localhost/tmp/lynxXXXXrHyhys/userguide.html#X38
@@ -6,19 +6,77 @@ to run. If you don't already have an up-to-date version of Python
6
6
  installed it can be downloaded from the official Python website
7
7
  http://www.python.org/.
8
8
 
9
- The latest AsciiDoc downloads can be found on the AsciiDoc website
10
- http://www.methods.co.nz/asciidoc/downloads.html and at the
11
- SourceForge http://sourceforge.net/projects/asciidoc/.
12
9
 
13
- Prepackaged AsciiDoc installation
14
- ---------------------------------
15
- The AsciiDoc
16
- http://www.methods.co.nz/asciidoc/downloads.html[downloads page]
17
- lists AsciiDoc packages for various Linux distributions.
10
+ Prerequisites
11
+ -------------
12
+ See the link:README.html[README] page.
13
+
14
+
15
+ Installing from the Mercurial repository
16
+ ----------------------------------------
17
+ The AsciiDoc http://www.selenic.com/mercurial/[Mercurial] repository
18
+ is hosted by http://code.google.com/[Google Code].
19
+ To browse the repository go to
20
+ http://code.google.com/p/asciidoc/source/browse/.
21
+ You can install AsciiDoc from the repository if you don't have an up to
22
+ date packaged version or want to get the latest version from the trunk:
23
+
24
+ - Make sure you have http://www.selenic.com/mercurial/[Mercurial]
25
+ installed, you can check with:
26
+
27
+ $ hg --version
28
+
29
+ - Go to the directory you want to install AsciiDoc into and download
30
+ the repository. This example gets the {revnumber} tagged release:
31
+
32
+ [subs="attributes"]
33
+ $ cd ~/bin
34
+ $ hg clone -r {revnumber} https://asciidoc.googlecode.com/hg/ asciidoc-{revnumber}
35
+
36
+ You now have two choices: you can run asciidoc locally from your
37
+ repository or you can use 'autoconf(1)' and 'make(1)' to perform a
38
+ system-wide install.
18
39
 
40
+ Running asciidoc from your local copy
41
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42
+ Create a symlink to the AsciiDoc script in a search `PATH` directory
43
+ so it's easy to execute `asciidoc` from the command-line, for example:
19
44
 
45
+ [subs="attributes"]
46
+ $ ln -s ~/bin/asciidoc-{revnumber}/asciidoc.py ~/bin/asciidoc
47
+ $ ln -s ~/bin/asciidoc-{revnumber}/a2x.py ~/bin/a2x
48
+
49
+ Use the Mercurial `pull` command to update your local AsciiDoc repository.
50
+
51
+ Installing asciidoc for all users
52
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53
+ Create `configure` using 'autoconf(1)'; use `configure` to create the
54
+ `Makefile`; run 'make(1)'; build the man pages; install:
55
+
56
+ ---------------------------------------------
57
+ $ autoconf
58
+ $ ./configure
59
+ $ make
60
+ $ sudo make install
61
+ ---------------------------------------------
62
+
63
+ To uninstall:
64
+
65
+ ---------------------------------------------
66
+ $ sudo make uninstall
67
+ ---------------------------------------------
68
+
69
+
70
+ [[X1]]
20
71
  Distribution tarball installation
21
72
  ---------------------------------
73
+ The distribution source tarballs can be downloaded from the
74
+ SourceForge http://sourceforge.net/projects/asciidoc/.
75
+
76
+ NOTE: Unless you are <<X3,installing on Microsoft Windows>> you should
77
+ use the tarball and not the zip file to install the the distribution
78
+ (the tarball contains symlinks).
79
+
22
80
  If your flavor or UNIX or Linux does not have a packaged AsciiDoc
23
81
  distribution or if you prefer to install the latest AsciiDoc version
24
82
  from source use the `configure` shell script in the tarball root
@@ -28,10 +86,9 @@ The `autoconf(1)` generated `configure` script creates a make file
28
86
  that is tailored for your system. To install:
29
87
 
30
88
  [subs="attributes"]
31
- $ tar -xzf asciidoc-{revision}.tar.gz
32
- $ cd asciidoc-{revision}
89
+ $ tar -xzf asciidoc-{revnumber}.tar.gz
90
+ $ cd asciidoc-{revnumber}
33
91
  $ ./configure
34
- $ make
35
92
  $ sudo make install
36
93
 
37
94
  To install the documentation:
@@ -48,15 +105,27 @@ configuration file directory (`asciidoc.vim` in the `syntax` directory
48
105
  and `asciidoc_filetype.vim` in the `ftdetect` directory).
49
106
 
50
107
 
108
+ [[X3]]
51
109
  Microsoft Windows installation
52
110
  ------------------------------
53
- To install the zip formatted distribution just unzip the contents to a
54
- new folder:
111
+ AsciiDoc is developed and tested on Linux but there seem to be quite a
112
+ few people using it on Windows. To install AsciiDoc on Windows unzip
113
+ the distribution Zip file contents:
55
114
 
56
115
  [subs="attributes"]
57
- $ mkdir asciidoc
58
- $ cd asciidoc
59
- $ unzip ../asciidoc-{revision}.zip
116
+ $ unzip asciidoc-{revnumber}.zip
117
+
118
+ This will create the folder +asciidoc-{revnumber}+ containing the
119
+ `asciidoc.py` and `a2x.py` executables along with configuration files
120
+ and documentation.
121
+
122
+ To generate DocBook based outputs (e.g. PDFs) you will also need a
123
+ working DocBook toolchain. Installing and configuring a DocBook
124
+ toolchain on Windows can be a challenge -- this blog post explains
125
+ http://blog.rainwebs.net/2010/02/25/how-to-create-handsome-pdf-documents-without-frustration/[How
126
+ to Create Handsome PDF Documents Without Frustration] using
127
+ http://www.cygwin.com/[Cygwin],
128
+ http://dblatex.sourceforge.net/[dblatex] and AsciiDoc.
60
129
 
61
130
 
62
131
  Testing your installation
@@ -65,7 +134,94 @@ Test out asciidoc by changing to the AsciiDoc application directory
65
134
  and convert the User Guide document (`./doc/asciidoc.txt`) to XHTML
66
135
  (`./doc/asciidoc.html`):
67
136
 
68
- $ asciidoc doc/asciidoc.txt
137
+ $ python asciidoc.py doc/asciidoc.txt
138
+
139
+ link:testasciidoc.html[testasciidoc] offers a more extensive set of
140
+ conformance tests, though you do need to create the test data before
141
+ running the tests (this in itself is a good post-install test):
142
+
143
+ $ python ./tests/testasciidoc.py update
144
+
145
+ Now you can run the tests by executing this command:
146
+
147
+ $ python ./tests/testasciidoc.py run
148
+
149
+ A full battery of tests can be run from the `main.aap` script in the
150
+ distribution root directory:
151
+
152
+ $ aap test
153
+
154
+
155
+ Building the distribution
156
+ -------------------------
157
+ The AsciiDoc distribution is built using http://www.a-a-p.org/[A-A-P]
158
+ (a software build system written by Bram Moolenaar). The AsciiDoc
159
+ A-A-P scripts are:
160
+
161
+ `./main.aap`:: Builds the distribution tarball and zip files,
162
+ documentation and example website.
163
+ `./doc/main.aap`:: Builds distribution documentation.
164
+ `./examples/website/main.aap`:: Builds AsciiDoc website.
165
+ `./common.aap`:: Included in all scripts.
166
+
167
+ To build the distribution tarball and zip files, documentation and
168
+ example website run A-A-P from the distribution root directory:
169
+
170
+ $ aap
171
+
172
+
173
+ [[X2]]
174
+ Prepackaged AsciiDoc installation
175
+ ---------------------------------
176
+ The following platform specific AsciiDoc packages are available:
177
+
178
+ *Debian GNU/Linux*::
179
+ If you use Debian or a Debian based distribution there's an
180
+ http://packages.debian.org/asciidoc[AsciiDoc Debian package]
181
+ available. Thanks to mailto:stone@debian.org[Fredrik Steen] who
182
+ built and maintains the Debian AsciiDoc package.
183
+
184
+ *Gentoo Linux*::
185
+ If you use Gentoo Linux there's a
186
+ http://packages.gentoo.org/package/app-text/asciidoc[Gentoo AsciiDoc
187
+ package] available. Thanks to mailto:brandon@ifup.org[Brandon
188
+ Philips] for writing the ebuild.
189
+
190
+ *Fedora Linux*::
191
+ With help from Terje Røsten, Chris Wright added asciidoc to Fedora
192
+ Extras which is available in the default installation. To install
193
+ asciidoc execute the following command:
194
+
195
+ $ yum install asciidoc
196
+
197
+ *Slackware Linux*::
198
+ John Calixto has created a Slackware package for AsciiDoc which can
199
+ be downloaded from http://linuxpackages.net/.
200
+
201
+ *Ark Linux*::
202
+ mailto:bero@arklinux.org[Bernhard Rosenkraenzer] added AsciiDoc to
203
+ Ark Linux -- the package is available from the Ark Linux repository
204
+ at http://arklinux.osuosl.org/dockyard-devel/, so Ark Linux users
205
+ should just run `apt-get install asciidoc`.
206
+
207
+ *T2 Linux*::
208
+ mailto:cw@ixplanet.de[Christian Wiese] added AsciiDoc to the
209
+ http://www.t2-project.org/[T2 Linux] repository at
210
+ http://svn.exactcode.de/t2/trunk/package/textproc/asciidoc/. To
211
+ build and install the package on a T2 system, run
212
+ `./scripts/Emerge-Pkg asciidoc` from within your T2 source directory
213
+ (default: `/usr/src/t2-src`).
214
+
215
+ *Red Hat Enterprise Linux, Fedora and CentOS packages*::
216
+ Dag Wieers has built AsciiDoc RPMs for a number of Red Hat based
217
+ distributions, they can be downloaded from
218
+ http://dag.wieers.com/rpm/packages/asciidoc/.
219
+
220
+ *CSW Package for Sun Solaris*::
221
+ Ben Walton has created a CSW package for AsciiDoc, you can find it
222
+ here: http://opencsw.org/packages/asciidoc.
223
+
224
+ See also link:userguide.html#X38[Packager Notes] in the 'AsciiDoc User
225
+ Guide'.
226
+
69
227
 
70
- NOTE: Windows users will need to execute the `asciidoc.py` script
71
- directly or create a suitable `asciidoc.bat` file.