mizuho 0.9.6

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