FooBarWidget-mizuho 0.9.0

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