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
data/LICENSE.txt ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2008 Hongli Lai
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in
11
+ all copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19
+ THE SOFTWARE.
20
+
data/README.markdown ADDED
@@ -0,0 +1,61 @@
1
+ # Mizuho documentation formatting tool
2
+
3
+ Mizuho is a documentation formatting tool, best suited for small to
4
+ medium-sized documentation. One writes documentation in plain text
5
+ files, which Mizuho then converts to nicely formatted HTML.
6
+
7
+ Mizuho supports input files in [Asciidoc](http://www.methods.co.nz/asciidoc/)
8
+ format. Asciidoc is a text formatting tool, used by e.g. Git for its
9
+ documentation. Thanks to Asciidoc, Mizuho supports a large number of formatting
10
+ options.
11
+
12
+ ### Under the hood
13
+
14
+ Mizuho is actually a wrapper around Asciidoc. Asciidoc itself can only
15
+ generate single-page XHTML output. Mizuho extends Asciidoc by providing
16
+ multi-page XHTML output support and support for multiple templates.
17
+
18
+ ## Features and highlights
19
+
20
+ * You can output the documentation in a single XHTML file, or in multiple
21
+ XHTML files (one per chapter).
22
+ * Output is fully customizable via ERB templates.
23
+ * Based on Asciidoc and supports all Asciidoc formatting commands.
24
+ * Comes bundled with Asciidoc so you don't have to install it yourself. Mizuho
25
+ Just Works(tm) out-of-the-box.
26
+
27
+ ## Requirements
28
+
29
+ * hpricot (`gem install hpricot`)
30
+ * Python (because Asciidoc is written in Python)
31
+ * [GNU Source-highlight](http://www.gnu.org/software/src-highlite/), if you
32
+ want syntax highlighting support
33
+
34
+ ## Installation
35
+
36
+ Run the following command as root:
37
+
38
+ gem install FooBarWidget-mizuho
39
+
40
+ ## Usage
41
+
42
+ First, read the Asciidoc manual to learn the input file format:
43
+ http://www.methods.co.nz/asciidoc/userguide.html
44
+
45
+ Next, write an input file and save it in a .txt file.
46
+
47
+ Finally, convert the .txt file to a single XHTML file with Mizuho, with the
48
+ default template:
49
+
50
+ mizuho input.txt
51
+
52
+ This will generate 'input.html'. Or, you can convert it to multiple XHTML files
53
+ that also have a different look:
54
+
55
+ mizuho input.txt --template manualsonrails --multi-page
56
+
57
+ Take a look at the 'templates' directory for available templates.
58
+
59
+ ## Credits
60
+
61
+ This tool is named after Kazami Mizuho from the 2003 anime 'Onegai Teacher'.
data/Rakefile ADDED
@@ -0,0 +1,41 @@
1
+ require 'rake/gempackagetask'
2
+
3
+ desc "Run unit tests"
4
+ task :test do
5
+ ruby "-S spec -f s -c test/*_spec.rb"
6
+ end
7
+
8
+ desc "Build a gem and install it"
9
+ task :install => :gem do
10
+ File.read("mizuho.gemspec") =~ /s\.version = \"(.*?)\"/
11
+ version = $1
12
+ ruby "-S gem install mizuho-#{version}.gem"
13
+ end
14
+
15
+ spec = Gem::Specification.new do |s|
16
+ s.name = "mizuho"
17
+ s.version = "0.9.6"
18
+ s.summary = "Mizuho documentation formatting tool"
19
+ s.email = "hongli@phusion.nl"
20
+ s.homepage = "http://github.com/FooBarWidget/mizuho/tree/master"
21
+ s.description = "A documentation formatting tool. Mizuho converts Asciidoc input files into nicely outputted HTML, possibly one file per chapter. Multiple templates are supported, so you can write your own."
22
+ s.has_rdoc = false
23
+ s.executables = ["mizuho", "mizuho-asciidoc"]
24
+ s.authors = ["Hongli Lai"]
25
+ s.add_dependency("hpricot")
26
+
27
+ s.files = FileList[
28
+ "README.markdown", "LICENSE.txt", "Rakefile",
29
+ "bin/*",
30
+ "lib/**/*",
31
+ "test/*",
32
+ "templates/*",
33
+ "asciidoc/**/*",
34
+ "source-highlight/**/*"
35
+ ]
36
+ end
37
+
38
+ Rake::GemPackageTask.new(spec) do |pkg|
39
+ pkg.need_zip = false
40
+ pkg.need_tar = false
41
+ end
data/asciidoc/BUGS ADDED
@@ -0,0 +1,39 @@
1
+ Bugs and Known Problems
2
+
3
+ version 8.3.3, 2 January 2009
4
+ __________________________________________________________________
5
+
6
+ 1. AsciiDoc
7
+
8
+ * A benign warning with will become a reserved keyword in Python 2.6
9
+ sometimes occurs when using Python 2.5 -- it's harmless and will
10
+ disappear with Python 3.
11
+ * The toc attribute will be ignored if it's set in a custom user or
12
+ document configuration file. This is because the default
13
+ configuration file containing the document [header] is sourced
14
+ before custom configuration files and the toc attribute is
15
+ processed using conditional inclusion macros.
16
+ * Reported line numbers in diagnostic messages are sometimes wrong.
17
+ * Embedding open brace characters { in argument values can cause
18
+ incorrect argument substitution.
19
+ * Attribute references in macro attribute lists can't be unescaped
20
+ (with the exception of attribute list entry {0}).
21
+ * Section numbering is incorrect when outputting HTML from a
22
+ multi-part book type document. This is not a biggy since multi-part
23
+ books are generally processed to DocBook.
24
+ * A row of apostrophes in an inline context throws AsciiDoc into an
25
+ endless loop.
26
+ * Multiple comma separated command names in the manpage NAME section
27
+ translate to a single DocBook refname instead of multiple refname
28
+ elements.
29
+ * Escaping quoted text and macros is sometimes tricky owing to some
30
+ macro and quoting ambiguities.
31
+ __________________________________________________________________
32
+
33
+ 2. dblatex
34
+
35
+ See ./dblatex/dblatex-readme.txt.
36
+ __________________________________________________________________
37
+
38
+ Version 8.3.3
39
+ Last updated 2009-01-02 12:45:15 NZDT
data/asciidoc/BUGS.txt ADDED
@@ -0,0 +1,32 @@
1
+ Bugs and Known Problems
2
+ =======================
3
+
4
+ AsciiDoc
5
+ --------
6
+ - A benign warning 'with will become a reserved keyword
7
+ in Python 2.6' sometimes occurs when using Python 2.5 -- it's
8
+ harmless and will disappear with Python 3.
9
+ - The `toc` attribute will be ignored if it's set in a custom user or
10
+ document configuration file. This is because the default
11
+ configuration file containing the document `[header]` is sourced
12
+ before custom configuration files and the `toc` attribute is
13
+ processed using conditional inclusion macros.
14
+ - Reported line numbers in diagnostic messages are sometimes wrong.
15
+ - Embedding open brace characters `{` in argument values can cause
16
+ incorrect argument substitution.
17
+ - Attribute references in macro attribute lists can't be unescaped
18
+ (with the exception of attribute list entry `\{0}`).
19
+ - Section numbering is incorrect when outputting HTML from a
20
+ multi-part book type document. This is not a biggy since multi-part
21
+ books are generally processed to DocBook.
22
+ - A row of apostrophes in an inline context throws AsciiDoc into an
23
+ endless loop.
24
+ - Multiple comma separated command names in the manpage NAME section
25
+ translate to a single DocBook `refname` instead of multiple
26
+ `refname` elements.
27
+ - Escaping quoted text and macros is sometimes tricky owing to some
28
+ macro and quoting ambiguities.
29
+
30
+ dblatex
31
+ -------
32
+ See `./dblatex/dblatex-readme.txt`.
@@ -0,0 +1,1796 @@
1
+ AsciiDoc ChangeLog
2
+
3
+ version 8.3.3, 2 January 2009
4
+ __________________________________________________________________
5
+
6
+ 1. Version 8.3.3 (2009-01-02)
7
+
8
+ This release supercedes 8.3.2.
9
+
10
+ Bug fixes
11
+ * The broken and confusing numeration and numeration2 numbered list
12
+ attributes have been dropped, use the style attribute instead.
13
+ __________________________________________________________________
14
+
15
+ 2. Version 8.3.2 (2009-01-01)
16
+
17
+ Additions and changes
18
+ * Added Gouichi Iisaka's Graphviz filter to distribution.
19
+ * The SidebarBlock element can now be rendered with an abstract
20
+ style.
21
+ * Reorganized filters into a separate subdirectory for each filter.
22
+ * Updated Makefile.in and MANIFEST files to reflect new filters
23
+ organization.
24
+ * Added listing style to LiteralBlock element so listings with nested
25
+ listing blocks can be rendered as a listing block.
26
+ * Changed example code filter to use preferred ListingBlock syntax
27
+ (the old ~ delimited filter syntax is no longer used).
28
+ * Implemented enumeration and enumeration2 numbered list attributes
29
+ for specifying the list numbering style (arabic, loweralpha,
30
+ upperalpha, lowerroman and upperroman).
31
+ * AsciiDoc now recognizes upperalpha, lowerroman and upperroman
32
+ numbers in listdef-numbered2 numbered lists and sets the number
33
+ style based on the style of the first numbered list item
34
+ (alternative to setting enumeration2 attribute).
35
+ * Updated formatlistpat definition in .vimrc example in User Guide.
36
+ * You can now backslash escape system block macros.
37
+ * Added Pychart FAQ.
38
+ * Drop paragraph text and list text, index and label match groups
39
+ from attributes -- they are included in the element's text and we
40
+ don't want them processed a second time as attributes.
41
+ * Changed comment line block macro to a passthrough block macro to
42
+ ensure no substitutions.
43
+ * A subslist no longer has to be appended to a PassthroughBlock macro
44
+ definition, if omitted no substitutions are performed.
45
+ * Code tidy up: replaced deprecated <> operator with !=.
46
+ * Removed unused linuxdoc code.
47
+ * Code tidy ups: dropped old types module reference; replaced
48
+ has_key() with preferred in operator.
49
+
50
+ Bug fixes
51
+ * Old syntax source highlight filter regression: special characters
52
+ where not escaped in DocBook outputs.
53
+ __________________________________________________________________
54
+
55
+ 3. Version 8.3.1 (2008-12-14)
56
+
57
+ Additions and changes
58
+ * Replaced the install.sh script with Ben Walton's updated autoconf
59
+ scripts -- see [1]INSTALL for details.
60
+ * Added a generalized AttributeEntry syntax to allow arbitrary
61
+ configuration file entries to be set from within an AsciiDoc
62
+ document (suggested by Henrik Maier).
63
+ * Listing delimited blocks in DocBook outputs now support IDs; IDs of
64
+ titled Listing and Literal delimited blocks have been moved to the
65
+ enclosing DocBook example tag (thanks to Vijay Kumar for this
66
+ patch).
67
+ * Replaced vertical typewriter apostrophe with punctuation apostrophe
68
+ (thanks to Noah Slater).
69
+
70
+ Bug fixes
71
+ * Regression: Excluding double-quotes from unquoted attribute values
72
+ resulted in backward incompatibility, double-quotes in unquoted
73
+ attribute values has been reinstated.
74
+ * Regression: Text like &...; was sometimes mistaken for an entity
75
+ reference -- tightened up entity reference matching.
76
+ __________________________________________________________________
77
+
78
+ 4. Version 8.3.0 (2008-11-29)
79
+
80
+ Additions and changes
81
+ * [2]AsciiDoc new tables is a complete redesign of the tables syntax
82
+ and generation. The new syntax and features are a huge improvement
83
+ over the old tables. The old tables syntax has been deprecated but
84
+ is currently still processed.
85
+ * [3]Lists can now be styled like other block elements. This allows a
86
+ single list syntax for glossary, qanda (Question and Answer) and
87
+ bibliography lists instead of having to remember a different syntax
88
+ for each type.
89
+ * Inline passthroughs macros have been improved and block passthrough
90
+ macros added. Attribute substitution can be optionally specified
91
+ when the macro is called.
92
+ * The passthrough block has a fully transparent passthrough delimited
93
+ block block style called pass.
94
+ * The asciimath and latexmath [4]passthrough macros along with
95
+ asciimath and latexmath [5]passthrough blocks provide a (backend
96
+ dependent) mechanism for rendering mathematical formulas. There are
97
+ [6]LaTeX Math, [7]AsciiMathML and [8]LaTeXMathML examples on the
98
+ AsciiDoc website.
99
+ * Reimplemented and cleaned up filter processing based on a patch
100
+ submitted by Kelly Anderson. Uses the newer subprocess module
101
+ instead of the deprecated popen2 module. Now works in Win32 command
102
+ shell.
103
+ * Addition FAQs, more documentation updates.
104
+ * Arbitrary HTML/XML entities can be entered in AsciiDoc source.
105
+ * Did away with the need for the shaded-literallayout.patch (thanks
106
+ to Henrik Maier for this patch).
107
+ * Implemented page break block macro.
108
+ * Added line breaks and ruler processing instructions to DocBook
109
+ outputs (thanks to Henrik Maier for this patch).
110
+ * Added deg (degree) and wj (word joiner) entity attributes (thanks
111
+ to Henrik Maier).
112
+ * Tweaked DocBook indexterm2 macro to avoid white space preceding the
113
+ term when used in table cells (thanks to Henrik Maier for this
114
+ patch).
115
+ * Title elements now process the options attribute like other block
116
+ elements.
117
+ * Added `single quoted' element.
118
+ * Spaces on both sides of a -- em-dash are translated to thin space
119
+ characters.
120
+ * Improved detection and reporting of malformed attribute lists.
121
+ * The list compact style is now a list option.
122
+ * Added strong labeled list option which makes the labels bold (HTML
123
+ outputs only).
124
+ * Dropped unsupported linuxdoc backend.
125
+ * Dropped deprecated xhtml-deprecated (version 6) backend.
126
+ * Added breakable and unbreakable attribute options to tables to
127
+ control table breaking across page boundaries (DocBook XSL/FO
128
+ outputs). By and in collaboration with Henrik Maier.
129
+ * Added pgwide attribute option to tables to table, block image,
130
+ horizontal labeled lists. Specifies that the element should be
131
+ rendered across the full text width of the page irrespective of the
132
+ current indentation (DocBook XSL/FO outputs). Thanks to Henrik
133
+ Maier for this patch.
134
+ * Vim syntax highlighter: spaces before/after bullets no longer
135
+ highlighted (which is ugly if using a theme that highlights with
136
+ underlines). Thanks to Donald Chai for this patch.
137
+ * Added a2x(1) --fop option.
138
+ * Added a2x(1) --no-xmllint option.
139
+ * Highlighted labelled list terms with the navy color in XHTML
140
+ outputs.
141
+ * Use w3m(1) as default a2x(1) text format generator (fallback to
142
+ lynx(1)).
143
+ * Changed callout formats in html4 and xhtml11 outputs to angle
144
+ brackets to match source highlighter rendering.
145
+ * Macros now inject user defined <optionname>-option attributes into
146
+ markup.
147
+ * Added IRC URLs to AsciiDoc inline macros.
148
+ * Added depth attribute to include::[] system macro.
149
+ * Added footnoteref inline macro.
150
+ * Added stylesheet XHTML attribute to specify additional custom CSS
151
+ stylesheet.
152
+ * If a paragraph style is specified it will be added to the XHTML
153
+ class attribute and DocBook role attribute.
154
+ * Replacements can be set in a document using the reserved
155
+ AttributeEntry name replacement.
156
+ * The prefix for auto-generated section name IDs can be set with the
157
+ idprefix attribute.
158
+
159
+ Bug fixes
160
+ * Escaped quote skipped over leading and trailing quote instead of
161
+ just the leading quote.
162
+ * Fixed bug that was causing false negative safe mode warnings (patch
163
+ submitted by Julien Palmas).
164
+ * Placed priority of AttributeEntry, AttributeList and BlockTitle
165
+ above Title. This ensures an AttributeEntry, AttributeList or
166
+ BlockTitle followed by a same length leading ListingBlock delimiter
167
+ is not mistaken for a two-line title.
168
+ * Vim syntax highlighter: fixed multi-line quoted text.
169
+ * Contstrained quote termination after non-space character enforced.
170
+ * Vim syntax highlighter: unterminated quoted text is no longer
171
+ highlighted.
172
+ * Vim syntax highlighter: passthroughs now exactly match AsciiDoc
173
+ semantics.
174
+ * Vim syntax highlighter: escaped quoted text, attribute references
175
+ and inline macros are not highlighted.
176
+ * Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks
177
+ to Scott Wall); non-greedy $$...$$.
178
+ * Vim syntax highlighter: Comment lines mistaken for vertical list
179
+ labels (thanks to Scott Wall).
180
+ * Vim syntax highlighter: Single unmatched $$ mistakenly highlighted
181
+ remaining text (patch contributed by Scott Wall).
182
+ * Callouts now work in source highlighted listing generated by
183
+ dblatex.
184
+ * Fixed exception that occured if undefined attribute was present in
185
+ filter command.
186
+ * AttributeList block can now follow a paragraph without intervening
187
+ blank line.
188
+ * The include macro tabsize attribute is no longer propagated to
189
+ nested includes.
190
+
191
+ Omissions
192
+ The following features were implemented but then but removed from this
193
+ release:
194
+ * pi, cdata and comment passthrough macros and passthrough block
195
+ styles (creeping featurism, use pass macros instead).
196
+ * Generic tag inline macro (creeping featurism, use pass macros
197
+ instead).
198
+
199
+ 4.1. Compatibility issues
200
+
201
+ Version 8.3.0 has a number of backward incompatibilities with respect
202
+ to the previous 8.2.7 release:
203
+ * The old table syntax is still processed but a DEPRECATED warning is
204
+ issued.
205
+ * Entity references have to be escaped with a backslash.
206
+ * You have to explicitly precede horizontal style labeled lists with
207
+ the [horizontal] style attribute -- by default all labeled lists
208
+ are rendered vertically.
209
+ * The list compact style has been dropped and is now a list option
210
+ (use options="compact" in attribute lists).
211
+ * AsciiDoc version 6 sytnax no longer supported.
212
+ * Linuxdoc been removed from the distribution.
213
+ * The unsupported experimental latex backend has not been tested on
214
+ this release.
215
+ * The introduction of single-quote quoting requires that double-quote
216
+ quoting is escaped with two backslashes.
217
+ __________________________________________________________________
218
+
219
+ 5. Version 8.2.7 (2008-07-04)
220
+
221
+ Additions and changes
222
+ * Added dvi, ps and tex output format options to a2x(1).
223
+ * Added --dblatex option to a2x(1) so dblatex(1) can be used to
224
+ generate PDFs.
225
+ * Added custom dblatex(1) configuration files (in distribution
226
+ ./dblatex directory) that are used by a2x(1).
227
+ * dblatex(1) is now used to generate the distributed PDF version of
228
+ the AsciiDoc User Guide.
229
+ * If you don't need a customized the link caption you can enter the
230
+ http, https, ftp, file URLs and email addresses without any special
231
+ macro syntax -- you get the links by just cutting and pasting URLs
232
+ and emails addresses. This also makes it easier to open links
233
+ directly form AsciiDoc source ( most editors allow you to open URLs
234
+ directly). The Vim syntax highlighter has been updated to reflect
235
+ these changes.
236
+ * Highlighted source code paragraphs have been implemented -- it's a
237
+ much more convenient way to enter short code examples (see [9]the
238
+ online docs).
239
+ * The source highlighter and music filter syntax has changed -- they
240
+ now used the ListingBlock syntax customized with source and music
241
+ style attribute values. This follows the Paragraph styling
242
+ convention introduced by the source paragraph (previous item) and
243
+ is easier to read. The old syntax still works but has been
244
+ deprecated.
245
+ * QuoteBlocks now have a verse style -- you no longer have to nest a
246
+ verse LiteralBlock inside a QuoteBlock for verses. The verse style
247
+ on the LiteralBlock has been deprecated (still works though) and
248
+ the style attribute is positional attribute 1, pushing attribution
249
+ and citetitle attributes to the right (you'll need to insert a
250
+ quote attribute into your existing QuoteBlocks).
251
+ * It is no up to the DocBook processor to highlight source code
252
+ syntax in <programlisting> elements rather than GNU Highlighter --
253
+ this is the correct way to handle it, plus dblatex(1) makes a much
254
+ better job.
255
+ * scaledwidth and align attributes have been added to the image
256
+ macro. They apply to DocBook outputs (specifically for PDF
257
+ documents). scaledwidth sets the image size as a percent of the
258
+ available page width; align applies left, center or right
259
+ horizontal image justification.
260
+ * Added a2x(1) --fop-opts=FOP_OPTS option (patch submitted by Miklos
261
+ Vajna).
262
+ * Added a2x(1) --dblatex-opts=DBLATEX_OPTS option.
263
+ * Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing
264
+ fo.xsl problem and allows PDF's to be generated with FOP 0.95
265
+ (previously had to use FOP 0.20.5).
266
+ * The User Guide has been updated and outdated FOP configuration and
267
+ installation sections removed.
268
+
269
+ Bug fixes
270
+ * Fixed stylesheets/xhtml11-manpage.css not being included when
271
+ linkcss attribute was used.
272
+ * Configuration file *-style attributes are now dumped correctly.
273
+ * Fixed FAILED: malformed section entry LaTeX backend error.
274
+
275
+ See the also the [10]AsciiDoc repository changelog.
276
+ __________________________________________________________________
277
+
278
+ 6. Version 8.2.6 (2008-04-29)
279
+
280
+ Additions and changes
281
+ * Enhancements to the Vim AsciiDoc syntax highlighter, for example,
282
+ quoted text is now highlighted in titles and macro captions.
283
+ * If you define the data-uri intrinsic attribute images referenced by
284
+ image macros will be embedded in XHTML using the [11]data: URI
285
+ scheme. NOTE: Microsoft browser support for the data: URI scheme is
286
+ currently limited to MSIE 8 beta 1.
287
+ * Added toc-title attribute to allow custom table of contents titles.
288
+ * Added references to Alex Efros's AsciiDoc Cheatsheet to AsciiDoc
289
+ website.
290
+ * asciidoc(1) and a2x(1) man pages formatted to conform to
291
+ man-pages(7) recommendations.
292
+ * Old code-filter syntax (pre-8.1.0) is no longer recognized so that
293
+ malformed two-line level 2 titles are no longer confused with
294
+ code-filter block delimiters.
295
+ * Added -> <- => <= arrow replacements from the Arrows block of
296
+ Unicode.
297
+ * Added DocBook refentry lang attribute -- patch contributed by
298
+ VMiklos.
299
+ * AttributeEntry names can now be numeric ("named macro targets").
300
+ * Hide Table of Contents title if Table of Contents empty -- patch
301
+ contributed by Alex Efros.
302
+ * Various XHTML CSS tweaks.
303
+ * Code cleanup:
304
+ + Replaced realpath() with Python 2.2 os.path.realpath() library
305
+ function.
306
+ + Replaced old string library functions with string methods.
307
+ + Use file generators instead of readlines().
308
+ + Renamed entities that shadowed builtins.
309
+ + Standardized string quoting.
310
+ + Dropped readlines() function.
311
+
312
+ Bug fixes
313
+ * Fixed broken CSS for decimal ordered lists nested in alpha ordered
314
+ list, thanks to Alex Efros.
315
+ * A missing closing block delimiter now reports the opening delimiter
316
+ line number instead of the end of file line number.
317
+ * Fixed an error generated by the asciidoc -e option when there are
318
+ no block definitions -- patch contributed by Alejandro Mery.
319
+ * Handle both \r\n (as well as \n) line separators that may be
320
+ returned by {sys} attribute evaluation.
321
+ * Numbered attribute names no longer interfere with positional
322
+ attribute list values.
323
+ __________________________________________________________________
324
+
325
+ 7. Version 8.2.5 (2007-11-18)
326
+
327
+ Bug fixes
328
+ * Fixed exception thrown by illegal command-line arguments.
329
+ * Rolled back the with warning bug fix introduced in 8.2.4 -- it was
330
+ incompatible with Python <2.5.
331
+ __________________________________________________________________
332
+
333
+ 8. Version 8.2.4 (2007-11-10)
334
+
335
+ Additions and changes
336
+ * You can now use the lang attribute to set the DocBook language
337
+ attribute.
338
+ * Attribute values can now contain attribute references.
339
+ * If the lang attribute is defined then configuration files named
340
+ like lang-<lang>.conf will be loaded automatically.
341
+ * The help file name help-<lang>.conf is based on the AsciiDoc lang
342
+ attribute, defaults to help.conf (English).
343
+ * Admonition, figure and table captions have been factored into a
344
+ predefined set of caption_* attributes. They only apply to directly
345
+ generated (X)HTML outputs (DocBook stylesheets generate their own
346
+ language specific captions based on the lang attribute).
347
+ * Dropped platform dependent doc/asciidoc.chm file from distribution
348
+ documentation formats.
349
+
350
+ Bug fixes
351
+ * The spurious warning with will become a reserved keyword in Python
352
+ 2.6 has been suppressed.
353
+ __________________________________________________________________
354
+
355
+ 9. Version 8.2.3 (2007-09-12)
356
+
357
+ Additions and changes
358
+ * Added VMiklos's permalink patch for auto-generated section IDs
359
+ (enabled by default by the sectids attribute).
360
+ * Added [12]FAQ to website.
361
+ * Changed format of {localdate} attribute to ISO 8601 (%Y-%m-%d).
362
+ * Added abc2ly --beams=None option to make music2png.py conform to
363
+ ABC's notion of beams.
364
+ * XHTML level 2 section headings are now styled with an underlining
365
+ border.
366
+ * XHTML links to AsciiDoc title elements are now implemented with
367
+ title ID attributes (previously separate <a> element targets were
368
+ generated.
369
+ * Multi-word first, middle and last names can be entered in the
370
+ header author line using the underscore as a word separator.
371
+ * The nested inline macros restriction has now been lifted, for
372
+ example you can now include links and inline images inside
373
+ footnotes.
374
+ * Help topic names can be shortened (so long as they are not
375
+ ambiguous). For example asciidoc -hm will print the AsciiDoc man
376
+ page.
377
+ * Added {two_colons} and {two_semicolons} attributes for escaping
378
+ labeled list ambiguity.
379
+ * If quirks mode is disabled the XHTML Mime Type is set to the
380
+ recommended application/xhtml+xml (rather than text/html).
381
+
382
+ Bug fixes
383
+ * Author information is now correctly set when using attribute
384
+ entries in the header instead of an author line (previously the
385
+ author attribute was not being calculated correctly and there were
386
+ attribute substitution problems).
387
+ __________________________________________________________________
388
+
389
+ 10. Version 8.2.2 (2007-07-22)
390
+
391
+ Additions and changes
392
+ * [13]LaTeXMathML capability has been added for users who are more
393
+ familiar with or prefer LaTeX math formulas to the [14]ASCIIMathML
394
+ notation (thanks to Arthur Sakellariou for the patch).
395
+ * The source highlight and code filters now process embedded
396
+ callouts.
397
+ * Added an --attribute=ATTRIBUTE option to a2x(1) for passing
398
+ attribute values to asciidoc(1) (a shortcut for --asciidoc-opts="-a
399
+ ATTRIBUTE").
400
+ * Image block and inline macros prepend optional {imagesdir}
401
+ attribute to image link targets.
402
+
403
+ Bug fixes
404
+ * Fixed an assertion error that occurred when a configuration file
405
+ containing an \include::[] macro was loaded using the --conf-file
406
+ option and the configuration file name did not include an explicit
407
+ directory path -- patch submitted by Dmitry Potapov.
408
+ * Asciidoc titles are only converted to lower case if all characters
409
+ are upper case otherwise case is left unchanged -- patch submitted
410
+ by Dmitry Potapov.
411
+ * Added a missing check that input is not stdin before loading
412
+ configuration files from the document directory -- patch submitted
413
+ by Dmitry Potapov.
414
+ * Attribute list items must evaluate to strings, numbers or None
415
+ (previously it was possible to evaluate to other object types which
416
+ resulted in surprising attribute values).
417
+ * If an AsciiDoc document has no title an empty XHTML 1.1 title
418
+ element is created -- previously the title element was dropped
419
+ which resulted in invalid XHTML 1.1.
420
+ * The Vim syntax file no longer highlights escaped callouts.
421
+ * The Vim syntax highlighter now correctly highlights Double-dollar
422
+ passthroughs when they enclose dollar delimited ASCIIMathML and
423
+ LaTeXMathML formulas.
424
+ __________________________________________________________________
425
+
426
+ 11. Version 8.2.1 (2007-04-06)
427
+
428
+ Additions and changes
429
+ * A number of improvements have been made to the Vim syntax
430
+ highlighter, for example the word C++ is no longer mistaken for the
431
+ start of an unconstrained monospace quote.
432
+ * Labeled list definitions have been tightened -- a list label can no
433
+ longer containing trailing spaces. The following example is no
434
+ longer recognized as a valid list label:
435
+ Lorum ipsum ::
436
+ This change implements the originally intended behavior (as per the
437
+ AsciiDoc documentation and examples) so there should be very few
438
+ compatibility issues.
439
+ __________________________________________________________________
440
+
441
+ 12. Version 8.2.0 (2007-04-04)
442
+
443
+ Additions and changes
444
+ * A Vim syntax file is now included in the AsciiDoc distribution
445
+ (inspired by Felix Obenhuber's asciidoc.vim script). You can find
446
+ it (along with a Vim filetype detection script in the distribution
447
+ ./vim/ directory (the scripts are installed automatically by the
448
+ AsciiDoc installer ./install.sh). See Appendix J of the AsciiDoc
449
+ User Guide for details.
450
+ * Added toclevel attribute (1..4) which sets the number of title
451
+ levels reported in the table of contents. Defaults to 2 and must be
452
+ used with the toc attribute. Example usage:
453
+ $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt
454
+ * Added a listindex attribute which is the current list item index
455
+ (1..). If this attribute appears outside a list its value is the
456
+ number of items in the most recently closed list.
457
+ * The single line titles syntax now accepts trailing suffixes -- this
458
+ syntax matches the title line syntax of a number of popular Wiki
459
+ markups.
460
+ * If a QuoteBlock has no attribution or citetitle then the DocBook
461
+ <attribution> element is not generated (previously generated empty
462
+ <attribution> element).
463
+ * If the text of a labeled list item is blank then no texttag is
464
+ written.
465
+ * An end of line backslash performs line continuation for horizontal
466
+ labeled list items.
467
+ * The Revision line now accommodates Subversion $Id markers (in
468
+ addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for
469
+ this patch.
470
+ * Implemented a2x(1) option --skip-asciidoc which allows a2x(1) to
471
+ convert DocBook XML files not derived from AsciiDoc sources.
472
+ * If a2x(1) --doctype option is not specified it defaults to manpage
473
+ if --format=manpage else defaults to article (previously --doctype
474
+ always defaulted to article).
475
+ * Added an External Resources section to the [15]AsciiDoc home page.
476
+ __________________________________________________________________
477
+
478
+ 13. Version 8.1.0 (2006-10-22)
479
+
480
+ Additions and changes
481
+ * AsciiDoc generated XHTML documents now display a table of contents
482
+ if the toc attribute is defined (JavaScript needs to be enabled for
483
+ this to work). Thanks to Troy Hanson who contributed this feature
484
+ based on a JavaScript by Mihai Bazon. I've simplified things
485
+ somewhat to match Docbook XSL Stylesheets style, see Troy's [16]tpl
486
+ User Guide for a fancier layout. Use the -a toc -a numbered
487
+ command-line options to produce a number table of contents.
488
+ * A [17]music filter is included in the distribution ./filters/
489
+ directory. It translates music in [18]LilyPond or [19]ABC notation
490
+ to standard classical notation in the form of a trimmed PNG image
491
+ which is inserted into the AsciiDoc output document.
492
+ * Incorporated Paul Melis's Win32 filter patch. This workaround
493
+ allows AsciiDoc to run filters under Windows.
494
+ * Added uninstall.sh script.
495
+ * Rather than proliferate a confusing number of filter block
496
+ delimiters the following convention has been adopted: delimiters
497
+ belonging to DelimitedBlock filters distributed with AsciiDoc will
498
+ consist of a word (normally a noun identifying the block content)
499
+ followed by four or more tilde characters. This has necessitated
500
+ changing existing filter delimiters (the old delimiters still work
501
+ but may be deprecated in future versions):
502
+ + The example code filter block delimiter is now the word code
503
+ followed by four or more tilde characters.
504
+ + The source highlight filter block delimiter is now the word
505
+ source followed by four or more tilde characters.
506
+ * Conditionally redefined subscript and superscripting so they use
507
+ the old replacements mechanism when asciidoc7compatible is defined
508
+ rather than the asciidoc 8 default unconstrained quoting (patch for
509
+ affected files attached).
510
+ * Moved the source highlight filter from ./examples/ to ./filter/.
511
+ * Added {verbose} intrinsic attribute (useful for passing verbose
512
+ flag to filters).
513
+ * Added {outdir} intrinsic attribute.
514
+ * Renamed {docdir} intrinsic attribute to unambiguous`{indir}
515
+ ({docdir}` still works but may be removed in future release).
516
+ * If asciidoc(1) outputs to stdout then intrinsic attribute {docname}
517
+ is extracted from the input file name.
518
+ __________________________________________________________________
519
+
520
+ 14. Version 8.0.0 (2006-08-27)
521
+
522
+ This is a major release because changes to quoting and index entry
523
+ handling may break existing documents (see Additions and changes below
524
+ and Appendix A: Migration Notes in the AsciiDoc User Guide).
525
+
526
+ Please report any problems you encounter.
527
+
528
+ [20]Stuart Rackham
529
+
530
+ Additions and changes
531
+ * Quoting can can occur within words (based on patch submitted by
532
+ Benjamin Klum). See the Unconstrained Quotes sub-section in the
533
+ User Guide.
534
+ * The underline and plus characters can be used as alternatives to
535
+ the existing apostrophe and backtick quote characters. They are
536
+ arguably better choices than the apostrophe and backtick as they
537
+ are not confused with punctuation.
538
+ * The syntax for index entry macros have have been deprecated from
539
+ +...+ and +...+ to ((...)) and (((...))) respectively. Rationale:
540
+ + Bracketing is consistent other with [[...]] and <<...>>
541
+ reference macros.
542
+ + To easily confused with triple plus passthroughs.
543
+ + To make way for the new monospace quoting.
544
+ * Superscripts and subscripts are implemented as constrained quotes
545
+ so they can now be escaped with a leading backslash and prefixed
546
+ with with an attribute list.
547
+ * An experimental LaTeX backend has been written by Benjamin Klum (a
548
+ number additions in this release are to accommodate the LaTeX
549
+ backend).
550
+ * include macro file names now expand environment variables and tilde
551
+ expansions.
552
+ * A configuration file [quotes] entry can be undefined by setting to
553
+ a blank value.
554
+ * Added callto inline macro for Skype callto links.
555
+ * Added colnumber attribute for table data markup.
556
+ * A leading comment block or comment lines are now skipped
557
+ (previously a document had to start with either attribute entries
558
+ or a document Title).
559
+ * Experimental rows attribute (number of source lines in table)
560
+ available in table markup templates (used by experimental LaTeX
561
+ backend).
562
+ * Included install shell script written by [21]Jacob Mandelson for
563
+ installing the tarball distribution.
564
+ * Added INSTALL documentation file.
565
+ * Added replacements2 substitution options -- a second replacements
566
+ section.
567
+ * Added the ability to redefine normal and verbatim substitutions
568
+ with subsnormal and subsverbatim entries in configuration file
569
+ [miscellaneous] section.
570
+ * By default AttributeEntry values are substituted for
571
+ specialcharacters and attributes, if you want a different
572
+ AttributeEntry substitution set the attributeentry-subs attribute.
573
+ * The name in name=value configuration file entries can now end with
574
+ a backslash, just escape the trailing backslash with a backslash.
575
+ For example:
576
+ abc\\=xyz
577
+ Results in name=abc\ and value=xyz -- previously this would have
578
+ escaped the = character.
579
+ * A blank configuration file section deletes any preceding section
580
+ with the same name (applies to non-markup template sections).
581
+ * A command-line attribute value with a @ suffix does not override
582
+ existing document and configuration file attributes (normally
583
+ command-line attributes have precedence over document and
584
+ configuration file attributes).
585
+ * localtime attribute is now encoded from the native system encoding
586
+ to the output encoding. Patch submitted by [22]FKtPp -- here's his
587
+ description of the problem:
588
+ "I am a Chinese user of AsciiDoc and I find that when I use UTF-8
589
+ (the default encoding) to write asciidoc documents in Windows
590
+ platform the resulting html footer line will get screwed. It was
591
+ caused by a localized tzname that was always encoded in the windows
592
+ native encoding, which in my case is cp936."
593
+ * a2x(1) can generate Open Document Text files using [23]docbook2odf.
594
+ Currently docbook2odf(1) only processes a subset of DocBook,
595
+ unimplemented elements are skipped.
596
+ * The a2x(1) format option defaults to xhtml (previously a format had
597
+ to be specified explicitly).
598
+ * The -d, --doctype=DOCTYPE option has been added to a2x(1) which is
599
+ a shortcut for --asciidoc-options="--doctype=DOCTYPE".
600
+ * Replaced a2x(1) --no-icons and --no-copy options with their negated
601
+ equivalents: --icons and --copy respectively. The default behavior
602
+ has also changed: copying and use of icons is disabled by default.
603
+ Rationale:
604
+ + To make the default behavior more consistent since use of
605
+ icons and CSS stylesheets does not apply to all formats.
606
+ + To make the default behavior less surprising (the creation of
607
+ icon and stylesheet output files must now be explicit).
608
+ * a2x(1) has been bumped from version 0.1.1 to version 1.0.0.
609
+
610
+ Bug fixes
611
+ * Removed duplicate ./doc/a2x.1.txt from distribution tarball.
612
+ * Documentation errata.
613
+ * Attribute replacement is no longer performed twice in Titles and
614
+ AttributeEntrys.
615
+ * a2x(1) skipped asciidoc(1) execution when rerun with different
616
+ --asciidoc-options options, it now always executes asciidoc(1). The
617
+ problem was that previously asciidoc(1) was executed only if the
618
+ output file was missing or older than the source file.
619
+ __________________________________________________________________
620
+
621
+ 15. Version 7.1.2 (2006-03-07)
622
+
623
+ Additions and changes
624
+ * Support for [24]ASCIIMathML has been added. See Appendix I:
625
+ ASCIIMathML Support in the User Guide and the examples at
626
+ [25]http://www.methods.co.nz/asciidoc/asciimath.html.
627
+ * You can now prefix quoted text with inline attributes lists. You
628
+ can use this to set font size and color (XHTML and HTML outputs).
629
+ * Added #...\# quoting -- it does nothing -- it's purpose is to allow
630
+ inline attributes to be applied to normal text.
631
+ * An [26]inline passthrough mechanism has been implemented.
632
+ * Configuration file comment lines can be escaped with a backslash --
633
+ this is to allows the inclusion of configuration lines that start
634
+ with a hash character.
635
+ * The scriptsdir attribute can be used to specify the name of the
636
+ directory containing linked JavaScripts (see the [27]User Guide for
637
+ details.
638
+ * The BackendBlock has been renamed PassthroughBlock for consistency
639
+ with the new inline passthrough naming.
640
+ * a2x(1) now works with the older bash(1) version 2.05b. Patch
641
+ submitted by [28]Francis Daly.
642
+ * Content included by the \include1::[] system macro is no longer
643
+ subject to attribute substitution so that ambiguities no longer
644
+ arise when used to include CSS or JavaScript files.
645
+ __________________________________________________________________
646
+
647
+ 16. Version 7.1.1 (2006-02-24)
648
+
649
+ Additions and changes
650
+ * The caption attribute can be used to customize admonition captions
651
+ as well as image, table and example block element title prefixes
652
+ (xhtml11 and html4 backends).
653
+ * You can now override the default icon image using the icon
654
+ attribute to specify the path of the linked image (xhtml11 and
655
+ html4 backends only).
656
+ * The deprecated imagesdir attribute is no longer recognized (use
657
+ iconsdir instead).
658
+ * Added Appendix H: Using AsciiDoc with non-English Languages to the
659
+ AsciiDoc User Guide.
660
+ * Added Admonition Icons and Captions subsection to the User Guide
661
+ explaining how to customize Admonition elements.
662
+
663
+ Bug fixes
664
+ * a2x(1) failed when configuration files were installed in the global
665
+ /etc/asciidoc/ directory -- it was only searching the directory
666
+ containing the asciidoc executable (thanks to Christian Wiese for
667
+ finding and submitting a patch this bug).
668
+ * The html4 backend admonition caption now correctly displays the
669
+ admonition caption attribute (previously displayed the style
670
+ attribute).
671
+ __________________________________________________________________
672
+
673
+ 17. Version 7.1.0 (2006-01-13)
674
+
675
+ Additions and changes
676
+ * a2x(1) toolchain wrapper utility. This overcomes the biggest hurdle
677
+ for new users which seems to be assembling and using a working
678
+ DocBook XML toolchain. With a2x(1) you can generate XHTML (chunked
679
+ and unchunked), PDF, man page, HTML Help and text file outputs from
680
+ an AsciiDoc input file with a single command. All you need to
681
+ install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL
682
+ Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you
683
+ want text).
684
+ * Block titles can now start with any non-space character (previously
685
+ where not allowed to start with .~-_ characters).
686
+ * ./stylesheets/docbook.css renamed to ./stylesheets/docbook-xsl.css
687
+ to clarify its function.
688
+ * Renamed ./docbook-xsl/manpages.xsl to ./docbook-xsl/manpage.xsl for
689
+ consistency.
690
+ * Admonition and navigation icons moved to ./images/icons/ to clarify
691
+ usage and conform with a2x(1) usage.
692
+ * Renamed xhtml11 intrinsic attribute imagesdir to iconsdir to keep
693
+ vocab consistent and changed default value to ./images/icons
694
+ (previously ./images). imagesdir attribute still accepted but
695
+ deprecated.
696
+ * Unused image files have been weeded out of the distribution.
697
+ * Packager notes (appendix B) have been updated to reflect the needs
698
+ of a2x(1).
699
+
700
+ Important: The renaming of the xhtml11 backend imagesdir intrinsic
701
+ attribute and it's new default value introduces a backward
702
+ compatibility issue: if you use the icons attribute you will need to
703
+ either move your icons to the new default ./images/icons location or
704
+ include an --attribute iconsdir="your_icons_path" option in your
705
+ asciidoc commands.
706
+
707
+ Bug fixes
708
+ * Backslash line continuation is now observed in verbatim paragraphs.
709
+ * Fixed errors generated by example
710
+ ./examples/website/build-website.sh script.
711
+ __________________________________________________________________
712
+
713
+ 18. Version 7.0.4 (2005-12-08)
714
+
715
+ Additions and changes
716
+ * Added ternary conditional attributes
717
+ {<name>@<regexp>:<value1>[:<value2>]} and
718
+ {<name>$<regexp>:<value1>[:<value2>]}.
719
+ * Safety violations now generate errors (they previously generated
720
+ warnings).
721
+ * asciidoc(1) now defaults to safe mode, consequently the
722
+ [miscellaneous] safe mode entry and --safe command-line option are
723
+ no longer necessary (though for backward compatibility asciidoc(1)
724
+ still accepts the --safe option).
725
+ * Backend Blocks are now flagged unsafe (they could be used to
726
+ include arbitrary and hence potentially unsafe output content).
727
+ * Filters are no longer considered unsafe. There's not much point in
728
+ insisting on filter safety since the installation of an unsafe
729
+ filter would require the introduction of new or modified
730
+ configuration files -- if your application configurations can be
731
+ compromised you're in all sorts of trouble (safe mode protects
732
+ against unsafe input files not unsafe configuration). As with all
733
+ filters, before installing, you should verify that they can't be
734
+ coerced into generating malicious output or exposing sensitive
735
+ information.
736
+
737
+ Bug fixes
738
+ * Fixed a lot of glaring grammatical and factual errors in the User
739
+ Guide.
740
+ __________________________________________________________________
741
+
742
+ 19. Version 7.0.3 (2005-12-01)
743
+
744
+ Additions and changes
745
+ * Added --safe and --unsafe command-line options -- AsciiDoc can now
746
+ be executed in a safe mode which disallows the execution of
747
+ arbitrary code or the inclusion of arbitrary files (see
748
+ [29]Appendix C in the AsciiDoc User Guide).
749
+ * Included [30]source-highlight filter in the distribution
750
+ ./examples/source-highlight-filter/ directory (based on filter
751
+ submitted by [31]Ryan Phillips).
752
+ * Included the DocBook XSL Stylesheets 1.69.1 customizations used to
753
+ generate the distributed AsciiDoc documentation (read the
754
+ asciidoc-docbook-xsl.txt file in the distribution ./docbook-xsl/
755
+ directory).
756
+ * AsciiDoc DocBook XSL Stylesheet drivers moved from ./doc/ to
757
+ ./docbook-xsl/.
758
+ * Modified ./doc/manpages.xsl so only URL content is displayed in
759
+ manpages.
760
+
761
+ Bug fixes
762
+ * Explicitly set table CSS border style (xhtml11 backend) to solid
763
+ because default border styles vary from browser to browser.
764
+ __________________________________________________________________
765
+
766
+ 20. Version 7.0.2 (2005-08-28)
767
+
768
+ Additions and changes
769
+ * There are now long versions of all AsciiDoc options.
770
+ * If the --backend is not specified it defaults to xhtml11.
771
+ * Added CSS simulated frames layout to the examples website (see
772
+ ./examples/website/layout2/README-website.txt). This layout does
773
+ not work with IE6 and the original tables based layout is still the
774
+ default.
775
+ * Support page added to AsciiDoc website.
776
+
777
+ Bug fixes
778
+ * Invalid options are now trapped gracefully.
779
+ * Documentation errata.
780
+ __________________________________________________________________
781
+
782
+ 21. Version 7.0.1 (2005-06-24)
783
+
784
+ Additions and changes
785
+ * Reverted to use of strong, em, tt XHTML tags -- they're more
786
+ obvious and no less correct than span tags, besides, the generated
787
+ file sizes are smaller (the User Guide was 11% smaller).
788
+ * Table title rendered with caption tag rather than a separate div.
789
+ * The AsciiDoc stylesdir attribute (if specified) is now recognized
790
+ when searching for embedded stylesheets (previously only searched
791
+ default ./stylesheets directory).
792
+ * Default charset encoding changed from ISO-8859-1 to UTF-8 -- it's
793
+ less language specific and displays most common languages.
794
+ * \template::[] macros now expand in all configuration file sections
795
+ previously only in markup template sections.
796
+ * Cleaned up example website layout CSS and configuration
797
+ (presentation has not been changed).
798
+ * Refactored xhtml11.conf configuration file.
799
+ * Set consistent and sensible permissions on distributed files.
800
+ * White space is now stripped from DSV formatted table cell data.
801
+ * class="tableblock" attribute added to tables generated by
802
+ xhtml-deprecated-css.conf to assist CSS.
803
+
804
+ Bug fixes
805
+ * Illegal character set encoder (specified by the AsciiDoc encoding
806
+ attribute) and character data are trapped gracefully.
807
+ * AsciiDoc table format attribute in table attribute lists were not
808
+ recognized.
809
+ * The nested horizontal labeled list example in the AsciiDoc User
810
+ Guide has been dropped -- it generated invalid DocBook markup.
811
+ __________________________________________________________________
812
+
813
+ 22. Version 7.0.0 (2005-06-06)
814
+
815
+ This is a major release with many code and documentation changes.
816
+ Please report any problems you encounter.
817
+
818
+ [32]Stuart Rackham
819
+
820
+ Additions and changes
821
+ * A new xhtml11 backend generates XHTML 1.1 with integrated CSS2
822
+ replacing the previous xhtml, css, and css-embedded backends.
823
+ * The CSS stylesheets have finally been rewritten.
824
+ * The asciidoc(1) command help now includes user [33]customizable
825
+ help topics. When asciidoc is invoked with the --help option the
826
+ command argument is interpreted as a help topic.
827
+ * The previous example website has been replaced by the actual
828
+ AsciiDoc website (see ./examples/website/.
829
+ * XHTML generation options now controlled by the following
830
+ attributes: badges, linkcss, icons, numbered, quirks, theme,
831
+ stylesdir, imagesdir (see the [34]User Guide for details.
832
+ * By default HTML and XHTML are output as stand-alone documents (no
833
+ embedded CSS and no linked admonition icon images).
834
+ * Documents encoded with the UTF-8 Unicode character set are now
835
+ processed thanks to a patch supplied by [35]Viktor Vasilev.
836
+ * The -a ^name command-line syntax to undefine an attribute has been
837
+ deprecated in favor of the -a name! syntax.
838
+ * AttributeEntry syntax addition: :name!: to undefine name attribute.
839
+ * Added template system block macro to allow the inclusion of one
840
+ configuration file template section within another.
841
+ * A verse style attribute can now be applied to literal paragraphs
842
+ and blocks to reproduce line breaks and white space from the source
843
+ document.
844
+ * Replacements and Special Words can now be escaped with leading
845
+ backslashes.
846
+ * Replacements are now processed in configuration file order
847
+ (previous ordering was indeterminate).
848
+ * System macros can now be used in the base asciidoc.conf
849
+ configuration file.
850
+ * Deprecated features that emitted warnings in prior versions are no
851
+ longer tolerated.
852
+ * The eval system attribute expression evaluates to False the
853
+ attribute is undefined, if it evaluates to True the result is an
854
+ empty string.
855
+ * The Paragraph and DelimitedBlock presubs parameter can be aliased
856
+ as subs.
857
+ * Added verbatim substitutions option.
858
+ * Renamed List Continuation Block to List Block and renamed the
859
+ listcontinuation option to list.
860
+ * Deprecated default substitutions option (use normal instead).
861
+ * The section-numbers section numbering attribute has be renamed
862
+ numbered.
863
+ * Dropped the #UNDER CONSTRUCTION# block macro.
864
+ * Rewrote Paragraph and DelimitedBlock handlers adding a [36]styles
865
+ configuration entry.
866
+
867
+ Bug fixes
868
+ * Included files are no longer read inside conditionally excluded
869
+ content.
870
+ * Manpage command names containing dashes (in the manpage NAME
871
+ section) were misinterpreted as the spaced dash command
872
+ name/purpose separator. Bug report and patch supplied by [37]David
873
+ Greaves.
874
+ * Unexpected error following malformed author line error.
875
+ __________________________________________________________________
876
+
877
+ 23. Version 6.0.3 (2005-04-20)
878
+
879
+ Additions and changes
880
+ * Special characters are now substituted in AttributeEntry element
881
+ values.
882
+ * Spaced and unspaced em dashes are now recognized (previously only
883
+ spaced em dashes were recognized).
884
+ * Replaced the table noborders option with richer frame and grid
885
+ attributes.
886
+ * The duplicate macro warning message now only occurs when the
887
+ verbose (-v) option is enabled.
888
+ * Single lines starting with two forward slashes hard up against the
889
+ left margin are treated as comments and are not processed.
890
+ * Renamed section delimited block option to sectionbody to more
891
+ accurately reflect it's role.
892
+ * Added a List Continuation block -- a specialized delimited block
893
+ that is functionally equivalent to the List Item Continuation
894
+ feature except that the list contained within the block does not
895
+ require explicit + list item continuation lines.
896
+ * Dropped deprecated <u> tags from generated HTML.
897
+ * Literal Block delimiters must now consist of at least four points
898
+ (previously three) to avoid lone ellipsis ambiguity.
899
+
900
+ Bug fixes
901
+ * Some system attribute evaluation failures caused unexpected
902
+ exceptions to occur.
903
+ __________________________________________________________________
904
+
905
+ 24. Version 6.0.2 (2005-03-30)
906
+
907
+ Additions and changes
908
+ * Three new system block macros have been added -- eval, sys and sys2
909
+ which are the block macro equivalents to the same named system
910
+ attributes.
911
+ * Intrinsic macros have been renamed system macros along with action
912
+ attributes which have been renamed system attributes:
913
+ + To reflect their common (though contextually different)
914
+ behavior.
915
+ + To avoid confusion with intrinsic attributes.
916
+
917
+ Bug fixes
918
+ * Asciidoc now searches in /etc/asciidoc/filters for filters.
919
+ __________________________________________________________________
920
+
921
+ 25. Version 6.0.1 (2005-03-06)
922
+
923
+ Additions and changes
924
+ * A global configuration file location /etc/asciidoc has been added
925
+ and is now processed before all other locations (patch supplied by
926
+ [38]Fredrik Steen).
927
+ * Recoded tempfile.mktemp() and other artifacts that are no longer
928
+ necessary or desirable (patches supplied by [39]Fredrik Steen).
929
+ * Added BUGS file to the distribution.
930
+
931
+ Bug fixes
932
+ * Illegal comment syntax in css-embedded-stylesheet.conf resulted in
933
+ illegal CSS in files generated by the css-embedded backend.
934
+ __________________________________________________________________
935
+
936
+ 26. Version 6.0.0 (2005-01-28)
937
+
938
+ This release has had some fairly major code and documentation changes.
939
+ Please report any problems you encounter.
940
+
941
+ [40]Stuart Rackham
942
+
943
+ A lot of new stuff. A new major version number -- some regression
944
+ incompatibility (hopefully mitigated by deprecated warnings).
945
+
946
+ Went mad trying to rein in the current feature anarchy -- established a
947
+ unified notion of document attributes. Attempted to introduce a
948
+ consistent vocabulary -- renamed many poorly or inconsistently named
949
+ entities.
950
+
951
+ Actually, deprecated syntax is still processed correctly in almost all
952
+ cases. One source of incompatibility that may arise if you have
953
+ customized CSS stylesheets is the change of AsciiDoc CSS class names
954
+ (see below). I guess the moral is if you've done a lot of configuration
955
+ file customization and are happy with version 5 then you may want to
956
+ stay put.
957
+
958
+ Note: This version requires Python 2.3 or better to run.
959
+
960
+ Additions and changes
961
+ * Glossary entries have been renamed attributes. This eliminates
962
+ confusion with the accepted meaning of glossary.
963
+ * An AttributeEntry block element has been added so that document
964
+ attributes can be assigned from within an AsciiDoc document.
965
+ * The AttributeList block element has been added which is a more
966
+ general solution than the (now deprecated) DelimitedBlock
967
+ arguments.
968
+ * An BlockId element has been added for setting block element anchor
969
+ (link target) IDs.
970
+ * Quoted text can now span multiple lines (thanks to James Bowlin for
971
+ this patch).
972
+ * Inline macros can now span multiple lines.
973
+ * ``double backtick / apostrophe'' quotes generate "curly quotes".
974
+ * A warning is now emitted for out of order list item (applies to
975
+ explicitly enumerated numbered list items).
976
+ * Added include action attribute.
977
+ * A line of three or more apostrophes generates an HTML horizontal
978
+ ruler (<hr/> tag). You will get a warning if processed with
979
+ non-HTML backend.
980
+ * An {imagesdir} attribute specifies image file location for images
981
+ referenced in configuration files when generating HTML (the default
982
+ location is images).
983
+ * An {stylesdir} attribute specifies the location of CSS stylesheets
984
+ when generating styled HTML (the default location for configured
985
+ markup is .).
986
+ * list entry has been deprecated, use {0} instead.
987
+ * New ExampleBlock delimited block along with associated variants
988
+ Note, Tip, Warning, Caution and Important.
989
+ * The docbook.conf file now facilitates the optional inclusion of a
990
+ DocBook revision history file.
991
+ * To better reflect their purpose the following block elements have
992
+ been renamed: VerbatimBlock to ListingBlock; IndentedBlock to
993
+ LiteralBlock; IndentedParagraph to LiteralParagraph; CustomBlock to
994
+ BackendBlock; SimpleSection to SectionBody. Any corresponding CSS
995
+ class names have also been changed which could result in backward
996
+ incompatibility in customized stylesheets.
997
+ * Swapped plain DocBook admonition icons for Jimmac's DocBook icons
998
+ ([41]http://jimmac.musichall.cz/ikony.php3). The original plain
999
+ icons have been moved to ./images/plain.
1000
+ * Renamed html backend to xhtml to better reflect it's function
1001
+ (former html-4 backend renamed to html).
1002
+ * A new inline anchor macro syntax [[[<id>]]] is available, it
1003
+ displays [<id>] at the anchor location and is for anchoring
1004
+ bibliography list entries.
1005
+ * An optional single-line titles syntax can be used.
1006
+ * Tweaks to distributed CSS stylesheets and FOP fo.xsl customization
1007
+ file.
1008
+ * List Item Continuation has been implemented which allows additional
1009
+ block elements to be included in list items by separating them from
1010
+ the preceding list item element with a line containing a single
1011
+ plus character.
1012
+ * A new Horizontal Labeled List list type has been added. Generates
1013
+ two column list -- the first column contains the list element
1014
+ labels, the second contains the element text. Same syntax as
1015
+ Vertical Labeled Lists except the double colon label suffix is
1016
+ followed by the start of the list item text.
1017
+
1018
+ Bug fixes
1019
+ * Fixed broken backslash line continuation.
1020
+ * Labeled list end tags were not undergoing attribute substitution.
1021
+ * Documents without any author information now generate legitimate
1022
+ DocBook (previously if the author line was not included in the
1023
+ document header then an empty (illegal) DocBook author element was
1024
+ generated).
1025
+ * Multiple spaces in filter command arguments were replaced by a
1026
+ single space. The ./examples/asciidoc2text/asciidoc2text.sh script
1027
+ now indents text correctly.
1028
+ __________________________________________________________________
1029
+
1030
+ 27. Version 5.1.1 (2004-10-10)
1031
+
1032
+ 15-December-2004: Interim update: Updated asciidoc.py to fix broken
1033
+ join_lines function -- no other changes.
1034
+ * PDF documentation is now produced from DocBook XML using XSLTLib
1035
+ and FOP. Previously we processed DocBook SGML with jw(1) (which
1036
+ used Dvips to convert DVI files to PDF). FOP has come a long way in
1037
+ the last 12 months and produces very acceptable PDF under both
1038
+ Linux and Windows.
1039
+ * Sections detailing how to install and use the DocBook XSL
1040
+ Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers
1041
+ have been added to the User Guide.
1042
+ * The PDF output from the he example article template has been
1043
+ included in the distribution (./doc/article.pdf).
1044
+ * Special characters are emitted using decimal Unicode character
1045
+ codes (previously used named character entities which cannot be
1046
+ assumed included in non-HTML documents).
1047
+ * Added registered trademark � to [replacements].
1048
+ * CSS stylesheet tweaks.
1049
+ * Admonitions (Note, Tip, Important, Warning, Caution) include icons
1050
+ when generating css output.
1051
+ __________________________________________________________________
1052
+
1053
+ 28. Version 5.1.0 (2004-09-18)
1054
+
1055
+ * Callouts have been implemented (see the Callouts section of the
1056
+ AsciiDoc User Guide for details).
1057
+ * Added XSL drivers for generating XHTML, chunked XHTML and HTML Help
1058
+ from DocBook XML using XSL stylesheets and xsltproc(1).
1059
+ * Added CSS stylesheet for HTML generated from DocBook XML using XSL
1060
+ stylesheets.
1061
+ * Distribution contains HTML Help formatted User Guide
1062
+ (./doc/asciidoc.chm), the User Guide tells you how it's generated.
1063
+ * Images referred to by distributed stylesheets are now located in
1064
+ the ./images subdirectory (previously located in .).
1065
+ * Filters path names are now handled properly under Cygwin.
1066
+ * The usual documentation and examples additions, updates and
1067
+ polishing.
1068
+ __________________________________________________________________
1069
+
1070
+ 29. Version 5.0.9 (2004-09-09)
1071
+
1072
+ * The convention of using a .asc file extension for AsciiDoc files
1073
+ has been dropped in favor of the familiar .txt extension. It makes
1074
+ more sense in that AsciiDoc is a text presentation format and
1075
+ because .asc clashed with the same extension used by other
1076
+ applications. It's only a naming convention -- you don't have to
1077
+ switch if you don't want to.
1078
+ * Changed the subscript formatting character from underline to tilde
1079
+ since underscores in file names are reasonably common (especially
1080
+ in link and image macros).
1081
+ * An alternative syntax for the index term inline macro has been
1082
+ added: <primary>,<secondary>,<tertiary>.
1083
+ * Index terms that have secondary and tertiary entries now
1084
+ additionally generate separate index terms for the secondary and
1085
+ tertiary entries.
1086
+ * A <primary> index term inline macro has been added which displays
1087
+ the term in the primary text flow.
1088
+ * Added alternative variable list definition using double semi-colon
1089
+ terminator as opposed to the standard double colon terminator so
1090
+ variable lists can be nested to two levels.
1091
+ * Footnotes now appear on a separate line in HTML and Linuxdoc
1092
+ outputs.
1093
+ * Python version compatibility is checked at startup.
1094
+ * Preface and appendix section titles in multi-part Book documents
1095
+ are meant to be out of sequence -- warnings are no longer emitted
1096
+ when outputting HTML.
1097
+ * Empty section warnings have been replaced by error messages and are
1098
+ emitted only if invalid markup would result.
1099
+ * Missing macro sections or invalid macro name warnings are only
1100
+ generated at startup if the -v (verbose) option is set. Otherwise
1101
+ they are deferred until a matching macro is encountered in the
1102
+ input file.
1103
+ * Missing or invalid table definition warnings are only generated at
1104
+ startup if the -v (verbose) option is set. Otherwise they are
1105
+ deferred until a matching table is encountered in the input file.
1106
+ * AsciiDoc now makes more of an effort to continue in the face of
1107
+ errors.
1108
+ * Fixed broken ./examples/website/main.aap script.
1109
+ * Converted distribution text files DOS text format as a sop to
1110
+ Windows users with challenged text editors.
1111
+ * Documentation additions and corrections.
1112
+ __________________________________________________________________
1113
+
1114
+ 30. Version 5.0.8 (2004-05-15)
1115
+
1116
+ * Spurious out of sequence level 2 warnings no longer appear when
1117
+ processing book document multi-part book top level Preface and
1118
+ Appendix sub-sections since they are (correctly) out of sequence.
1119
+ * A warning is no longer emitted for empty Index sections since this
1120
+ is normal when generating DocBook outputs.
1121
+ * Fixed: [quotes] configuration file entries where not being
1122
+ overridden by downstream configuration file entries.
1123
+ * Footnote text is now output enclosed in square brackets in HTML
1124
+ documents.
1125
+ * Added superscripts and subscripts to the standard PRS configuration
1126
+ files.
1127
+ * Adjusted CSS stylesheets so list titles don't have so much space
1128
+ between title and first list item (broken in IE6 due to poor CSS
1129
+ compliance). Lessened sidebar title top margin.
1130
+ __________________________________________________________________
1131
+
1132
+ 31. Version 5.0.7 (2004-04-22)
1133
+
1134
+ * The version 5.0.6 README incorrectly stated that AsciiDoc would run
1135
+ under Python 2.0, in fact it requires Python 2.1 or better. The
1136
+ README has been corrected.
1137
+ * Documented techniques for combining and splitting AsciiDoc
1138
+ documents and processing the combined and split parts (see the Tips
1139
+ and Tricks section of the User Guide).
1140
+ * An example of marking up superscripts and subscripts is documented
1141
+ in the Tips and Tricks section of the User Guide (the example
1142
+ configuration file is in the AsciiDoc examples directory).
1143
+ * Added ellipsis to shipped [replacements]; three periods output an
1144
+ ellipsis entity.
1145
+ * Removed unused SectionClose class.
1146
+ * The AsciiDoc Preamble element is output as a DocBook Preface when
1147
+ processed as a book document type (in older AsciiDoc versions a
1148
+ warning was issued and processing stopped).
1149
+ * Fixed a quoting anomaly: quoted text can no longer begin or end
1150
+ with with white space.
1151
+ __________________________________________________________________
1152
+
1153
+ 32. Version 5.0.6 (2004-03-07)
1154
+
1155
+ * New image macro implements optional image scaling and linking and
1156
+ works in both inline and block contexts. The image macro obsolesces
1157
+ the existing graphic block macro and icon inline macro.
1158
+ * Macro substitution section names now have -inlinemacro and
1159
+ -blockmacro suffixes to resolve context ambiguity, make their
1160
+ purpose clearer and relieve section namespace congestion.
1161
+ * Header derived glossary entries can now be overridden from the
1162
+ command-line.
1163
+ * Special character substitution is now performed on AuthorLine
1164
+ derived author names.
1165
+ * A macro or block argument called options can be used as a shortcut
1166
+ for a list named arguments with zero length string values.
1167
+ * Tables can be output without borders using the options="noborders"
1168
+ argument.
1169
+ * Table data lines that do not immediately follow a table section
1170
+ underline can now be blank. This allows CSV data with embedded
1171
+ blank lines to be processed correctly.
1172
+ * Blank DSV format table data lines are silently skipped.
1173
+ * Tightened up on enforcement of configuration file section names to
1174
+ reduce the possibility of section content being seen as a section
1175
+ header line.
1176
+ * Section titles can be optionally suffixed with title arguments
1177
+ enclosed in double square brackets.
1178
+ * A replacement has been added to asciidoc.conf to replace inline
1179
+ double dashes with the -- entity.
1180
+ * Changed the .UNDER-CONSTRUCTION. macro syntax to UNDER-CONSTRUCTION
1181
+ so it is not mistaken for a BlockTitle. Similarly changed the .NEW.
1182
+ replacement with #NEW#.
1183
+ * &35;NEW# and #UNDER-CONSTRUCTION macros are now included in the
1184
+ DocBook backend.
1185
+ * Replaced shipped smallnew.gif with smallnew.png.
1186
+ * Documentation tidy ups.
1187
+ __________________________________________________________________
1188
+
1189
+ 33. Version 5.0.5 (2004-02-25)
1190
+
1191
+ * Fixed the disappearing paragraph titles problem that was caused by
1192
+ Inline macros (incorrectly) processing BlockTitles.
1193
+ * Tightened AuthorLine validation. Previously invalid email addresses
1194
+ and embedded special characters in the AuthorLine resulted in
1195
+ invalid output markup.
1196
+ __________________________________________________________________
1197
+
1198
+ 34. Version 5.0.4 (2004-02-09)
1199
+
1200
+ * Reinstated missing infile, outfile, filetype and
1201
+ filetype-<filetype> glossary entries.
1202
+ * As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater,
1203
+ this has now been documented.
1204
+ __________________________________________________________________
1205
+
1206
+ 35. Version 5.0.3 (2004-01-23)
1207
+
1208
+ * Fixed problem that caused any filters directory file containing
1209
+ .conf (not just those with the .conf extension) from being loaded.
1210
+ * All [miscellaneous] configuration file entries can now be
1211
+ referenced like glossary entries (they are now processed internally
1212
+ as glossary entries).
1213
+ * The output file line terminator (previously hardwired to \r\n is
1214
+ now set using the newline entry in the configuration file
1215
+ [miscellaneous] section.
1216
+ * The misspelt blocktitles configuration file entry name has been
1217
+ corrected (to blocktitle).
1218
+ * An {empty} glossary entry has been added to the default
1219
+ configuration which is useful for outputting trailing blank lines
1220
+ from configuration file substitution sections.
1221
+ __________________________________________________________________
1222
+
1223
+ 36. Version 5.0.2 (2003-12-18)
1224
+
1225
+ * New (alternative) anchor and xref macro syntax (old syntax still
1226
+ valid).
1227
+ * DocBook mediaobject and inlinemediaobject tags are generated in
1228
+ place of graphic and inlinegraphic tags by the AsciiDoc graphic and
1229
+ icon macros. If a macro argument is specified it is the alternative
1230
+ text output if the target document format does not support the
1231
+ specified graphic file format.
1232
+ * Dropped the LinuxDoc left and right square bracket special
1233
+ character substitutions as they interfered with macro substitution.
1234
+ * Documentation updates and corrections.
1235
+ __________________________________________________________________
1236
+
1237
+ 37. Version 5.0.1 (2003-12-09)
1238
+
1239
+ * Fixed problem with anchor tag when generating CSS styled HTML.
1240
+ __________________________________________________________________
1241
+
1242
+ 38. Version 5.0 (2003-12-08)
1243
+
1244
+ This release has had some fairly major code and documentation changes.
1245
+ Please report any problems you encounter.
1246
+
1247
+ [42]Stuart Rackham
1248
+
1249
+ * AsciiDoc can now produce a full-blown multi-part DocBook book
1250
+ including dedication, abstract, preface, colophon, glossary,
1251
+ appendix, bibliography and book part elements using the new
1252
+ specialsections configuration file section.
1253
+ * All Section element children (Paragraph, DelimitedBlock, List,
1254
+ Table, BlockMacro) can now be titled using the BlockTitle element.
1255
+ A BlockTitle element is a single line containing a title and
1256
+ beginning with a period.
1257
+ * The index and backmatter macros have been dropped, superseded by
1258
+ specialsections.
1259
+ * The AsciiDoc Preface element has been renamed Preamble (to avoid
1260
+ confusion with the DocBook book preface element).
1261
+ * Out of sequence titles are now tolerated with a warning. This
1262
+ allows book document level 0 sections to be processed.
1263
+ * An anchor inline macro has been added for document link target
1264
+ creation.
1265
+ * Note, Tip, Important and Warning paragraph types have been added to
1266
+ support the corresponding DocBook elements.
1267
+ * Title substitution is now performed in SidebarBlock titles.
1268
+ * DocBook graphics now output as figure and informalfigure elements
1269
+ rather than mediaobjects. This ensures numbered figures and a lists
1270
+ of figures are produced by the DocBook toolchain.
1271
+ * You can now escape block argument lines by appending a backslash.
1272
+ Alternatively, if you embed arguments in the delimiter line
1273
+ AsciiDoc does not check for an arguments line.
1274
+ * The default DocBook backend file extension has been changed from
1275
+ .docbook to .xml (.sgml for the docbook-sgml backend).
1276
+ * Warnings are output by default (previously they only printed when
1277
+ verbose option enabled).
1278
+ * A Question and Answer variable list definition has been added to
1279
+ the shipped configuration files, primarily to create DocBook qanda
1280
+ DocBook elements.
1281
+ * Fixed broken code-filter -b linuxdoc option. The asciidoc.asc User
1282
+ Guide can now be processed by linuxdoc(1) (although tables are
1283
+ dropped because LinuxDoc does not implement tables).
1284
+
1285
+ Compatibility issues:
1286
+ 1. Table titles are no longer in the arguments line, use the new
1287
+ BlockTitles.
1288
+ 2. Graphic titles are no longer in the graphic block macro caption,
1289
+ use the new BlockTitles.
1290
+ 3. The code-filter title must be placed in a preceding BlockTitle.
1291
+ 4. SidebarBlock titles must be placed in a preceding BlockTitle.
1292
+ 5. The DelimitedBlock option sidebar has been renamed to section.
1293
+ 6. The default DocBook backend file extension has been changed from
1294
+ .docbook to .xml (.sgml for the docbook-sgml backend).
1295
+ __________________________________________________________________
1296
+
1297
+ 39. Version 4.2 (2003-11-26)
1298
+
1299
+ * The default HTML output is now XHTML 1.0 markup. To output the
1300
+ former HTML 4 markup specify the html-4 backend.
1301
+ * The default DocBook output is now DocBook XML. To output the former
1302
+ DocBook SGML specify the docbook-sgml backend. The associated
1303
+ docbook-sgml.conf file illustrates how to support minor DTD
1304
+ variations. Examples of using the xmlto(1) command for DocBook
1305
+ conversion have been added to the User Guide.
1306
+ * Glossary entries set using the command-line -g option can now be
1307
+ referenced in configuration files.
1308
+ * Configuration dumps (-c command-line option) no longer output
1309
+ redundant undefined glossary entries.
1310
+ * DelimitedBlock arguments can now be specified in a separate
1311
+ arguments line immediately following the leading delimiter line,
1312
+ This is in preference to the existing delimiter embedded arguments.
1313
+ Reasons:
1314
+ + The syntax is in keeping with the Tables arguments syntax.
1315
+ + It's easier to enter and implements line continuation.
1316
+ * A new QuoteBlock DelimitedBlock definition has been added to the
1317
+ distribution configuration files.
1318
+ * The table arguments lines can be continued using the backslash line
1319
+ continuation character.
1320
+ * Added new calculated glossary reference type {<name>%<value>}.
1321
+ * Double-quote characters can now appear in unquoted positional
1322
+ arguments.
1323
+ __________________________________________________________________
1324
+
1325
+ 40. Version 4.1 (2003-11-13)
1326
+
1327
+ * Added DSV (Delimiter Separated Values) tables format.
1328
+ * {eval:<expr>} glossary references drop the containing line if
1329
+ <expr> evaluates to None.
1330
+ * Block, Table and Macro arguments can now be positional (quoted or
1331
+ unquoted).
1332
+ * Vocabulary change: DelimitedBlock, Table and Macro attributes are
1333
+ now referred to as arguments. This makes more sense in light of the
1334
+ extended syntax and avoids confusion with backend markup tag
1335
+ attributes.
1336
+ * tablewidth table ruler parameter can now be expressed in percent
1337
+ units (0..100). If between 0 and 1 then the original fractional
1338
+ unit measure is applied.
1339
+ * The use of quoting for generating footnotes and index entries has
1340
+ been dropped in favor of footnote and indexterm inline macros.
1341
+ * backmatter inline macro included in distribution.
1342
+ * Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant.
1343
+ * Fixed: tablewidth was processed incorrectly when passed as table
1344
+ argument.
1345
+ * Fixed: Glossary references like {x={y}} were one character off if
1346
+ {x] was defined and {y} was not.
1347
+ __________________________________________________________________
1348
+
1349
+ 41. Version 4.0 (2003-11-08)
1350
+
1351
+ This release has had some fairly major code and documentation changes.
1352
+ Please report any problems you encounter.
1353
+
1354
+ Stuart Rackham
1355
+
1356
+ * Added tables to AsciiDoc.
1357
+ * Added two special subs options: default specifies the default
1358
+ substitution options and none specifies no substitution. These
1359
+ options can only appear singly.
1360
+ * Line continuation using a trailing backslash character is available
1361
+ in Paragraphs, ListItems, Tables.
1362
+ * The left and right quotes for quoted text can now be specified
1363
+ separately.
1364
+ * Shipped configuration files implement footnotes (only useful for
1365
+ DocBook output) using \[[]] quoting.
1366
+ * Shipped configuration files implement index terms (only useful for
1367
+ DocBook and LinuxDoc output) using \(()) quoting.
1368
+ * The shipped html backend configuration now emits valid HTML 4.01
1369
+ Transitional.
1370
+ * Added new calculated glossary reference types {<name>!<value>} and
1371
+ {<name>#<value>}.
1372
+ * The DelimitedBlock params option has been dropped in favor of the
1373
+ new block attributes mechanism. If you have customized block params
1374
+ options you may need to adjust source files to use the block
1375
+ attributes syntax. The example code filter has been updated to
1376
+ reflect these changes.
1377
+ * The code filter now has a -t tabsize option.
1378
+ * Replaced -w option with -v (verbose) option. The warnings option
1379
+ was just to confusing.
1380
+ * Named attributes can now be specified in macro calls.
1381
+ * The tabsize attribute is recognized in the built-in include macros.
1382
+ A tabsize of zero suppresses tab expansion.
1383
+ * The configuration file [options] section has been split into
1384
+ [miscellaneous] and [titles]. If you have customized any of these
1385
+ settings you will need to adjust the affected configuration files.
1386
+ * Configuration file [miscellaneous] entries can now also be set
1387
+ using the command-line -g option.
1388
+ * Fixed: error that occurred when attempting to use zero length
1389
+ configuration and source files.
1390
+ * Fixed: blocking filter halt problem.
1391
+ * Fixed: inline macro escape prefix problem.
1392
+ * Fixed: missing macros from configuration dump problem.
1393
+ * Fixed: named macros were dumped incorrectly.
1394
+ * Many documentation changes/additions/corrections.
1395
+ __________________________________________________________________
1396
+
1397
+ 42. Version 3.2.2 (2003-10-26)
1398
+
1399
+ * Added -n option (synonym for -g section-numbers).
1400
+ * Dropped the processing commentary (hey, this is Unix).
1401
+ * Added new calculated glossary reference type {<name>?<value>}.
1402
+ <name> is the glossary entry name and <value> is the text
1403
+ substituted if the glossary entry is defined. <value> can only
1404
+ contain literal text (no glossary references allowed).
1405
+ * Added asciidoc2text to distribution examples/asciidoc2text
1406
+ directory (converts AsciiDoc source to text file with section
1407
+ numbering).
1408
+ * Fixed incorrect nesting of Simple lists inside Variable lists.
1409
+ * List definitions have been modified so that list items can be
1410
+ indented. This allows a more intuitive indentation of nested lists
1411
+ in AsciiDoc source.
1412
+ * Lists must be separated from preceding paragraphs by a blank line.
1413
+ This is to avoid paragraph lines being mistaken for list items.
1414
+ * Corrected asciidoc man page documentation error: the`-f` option
1415
+ does not search relative to source document directory for the
1416
+ configuration file.
1417
+ * Minor updates to various distribution .conf files.
1418
+ * Included badges.conf in examples directory.
1419
+ * css-embedded-stylesheet.conf now supports footer badges.
1420
+ * The default in-line element processing order has been changed:
1421
+ Glossary References are now processed before Inline Macros. This
1422
+ allows glossary expansions to occur inside macro references.
1423
+ * Glossary entries are now allowed in Author and Revision lines.
1424
+ * Default List subs options and Paragraph presubs options are
1425
+ assigned the following default value if not specified:
1426
+ specialcharacters,quotes,specialwords,replacements,glossary,macros
1427
+ * Documentation changes/additions/corrections.
1428
+ __________________________________________________________________
1429
+
1430
+ 43. Version 3.2 (2003-05-26)
1431
+
1432
+ * Added a -s command-line option to suppress the output of [header]
1433
+ and [footer] sections.
1434
+ * Article document headers are no longer mandatory: this allows
1435
+ AsciiDoc to process arbitrary chunks of text. When used in
1436
+ conjunction with the new -s command-line option corresponding
1437
+ chunks of backend markup can be generated.
1438
+ * AsciiDoc now emits a warning message and continues when an out of
1439
+ sequence section title is detected (previously it failed and
1440
+ halted). This allows document sections to be processed separately.
1441
+ * Optional presubs and postsubs entries have been added to
1442
+ DelimitedBlock and Paragraph definitions. As a consequence
1443
+ substitution options are no longer legal in options entries.
1444
+ * presubs and postsubs substitutions are processed in the order the
1445
+ options are specified (rather than the fixed options order of
1446
+ previous versions).
1447
+ * ./filters subdirectories are automatically searched for filter
1448
+ commands.
1449
+ * A title-subs configuration option specifies the substitutions
1450
+ performed on document Header and Section titles.
1451
+ * A subs entry in now included in List configuration file definitions
1452
+ that specified substitutions performed on list entry text.
1453
+ * Configuration files are auto-loaded from ./filters subdirectories.
1454
+ * Added example code filter (see ./examples/filters).
1455
+ * Bug fix: if section was empty you may have got erroneous missing
1456
+ tag "paragraph" error.
1457
+ * Internal code tidy up.
1458
+ __________________________________________________________________
1459
+
1460
+ 44. Version 3.1 (2003-05-18)
1461
+
1462
+ * In version 3.0 a [macros] section entry of the form name was
1463
+ equivalent to name=. An entry of the form name now undefines the
1464
+ entry (to bring it in line with the behavior of other special
1465
+ sections).
1466
+ * Paragraphs have now been generalized (in the same way as Lists and
1467
+ DelimitedBlocks).
1468
+ * The indentsize option has been dropped as as consequence of
1469
+ paragraph generalization.
1470
+ * Pipe | characters can be included in substituted tag and
1471
+ substitution section text using the {brvbar} (broken vertical bar)
1472
+ glossary reference.
1473
+ * Removed the restriction requiring substitution section text
1474
+ placeholders | to be on a separate line.
1475
+ * Added an -e asciidoc(1) command option that excludes implicit
1476
+ configuration files (used in conjunction with -c generated
1477
+ configuration files).
1478
+ * Version 3.0 documentation has undergone a considerable cleanup.
1479
+ * The dumping of quoted section entries (see -c option) now works
1480
+ correctly.
1481
+ * The format of special section entries has been made consistent:
1482
+ name undefines the entry; name= sets the entry value to a blank
1483
+ string; name=value sets the entry value to value.
1484
+ * As a consequence of the previous change the caret prefix is no
1485
+ longer used in glossary configuration file entries (although it is
1486
+ still used when undefining an entry using the -g command-line
1487
+ option).
1488
+ __________________________________________________________________
1489
+
1490
+ 45. Version 3.0 (2003-05-13)
1491
+
1492
+ This version is the culmination of work begun in the 2.x releases
1493
+ whereby fixed policy has been replaced by extensible mechanisms.
1494
+ * Added -c command-line option to dump a composite asciidoc(1)
1495
+ configuration file to stdout.
1496
+ * Lists and Delimited Blocks are now defined by a set of
1497
+ configuration file parameter sections. The user can modify the
1498
+ default definitions or add new ones.
1499
+ * Block content can now be processed through external filters.
1500
+ * The default behavior for Custom Blocks is to perform glossary
1501
+ substitution (previously there was no substitution inside Custom
1502
+ Blocks).
1503
+ * The old 2.x style macros have been reimplemented; as with Lists and
1504
+ Delimited Blocks there syntax and behavior can be configured by the
1505
+ user. The default macro syntax remains the same but the semantics
1506
+ are now (hopefully) a bit more intelligible.
1507
+ * Block and Builtin macros use :: delimiter instead of the 2.x single
1508
+ colon delimit (to distinguish them from inline macros). The 2.x
1509
+ syntax is still supported for backward compatibility.
1510
+ * Nested lists are now supported and IndentedParagraphs can be
1511
+ included in list items.
1512
+ * Conditional source inclusion can be specified using built in ifdef,
1513
+ ifndef and endif macros.
1514
+ * The new conditional source inclusion feature has been used to
1515
+ reduce the number of default configuration files down to one per
1516
+ backend.
1517
+ * A change of name: 2.x Substitutions are now called Replacements and
1518
+ the 2.x [substitutions] configuration file section is now called
1519
+ [replacements] (the old name is still recognized for backward
1520
+ compatibility).
1521
+ * The line break is now implemented as a Replacements substitution.
1522
+ * Inline icon macro for inline images has been added to default
1523
+ configuration files.
1524
+ __________________________________________________________________
1525
+
1526
+ 46. Version 2.2 (2003-04-07)
1527
+
1528
+ * The master.conf configuration file name has been deprecated in
1529
+ favor of asciidoc.conf.
1530
+ * The standard configuration files set is now loaded from the
1531
+ .asciidoc folder in the users home directory (if it exists) and
1532
+ then from the source document directory. Configuration files that
1533
+ don't exist are silently skipped.
1534
+ * Configuration files named like the source file will be
1535
+ automatically loaded if they are found in the source file
1536
+ directory. For example if the source file is mydoc.asc and the -b
1537
+ html option is used then asciidoc(1) will look for mydoc.conf and
1538
+ mydoc-html.conf in that order.
1539
+ * The characters used to quote formatted text can be configured and
1540
+ extended by the user (see the master.conf [quotes] section).
1541
+ * Quoted text can now be escaped by prefixing a backslash character
1542
+ to the leading quote.
1543
+ * The double single-quote '' strong text quote has been deprecated in
1544
+ favor of an asterisk * character.
1545
+ * Added {eval:expression}, {sys:command} and {sys2:command} glossary
1546
+ reference actions.
1547
+ * Trailing brace characters } are now allowed inside glossary
1548
+ references provided they are escaped with a backslash character.
1549
+ * Glossary entries can now be escaped by prefixing a backslash
1550
+ character to the leading brace character (use this in preference to
1551
+ placing the backslash inside the brace).
1552
+ * The output macro has been deprecated (use the new include1 macro
1553
+ inside a CustomBlock).
1554
+ * The default document type is article (asciidoc no longer attempts
1555
+ to guess).
1556
+ * Files included within DelimitedBlocks are not searched for block
1557
+ termination underlines. This ensures the entire file is part of the
1558
+ DelimitedBlock.
1559
+ * include macros can now be used in configuration files.
1560
+ * Corrected {infile} and {outfile} glossary entry documentation.
1561
+ * File inclusion is now limited to a depth of 5 to catch recursion
1562
+ loops.
1563
+ * Inline tags have been deprecated, they're not necessary and they
1564
+ immediately make the source document backend specific. Use
1565
+ CustomBlocks or Substitutions instead.
1566
+ __________________________________________________________________
1567
+
1568
+ 47. Version 2.1 (2003-03-17)
1569
+
1570
+ * Added section auto numbering {sectnum} glossary entry
1571
+ (auto-numbering function contributed by Ludovico Magnocavallo).
1572
+ * asciidoc(1) now correctly returns non-zero exit status if an error
1573
+ occurs.
1574
+ * An AsciiDoc example website has been included in the AsciiDoc
1575
+ distribution examples/website directory (also online at
1576
+ [43]http://www.methods.co.nz/asciidoc/examples/website/).
1577
+ * NOTE: The asciidoc wrapper script included in the 2.0 distribution
1578
+ has been dropped, if you've symlinked or aliased to asciidoc you'll
1579
+ need to change them to point directly to asciidoc.py instead.
1580
+ * An RCS $Id$ marker can be used as the document header revision line
1581
+ (based on a patch submitted by Ludovico Magnocavallo).
1582
+ * In addition to the name=value glossary entry format two new ones
1583
+ have been introduced: name (the default value is set to an empty
1584
+ string) and ^name (the glossary entry is undefined).
1585
+ * The -q command-line option has been deprecated and the -w level
1586
+ command-line option added.
1587
+ NOTE: By default skipped substitution warnings are now suppressed.
1588
+ * If a configuration file specified with the -f command-line option
1589
+ is not found relative to the current working directory then the
1590
+ search is repeated relative to the asciidoc(1) directory. This
1591
+ allows global configuration files to be used.
1592
+ * Added {infile}, {outfile} predefined glossary entries.
1593
+ * Added under-construction macro to HTML article configuration files.
1594
+ * Deprecated {asciidoc_version} glossary entry in favor of
1595
+ {asciidoc-version} (to it consistent with other entries).
1596
+ __________________________________________________________________
1597
+
1598
+ 48. Version 2.0 (2003-02-24)
1599
+
1600
+ * The emphasized, strong and monospaced words options have been
1601
+ generalized with the introduction of macro based special words
1602
+ lists.
1603
+ * Glossary references can now appear in both the document and macro
1604
+ bodies.
1605
+ * All output files use crlf line termination (previously used UNIX lf
1606
+ (newline) termination).
1607
+ * Added [substitutions] section which implements arbitrary regular
1608
+ expression based substitutions.
1609
+ * An optional master.conf configuration file can be used for entries
1610
+ that are not backend or document type specific.
1611
+ * Special character definitions moved from the code to the new
1612
+ [special_characters] configuration file section.
1613
+ * Configuration file glossary added.
1614
+ * Command-line -g glossary entry added.
1615
+ * A new book document type has been implemented for the docbook
1616
+ backend. It outputs DocBook book documents.
1617
+ * A major internal change has been the implementation of parametrized
1618
+ user definable macros. Internally most document elements are now
1619
+ processed as macros.
1620
+ * Configuration file macro variables can be specified with default
1621
+ values (literals or other macro variables).
1622
+ * An attempt has been made to tighten up the vocabulary used to
1623
+ describe the AsciiDoc document syntax.
1624
+ * The term abstract has been replaced by the more general term
1625
+ preface and a new preface section introduced into article
1626
+ configuration files (replacing the synopsis sections).
1627
+ * Any section elements can now be put in the document preface
1628
+ (previous versions only allowed paragraphs).
1629
+ * AsciiDoc Blocks have been unified and their behavior can be user
1630
+ defined and parametrized.
1631
+ * An output inclusion allows an external file to be written directly
1632
+ to the backend output file.
1633
+ * A new CustomBlock has been added. Default behavior is to insert the
1634
+ enveloped AsciiDoc source lines directly into the output file.
1635
+ * A line break tag can be inserted by terminating a line with a +
1636
+ character (only really useful for HTML backends).
1637
+ * An fourth section level has been introduced.
1638
+ * The SidebarBlock delimiter line characters have been changed. The
1639
+ deprecated underline is still accepted.
1640
+ * Levels 2 and 3 title underline characters have been changed. The
1641
+ deprecated underlines are still accepted.
1642
+ * Lines with backend specific inline tags can be inserted into
1643
+ AsciiDoc source files.
1644
+ * Single words enveloped by underscores are no longer emphasized.
1645
+ This feature was deprecated as it is redundant (use single quotes
1646
+ instead) and was being applied to file names with underscores.
1647
+ * A -q quiet option has been added to suppress warning messages.
1648
+ * Badge images sourced locally.
1649
+ * Added author and author-mail meta tags to HTML configuration files.
1650
+ __________________________________________________________________
1651
+
1652
+ 49. Version 1.5 (2003-01-08)
1653
+
1654
+ * Implemented sidebar document elements.
1655
+ * Explicit checks for user specified configuration files and input
1656
+ file (rather than throwing exception).
1657
+ __________________________________________________________________
1658
+
1659
+ 50. Version 1.4 (2003-01-04)
1660
+
1661
+ * New configuration file options emphasizedwords and strongwords.
1662
+ These allow the definition of words that will always be emphasized
1663
+ or rendered in a strong font without inline formatting.
1664
+ * Document and section titles are no long subject to inline
1665
+ formatting.
1666
+ * Multiple configuration files can be overlaid in a single command.
1667
+ * Configuration file tags and options entries can now be overridden
1668
+ on an entry by entry basis (previously the entire section was
1669
+ overloaded).
1670
+ * Configuration file tags and options entries are now cached this has
1671
+ resulted in around 37% performance improvement over version 1.3.
1672
+ * Variable lists can now contain multiple terms per list item.
1673
+ * Placeholder paragraph eliminated from empty sections that contain
1674
+ subsections.
1675
+ * Added {asciidoc_version} substitution variable.
1676
+ * More documentation additions and tidy ups.
1677
+ __________________________________________________________________
1678
+
1679
+ 51. Version 1.3 (2003-01-01)
1680
+
1681
+ * A new strong text formatting convention has been implemented: Word
1682
+ phrases enclosed in pairs of single quote characters (acute
1683
+ accents) are rendered in a strong font (usually bold).
1684
+ * Paragraphs can now be followed immediately by Simple lists and
1685
+ Ordered lists without an intervening blank line.
1686
+ * A user specified configuration file (asciidoc(1) -f option)
1687
+ overlays the default configuration file rather than replacing it.
1688
+ Custom configuration files need only contain those sections that
1689
+ have been customized.
1690
+ * Comment Block delimiters have been relaxed slightly. They must
1691
+ start with three forward slashes /// but the remainder can contain
1692
+ any characters, this allows comments to be embedded in the
1693
+ delimiter line.
1694
+ * Leading non-digit characters preceding revision number are now
1695
+ ignored.
1696
+ * Set default indentsize [option] from 2 to documented default value
1697
+ of zero in HTML backend html-article.conf and html-manpage.conf
1698
+ files.
1699
+ * Fixed error that occurred when taking input from stdin without
1700
+ explicitly specifying a document type.
1701
+ * Restored file name and line number error message information.
1702
+ * Changed deprecated -t option to -d in asciidoc --help and usage
1703
+ command output.
1704
+ * CSS styles tweaking.
1705
+ * Code, configuration file and documentation tidy ups.
1706
+ __________________________________________________________________
1707
+
1708
+ 52. Version 1.2 (2002-12-28)
1709
+
1710
+ * Implemented include URL to allow file inclusion.
1711
+ * fileextension configuration file [option] renamed to more sensible
1712
+ outfilesuffix (fileextension still accepted by this version but
1713
+ will be dropped in future).
1714
+ * Improved error reporting.
1715
+ * CSS backends generate valid XHTML.
1716
+ * New css-embedded backend generates HTML with embedded stylesheets
1717
+ (use the css backend for linked stylesheets). The css-embedded
1718
+ backend output contains no linked images so the generated html
1719
+ files are completely self contained.
1720
+ * Bug fixes.
1721
+ __________________________________________________________________
1722
+
1723
+ 53. Version 1.1 (2002-12-03)
1724
+
1725
+ * Added css (cascading style sheets) backend
1726
+ * Implemented IndentedBlock document element.
1727
+ * Tabsize command-line option has been deprecated in favor of
1728
+ configuration file.
1729
+ * Default indent width changed to zero.
1730
+ * Added {localdate} and {localtime} substitution variables.
1731
+ * Added optional [options] configuration file section with
1732
+ fileextension, tabsize and indentsize options.
1733
+ * Implemented {authorinitials} substitution variable.
1734
+ * Added https link type.
1735
+ * Corrected [graphic] substitution from {title} to {caption} in
1736
+ linuxdoc-article.conf configuration file.
1737
+ * Fixed error that occurred when == title underline was used.
1738
+ __________________________________________________________________
1739
+
1740
+ 54. Version 1.0 (2002-11-25)
1741
+
1742
+ First AsciiDoc public release along with AsciiDoc web site
1743
+ ([44]http://www.methods.co.nz/asciidoc/) and SourceForge.net project
1744
+ registration ([45]https://sourceforge.net/projects/asciidoc/).
1745
+ __________________________________________________________________
1746
+
1747
+ Version 8.3.3
1748
+ Last updated 2009-01-02 12:59:07 NZDT
1749
+
1750
+ References
1751
+
1752
+ 1. http://www.methods.co.nz/asciidoc/INSTALL.html
1753
+ 2. http://www.methods.co.nz/asciidoc/newtables.html
1754
+ 3. http://www.methods.co.nz/asciidoc/newlists.html
1755
+ 4. http://www.methods.co.nz/asciidoc/userguide.html#X77
1756
+ 5. http://www.methods.co.nz/asciidoc/userguide.html#X76
1757
+ 6. http://www.methods.co.nz/asciidoc/latexmath.pdf
1758
+ 7. http://www.methods.co.nz/asciidoc/asciimathml.html
1759
+ 8. http://www.methods.co.nz/asciidoc/latexmathml.html
1760
+ 9. http://www.methods.co.nz/asciidoc/source-highlight-filter.html
1761
+ 10. https://sharesource.org/hg/asciidoc/
1762
+ 11. http://en.wikipedia.org/wiki/Data:_URI_scheme
1763
+ 12. http://www.methods.co.nz/asciidoc/faq.html
1764
+ 13. http://www.maths.nottingham.ac.uk/personal/drw/lm.html
1765
+ 14. http://www.methods.co.nz/asciidoc/asciimath.html
1766
+ 15. http://www.methods.co.nz/asciidoc/index.html
1767
+ 16. http://tpl.sourceforge.net/userguide.html
1768
+ 17. http://www.methods.co.nz/asciidoc/music-filter.html
1769
+ 18. http://lilypond.org/
1770
+ 19. http://abcnotation.org.uk/
1771
+ 20. mailto:srackham@gmail.com
1772
+ 21. mailto:jlm@ofb.net
1773
+ 22. mailto:m_pupil@yahoo.com.cn
1774
+ 23. http://open.comsultia.com/docbook2odf/
1775
+ 24. http://www1.chapman.edu/~jipsen/mathml/asciimath.html
1776
+ 25. http://www.methods.co.nz/asciidoc/asciimath.html
1777
+ 26. file://localhost/tmp/lynxXXXXydLULz/userguide.html#X50
1778
+ 27. file://localhost/tmp/lynxXXXXydLULz/userguide.html#X33
1779
+ 28. mailto:francis@daoine.org
1780
+ 29. file://localhost/tmp/lynxXXXXydLULz/userguide.html#X39
1781
+ 30. file://localhost/tmp/lynxXXXXydLULz/source-highlight-filter.html
1782
+ 31. mailto:trolocsis@gmail.com
1783
+ 32. mailto:srackham@gmail.com
1784
+ 33. file://localhost/tmp/lynxXXXXydLULz/userguide.html#X36
1785
+ 34. file://localhost/tmp/lynxXXXXydLULz/userguide.html#X33
1786
+ 35. mailto:viktor@rbg.informatik.tu-darmstadt.de
1787
+ 36. file://localhost/tmp/lynxXXXXydLULz/userguide.html#X23
1788
+ 37. mailto:david@dgreaves.com
1789
+ 38. mailto:stone@debian.org
1790
+ 39. mailto:stone@debian.org
1791
+ 40. mailto:srackham@gmail.com
1792
+ 41. http://jimmac.musichall.cz/ikony.php3
1793
+ 42. mailto:srackham@gmail.com
1794
+ 43. http://www.methods.co.nz/asciidoc/examples/website/
1795
+ 44. http://www.methods.co.nz/asciidoc/
1796
+ 45. https://sourceforge.net/projects/asciidoc/