1 | AsciiDoc ChangeLog |
---|
2 | ================== |
---|
3 | |
---|
4 | :website: http://www.methods.co.nz/asciidoc/ |
---|
5 | |
---|
6 | |
---|
7 | Version 8.6.8 (2012-07-17) |
---|
8 | -------------------------- |
---|
9 | .Release highlights |
---|
10 | Added full complement of styles to 'Open Blocks' and 'Normal |
---|
11 | Paragraphs' -- those with a minimalist bent could construct virtually |
---|
12 | any document using just Title, Normal Paragraph and Open Block |
---|
13 | syntaxes. |
---|
14 | |
---|
15 | .Other additions and changes |
---|
16 | - Increased default maximum include depth from 5 to 10. |
---|
17 | - Emit warning if maximum include depth is exceeded. |
---|
18 | - Suppress repeated console messages. |
---|
19 | - Music filter: removed '--beams=None' option from abc2ly invocation |
---|
20 | because it is broken on LilyPond 2.14 (Ubuntu 12.04). |
---|
21 | - Replaced obsolete '<tt>' tag with '<code>' in HTML backends. |
---|
22 | - Allow configuration attribute entries to create a new section |
---|
23 | (previously you could only modify existing sections). See: |
---|
24 | https://groups.google.com/group/asciidoc/browse_thread/thread/7be28e9714f249c7[discussion |
---|
25 | list]. |
---|
26 | - Documented `{wj}` (word-joiner) attribute and updated FAQ. See: |
---|
27 | https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf[discussion |
---|
28 | list]. |
---|
29 | - FAQ: Added 'How can I place a footnote immediately following quoted |
---|
30 | text?' See |
---|
31 | https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf[discussion |
---|
32 | list]. |
---|
33 | - Added Greek language configuration file. Contributed by Michael |
---|
34 | Dourmousoglou. See |
---|
35 | https://groups.google.com/group/asciidoc/browse_thread/thread/9e79d8494ef8d870[discussion |
---|
36 | list]. |
---|
37 | - FAQ: Added 'Using roles to select fonts for PDF'. Submitted by Lex |
---|
38 | Trotman and based on solution by Antonio Borneo. See: |
---|
39 | https://groups.google.com/group/asciidoc/browse_frm/thread/64b071bb21de9cf0[discussion |
---|
40 | list]. |
---|
41 | - Apply same monospaced font size to all monospaced text. |
---|
42 | - Changed '0' number padding to spaces in numbered GNU |
---|
43 | source-highlight outputs. |
---|
44 | - Allow 'highlight' source highlighter to use 'python' for Python |
---|
45 | `{language}` name. r1142: Update the AsciiDoc 'source' filter to |
---|
46 | allow the use of the 'highlight' source code highlighter. See |
---|
47 | https://groups.google.com/group/asciidoc/browse_frm/thread/e045c9986c71d72a[discussion |
---|
48 | list]. |
---|
49 | + |
---|
50 | NOTE: The 'pygments' attribute has been deprecated in favor of the new |
---|
51 | 'source-highlighter' attribute. |
---|
52 | |
---|
53 | - Vim syntax highlighter: Don't confuse trailing open block delimiter |
---|
54 | with section underline. |
---|
55 | - Added 'skip' option to paragraphs (c.f. Delimited Block 'skip' |
---|
56 | option). |
---|
57 | |
---|
58 | .Bug fixes |
---|
59 | - *FIXED*: latex, music and graphviz filters: When the filter output |
---|
60 | image is data-uri encoded write it to the indir (instead of the |
---|
61 | outdir) so that encoder can find it. See |
---|
62 | https://groups.google.com/group/asciidoc/browse_thread/thread/f5174f450a61f14b[discussion |
---|
63 | list]. |
---|
64 | - *FIXED*: Escape the ']' character inside inline macros. See |
---|
65 | https://groups.google.com/group/asciidoc/browse_thread/thread/db3b734a6931cb74[discussion |
---|
66 | list]. |
---|
67 | - *FIXED*: source highlighter filter: Pass 'role' attribute to HTML |
---|
68 | backends. |
---|
69 | - *FIXED*: source highlight filter: docbook backend: 'role' attribute |
---|
70 | was not passed to listings without a title. Patch submitted by Lex |
---|
71 | Trotman. See |
---|
72 | https://groups.google.com/group/asciidoc/browse_thread/thread/13c9ee97930342b3[discussion |
---|
73 | list]. |
---|
74 | - *FIXED*: music2png.py: 'FOPException: Raster ByteInterleavedRaster' |
---|
75 | error (FOP 1.0, ImageMagick 6.6.9-7). |
---|
76 | |
---|
77 | |
---|
78 | |
---|
79 | Version 8.6.7 (2012-03-17) |
---|
80 | -------------------------- |
---|
81 | .Release highlights |
---|
82 | No major enhancements but quite a few bug fixes which, among other |
---|
83 | things, fixes Jython compatibility and improves Windows compatibility. |
---|
84 | |
---|
85 | .All additions and changes |
---|
86 | - Vim syntax highlighter: highlight entity refs in macro arguments. |
---|
87 | - Added files with `.asciidoc` extension to Vim file type detection. |
---|
88 | http://groups.google.com/group/asciidoc/browse_thread/thread/a9762e21ec0cc244/5d3a4ebf20e6847e[Patch] |
---|
89 | submitted by Dag Wiers. |
---|
90 | - Added 'replacement3' substitution to enable |
---|
91 | http://groups.google.com/group/asciidoc/browse_thread/thread/843d7d3d671006fb/25628e14c829db3f[ODT |
---|
92 | whitespace processing]. |
---|
93 | - Added 'unbreakable' option to XHTML and HTML 5 backends. |
---|
94 | - Implemented toc::[] block macro and 'toc-placement' attribute for |
---|
95 | HTML backends to allow the Table of Contents placement to be set |
---|
96 | manually by the author. |
---|
97 | - Added FAQs: 'How can I control page breaks when printing HTML |
---|
98 | outputs?' and 'Is it possible to reposition the Table of Contents |
---|
99 | in HTML outputs?'. |
---|
100 | - Added `--backend` and `--backend-opts` options to the 'a2x' command |
---|
101 | to allow 'a2x' to use backend plugin code extensions. |
---|
102 | http://groups.google.com/group/asciidoc/browse_thread/thread/b8e93740b7cd0e1d/b5e0b83fe37ae31a[Patch] |
---|
103 | submitted by Lex Trotman. |
---|
104 | - Added |
---|
105 | http://groups.google.com/group/asciidoc/browse_thread/thread/3d06b0105dfbb780/8c60eb7a62f522e4[args |
---|
106 | block attribute] to source highlight blocks to allow arbitrary |
---|
107 | parameters to be passed to the source highlighters. |
---|
108 | - If the 'ascii-ids' attribute is defined then non-ascii characters in |
---|
109 | auto-generated IDs |
---|
110 | http://groups.google.com/group/asciidoc/browse_thread/thread/33e99b78e2472122[are |
---|
111 | replaced] by their nearest ascii equivalents (to work around DocBook |
---|
112 | processor limitations). |
---|
113 | - Added global 'blockname' attribute which is dynamically updated to |
---|
114 | identify the current block. See |
---|
115 | http://groups.google.com/group/asciidoc/browse_thread/thread/8200e29815c40f72[discussion |
---|
116 | list]. |
---|
117 | - 'xhtml11', 'html5' backends: Include book part TOC entries for |
---|
118 | multi-part books. Patch submitted by Loïc Paillotin. |
---|
119 | - Removed code filter example from the AsciiDoc User Guide so that |
---|
120 | backends implemented as external plugins can compile the manual. See |
---|
121 | http://groups.google.com/group/asciidoc/browse_thread/thread/849e5ea91f43adf2[discussion |
---|
122 | list]. |
---|
123 | - If the delimited block 'skip' option is set then do not consume |
---|
124 | block title and attributes. This makes it possible for the comment |
---|
125 | delimited blocks to use an attribute list (previously the comment |
---|
126 | delimited block was hardwired to skip preceding attributes and |
---|
127 | titles). See |
---|
128 | http://groups.google.com/group/asciidoc/browse_thread/thread/e92a75abcc382701[discussion |
---|
129 | list]. |
---|
130 | - Added `backend-confdir` intrinsic attribute. |
---|
131 | |
---|
132 | .Bug fixes |
---|
133 | - *FIXED*: slidy backend: broken 'stylesheet' attribute. |
---|
134 | http://groups.google.com/group/asciidoc/browse_thread/thread/58d0843ae4345afd[Patch] |
---|
135 | submitted by Micheal Hackett. |
---|
136 | - *FIXED*: Restored |
---|
137 | http://groups.google.com/group/asciidoc/browse_thread/thread/b0e69e393b6f9f20/47a2c7586f9e40c6?lnk=gst&q=themes+tarball#47a2c7586f9e40c6[missing |
---|
138 | themes] to zip file distribution archive. |
---|
139 | - *FIXED*: Grammatical error in error messages. |
---|
140 | http://groups.google.com/group/asciidoc/browse_thread/thread/b9d705c6b6b39f59/1e120483dafca109[Patch] |
---|
141 | submitted by Dag Wieers. |
---|
142 | - *FIXED*: Use configured normal substitution in preference to the |
---|
143 | default one. |
---|
144 | - *FIXED*: The 'eval' block macro would execute multiple times if it |
---|
145 | evaluated to 'None'. |
---|
146 | - *FIXED*: Duplicated entries in TOC of large document. |
---|
147 | http://groups.google.com/group/asciidoc/browse_thread/thread/103445ab9d95cb0c[Patch] |
---|
148 | submitted by Sebastien Helleu. |
---|
149 | - *FIXED*: Python 2.4 backward |
---|
150 | http://code.google.com/p/asciidoc/issues/detail?id=9[incompatibility]. |
---|
151 | - *FIXED*: 8.6.6 regression broke Jython compatibility. See |
---|
152 | http://groups.google.com/group/asciidoc/browse_thread/thread/4608b77ec289f6c4[discussion |
---|
153 | list]. |
---|
154 | - *FIXED*: Leaky file handles in a2x and music and latex filters which |
---|
155 | created incompatibility problems for Jython. |
---|
156 | - *FIXED*: All Python filters are executed with the same Python |
---|
157 | interpreter that executes the asciidoc parent (previously filters |
---|
158 | were hardwired to execute the 'python' interpreter). This prevents |
---|
159 | http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b/3af3b4e57b827c78?lnk=gst&q=archlinux#3af3b4e57b827c78[Python |
---|
160 | mix-ups]. |
---|
161 | - *FIXED*: Microsoft Windows shelled command-line truncation that |
---|
162 | caused shelled commands to fail e.g. the 'data-uri' attribute |
---|
163 | failure. |
---|
164 | |
---|
165 | |
---|
166 | Version 8.6.6 (2011-09-04) |
---|
167 | -------------------------- |
---|
168 | .Release highlights |
---|
169 | - The AsciiDoc plugin architecture has been enhanced, unified and |
---|
170 | extended: |
---|
171 | * Plugin commands have been added to the asciidoc(1) `--backend` |
---|
172 | option. |
---|
173 | * An asciidoc(1) `--theme` option has been implemented to specify a |
---|
174 | theme and to manage theme plugins. |
---|
175 | * A plugin 'build' command (for creating plugins) added. |
---|
176 | * 'build', 'install', 'list' and 'remove' plugin commands are all |
---|
177 | recognized by asciidoc(1) `--backend`, `--filter` and `--theme` |
---|
178 | options. |
---|
179 | - A security update by Kenny MacDermid removes the use of `eval()` on |
---|
180 | untrusted input (to disallow code malicious execution). |
---|
181 | |
---|
182 | .All additions and changes |
---|
183 | - 'xhtml11', 'html5': Made verse and quote block text darker to print |
---|
184 | legibly in Google Chrome browser. |
---|
185 | - Added plugin 'build' command for plugin file creation. |
---|
186 | - Merged `--help plugins` back to `--help manpage` so it matches the |
---|
187 | asciidoc(1) manpage. |
---|
188 | - The `--filter` command-line option can specify the name of filters |
---|
189 | that will be unconditionally loaded. |
---|
190 | - If a filter directory contains a file named `__noautoload__` then |
---|
191 | the filter is not automatically loaded (you can used the `--filter` |
---|
192 | command-line option to override this behavior). |
---|
193 | - tests: Add Italian language tests. Patch submitted by Simon |
---|
194 | Ruderich. See: |
---|
195 | http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a |
---|
196 | - tests: Add tests for localized man pages. Patch submitted by Simon |
---|
197 | Ruderich. See: |
---|
198 | http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a |
---|
199 | - If the section name is prefixed with a '+' character then the |
---|
200 | section contents is appended to the contents of an already existing |
---|
201 | same-named section (the default behavior is to replace the the |
---|
202 | section). |
---|
203 | - If a configuration file section named 'docinfo' is loaded then it |
---|
204 | will be included in the document header. Typically the 'docinfo' |
---|
205 | section name will be prefixed with a '+' character so that it is |
---|
206 | appended to (rather than replace) other 'docinfo' sections. |
---|
207 | - Added `{sp}` intrinsic attribute for single space character. See |
---|
208 | http://groups.google.com/group/asciidoc/browse_thread/thread/a839aa01db0765d2 |
---|
209 | - Fixed TOC and footnotes generator. Patch submitted by Will. See |
---|
210 | http://groups.google.com/group/asciidoc/browse_thread/thread/734ac5afed736987 |
---|
211 | - The `asciidoc-confdir` attribute is set to the asciidoc executable |
---|
212 | directory if it contains global configuration files i.e. a local |
---|
213 | asciidoc installation. |
---|
214 | - asciidoc now throws an error instead of just a warning of the |
---|
215 | backend configuration file is not found. |
---|
216 | - latex filter: write MD5 file after successful PNG file generation. |
---|
217 | Always delete temp files irrespective of outcome. |
---|
218 | - Added truecolor option to LaTeX filter. Patch submitted by Michel |
---|
219 | KrÀmer. See: |
---|
220 | http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 |
---|
221 | - Unit test for table column specifiers with merged cells. Patch |
---|
222 | submitted by Simon Ruderich. See: |
---|
223 | http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a |
---|
224 | - Added verbose message for `ifeval::[]` macro evaluation. |
---|
225 | - Added test case for `ifeval::[]` evaluation. |
---|
226 | - Security update to remove the use of `eval()` on untrusted input (to |
---|
227 | disallow code malicious execution). Patch submitted by Kenny |
---|
228 | MacDermid. |
---|
229 | - Changed web site layout from table to CSS based. See |
---|
230 | http://groups.google.com/group/asciidoc/browse_thread/thread/ec8e8481eb0e27b0/d1c035092b5bb7a4?lnk=gst&q=caption+option#d1c035092b5bb7a4 |
---|
231 | - a2x: Pass `--format` option value to asciidoc as 'a2x-format' |
---|
232 | attribute. Patch submitted by Lex Trotman |
---|
233 | (http://groups.google.com/group/asciidoc/browse_thread/thread/3e177b84bc133ca9/659796dfadad30ea?lnk=gst&q=a2x+format#659796dfadad30ea). |
---|
234 | - Added two FAQs submitted by Lex Trotman. See: |
---|
235 | http://groups.google.com/group/asciidoc/browse_thread/thread/16d3fb9672a408e7 |
---|
236 | - html5,xhtml11: Implemented themes directory structure. |
---|
237 | - html5,xhtml11: Implemented asciidoc `--theme` management option |
---|
238 | (install, list, build and remove commands). |
---|
239 | - html5,xhtml11: A theme can now optionally include a JavaScript file |
---|
240 | `<theme>.js` |
---|
241 | - html5,xhtml11: If the 'data-uri' attribute is defined then icons |
---|
242 | from the theme icons directory (if they exist) will be embedded in |
---|
243 | the generated document. |
---|
244 | - Added optional 'warnings' argument to include macros. |
---|
245 | - The asciidoc `--verbose` option now prints file inclusion messages. |
---|
246 | - xhtml11, html5: Remove necessity for separate manpage CSS files. |
---|
247 | - Added 'css-signature' attribute to tests. |
---|
248 | - Add 'css-signature' attribute to set a CSS signature for the |
---|
249 | document. Patch submitted by Peg Russell, see: |
---|
250 | http://groups.google.com/group/asciidoc/browse_thread/thread/bacbf8aeb8ad6a3a |
---|
251 | - White background for toc2 TOC viewport so that horizontally scrolled |
---|
252 | content does not obscure the the TOC. Patch submitted by Lionel |
---|
253 | Orry, see: http://code.google.com/p/asciidoc/issues/detail?id=8 |
---|
254 | |
---|
255 | .Bug fixes |
---|
256 | - *FIXED*: Plugin install command: Delete backend directory is install |
---|
257 | fails. |
---|
258 | - *FIXED*: Plugin install command: Fixed bug extracting binary files |
---|
259 | on Windows (reported by Jean-Michel Inglebert). |
---|
260 | - *FIXED*: tests: Skip blank sections in testasciidoc.conf test |
---|
261 | configuration file instead of throwing an exception (reported by |
---|
262 | Jean-Michel Inglebert). |
---|
263 | - *FIXED*: If a plugin Zip file does not contain file permissions |
---|
264 | (probably because it was created under Windows) then install it |
---|
265 | using the default permissions. |
---|
266 | - *FIXED*: Fixed missing quote in preceding LaTeX filter patch. Fix |
---|
267 | submitted by Simon Ruderich. See: |
---|
268 | http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 |
---|
269 | - *FIXED*: Some path attributes were processed as escaped Python |
---|
270 | strings which could result in corrupted path names with backslash |
---|
271 | separated Windows path names. Reported by Will. See: |
---|
272 | http://groups.google.com/group/asciidoc/browse_thread/thread/e8f3938bcb4c8bb4/44d13113a35738ef |
---|
273 | - *FIXED*: Vertically spanned table cells resulted in incorrect column |
---|
274 | styles being applied to some cells. Reported by Will: |
---|
275 | http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a/9afc4559d51e1dbd |
---|
276 | - *FIXED*: LaTeX backend: fixed bad escapes. Patch submitted by Mark |
---|
277 | McCurry: |
---|
278 | http://groups.google.com/group/asciidoc/browse_thread/thread/8c111f1046b33691/158a944cf4d5ff0d?lnk=gst&q=latex+escapes#158a944cf4d5ff0d |
---|
279 | - *FIXED*: When using slidy backend, display of characters with |
---|
280 | accents is wrong because of 'meta http-equiv' line missing. Reported |
---|
281 | by Fabrice Flore-Thebault. See: |
---|
282 | http://groups.google.com/group/asciidoc/browse_thread/thread/eaf25f21d1da180a |
---|
283 | |
---|
284 | |
---|
285 | Version 8.6.5 (2011-05-20) |
---|
286 | -------------------------- |
---|
287 | .Release highlights |
---|
288 | - The addition of an 'html5' backend to generate HTML 5 output. Apart |
---|
289 | from the inclusion of 'audio' and 'video' block macros the 'html5' |
---|
290 | backend is functionally identical to the 'xhtml11' backend. |
---|
291 | |
---|
292 | - A new 'flask' theme for 'xhtml11' and 'html5' backends inspired by |
---|
293 | the http://flask.pocoo.org/docs/[Flask website] styling (see 'toc2' |
---|
294 | example in the next item below). |
---|
295 | |
---|
296 | - The new 'toc2' attribute generates a table of contents in |
---|
297 | the left hand margin ('xhtml11' and 'html5' backends). |
---|
298 | link:article-html5-toc2.html[This example] was generated using |
---|
299 | the following command: |
---|
300 | |
---|
301 | asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt |
---|
302 | |
---|
303 | - `a2x(1)` now has a flexible mechanism for copying arbitrary |
---|
304 | resource files to HTML based outputs -- this is very handy for |
---|
305 | generating EPUB files with embedded fonts and other resources. |
---|
306 | |
---|
307 | * The `a2x(1)` `--resource` option can be used to inject any file |
---|
308 | into EPUB output documents e.g. CSS resources such as fonts and |
---|
309 | background images. |
---|
310 | * Explicitly specified resources are added to the EPUB OPF manifest |
---|
311 | automatically. |
---|
312 | * You can explicitly specify file extension MIME types. |
---|
313 | * The enhanced resource processing works around a couple of DocBook |
---|
314 | XSL bugs (see link:epub-notes.html[EPUB Notes]). |
---|
315 | |
---|
316 | .All additions and changes |
---|
317 | - A new 'flask' theme for 'xhtml11' and 'html5' backends. A shameless |
---|
318 | knock-off of the http://flask.pocoo.org/docs/[Flask website] |
---|
319 | styling. |
---|
320 | - Added HTML 5 article with 'toc2' table of contents to the example on |
---|
321 | the AsciiDoc website home page. |
---|
322 | - Added 'filters' and 'topics' help topics. Fixed documentation |
---|
323 | errors in help text. Patch submitted by Lionel Orry, see: |
---|
324 | http://groups.google.com/group/asciidoc/browse_thread/thread/9da9d48a6461ff14 |
---|
325 | - Pass parent configuration files, command-line attributes and header |
---|
326 | attributes to table asciidoc filters. Based on patch submitted by |
---|
327 | Simon Ruderich, see: |
---|
328 | http://groups.google.com/group/asciidoc/browse_thread/thread/5c792cbb395b753b |
---|
329 | - Allow a 'title' attribute entry in the document header so that HTML |
---|
330 | backends can set the 'title' element separately from the displayed |
---|
331 | document title (the 'doctitle' attribute). |
---|
332 | - Pass 'lang' attribute to 'asciidoc' table style filter. Patch |
---|
333 | submitted by Simon Ruderich, see: |
---|
334 | http://groups.google.com/group/asciidoc/browse_thread/thread/e2100b7cb29283ce |
---|
335 | - xhtml11,html5: Added 'toc2' attribute which generates a scrollable |
---|
336 | table of contents in the left hand margin. Based on customized CSS |
---|
337 | written by Suraj Kurapati, see |
---|
338 | http://groups.google.com/group/asciidoc/browse_thread/thread/c5e30ee5555877f5 |
---|
339 | - Added 'asciidoc-confdir' intrinsic attribute which expands to the |
---|
340 | global conf directory. |
---|
341 | - Documented that you can specify multiple CSS files with the a2x(1) |
---|
342 | `--stylesheet` command option. See: |
---|
343 | http://groups.google.com/group/asciidoc/browse_thread/thread/baf3218551d05a05 |
---|
344 | - Improved xhtml11 backend's table of contents generation latency. |
---|
345 | Patch submitted by Hongli Lai. See: |
---|
346 | http://groups.google.com/group/asciidoc/browse_thread/thread/5a7fe64fbfd65ad |
---|
347 | - Added html5 backend. |
---|
348 | - For consistency converted all DOS formatted configuration and text |
---|
349 | files to UNIX format. |
---|
350 | - html4: Added ability to use 'role' attribute with most block |
---|
351 | elements. Patch contributed by Simon Ruderich. See |
---|
352 | http://groups.google.com/group/asciidoc/browse_thread/thread/5620ba634fdb030a |
---|
353 | - Added Dutch language configuration file and accompanying test file |
---|
354 | (contributed by Dag Wieers, see |
---|
355 | http://groups.google.com/group/asciidoc/browse_thread/thread/f969b9ce987d7f5d). |
---|
356 | - Configuration files are loaded in two passes when the -e |
---|
357 | command-line option is used (the same behavior as when the -e option |
---|
358 | is not used). Patch submitted by haad. See |
---|
359 | http://groups.google.com/group/asciidoc/browse_thread/thread/cd0f47495fd04181 |
---|
360 | and |
---|
361 | http://code.google.com/p/asciidoc/issues/detail?id=6&q=label%3APriority-Medium |
---|
362 | - Documented how to include embedded fonts in an EPUB document. |
---|
363 | - a2x: Added `.<ext>=<mimetype>` resource specifier syntax. |
---|
364 | - a2x: Enable admonition icons in example EPUBs. |
---|
365 | - a2x: allow environment variables and tilde home directories in |
---|
366 | resource manifest files. |
---|
367 | - a2x: don't process non-existent resource directories. |
---|
368 | - a2x: assume resource option is a directory if the name ends with a |
---|
369 | directory separator. |
---|
370 | - a2x: Added a new syntax to the `--resource` option specifier which |
---|
371 | allows the destination path to be specified. |
---|
372 | - a2x: Copy resources referenced in the OPF and resources referenced |
---|
373 | by the generated HTML (in theory DocBook XSL should ensure they are |
---|
374 | identical but this is not always the case e.g. |
---|
375 | http://sourceforge.net/tracker/?func=detail&atid=373747&aid=2854075&group_id=21935). |
---|
376 | - Drop border from callout list image links. |
---|
377 | - html4: Moved manpage NAME section out of header so that the name |
---|
378 | section is rendered when the asciidoc(1) `--no-header-footer` option |
---|
379 | is specified (so that manpages processed blogpost include the NAME |
---|
380 | section). |
---|
381 | - Vim syntax highlighter: TODO markers now appear in list items and |
---|
382 | literal paragraphs and blocks. |
---|
383 | - Constrained quotes can now be bounded on the left by a } character. |
---|
384 | See: |
---|
385 | http://groups.google.com/group/asciidoc/browse_thread/thread/b24cc3362f35b801 |
---|
386 | - Added text-decoration roles (underline, overline, line-through, |
---|
387 | blink) for xhtml11 and html5 outputs. |
---|
388 | |
---|
389 | .Bug fixes |
---|
390 | - *FIXED*: epubcheck 1.1 previously issued a warning for files not |
---|
391 | registered in the manifest (epubcheck 1.0.5 did not). This resulted |
---|
392 | in a problem compiling the adventures-of-sherlock-holmes.txt example |
---|
393 | (the `underline.png` resource was not in the manifest). |
---|
394 | |
---|
395 | |
---|
396 | Version 8.6.4 (2011-02-20) |
---|
397 | -------------------------- |
---|
398 | .Additions and changes |
---|
399 | - Added text foreground and background color along with text size CSS |
---|
400 | styles for XHTML outputs, see {website}userguide.html#X96[]. |
---|
401 | - Vim syntax highlighter: highlight macros that start with an |
---|
402 | attribute reference (a common idiom). |
---|
403 | - Vim syntax highlighter: highlight attribute references in macro |
---|
404 | attribute lists. |
---|
405 | - Attribute entries can be used to set configuration markup templates. |
---|
406 | - Double-width East Asian characters in titles now correctly match the |
---|
407 | title underline widths. Submitted by Changjian Gao (see |
---|
408 | http://groups.google.com/group/asciidoc/browse_thread/thread/77f28b0dfe60d262). |
---|
409 | - Implemented {website}manpage.html[asciidoc(1)] filter commands, see: |
---|
410 | http://groups.google.com/group/asciidoc/browse_thread/thread/40c64cd33ee1905c |
---|
411 | - User's home directory now calculated in a platform independent |
---|
412 | manner. |
---|
413 | - Added double-quote characters to French language file. Patch |
---|
414 | contributed Yves-Alexis Perez, see: |
---|
415 | http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 |
---|
416 | - Vim Syntax highlighter: Highlight closing OpenBlocks which |
---|
417 | immediately follow a literal paragraph. |
---|
418 | - Changed UNIX `/dev/null` to OS independent `os.devnull` in filters |
---|
419 | code. Suggested by Henrik Maier: |
---|
420 | http://groups.google.com/group/asciidoc/browse_thread/thread/5ac8e8ea895147e9 |
---|
421 | - Vim syntax highlighter: Single and double quoted text now highlights |
---|
422 | correctly when preceded by an attributes list. |
---|
423 | - Added Ukrainian language file (`lang-uk.conf`). Added double-quote |
---|
424 | characters to Russian language file.conf). Patches contributed by |
---|
425 | Lavruschenko Oleksandr, see |
---|
426 | http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 |
---|
427 | - Single and double quote characters are now set using the `{lsquo}`, |
---|
428 | `{rsquo}`, `{ldquo}` and `{rdquo}` attributes. This makes is easy to |
---|
429 | customise language specific quotes. See: |
---|
430 | http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 |
---|
431 | - Implemented 'conf-files' attribute to allow configuration files to |
---|
432 | be specified in the source document. Suggested by Lex Trotman, see: |
---|
433 | http://groups.google.com/group/asciidoc/browse_thread/thread/b11066a828ab45b9 |
---|
434 | |
---|
435 | .Bug fixes |
---|
436 | - *FIXED*: Auto-generated section title ids are now Unicode aware. |
---|
437 | - *FIXED*: Setting 'quotes' configuration entries using document |
---|
438 | attribute entries failed if the attribute entry was not in the |
---|
439 | document header. See: |
---|
440 | http://groups.google.com/group/asciidoc/browse_thread/thread/a1dd0562dee8b939 |
---|
441 | - *FIXED*: If the input and output file names were different then the |
---|
442 | output file name was incorrectly used to synthesize 'docinfo' file |
---|
443 | names. Reported by Christian Zuckschwerdt. |
---|
444 | - *FIXED*: An error can occur when more than one consecutive quotes |
---|
445 | are defined as a blank string. Reported by Peggy Russell. |
---|
446 | - *FIXED*: Encoding error in automatically generated author initials. |
---|
447 | Patch submitted by Xin Wang. See: |
---|
448 | http://groups.google.com/group/asciidoc/browse_thread/thread/f44615dca0b834e9 |
---|
449 | |
---|
450 | |
---|
451 | Version 8.6.3 (2010-11-14) |
---|
452 | -------------------------- |
---|
453 | .Additions and changes |
---|
454 | - Added and 'unbreakable' option to bulleted and numbered lists |
---|
455 | (thanks to Henrik Maier for this patch). |
---|
456 | - Added `ifeval::[]` system macro (thanks to Henrik Maier for |
---|
457 | suggesting this feature). |
---|
458 | - The image 'scale' attribute sets the DocBook 'imagedata' element |
---|
459 | 'scale' attribute. Patch submitted by Henrik Maier. |
---|
460 | - DocBook 'preface', 'colophon' and 'dedication' style section titles |
---|
461 | now work. Based on patch submitted by Henrik Maier. |
---|
462 | - 'a2x': Do not inject xsltproc parameters if they were specified on |
---|
463 | the command-line (parameter double-ups generate xsltproc 'Global |
---|
464 | parameter already defined' errors). |
---|
465 | - 'a2x': Refactored xsltproc parameter injection. |
---|
466 | - 'a2x': articles chunked at section level by default. |
---|
467 | - 'attributes', 'titles' and 'specialcharacters' sections are now read |
---|
468 | from the local `asciidoc.conf` file before the header is parsed. |
---|
469 | This fixes a regression problem. See |
---|
470 | http://groups.google.com/group/asciidoc/browse_thread/thread/1b3f88f1f8118ab3 |
---|
471 | - Document header attributes take precedence over configuration file |
---|
472 | attributes. |
---|
473 | - Refactored 'music', 'graphviz' and 'latex' filter configurations. |
---|
474 | - Refactored source filter configuration and added literal paragraph |
---|
475 | source style. |
---|
476 | - Separated paragraph styles from paragraph syntax -- any style can be |
---|
477 | applied to any syntax. |
---|
478 | - Added 'listing' and 'quote' paragraph styles. |
---|
479 | - Renamed paragraph 'default' style to 'normal'. |
---|
480 | - Updated `--help` option text. |
---|
481 | - 'a2x': The `asciidoc_opts`, `dblatex_opts`, `fop_opts` and |
---|
482 | `xsltproc_opts` command-line options can be specified multiple |
---|
483 | times. This makes embedding multiple 'a2x' options in document |
---|
484 | headers easier to manage and less error prone. |
---|
485 | - Added ASCIIMathML and LaTeXMathML support to slidy backend. |
---|
486 | - Pass the 'encoding' attribute to the Pygments source highlight |
---|
487 | filter command. |
---|
488 | - 'a2x': HTML Help `.hhk` file named after AsciiDoc source file. |
---|
489 | - 'a2x': Added `--xsl-file` option to allow custom XSL stylesheets to |
---|
490 | be specified. |
---|
491 | - Make builds the man pages. Patch submitted by Sebastian Pipping. See |
---|
492 | http://groups.google.com/group/asciidoc/browse_thread/thread/c21c2902c29bae64 |
---|
493 | |
---|
494 | .Bug fixes |
---|
495 | - *FIXED*: Sometimes double backquotes were misinterpreted as inline |
---|
496 | literal macros. See: |
---|
497 | http://groups.google.com/group/asciidoc/browse_thread/thread/f510ea82a88aaee8 |
---|
498 | - *FIXED*: Regression in 8.6.2: command-line attributes were not |
---|
499 | available to the global asciidoc.conf. |
---|
500 | - *FIXED*: Postponed document title substitutions until backend conf |
---|
501 | files have been loaded (8.6.2 regression). See |
---|
502 | http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 |
---|
503 | - *FIXED*: The XSL Stylesheets customizations were preventing chapter |
---|
504 | and section level TOCs from being generated when using XSL |
---|
505 | Stylesheets via 'a2x'. See |
---|
506 | http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 |
---|
507 | - *FIXED*: ``UnicodeDecodeError: \'ascii' codec can't decode byte'' |
---|
508 | error. This error is due to a limitation in the Python HTMLParser |
---|
509 | module, see: http://bugs.python.org/issue3932 |
---|
510 | - *FIXED*: Broken `--no-conf` option (8.6.2 regression). |
---|
511 | - *FIXED*: Regression in 8.6.2: configuration attribute entries set in |
---|
512 | the document header may cause a 'FAILED: incomplete configuration |
---|
513 | files' error. |
---|
514 | - *FIXED*: 'html4': corrected self closed meta tags. |
---|
515 | - *FIXED*: 'a2x' regression in 8.6.2: HTML Help `.hhp` file name had |
---|
516 | reverted to default name instead of the AsciiDoc source file name. |
---|
517 | See: |
---|
518 | http://groups.google.com/group/asciidoc/browse_thread/thread/dedc961b23e9ac56 |
---|
519 | - *FIXED*: Attributes in man page title caused it to be dropped |
---|
520 | resulting in invalid DocBook output. |
---|
521 | - *FIXED*: `make uninstall` now deletes the `asciidoc.1` and `a2x.1` |
---|
522 | man pages. |
---|
523 | |
---|
524 | |
---|
525 | Version 8.6.2 (2010-10-03) |
---|
526 | -------------------------- |
---|
527 | .Additions and changes |
---|
528 | - 'docbook45': Enclosed bibliographic lists in a 'bibliodiv' -- you |
---|
529 | can now include block titles with bibliographic lists. |
---|
530 | - Added optional 'keywords', 'description' and 'title' document header |
---|
531 | meta-data attributes to HTML backends for SEO. |
---|
532 | - AttributeEntry values can span multiple lines with a ' +' line |
---|
533 | continuation. |
---|
534 | - Added 'slidy' backend (based on Phillip Lord's slidy backend |
---|
535 | https://phillordbio-asciidoc-fixes.googlecode.com/hg/). |
---|
536 | - Implemented 'OpenBlock' 'partintro' style for book part |
---|
537 | introductions. |
---|
538 | - Comment lines substitute special characters only. |
---|
539 | - Backend specific global configuration files (all except |
---|
540 | `asciidoc.conf`) are loaded *after* the header has been parsed -- |
---|
541 | virtually any attribute can now be specified in the document header. |
---|
542 | - 'xhtml11': Volnitsky theme: allow bulleted lists to have intervening |
---|
543 | children. |
---|
544 | - 'xhtml11': refactored CSS font-family rules to start of file. |
---|
545 | - 'xhtml11': list bullets colored gray. |
---|
546 | - 'ifdef' and 'ifndef' system block macros accept multiple attribute |
---|
547 | names: multiple names separated by commas are 'ored'; multiple |
---|
548 | attribute names separated by pluses are 'anded'. |
---|
549 | - 'xhtml11': Volnitsky theme: set max-width on labeled lists. |
---|
550 | - Vim syntax highlighter: Entities inside quoted text are now |
---|
551 | highlighted. |
---|
552 | - Added 'role' and 'id' attributes to HTML outputs generated by |
---|
553 | 'OpenBlocks'. |
---|
554 | - Allow floating titles to generate 'h1' (level 0) titles in HTML |
---|
555 | outputs. |
---|
556 | - Added a 'start' attribute to numbered lists to set the start number. |
---|
557 | See: |
---|
558 | http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5 |
---|
559 | - Added two more docinfo attributes 'docinfo1' and 'docinfo2' to allow |
---|
560 | and control inclusion of a shared docinfo file. See |
---|
561 | http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24 |
---|
562 | - Vim syntax highlighter highlights multi-name conditional attributes. |
---|
563 | - LaTeX backend patch submitted by Andreas Hermann Braml (see |
---|
564 | http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5). |
---|
565 | - Implemented 'backend aliases'; renamed `docbook.conf` to |
---|
566 | `docbook45.conf` and aliased 'docbook45' backend to 'docbook'; |
---|
567 | aliased 'xhtml11' to 'html'. |
---|
568 | |
---|
569 | .Bug fixes |
---|
570 | - *FIXED*: Filter commands located in filter directories local to the |
---|
571 | source document that where not in the search 'PATH' where not found. |
---|
572 | - *FIXED*: Volnitsky theme: Verseblock font set normal instead of |
---|
573 | monospaced. |
---|
574 | - *FIXED*: 'xhtml11': Callout icons were not rendered as Data URIs |
---|
575 | when 'icons' and 'data-uri' attributes were specified. |
---|
576 | - *FIXED*: Long standing bug: nested include macros did not restore |
---|
577 | the parent document 'infile' and 'indir' attributes. See: |
---|
578 | http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7 |
---|
579 | - *FIXED*: 'html4': set preamble ID anchor. |
---|
580 | - *FIXED*: 'xhtml11': dropped unusable 'id' and 'role' attributes from |
---|
581 | preamble template. |
---|
582 | - *FIXED*: Bug in multi-name conditional attributes e.g. `{x,y#}` |
---|
583 | fails if x or y is undefined. |
---|
584 | - *FIXED*: latex filter not being installed by Makefile. Thanks to |
---|
585 | Grant Edwards for this patch. See |
---|
586 | http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8 |
---|
587 | - *FIXED*: 'a2x': Long-standing bug in a2x which always passes |
---|
588 | `--string-param navig.graphics 0` to 'xsltproc', regardless of |
---|
589 | whether icons are enabled or not. Reported by Michael Wild: |
---|
590 | http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58 |
---|
591 | |
---|
592 | |
---|
593 | Version 8.6.1 (2010-08-22) |
---|
594 | -------------------------- |
---|
595 | .Additions and changes |
---|
596 | - 'a2x': `--resource-dir` option renamed to `--resource`. |
---|
597 | - 'a2x': `--resource` option accepts both file and directory names. |
---|
598 | - 'a2x': Added `-m,--resource-manifest` option. |
---|
599 | - Added Vim syntax highlighting for quote attribute lists. |
---|
600 | - Load 'asciidoc.conf' from all configuration directories before any |
---|
601 | other configuration files. This ensures that attributes used for |
---|
602 | conditional inclusion are set before backend configuration files are |
---|
603 | processed. Previously if you wanted to control global conf file |
---|
604 | inclusion your only choice was to modify the global 'asciidoc.conf' |
---|
605 | file. |
---|
606 | - AsciiDoc 'Quote element' attributes have been simplified and |
---|
607 | generalized -- positional color and size attributes and named 'role' |
---|
608 | attribute have been replaced by a single positional attribute. |
---|
609 | |
---|
610 | .Bug fixes |
---|
611 | - *FIXED*: 'testasciidoc.py': `BACKEND` command argument was being |
---|
612 | ignored. |
---|
613 | - *FIXED*: Broken 'docinfo' file functionality in 'html4' and |
---|
614 | 'xhtml11' backends (previously the docinfo file was included in |
---|
615 | the 'body' instead of the 'header'). |
---|
616 | |
---|
617 | Regression issues |
---|
618 | ~~~~~~~~~~~~~~~~~ |
---|
619 | This release breaks compatibility with quoted element positional color |
---|
620 | and size attributes (HTML backends). To revert to the deprecated quote |
---|
621 | behavior define the 'deprecated-quotes' attribute in the global |
---|
622 | `asciidoc.conf` file or on the command-line. For a more detailed |
---|
623 | explanation of the rationale behind this change see |
---|
624 | http://groups.google.com/group/asciidoc/browse_thread/thread/b22603bfb879418c. |
---|
625 | |
---|
626 | |
---|
627 | Version 8.6.0 (2010-08-16) |
---|
628 | -------------------------- |
---|
629 | .Additions and changes |
---|
630 | - The AsciiDoc distribution can now be built ``out of the box'' |
---|
631 | from the distribution tarball or the Mercurial repository |
---|
632 | (provided you have the requisite build applications installed). |
---|
633 | - The global configuration files directory is ignored by both |
---|
634 | 'asciidoc' and 'a2x' if AsciiDoc configuration files are installed |
---|
635 | in the same directory as the asciidoc executable. This change |
---|
636 | allows both a system wide copy and multiple local copies of AsciiDoc |
---|
637 | to coexist on the same host PC. |
---|
638 | - CSS 'quirks' mode is no longer the default 'xhtml11' output |
---|
639 | (http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2). |
---|
640 | - Relaxed anchor ID name syntax |
---|
641 | (http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c). |
---|
642 | - Added document files: `doc/epub-notes.txt`, |
---|
643 | `doc/publishing-ebooks-with-asciidoc.txt`. |
---|
644 | - 'a2x': If all other resource locations are exhausted then recursively |
---|
645 | search directories named 'images' and 'stylesheets' in the |
---|
646 | 'asciidoc' configuration files directory. |
---|
647 | - 'a2x': options can also be set in the AsciiDoc source file. If the |
---|
648 | source file contains a line beginning with '// a2x:' then the |
---|
649 | remainder of the line will be treated as a2x command-line options. |
---|
650 | - Added dblatex table-width processing instruction -- tables generated |
---|
651 | by dblatex now observe the AsciiDoc table width as a percentage |
---|
652 | (thanks to Gustav Broberg for suggesting this enhancement). |
---|
653 | - 'a2x': Don't exit if the `--epubcheck` option is set and 'epubcheck' |
---|
654 | is missing, issue warning and continue. |
---|
655 | - Added a global 'plaintext' attribute for dealing with large amounts |
---|
656 | of imported text. |
---|
657 | - The author name format has been relaxed, if the the author does not |
---|
658 | match the formal specification then it is assigned to the |
---|
659 | 'firstname' attribute (previously asciidoc exited with an error |
---|
660 | message). |
---|
661 | - FAQ and documentation updates. |
---|
662 | - Refactored chunked.xsl and epub.xsl files. |
---|
663 | - Exchanged article.epub for more relevant book.epub on website. |
---|
664 | - Put asciidoc.epub User Guide on website. |
---|
665 | - 'a2x': Chunking EPUB and HTML outputs set to a per chapter basis and |
---|
666 | the first chapter is separate from preceding contents. |
---|
667 | - Changed dates format in example article and books to suppress EPUB |
---|
668 | validation error. |
---|
669 | - Added 'style' and 'role' CSS classes to xhtml11 section templates. |
---|
670 | - Added the 'role' element to xhtml11 backend block templates. |
---|
671 | - Suppressed md5 module deprecation warning from music and Graphviz filters. |
---|
672 | - Pygments (http://pygments.org/) option added to source code |
---|
673 | highlight filter. Based on Pygments source code filter written by |
---|
674 | David Hajage |
---|
675 | (http://groups.google.com/group/asciidoc/browse_thread/thread/d8d042f5a3021369/8934ebbb8cb7144b). |
---|
676 | - xhtml11: Added a new theme (volnitsky). Written and contributed by |
---|
677 | Leonid V. Volnitsky. |
---|
678 | - xhtml11: Set body element class name to document type. |
---|
679 | - Added refentryinfo element and contents (including revdate) to man |
---|
680 | page DocBook output. Man pages are now dated using the revdate |
---|
681 | attribute value if it has been defined. Based on patch supplied by |
---|
682 | Rainer Muller |
---|
683 | http://groups.google.com/group/asciidoc/browse_frm/thread/319e5cd94493e330/3fcb83fab067af42. |
---|
684 | - Added `{template:...}` system attribute. |
---|
685 | - Table of contents attribute 'toc' can now be specified in the |
---|
686 | document header. |
---|
687 | - Reimplemented music and latex filter -m option functionality when |
---|
688 | the input is stdin using MD5 checksums. |
---|
689 | - Added 'latex' filter. |
---|
690 | - Added auto file name generation to image generating filters |
---|
691 | (latex,music, graphviz). |
---|
692 | - Added `counter2` and `set2` system attributes (to implement image |
---|
693 | auto file name generation). |
---|
694 | - Undefined attribute in filter command generates error but does not |
---|
695 | exit. |
---|
696 | - Attribute substitution proceeds from start line to end line |
---|
697 | (previously was in reverse order which was really confusing). |
---|
698 | - Tidied up music filter code: |
---|
699 | * Format option is optional and default to 'abc' unless Lilypond |
---|
700 | notation detected. |
---|
701 | * The -m option does not apply to stdin input. |
---|
702 | - Added paragraph styles to music and graphviz filters. |
---|
703 | - Documented dynamic template names. 753: Graphviz filter can now |
---|
704 | generate SVG format images. Patch submitted by Elmo Todurov, see: |
---|
705 | http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b33d8f5f1e0af |
---|
706 | The xhtml11 SVG Graphviz template marked EXPERIMENTAL. No SVG |
---|
707 | support for other backends. |
---|
708 | - AsciiDoc template names can now contain embedded attribute |
---|
709 | references. |
---|
710 | - Added 'legalnotice' tag to `doc/article-docinfo.xml` example. |
---|
711 | - xhtml11 backend: Callouts and callout lists display callout icons |
---|
712 | when the 'icons' attribute is defined. See |
---|
713 | http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3ea812968854 |
---|
714 | - Document attribute names are case insensitive everywhere, this makes using |
---|
715 | attribute entries more consistent e.g. previously :VERS: had to be refered to |
---|
716 | with {vers} ({VERS} did not work). |
---|
717 | - Hungarian translation of footer-text (submitted by Miklos Vajna). |
---|
718 | See |
---|
719 | http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72# |
---|
720 | - asciidocapi.py 0.1.2: Can now load AsciiDoc script named asciidoc. |
---|
721 | See |
---|
722 | http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 |
---|
723 | Based on patch submitted by Phillip Lord. |
---|
724 | - German translation of footer-text (submitted by Simon Ruderich). See |
---|
725 | http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 |
---|
726 | - Pushed HTML footer text into language conf files with the |
---|
727 | introduction of a [footer-text] configuration file template section. |
---|
728 | See |
---|
729 | http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 |
---|
730 | |
---|
731 | .Bug fixes |
---|
732 | - *FIXED*: Sometimes multiple double quoted text elements in the same |
---|
733 | paragraph were mistakenly seen as starting with an inline literal. |
---|
734 | See |
---|
735 | http://groups.google.com/group/asciidoc/browse_frm/thread/219c86ae25b79a21 |
---|
736 | - *FIXED*: 'localtime' and 'doctime' attributes calculated incorrect |
---|
737 | daylight saving / non daylight saving timezones and consequently so |
---|
738 | did HTML footers. Patch submitted by Slawomir Testowy. See |
---|
739 | http://groups.google.com/group/asciidoc/browse_frm/thread/af652507caf6cec9 |
---|
740 | - *FIXED*: Missing selector for 'List of examples' title in DocBook |
---|
741 | CSS file. Patch submitted by Laurent Laville. See |
---|
742 | http://groups.google.com/group/asciidoc/browse_frm/thread/3f96900f7fbf5620 |
---|
743 | - *FIXED*: Broken accents in lang-hu.conf. See: |
---|
744 | http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 |
---|
745 | - *FIXED*: DocBook XSL generated HTML callout lists are properly |
---|
746 | aligned. Submitted by Lionel Orry. See |
---|
747 | http://groups.google.com/group/asciidoc/browse_frm/thread/2ff802547b6a75ea |
---|
748 | - *FIXED*: Filter execution now occurs prior to filter markup template |
---|
749 | substitution to ensure image data URI encoding happens after image |
---|
750 | generation (see |
---|
751 | http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b). |
---|
752 | - *FIXED*: The section numbers no longer increment when the 'numbered' |
---|
753 | attribute is undefined (see |
---|
754 | http://groups.google.com/group/asciidoc/browse_thread/thread/faa36e9e5c7da019/d24cab3fe363e58d). |
---|
755 | |
---|
756 | |
---|
757 | Version 8.5.3 (2010-01-18) |
---|
758 | -------------------------- |
---|
759 | .Additions and changes |
---|
760 | - a2x: Added a2x configuration file options ASCIIDOC_OPTS, |
---|
761 | DBLATEX_OPTS, FOP_OPTS, XSLTPROC_OPTS (appended to same-named |
---|
762 | command-line options). See |
---|
763 | http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b9bfa2116db28 |
---|
764 | - Dropped `.hgignore` from the repository. See |
---|
765 | http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea |
---|
766 | - Don't pass verbose options to asciidoc table filter so that |
---|
767 | asciidocapi messages are not discarded. See: |
---|
768 | http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea |
---|
769 | - Added `./tests/data/lang-pt-BR-test.txt` file to the repository. |
---|
770 | - xhtml11: Verse block and verse paragraph content enveloped in a |
---|
771 | 'pre' tag (instead of a 'div') so it renders better in text-only |
---|
772 | browsers. See: |
---|
773 | http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b66adb24e710 |
---|
774 | - User Guide: Clarified Passthrough Blocks (suggested by Simon |
---|
775 | Ruderich). |
---|
776 | - FAQ: 'How can I include lines of dashes inside a listing block?' |
---|
777 | - FAQ errata and updates (submitted by Simon Ruderich). |
---|
778 | - User Guide errata. |
---|
779 | - Simplified 'asciidoc-toc' processing instruction and included lists |
---|
780 | of figures, tables, examples and equations in books (i.e. revert to |
---|
781 | pre-8.5.0 behavior). |
---|
782 | - Attempted to have dblatex recognise the 'asciidoc-toc' processing |
---|
783 | instruction but couldn't get it to work. |
---|
784 | - Added 'notitle' attribute to allow the document title to be hidden. |
---|
785 | |
---|
786 | |
---|
787 | .Bug fixes |
---|
788 | - *FIXED*: Regression: system attribute escaping did not work. |
---|
789 | - *FIXED*: Website: broken image links in chunked User Guide. |
---|
790 | |
---|
791 | |
---|
792 | Version 8.5.2 (2009-12-07) |
---|
793 | -------------------------- |
---|
794 | .Additions and changes |
---|
795 | - Updated example article and book documents with the recommended |
---|
796 | explicit section name syntax (see the 'Special section titles |
---|
797 | vs. explicit template names' sidebar in the AsciiDoc 'User Guide'). |
---|
798 | - Added Italian language configuration file (contributed by Fabio |
---|
799 | Inguaggiato). |
---|
800 | - Added 'header' table style. See: |
---|
801 | http://groups.google.com/group/asciidoc/browse_frm/thread/a23fea28394c8ca9 |
---|
802 | - Pass 'icons', 'data-uri', 'imagesdir', 'iconsdir' attributes to |
---|
803 | 'asciidoc' table style filter so that images are rendered in table |
---|
804 | cells. |
---|
805 | - Pass 'trace' and 'verbose' attributes to 'asciidoc' table style |
---|
806 | filter so diagnostic information is printed from table cell source. |
---|
807 | - The 'eval' system attribute can be nested inside other system |
---|
808 | attributes. |
---|
809 | - HTML outputs: Table and figure caption punctuation set to more usual |
---|
810 | syntax. |
---|
811 | - docbook backend: footnotes can now contain embedded images. See |
---|
812 | http://groups.google.com/group/asciidoc/browse_frm/thread/50b28f6941de111a |
---|
813 | - CSS tweaks so that tables processed by DocBook XSL Stylesheets have |
---|
814 | the default asciidoc xhtml11 backend styling. See |
---|
815 | http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5204d5b2c9685 |
---|
816 | - Block titles take precedence over section titles to avoid titled |
---|
817 | delimited blocks being mistaken for two line section titles (see |
---|
818 | http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6f9989f828c3). |
---|
819 | - Section title trace displays level and title text. |
---|
820 | - FAQ additions. |
---|
821 | - Added `{zwsp}` (zero width space) attribute. |
---|
822 | - Undefined paragraph styles are reported (previously threw a runtime |
---|
823 | error). |
---|
824 | - Eliminated empty preamble generation. |
---|
825 | - Floating titles now processed in all contexts. |
---|
826 | - Implemented auto-lettered appendix names and updated example |
---|
827 | documents. |
---|
828 | - Section numbering can be disabled in HTML outputs with a |
---|
829 | ':numbered!:' AttributeEntry. |
---|
830 | - xhtml11: Nicer default quote block styling. |
---|
831 | - Exclude floating titles from xhtml11 table of contents. Patch |
---|
832 | submitted by Mark Burton (see |
---|
833 | http://groups.google.com/group/asciidoc/browse_frm/thread/14aefc1cb6bd85f5). |
---|
834 | - Enhanced `doc/article-docinfo.xml` example docinfo file. |
---|
835 | - Vim syntax highlighter improvements. |
---|
836 | |
---|
837 | .Bug fixes |
---|
838 | - *FIXED*: Absolute 'imagesdir' and 'iconsdir' attribute path names |
---|
839 | do not work with the xhtml11 data-uri encoding. See |
---|
840 | http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 |
---|
841 | - *FIXED*: Regression issue with inline data-uri images. See |
---|
842 | http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 |
---|
843 | - *FIXED*: An unexpected error occurred when processing a table |
---|
844 | containing CSV data if the 'cols' attribute was not explicitly |
---|
845 | specified. See |
---|
846 | http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f364b477ec165 |
---|
847 | |
---|
848 | |
---|
849 | Version 8.5.1 (2009-10-31) |
---|
850 | -------------------------- |
---|
851 | .Additions and changes |
---|
852 | - If an AsciiDoc document file begins with a UTF-8 BOM (byte order |
---|
853 | mark) then it is passed transparently through to the output file. |
---|
854 | The BOM is stripped from included files. See |
---|
855 | http://groups.google.com/group/asciidoc/browse_frm/thread/e5e61823ff4203cd |
---|
856 | - Added AsciiDoc 'role' attribute to quoted text. Sets 'class' |
---|
857 | attribute in HTML outputs; 'role' attribute in DocBook outputs. See: |
---|
858 | http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3e5711d243045 |
---|
859 | - Conditional attribute syntax extended: they now accept multiple ORed |
---|
860 | or ANDed attribute names. |
---|
861 | - The 'xhtml11' backend dynamically processes footnotes using |
---|
862 | JavaScript. |
---|
863 | - Tidied up and namespaced 'xhtml11' JavaScript. |
---|
864 | - Superceded `javascripts/toc.js` with `javascripts/asciidoc-xhtml11.js`. |
---|
865 | - Added 'disable-javascript' attribute ('xhtml11' backend). |
---|
866 | - Styled HTML footnotes. |
---|
867 | - Added links to HTML footnote refs. |
---|
868 | - Added title attribute to inline image macros to display popup |
---|
869 | ``tooltip'' (HTML outputs only). |
---|
870 | - Single-quoted attribute values are substituted in block macros (just |
---|
871 | like the AttributeList element). |
---|
872 | - For consistency changed underscores to dashes in attribute names. |
---|
873 | Public attributes with underscores retained for compatibility. |
---|
874 | - Added Brazilian Portuguese language configuration file (contributed |
---|
875 | by Thiago Farina). |
---|
876 | - Added 'leveloffset' attribute to make it easier to combine |
---|
877 | documents. |
---|
878 | |
---|
879 | .Bug fixes |
---|
880 | - *FIXED:* a2x: `--dblatex-opts` is now processed last so |
---|
881 | `asciidoc-dblatex.xsl` params can be overridden. Patch submitted by |
---|
882 | Mark Fernandes (see |
---|
883 | http://groups.google.com/group/asciidoc/browse_frm/thread/5215c99dcc865e7d). |
---|
884 | - *FIXED:* An error occurred if a directory in current path with same |
---|
885 | name as executable. |
---|
886 | |
---|
887 | Regression issues |
---|
888 | ~~~~~~~~~~~~~~~~~ |
---|
889 | There's been quite a bit of tiding up to the xhtml11 JavaScript. The |
---|
890 | most obvious change is that the toc.js script has been superceded by |
---|
891 | asciidoc-xhtml11.js so if you're linking you'll need get a copy of |
---|
892 | the new file from the distribution javascripts directory. |
---|
893 | |
---|
894 | If you use customised xhtml11 configuration file `[header]` and |
---|
895 | `[footer]` sections and you want them to use the new footnotes feature |
---|
896 | then you've got a bit more work to do: |
---|
897 | |
---|
898 | . The onload event expression changed. |
---|
899 | . The new `<div id="content">...</div>` div envelopes document |
---|
900 | content. |
---|
901 | . You need to add `<div id="footnotes">...</div>` div to the |
---|
902 | `[footnotes]` section for footnotes to work. |
---|
903 | . Drop the `ifdef::toc[]` macro that surround JavaScript inclusion. |
---|
904 | |
---|
905 | Take a look at the [header] and [footer] changes in the xhtml11.conf |
---|
906 | diff to see what's going on: |
---|
907 | http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf |
---|
908 | |
---|
909 | |
---|
910 | Version 8.5.0 (2009-10-04) |
---|
911 | -------------------------- |
---|
912 | .Additions and changes |
---|
913 | - Implemented a 'float' attribute for tables and block images (HTML |
---|
914 | outputs only). |
---|
915 | - Added `unfloat::[]` block macro to cancel floating. |
---|
916 | - Added table 'align' attribute to (HTML outputs only). |
---|
917 | - The image 'align' attribute now works with HTML backends. |
---|
918 | - Renamed table cell 'align' attribute to 'halign' so it doesn't clash |
---|
919 | with the new table 'align' attribute. |
---|
920 | - Added 'breakable' and 'unbreakable' options to AsciiDoc example and |
---|
921 | block image elements. |
---|
922 | - `[miscellaneous]` section entries now update properly when set from |
---|
923 | a document 'AttributeEntry'. |
---|
924 | - `[miscellaneous]` section `pagewidth` entry accepts fractional |
---|
925 | values. |
---|
926 | - Fractional column widths are now calculated correctly when using |
---|
927 | fractional 'pageunits' (DocBook tables). |
---|
928 | - Use DocBook XSL table width processing instructions. |
---|
929 | - asciidoc 'KeyboardInterrupt' exits with error code 1. |
---|
930 | - Added 'set' system attribute to allow attributes to be set from |
---|
931 | configuration file templates. |
---|
932 | - Allow constrained quotes to be bounded on the left by a colons and |
---|
933 | semicolons, see |
---|
934 | http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995 |
---|
935 | - Titled listing and literal blocks (DocBook outputs) no longer default |
---|
936 | to examples. See |
---|
937 | http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd |
---|
938 | - Updated language file table, figure and example captions to |
---|
939 | accommodate new auto-numbering in html4 and xhtml11 backends. |
---|
940 | - Titled source highlight filter listings generated by docbook backend |
---|
941 | are now rendered as examples. See |
---|
942 | http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd |
---|
943 | - Implemented 'counter' system attribute. |
---|
944 | - Use 'counter' system attributes to number titled tables and block |
---|
945 | images in HTML backends. |
---|
946 | - Added program name suffix to console messages. |
---|
947 | - Added substitution to the 'AttributeEntry' passthrough syntax, this |
---|
948 | replaces the now unnecessary 'attributeentry-subs' attribute. |
---|
949 | - Allow passthrough inline macro syntax to be used in |
---|
950 | 'AttributeEntrys'. |
---|
951 | - Reinstated 8.4.4 default 'lang' attribute behavior. See |
---|
952 | http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a. |
---|
953 | - Added 'max-width' attribute to the 'xhtml11' backend to set maximum |
---|
954 | display width. See |
---|
955 | http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50. |
---|
956 | - Added 'a2x.py', a rewritten and much enhanced version of the old |
---|
957 | 'a2x' bash script. |
---|
958 | - The new 'a2x' can output EPUB formatted documents. |
---|
959 | - Added `--safe` option and deprecated `--unsafe` option. Patch |
---|
960 | submitted by Todd Zullinger. See |
---|
961 | http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a |
---|
962 | and |
---|
963 | http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 |
---|
964 | - Added 'CHECK' and 'TEST' todo highlight words to Vim syntax |
---|
965 | highlighter. |
---|
966 | - Line breaks, page breaks, and horizontal rulers are now processed by |
---|
967 | dblatex, thanks to a patch submitted by Mark Fernandes |
---|
968 | (http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5). |
---|
969 | - Allow footnote macros hard up against the preceding word so the |
---|
970 | rendered footnote mark can be placed against the noted text without |
---|
971 | an intervening space (patch submitted by Stas Bushuev, |
---|
972 | http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5). |
---|
973 | - Normalized path in `safe_filename` function (submitted by Todd |
---|
974 | Zullinger, |
---|
975 | http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5). |
---|
976 | - The Asciidoc 'numbered' and 'toc' attributes cause DocBook outputs |
---|
977 | to include `asciidoc-numbered` and `asciidoc-toc` processing |
---|
978 | instructions, these are used by DocBook XSL to include section |
---|
979 | numbering and table of contents (like Asciidoc HTML backends). For |
---|
980 | backward compatibility both 'numbered' and 'toc' attributes are |
---|
981 | defined by default when the 'docbook' backend is used. See |
---|
982 | http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac. |
---|
983 | - 'data-uri' attribute is now evaluated dynamically and can be set in |
---|
984 | document body (previously could only be set from command-line). |
---|
985 | - Added 'sys3' and 'eval3' system attributes to passthrough generated |
---|
986 | output, this fixes the data-uri inline image problem: |
---|
987 | http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537. |
---|
988 | - Missing language file generates a warning instead of an error. |
---|
989 | - Updated Spanish language file (updates contributed by Gustavo Andrés |
---|
990 | Gómez Farhat). |
---|
991 | |
---|
992 | .Bug fixes |
---|
993 | - *FIXED:* Options in an 'AttributeList' option attribute are merged |
---|
994 | with (rather than replace) configuration file options. |
---|
995 | - *FIXED:* Comment blocks and comment block macros no longer consume |
---|
996 | preceding block titles and attribute lists. |
---|
997 | - *FIXED:* `examples/website/layout1.conf` and |
---|
998 | `examples/website/layout2.conf` TOC problem. Submitted by Mark |
---|
999 | (burtoogle). See |
---|
1000 | http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c |
---|
1001 | - *FIXED:* Only the first occurrence of passthrough macro was |
---|
1002 | substituted. Patch submitted by Peter Johnson. See |
---|
1003 | http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c |
---|
1004 | - *FIXED:* asciidoc now runs on Jython 2.5.0. |
---|
1005 | - *FIXED:* Wordpress margins and pads in a number of block |
---|
1006 | elements |
---|
1007 | (http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a). |
---|
1008 | |
---|
1009 | Regression issues |
---|
1010 | ~~~~~~~~~~~~~~~~~ |
---|
1011 | - Tables generated by 'dblatex' occupy 100% of the available space |
---|
1012 | regardless of the 'width' attribute setting. To restore width |
---|
1013 | behavior change the 'pageunits' miscellaneous parameter to 'pt'. You |
---|
1014 | can do this from the command-line with the `-a pageunits=pt` option. |
---|
1015 | See {website}userguide.html#X89[DocBook table widths]. |
---|
1016 | |
---|
1017 | |
---|
1018 | Version 8.4.5 (2009-05-24) |
---|
1019 | -------------------------- |
---|
1020 | .Additions and changes |
---|
1021 | - Added manpage 'Name' and 'Synopsis' section title customization to languages |
---|
1022 | configuration files. |
---|
1023 | - Synopsis manpage section no longer mandatory. |
---|
1024 | - Section markup templates can be specified by setting the title's |
---|
1025 | first positional attribute or 'template' attribute. |
---|
1026 | - The article and book document header can now include a revision |
---|
1027 | remark. |
---|
1028 | - A 'role' attribute can now be applied to block elements. This adds |
---|
1029 | the 'role' attribute to DocBook elements. Patch submitted by |
---|
1030 | http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038[Noah |
---|
1031 | Slater]). |
---|
1032 | - Renamed 'revision' and 'date' attributes to more sensible and consistent |
---|
1033 | 'revnumber' and 'revdate' (old names deprecated but still |
---|
1034 | recognized). |
---|
1035 | - Moved backend specific attributes to Appendix H in User Guide. |
---|
1036 | - Renamed and generalized the docbook backend revision history |
---|
1037 | inclusion mechanism to 'docinfo' to reflect the use of all article |
---|
1038 | or book information elements. The old revision history names still |
---|
1039 | work but have been deprecated. |
---|
1040 | - Refactored docbook.conf headers. |
---|
1041 | - Moved line break replacement from `[replacements]` to |
---|
1042 | `[replacements2]` so the replacement occurs after the mailto macro. |
---|
1043 | This fixes bug |
---|
1044 | http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2 |
---|
1045 | - The typewriter to punctuation apostrophe replacement can be escaped |
---|
1046 | with a backslash. |
---|
1047 | - Graphviz filter outputs images to 'imagesdir' if it is defined. |
---|
1048 | - Made the block image macro generic so that it can be used for filter |
---|
1049 | outputs. As a result Music and Graphviz filters: |
---|
1050 | * Have been greatly simplified. |
---|
1051 | * Honor the 'data-uri' attribute. |
---|
1052 | * 'html4' outputs no longer generate W3C validation warning. |
---|
1053 | - The 'iconsdir' attribute no longer requires a trailing directory |
---|
1054 | separator character. |
---|
1055 | - Removed borders around linked html4 images. |
---|
1056 | - Added 'html4' specific HTML output for music filter. |
---|
1057 | - 'a2x': Added `--unsafe` option (shortcut for |
---|
1058 | `--asciidoc-opts=--unsafe`). |
---|
1059 | - 'a2x': The FOP executable can now be named `fop` (this is the |
---|
1060 | default name in some distributions). |
---|
1061 | - Attributes are now substituted in the system macro attribute list. |
---|
1062 | - If the output is set to stdout (i.e. no output directory is defined) |
---|
1063 | then Music and Graphviz filters will output included images to the |
---|
1064 | source file directory. |
---|
1065 | - Added 'name' directive to 'testasciidoc'. |
---|
1066 | - Added lots of 'testasciidoc' new tests. |
---|
1067 | - Moved language specific configuration parameters into `lang-en.conf` |
---|
1068 | file. |
---|
1069 | - 'lang' attribute entry can be specified in the AsciiDoc source file |
---|
1070 | (preceding the header). |
---|
1071 | - Removed cruft from A-A-P scripts and documented them. |
---|
1072 | - Added German language config file (`lang-de.conf`) contributed by |
---|
1073 | Michael Wild. |
---|
1074 | - Added French language config file (`lang-fr.conf`) contributed by |
---|
1075 | Yves-Alexis Perez. |
---|
1076 | - Added Russian language config file (`lang-ru.conf`) contributed by |
---|
1077 | Artem Zolochevskiy. |
---|
1078 | - Added Hungarian language config file (`lang-hu.conf`) contributed by |
---|
1079 | Miklos Vajna. |
---|
1080 | |
---|
1081 | .Bug fixes |
---|
1082 | - *FIXED:* Multiple manpage names are now handled correctly when |
---|
1083 | generating DocBook output, each name now generates a separate |
---|
1084 | DocBook `<refname>` element. See |
---|
1085 | http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8 |
---|
1086 | - *FIXED:* A problem that caused AttributeEntries preceding the header |
---|
1087 | to be overwritten when the language conf file loaded. |
---|
1088 | - *FIXED:* Possible inline macro name ambiguity e.g. link matches olink. |
---|
1089 | - *FIXED:* The documented macro definition deletion behavior had been |
---|
1090 | broken for a long time. |
---|
1091 | - *FIXED:* Email addresses not recognized when followed by a period |
---|
1092 | character. |
---|
1093 | - *FIXED:* Hyphens in mailto macros can delimit nested addresses e.g. |
---|
1094 | \bloggs@mail was processed inside |
---|
1095 | \mailto:joe-bloggs@mail-server.com[Mail]. |
---|
1096 | - *FIXED:* User name in FTP URI generated incorrect FTP link. See |
---|
1097 | http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855 |
---|
1098 | - *FIXED:* Source highlighter now works with Wordpress backend (see |
---|
1099 | http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3). |
---|
1100 | |
---|
1101 | [[X2]] |
---|
1102 | Regression issues |
---|
1103 | ~~~~~~~~~~~~~~~~~ |
---|
1104 | . A colon following the date in the AsciiDoc header is treated as a |
---|
1105 | revision remark delimiter -- this could be an issue if you have used |
---|
1106 | a colon in the header date. |
---|
1107 | |
---|
1108 | |
---|
1109 | Version 8.4.4 (2009-04-26) |
---|
1110 | -------------------------- |
---|
1111 | .Additions and changes |
---|
1112 | - Added table column and row spanning. |
---|
1113 | - Table styles can now be applied per cell. |
---|
1114 | - Vertical cell alignment can be applied to columns and individual |
---|
1115 | cells. |
---|
1116 | - Added table 'align' attribute to set horizontal alignment for entire |
---|
1117 | table. |
---|
1118 | - Included Geoff Eddy's update of the experimental LaTeX backend. |
---|
1119 | - A new attribute named 'trace' controls the output of diagnostic |
---|
1120 | information. If the 'trace' attribute is defined then |
---|
1121 | element-by-element diagnostic messages detailing output markup |
---|
1122 | generation are printed to stderr. |
---|
1123 | - Added 'literal' paragraph style (allows 'literal' style to be |
---|
1124 | applied to normal paragraphs). |
---|
1125 | - Deleted unused `replacements2` from `xhtml11.conf`. |
---|
1126 | - Added `replacements2` to default substitutions. |
---|
1127 | - 'testasciidoc.py': messages to 'stdout', only diffs to 'stderr'. |
---|
1128 | - Added transparency to `smallnew.png` image. |
---|
1129 | |
---|
1130 | .Bug fixes |
---|
1131 | - All combinations of leading comments and attribute entries at the |
---|
1132 | start of a document are now skipped correctly. |
---|
1133 | - *FIXED:* `./configure` doesn't support `--docdir` as expected (patch |
---|
1134 | submitted by Artem Zolochevskiy) |
---|
1135 | - *FIXED:* Constrained quotes were incorrectly matched across line |
---|
1136 | boundaries e.g. the string `+\nabc+` incorrectly matched a monospace |
---|
1137 | quote. |
---|
1138 | |
---|
1139 | |
---|
1140 | Version 8.4.3 (2009-04-13) |
---|
1141 | -------------------------- |
---|
1142 | .Additions and changes |
---|
1143 | - DocBook outputs default to DocBook version 4.5 doctype (previously |
---|
1144 | 4.2). |
---|
1145 | - Configuration file `[specialsections]` definitions can be undefined |
---|
1146 | by setting their configuration entry values blank. |
---|
1147 | - The Makefile 'install' target depends on the 'all' target to ensure |
---|
1148 | pre-install patches are applied. |
---|
1149 | - 'testasciidoc.py' now emits user friendly messages if: |
---|
1150 | . the configuration file is missing. |
---|
1151 | . an illegal backend is specified. |
---|
1152 | . an illegal test number is specified. |
---|
1153 | |
---|
1154 | .Bug fixes |
---|
1155 | - Fixed |
---|
1156 | http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06[missing |
---|
1157 | template section] error. |
---|
1158 | - The 'testasciidoc.py' `--force` option no longer deletes test data |
---|
1159 | files that were not specified. |
---|
1160 | - Dropped second quotes substitution in table cells -- it had |
---|
1161 | effectively disabled quote escaping in table cells. |
---|
1162 | |
---|
1163 | |
---|
1164 | Version 8.4.2 (2009-03-19) |
---|
1165 | -------------------------- |
---|
1166 | .Additions and changes |
---|
1167 | - Added {website}testasciidoc.html[testasciidoc], a tool to verify |
---|
1168 | AsciiDoc conformance. |
---|
1169 | - A warning is issued if nested inline passthroughs are encountered. |
---|
1170 | - 'asciidocapi': setting an attribute value to `None` will undefine |
---|
1171 | (delete) the attribute (this in addition to the `name!` attribute |
---|
1172 | name format that the `asciidoc(1)` command uses). |
---|
1173 | |
---|
1174 | .Bug fixes |
---|
1175 | |
---|
1176 | |
---|
1177 | Version 8.4.1 (2009-03-10) |
---|
1178 | -------------------------- |
---|
1179 | .Additions and changes |
---|
1180 | - AsciiDoc now has a {website}asciidocapi.html[Python API]. The |
---|
1181 | following minimal example compiles `mydoc.txt` to `mydoc.html`: |
---|
1182 | + |
---|
1183 | [source,python] |
---|
1184 | ------------------------------------------------------------------------------- |
---|
1185 | from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI() |
---|
1186 | asciidoc.execute('mydoc.txt') |
---|
1187 | ------------------------------------------------------------------------------- |
---|
1188 | |
---|
1189 | - Backtick quoting for monospaced text is now implemented as an |
---|
1190 | 'inline literal' passthrough. This makes more sense since monospace |
---|
1191 | text is usually intended to be rendered literally. See |
---|
1192 | <<X2,Regression issues>> below for the impact this may have on |
---|
1193 | existing documents. Here are some examples that would previously |
---|
1194 | have had to be escaped: |
---|
1195 | |
---|
1196 | The `++i` and `++j` auto-increments. |
---|
1197 | Paths `~/.vim` and `~/docs`. |
---|
1198 | The `__init__` method. |
---|
1199 | The `{id}` attribute. |
---|
1200 | |
---|
1201 | - Added `--doctest` option to `asciidoc(1)` command. |
---|
1202 | - Added an optional second argument to 'BlockId' element, this sets |
---|
1203 | the `{reftext}` attribute which in turn is used to set the `xreflabel` |
---|
1204 | attribute in DocBook elements. |
---|
1205 | - Added lists to `--help` syntax summary. |
---|
1206 | - `{infile}` and `{indir}` attributes reflect the current input file |
---|
1207 | (previously always referred to the root document). |
---|
1208 | - `{docfile}` (new) and `{docdir}` (previously deprecated) attributes |
---|
1209 | refer to the root document specified on the `asciidoc(1)` |
---|
1210 | command-line. |
---|
1211 | - Vim syntax highlighter improvements. |
---|
1212 | - Syntax summary command (`asciidoc -h syntax`) additions. |
---|
1213 | - Admonition icons now have transparent backgrounds. |
---|
1214 | - Changed yellow W3C badges to blue ones in page footers. |
---|
1215 | |
---|
1216 | .Bug fixes |
---|
1217 | - Dropped `asciidoc(1)` broken undocumented `--profile` option. |
---|
1218 | - Em dash replacement now recognized at start of block. |
---|
1219 | |
---|
1220 | Regression issues |
---|
1221 | ~~~~~~~~~~~~~~~~~ |
---|
1222 | Replacing backtick quoting with the 'inline literal' passthrough |
---|
1223 | raises two regression scenarios for existing documents: |
---|
1224 | |
---|
1225 | 1. You have escaped the expansion of enclosed inline elements, for |
---|
1226 | example: `\{id}`. You would need to delete the backslashes: `{id}` |
---|
1227 | (if you don't the backslashes will be printed). Mostly it's just a |
---|
1228 | case of interactively finding and replacing of all occurrences of |
---|
1229 | `\. |
---|
1230 | |
---|
1231 | 2. There are enclosed inline elements, for example: `some *bold* |
---|
1232 | monospaced`. You would need to switch to plus character monospace |
---|
1233 | quoting: `+some *bold* monospaced+` (if you don't the enclosed |
---|
1234 | elements won't be expanded). |
---|
1235 | |
---|
1236 | If your existing documents include these cases and you don't want to |
---|
1237 | upgrade then use the `-a no-inline-literal` command-line option, |
---|
1238 | alternatively put this in `~/.asciidoc/asciidoc.conf`: |
---|
1239 | |
---|
1240 | [attributes] |
---|
1241 | no-inline-literal= |
---|
1242 | |
---|
1243 | |
---|
1244 | Version 8.3.5 (2009-02-02) |
---|
1245 | -------------------------- |
---|
1246 | .Additions and changes |
---|
1247 | - Cached compiled regular expression delimiters (speed up 'User |
---|
1248 | Manual' compilation by 250%). |
---|
1249 | - Created distinct list definitions for each numbered list style to |
---|
1250 | allow nesting of all styles. |
---|
1251 | - Roman numbers in numbered lists are followed by a closing |
---|
1252 | parenthesis instead of a period to eliminate 'i', 'v', 'x' item |
---|
1253 | ambiguity with respect to alpha numbered list items. |
---|
1254 | - Added `**`, `***`, `****`, `*****` |
---|
1255 | bulleted lists. |
---|
1256 | - Added `...`, `....`, `.....` implicit numbered |
---|
1257 | lists. |
---|
1258 | - Added `:::`, `::::` labeled lists. |
---|
1259 | - Updated User Guide for new list syntaxes. |
---|
1260 | - Optimized paragraph and list termination detection with separate |
---|
1261 | precompiled regular expressions for performance and to prevent |
---|
1262 | reaching Python 100 named group limit. |
---|
1263 | - Updated Vim syntax highlighter for new list syntaxes. |
---|
1264 | - Allow `template::[]` macros in conf file entries sections (not just |
---|
1265 | in template sections). |
---|
1266 | - Dropped unused `[listdef-numbered2]` conf file sections. |
---|
1267 | - Renamed 'ListBlock' to more appropriate 'OpenBlock'. |
---|
1268 | - Implemented single-line versions of `ifdef::[]` and `ifndef::[]` |
---|
1269 | macros. |
---|
1270 | - 'html4' backend styling: |
---|
1271 | * Underlined admonition captions. |
---|
1272 | * Added side border to Example Blocks. |
---|
1273 | - 'xhtml11' backend styling: |
---|
1274 | * Dropped right hand margin from all but quote and verse blocks. |
---|
1275 | * html4 backend: corrected over-sized width of caption in admonition |
---|
1276 | block. |
---|
1277 | |
---|
1278 | .Bug fixes |
---|
1279 | - Fixed broken numbered list nesting. |
---|
1280 | |
---|
1281 | Compatibility issues |
---|
1282 | ~~~~~~~~~~~~~~~~~~~~ |
---|
1283 | The roman numbered list parenthesis syntax is incompatible with the |
---|
1284 | potentially ambiguous roman period syntax introduced in 8.3.2. |
---|
1285 | |
---|
1286 | |
---|
1287 | Version 8.3.4 (2009-01-20) |
---|
1288 | -------------------------- |
---|
1289 | .Additions and changes |
---|
1290 | - Implemented a title 'float' style. A floating title (or bridgehead) |
---|
1291 | is rendered just like a normal section but is not formally |
---|
1292 | associated with a text body and is not part of the regular section |
---|
1293 | hierarchy so the normal ordering rules do not apply. |
---|
1294 | - Implemented inline comment macro so comment lines can now appear |
---|
1295 | inside block elements. |
---|
1296 | - Comment lines are sent to the output if the 'showcomments' attribute |
---|
1297 | is defined (comment blocks are never sent to the output). |
---|
1298 | - Single quoting attribute values in 'AttributeList' elements causes |
---|
1299 | them to be substituted like normal inline text (without single |
---|
1300 | quoting only attribute substitution is performed). |
---|
1301 | - Rewrote list item processing (was very crufty). List continuation |
---|
1302 | and list blocks now work as expected. Updated and clarified list |
---|
1303 | documentation in User Guide. |
---|
1304 | - The 'revision' attribute now recognizes the RCS $Id$ marker format. |
---|
1305 | - An RCS $Id$ marker formatted revision line in the header does not |
---|
1306 | need to be preceded by an author line. |
---|
1307 | - If an RCS $Id$ formatted revision is specified and the author name |
---|
1308 | has not already been set then the author name in the $Id$ marker |
---|
1309 | will be used. |
---|
1310 | - Updated Gouichi Iisaka's Graphviz filter to version 1.1.3. |
---|
1311 | - Added 'autowidth' table attribute option for (X)HTML outputs. |
---|
1312 | - DocBook backend now puts 'orgname' optional attribute in DocBook |
---|
1313 | header. |
---|
1314 | - Deprecated undocumented 'companyname' attribute in favor of |
---|
1315 | DocBook's 'corpname'. |
---|
1316 | - Removed explicit closing backslash from HTML4 self-closing tags to |
---|
1317 | comply with WC3 recommendation. |
---|
1318 | |
---|
1319 | .Bug fixes |
---|
1320 | - Fixed 8.3.3 regression whereby adjacent lists with the same syntax |
---|
1321 | but different list styles were incorrectly treated as a single list. |
---|
1322 | |
---|
1323 | |
---|
1324 | Version 8.3.3 (2009-01-02) |
---|
1325 | -------------------------- |
---|
1326 | This release supersedes 8.3.2. |
---|
1327 | |
---|
1328 | .Bug fixes |
---|
1329 | - The broken and confusing numeration and numeration2 numbered list |
---|
1330 | attributes have been dropped, use the style attribute instead. |
---|
1331 | |
---|
1332 | |
---|
1333 | Version 8.3.2 (2009-01-01) |
---|
1334 | -------------------------- |
---|
1335 | .Additions and changes |
---|
1336 | - Added Gouichi Iisaka's Graphviz filter to distribution. |
---|
1337 | - The 'SidebarBlock' element can now be rendered with an 'abstract' |
---|
1338 | style. |
---|
1339 | - Reorganized filters into a separate subdirectory for each filter. |
---|
1340 | - Updated `Makefile.in` and `MANIFEST` files to reflect new filters |
---|
1341 | organization. |
---|
1342 | - Added 'listing' style to 'LiteralBlock' element so listings with |
---|
1343 | nested listing blocks can be rendered as a listing block. |
---|
1344 | - Changed example 'code' filter to use preferred 'ListingBlock' syntax |
---|
1345 | (the old `~` delimited filter syntax is no longer used). |
---|
1346 | - Implemented 'enumeration' and 'enumeration2' numbered list |
---|
1347 | attributes for specifying the list numbering style ('arabic', |
---|
1348 | 'loweralpha', 'upperalpha', 'lowerroman' and 'upperroman'). |
---|
1349 | - AsciiDoc now recognizes 'upperalpha', 'lowerroman' and 'upperroman' |
---|
1350 | numbers in `listdef-numbered2` numbered lists and sets the number |
---|
1351 | style based on the style of the first numbered list item |
---|
1352 | (alternative to setting 'enumeration2' attribute). |
---|
1353 | - Updated `formatlistpat` definition in `.vimrc` example in User |
---|
1354 | Guide. |
---|
1355 | - You can now backslash escape system block macros. |
---|
1356 | - Added 'Pychart' FAQ. |
---|
1357 | - Drop paragraph 'text' and list 'text', 'index' and 'label' match |
---|
1358 | groups from attributes -- they are included in the element's text |
---|
1359 | and we don't want them processed a second time as attributes. |
---|
1360 | - Changed comment line block macro to a passthrough block macro to |
---|
1361 | ensure no substitutions. |
---|
1362 | - A 'subslist' no longer has to be appended to a 'PassthroughBlock' |
---|
1363 | macro definition, if omitted no substitutions are performed. |
---|
1364 | - Code tidy up: replaced deprecated `<>` operator with `!=`. |
---|
1365 | - Removed unused linuxdoc code. |
---|
1366 | - Code tidy ups: dropped old types module reference; replaced |
---|
1367 | `has_key()` with preferred `in` operator. |
---|
1368 | |
---|
1369 | .Bug fixes |
---|
1370 | - Old syntax source highlight filter regression: special characters |
---|
1371 | where not escaped in DocBook outputs. |
---|
1372 | |
---|
1373 | |
---|
1374 | Version 8.3.1 (2008-12-14) |
---|
1375 | -------------------------- |
---|
1376 | .Additions and changes |
---|
1377 | - Replaced the `install.sh` script with Ben Walton's updated autoconf |
---|
1378 | scripts -- see {website}INSTALL.html[INSTALL] for details. |
---|
1379 | - Added a generalized 'AttributeEntry' syntax to allow arbitrary |
---|
1380 | configuration file entries to be set from within an AsciiDoc |
---|
1381 | document (suggested by Henrik Maier). |
---|
1382 | - Listing delimited blocks in DocBook outputs now support IDs; IDs of |
---|
1383 | titled Listing and Literal delimited blocks have been moved to the |
---|
1384 | enclosing DocBook example tag (thanks to Vijay Kumar for this |
---|
1385 | patch). |
---|
1386 | - Replaced vertical typewriter apostrophe with punctuation apostrophe |
---|
1387 | (thanks to Noah Slater). |
---|
1388 | |
---|
1389 | .Bug fixes |
---|
1390 | - Regression: Excluding double-quotes from unquoted attribute values |
---|
1391 | resulted in backward incompatibility, double-quotes in unquoted |
---|
1392 | attribute values has been reinstated. |
---|
1393 | - Regression: Text like `&...;` was sometimes mistaken for an entity |
---|
1394 | reference -- tightened up entity reference matching. |
---|
1395 | |
---|
1396 | |
---|
1397 | Version 8.3.0 (2008-11-29) |
---|
1398 | -------------------------- |
---|
1399 | .Additions and changes |
---|
1400 | - {website}newtables.html[AsciiDoc new tables] is a complete redesign |
---|
1401 | of the tables syntax and generation. The new syntax and features are |
---|
1402 | a huge improvement over the old tables. The old tables syntax has |
---|
1403 | been deprecated but is currently still processed. |
---|
1404 | - {website}newlists.html[Lists can now be styled] like other block |
---|
1405 | elements. This allows a single list syntax for 'glossary', 'qanda' |
---|
1406 | (Question and Answer) and 'bibliography' lists instead of having to |
---|
1407 | remember a different syntax for each type. |
---|
1408 | - Inline passthroughs macros have been improved and block passthrough |
---|
1409 | macros added. Attribute substitution can be optionally specified |
---|
1410 | when the macro is called. |
---|
1411 | - The passthrough block has a fully transparent passthrough delimited |
---|
1412 | block block style called 'pass'. |
---|
1413 | - The 'asciimath' and 'latexmath' |
---|
1414 | {website}userguide.html#X77[passthrough macros] along with |
---|
1415 | 'asciimath' and 'latexmath' {website}userguide.html#X76[passthrough |
---|
1416 | blocks] provide a (backend dependent) mechanism for rendering |
---|
1417 | mathematical formulas. There are {website}latexmath.pdf[LaTeX Math], |
---|
1418 | {website}asciimathml.html[AsciiMathML] and |
---|
1419 | {website}latexmathml.html[LaTeXMathML] examples on the AsciiDoc |
---|
1420 | website. |
---|
1421 | - Reimplemented and cleaned up filter processing based on a patch |
---|
1422 | submitted by Kelly Anderson. Uses the newer subprocess module |
---|
1423 | instead of the deprecated popen2 module. Now works in Win32 command |
---|
1424 | shell. |
---|
1425 | - Addition FAQs, more documentation updates. |
---|
1426 | - Arbitrary HTML/XML entities can be entered in AsciiDoc source. |
---|
1427 | - Did away with the need for the `shaded-literallayout.patch` (thanks |
---|
1428 | to Henrik Maier for this patch). |
---|
1429 | - Implemented 'page break' block macro. |
---|
1430 | - Added 'line breaks' and 'ruler' processing instructions to DocBook |
---|
1431 | outputs (thanks to Henrik Maier for this patch). |
---|
1432 | - Added 'deg' (degree) and 'wj' (word joiner) entity attributes |
---|
1433 | (thanks to Henrik Maier). |
---|
1434 | - Tweaked DocBook 'indexterm2' macro to avoid white space preceding |
---|
1435 | the term when used in table cells (thanks to Henrik Maier for this |
---|
1436 | patch). |
---|
1437 | - Title elements now process the 'options' attribute like other block |
---|
1438 | elements. |
---|
1439 | - Added `single quoted' element. |
---|
1440 | - Spaces on both sides of a -- em-dash are translated to thin space |
---|
1441 | characters. |
---|
1442 | - Improved detection and reporting of malformed attribute lists. |
---|
1443 | - The list 'compact' style is now a list option. |
---|
1444 | - Added 'strong' labeled list option which makes the labels bold (HTML |
---|
1445 | outputs only). |
---|
1446 | - Dropped unsupported 'linuxdoc' backend. |
---|
1447 | - Dropped deprecated 'xhtml-deprecated' (version 6) backend. |
---|
1448 | - Added 'breakable' and 'unbreakable' attribute options to tables to |
---|
1449 | control table breaking across page boundaries (DocBook XSL/FO |
---|
1450 | outputs). By and in collaboration with Henrik Maier. |
---|
1451 | - Added 'pgwide' attribute option to tables to table, block image, |
---|
1452 | horizontal labeled lists. Specifies that the element should be |
---|
1453 | rendered across the full text width of the page irrespective of the |
---|
1454 | current indentation (DocBook XSL/FO outputs). Thanks to Henrik Maier |
---|
1455 | for this patch. |
---|
1456 | - Vim syntax highlighter: spaces before/after bullets no longer |
---|
1457 | highlighted (which is ugly if using a theme that highlights with |
---|
1458 | underlines). Thanks to Donald Chai for this patch. |
---|
1459 | - Added `a2x(1)` `--fop` option. |
---|
1460 | - Added `a2x(1)` `--no-xmllint` option. |
---|
1461 | - Highlighted labelled list terms with the navy color in XHTML |
---|
1462 | outputs. |
---|
1463 | - Use `w3m(1)` as default `a2x(1)` text format generator (fallback to |
---|
1464 | `lynx(1)`). |
---|
1465 | - Changed callout formats in html4 and xhtml11 outputs to angle |
---|
1466 | brackets to match source highlighter rendering. |
---|
1467 | - Macros now inject user defined `<optionname>-option` attributes into |
---|
1468 | markup. |
---|
1469 | - Added IRC URLs to AsciiDoc inline macros. |
---|
1470 | - Added `depth` attribute to `include::[]` system macro. |
---|
1471 | - Added 'footnoteref' inline macro. |
---|
1472 | - Added 'stylesheet' XHTML attribute to specify additional custom CSS |
---|
1473 | stylesheet. |
---|
1474 | - If a paragraph style is specified it will be added to the XHTML |
---|
1475 | 'class' attribute and DocBook 'role' attribute. |
---|
1476 | - Replacements can be set in a document using the reserved |
---|
1477 | AttributeEntry name 'replacement'. |
---|
1478 | - The prefix for auto-generated section name IDs can be set with the |
---|
1479 | 'idprefix' attribute. |
---|
1480 | |
---|
1481 | .Bug fixes |
---|
1482 | - Escaped quote skipped over leading and trailing quote instead of |
---|
1483 | just the leading quote. |
---|
1484 | - Fixed bug that was causing false negative safe mode warnings (patch |
---|
1485 | submitted by Julien Palmas). |
---|
1486 | - Placed priority of AttributeEntry, AttributeList and BlockTitle |
---|
1487 | above Title. This ensures an AttributeEntry, AttributeList or |
---|
1488 | BlockTitle followed by a same length leading ListingBlock delimiter |
---|
1489 | is not mistaken for a two-line title. |
---|
1490 | - Vim syntax highlighter: fixed multi-line quoted text. |
---|
1491 | - Contstrained quote termination after non-space character enforced. |
---|
1492 | - Vim syntax highlighter: unterminated quoted text is no longer |
---|
1493 | highlighted. |
---|
1494 | - Vim syntax highlighter: passthroughs now exactly match AsciiDoc |
---|
1495 | semantics. |
---|
1496 | - Vim syntax highlighter: escaped quoted text, attribute references |
---|
1497 | and inline macros are not highlighted. |
---|
1498 | - Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks |
---|
1499 | to Scott Wall); non-greedy pass:[$$...$$]. |
---|
1500 | - Vim syntax highlighter: Comment lines mistaken for vertical list |
---|
1501 | labels (thanks to Scott Wall). |
---|
1502 | - Vim syntax highlighter: Single unmatched $$ mistakenly highlighted |
---|
1503 | remaining text (patch contributed by Scott Wall). |
---|
1504 | - Callouts now work in source highlighted listing generated by |
---|
1505 | dblatex. |
---|
1506 | - Fixed exception that occured if undefined attribute was present in |
---|
1507 | filter command. |
---|
1508 | - AttributeList block can now follow a paragraph without intervening |
---|
1509 | blank line. |
---|
1510 | - The include macro tabsize attribute is no longer propagated to |
---|
1511 | nested includes. |
---|
1512 | |
---|
1513 | .Omissions |
---|
1514 | The following features were implemented but then but removed from this |
---|
1515 | release: |
---|
1516 | |
---|
1517 | - 'pi', 'cdata' and 'comment' passthrough macros and passthrough block |
---|
1518 | styles (creeping featurism, use 'pass' macros instead). |
---|
1519 | - Generic 'tag' inline macro (creeping featurism, use 'pass' macros |
---|
1520 | instead). |
---|
1521 | |
---|
1522 | |
---|
1523 | [[X1]] |
---|
1524 | Compatibility issues |
---|
1525 | ~~~~~~~~~~~~~~~~~~~~ |
---|
1526 | Version 8.3.0 has a number of backward incompatibilities with respect |
---|
1527 | to the previous 8.2.7 release: |
---|
1528 | |
---|
1529 | - The old table syntax is still processed but a 'DEPRECATED' warning |
---|
1530 | is issued. |
---|
1531 | - Entity references have to be escaped with a backslash. |
---|
1532 | - You have to explicitly precede horizontal style labeled lists with |
---|
1533 | the `[horizontal]` style attribute -- by default all labeled lists |
---|
1534 | are rendered vertically. |
---|
1535 | - The list 'compact' style has been dropped and is now a list option |
---|
1536 | (use `options="compact"` in attribute lists). |
---|
1537 | - AsciiDoc version 6 sytnax no longer supported. |
---|
1538 | - Linuxdoc been removed from the distribution. |
---|
1539 | - The unsupported experimental 'latex' backend has not been tested on |
---|
1540 | this release. |
---|
1541 | - The introduction of single-quote quoting requires that double-quote |
---|
1542 | quoting is escaped with two backslashes. |
---|
1543 | |
---|
1544 | |
---|
1545 | Version 8.2.7 (2008-07-04) |
---|
1546 | -------------------------- |
---|
1547 | .Additions and changes |
---|
1548 | - Added `dvi`, `ps` and `tex` output format options to a2x(1). |
---|
1549 | - Added `--dblatex` option to a2x(1) so `dblatex(1)` can be used to |
---|
1550 | generate PDFs. |
---|
1551 | - Added custom `dblatex(1)` configuration files (in distribution |
---|
1552 | `./dblatex` directory) that are used by a2x(1). |
---|
1553 | - `dblatex(1)` is now used to generate the distributed PDF version of |
---|
1554 | the AsciiDoc User Guide. |
---|
1555 | - If you don't need a customized the link caption you can enter the |
---|
1556 | 'http', 'https', 'ftp', 'file' URLs and email addresses without any |
---|
1557 | special macro syntax -- you get the links by just cutting and |
---|
1558 | pasting URLs and emails addresses. This also makes it easier to open |
---|
1559 | links directly form AsciiDoc source ( most editors allow you to open |
---|
1560 | URLs directly). The Vim syntax highlighter has been updated to |
---|
1561 | reflect these changes. |
---|
1562 | - Highlighted source code paragraphs have been implemented -- it's a |
---|
1563 | much more convenient way to enter short code examples (see |
---|
1564 | http://www.methods.co.nz/asciidoc/source-highlight-filter.html[the |
---|
1565 | online docs]). |
---|
1566 | - The source highlighter and music filter syntax has changed -- they |
---|
1567 | now used the ListingBlock syntax customized with 'source' and |
---|
1568 | 'music' style attribute values. This follows the Paragraph styling |
---|
1569 | convention introduced by the source paragraph (previous item) and is |
---|
1570 | easier to read. The old syntax still works but has been deprecated. |
---|
1571 | - QuoteBlocks now have a 'verse' style -- you no longer have to nest a |
---|
1572 | 'verse' LiteralBlock inside a QuoteBlock for verses. The 'verse' |
---|
1573 | style on the LiteralBlock has been deprecated (still works though) |
---|
1574 | and the 'style' attribute is positional attribute 1, pushing |
---|
1575 | 'attribution' and 'citetitle' attributes to the right (you'll need |
---|
1576 | to insert a 'quote' attribute into your existing QuoteBlocks). |
---|
1577 | - It is no up to the DocBook processor to highlight source code syntax |
---|
1578 | in `<programlisting>` elements rather than GNU Highlighter -- this |
---|
1579 | is the correct way to handle it, plus `dblatex(1)` makes a much |
---|
1580 | better job. |
---|
1581 | - 'scaledwidth' and 'align' attributes have been added to the 'image' |
---|
1582 | macro. They apply to DocBook outputs (specifically for PDF |
---|
1583 | documents). 'scaledwidth' sets the image size as a percent of the |
---|
1584 | available page width; 'align' applies 'left', 'center' or 'right' |
---|
1585 | horizontal image justification. |
---|
1586 | - Added a2x(1) `--fop-opts=FOP_OPTS` option (patch submitted by Miklos |
---|
1587 | Vajna). |
---|
1588 | - Added a2x(1) `--dblatex-opts=DBLATEX_OPTS` option. |
---|
1589 | - Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing |
---|
1590 | `fo.xsl` problem and allows PDF's to be generated with FOP 0.95 |
---|
1591 | (previously had to use FOP 0.20.5). |
---|
1592 | - The User Guide has been updated and outdated FOP configuration and |
---|
1593 | installation sections removed. |
---|
1594 | |
---|
1595 | .Bug fixes |
---|
1596 | - Fixed `stylesheets/xhtml11-manpage.css` not being included when |
---|
1597 | 'linkcss' attribute was used. |
---|
1598 | - Configuration file `*-style` attributes are now dumped correctly. |
---|
1599 | - Fixed 'FAILED: malformed section entry' LaTeX backend error. |
---|
1600 | |
---|
1601 | See the also the https://sharesource.org/hg/asciidoc/[AsciiDoc |
---|
1602 | repository changelog]. |
---|
1603 | |
---|
1604 | |
---|
1605 | Version 8.2.6 (2008-04-29) |
---|
1606 | -------------------------- |
---|
1607 | .Additions and changes |
---|
1608 | - Enhancements to the Vim AsciiDoc syntax highlighter, for example, |
---|
1609 | quoted text is now highlighted in titles and macro captions. |
---|
1610 | - If you define the `data-uri` intrinsic attribute images referenced |
---|
1611 | by 'image' macros will be embedded in XHTML using the |
---|
1612 | http://en.wikipedia.org/wiki/Data:_URI_scheme[data: URI scheme]. |
---|
1613 | *NOTE*: Microsoft browser support for the 'data: URI scheme' is |
---|
1614 | currently limited to MSIE 8 beta 1. |
---|
1615 | - Added `toc-title` attribute to allow custom table of contents |
---|
1616 | titles. |
---|
1617 | - Added references to Alex Efros's AsciiDoc Cheatsheet to AsciiDoc |
---|
1618 | website. |
---|
1619 | - `asciidoc(1)` and `a2x(1)` man pages formatted to conform to |
---|
1620 | `man-pages(7)` recommendations. |
---|
1621 | - Old code-filter syntax (pre-8.1.0) is no longer recognized so that |
---|
1622 | malformed two-line level 2 titles are no longer confused with |
---|
1623 | 'code-filter' block delimiters. |
---|
1624 | - Added -> <- => <= arrow replacements from the Arrows block of |
---|
1625 | Unicode. |
---|
1626 | - Added DocBook refentry lang attribute -- patch contributed by |
---|
1627 | VMiklos. |
---|
1628 | - AttributeEntry names can now be numeric (``named macro targets''). |
---|
1629 | - Hide Table of Contents title if Table of Contents empty -- patch |
---|
1630 | contributed by Alex Efros. |
---|
1631 | - Various XHTML CSS tweaks. |
---|
1632 | - Code cleanup: |
---|
1633 | * Replaced `realpath()` with Python 2.2 `os.path.realpath()` library |
---|
1634 | function. |
---|
1635 | * Replaced old string library functions with string methods. |
---|
1636 | * Use file generators instead of `readlines()`. |
---|
1637 | * Renamed entities that shadowed builtins. |
---|
1638 | * Standardized string quoting. |
---|
1639 | * Dropped `readlines()` function. |
---|
1640 | |
---|
1641 | .Bug fixes |
---|
1642 | - Fixed broken CSS for decimal ordered lists nested in alpha ordered |
---|
1643 | list, thanks to Alex Efros. |
---|
1644 | - A missing closing block delimiter now reports the opening delimiter |
---|
1645 | line number instead of the end of file line number. |
---|
1646 | - Fixed an error generated by the asciidoc `-e` option when there are |
---|
1647 | no block definitions -- patch contributed by Alejandro Mery. |
---|
1648 | - Handle both `\r\n` (as well as `\n`) line separators that may be |
---|
1649 | returned by `{sys}` attribute evaluation. |
---|
1650 | - Numbered attribute names no longer interfere with positional |
---|
1651 | attribute list values. |
---|
1652 | |
---|
1653 | |
---|
1654 | Version 8.2.5 (2007-11-18) |
---|
1655 | -------------------------- |
---|
1656 | .Additions and changes |
---|
1657 | |
---|
1658 | .Bug fixes |
---|
1659 | - Fixed exception thrown by illegal command-line arguments. |
---|
1660 | - Rolled back the 'with' warning bug fix introduced in 8.2.4 -- it was |
---|
1661 | incompatible with Python <2.5. |
---|
1662 | |
---|
1663 | |
---|
1664 | Version 8.2.4 (2007-11-10) |
---|
1665 | -------------------------- |
---|
1666 | .Additions and changes |
---|
1667 | - You can now use the `lang` attribute to set the DocBook language |
---|
1668 | attribute. |
---|
1669 | - Attribute values can now contain attribute references. |
---|
1670 | - If the `lang` attribute is defined then configuration files named |
---|
1671 | like `lang-<lang>.conf` will be loaded automatically. |
---|
1672 | - The help file name `help-<lang>.conf` is based on the AsciiDoc |
---|
1673 | `lang` attribute, defaults to `help.conf` (English). |
---|
1674 | - Admonition, figure and table captions have been factored into a |
---|
1675 | predefined set of `caption_*` attributes. They only apply to |
---|
1676 | directly generated (X)HTML outputs (DocBook stylesheets generate |
---|
1677 | their own language specific captions based on the `lang` attribute). |
---|
1678 | - Dropped platform dependent `doc/asciidoc.chm` file from |
---|
1679 | distribution documentation formats. |
---|
1680 | |
---|
1681 | .Bug fixes |
---|
1682 | - The spurious warning 'with will become a reserved keyword |
---|
1683 | in Python 2.6' has been suppressed. |
---|
1684 | |
---|
1685 | |
---|
1686 | Version 8.2.3 (2007-09-12) |
---|
1687 | -------------------------- |
---|
1688 | .Additions and changes |
---|
1689 | - Added VMiklos's 'permalink' patch for auto-generated section IDs |
---|
1690 | (enabled by default by the `sectids` attribute). |
---|
1691 | - Added http://www.methods.co.nz/asciidoc/faq.html[FAQ] to website. |
---|
1692 | - Changed format of \{localdate} attribute to ISO 8601 (`%Y-%m-%d`). |
---|
1693 | - Added `abc2ly --beams=None` option to make `music2png.py` conform to |
---|
1694 | ABC's notion of beams. |
---|
1695 | - XHTML level 2 section headings are now styled with an underlining |
---|
1696 | border. |
---|
1697 | - XHTML links to AsciiDoc title elements are now implemented with |
---|
1698 | title ID attributes (previously separate `<a>` element targets were |
---|
1699 | generated. |
---|
1700 | - Multi-word first, middle and last names can be entered in the header |
---|
1701 | author line using the underscore as a word separator. |
---|
1702 | - The nested inline macros restriction has now been lifted, for |
---|
1703 | example you can now include links and inline images inside |
---|
1704 | footnotes. |
---|
1705 | - Help topic names can be shortened (so long as they are not |
---|
1706 | ambiguous). For example `asciidoc -hm` will print the AsciiDoc man |
---|
1707 | page. |
---|
1708 | - Added `{two_colons}` and `{two_semicolons}` attributes for |
---|
1709 | escaping labeled list ambiguity. |
---|
1710 | - If quirks mode is disabled the XHTML Mime Type is set to the |
---|
1711 | recommended `application/xhtml+xml` (rather than `text/html`). |
---|
1712 | |
---|
1713 | .Bug fixes |
---|
1714 | - Author information is now correctly set when using attribute entries |
---|
1715 | in the header instead of an author line (previously the 'author' |
---|
1716 | attribute was not being calculated correctly and there were |
---|
1717 | attribute substitution problems). |
---|
1718 | |
---|
1719 | |
---|
1720 | Version 8.2.2 (2007-07-22) |
---|
1721 | -------------------------- |
---|
1722 | .Additions and changes |
---|
1723 | - http://www.maths.nottingham.ac.uk/personal/drw/lm.html[LaTeXMathML] |
---|
1724 | capability has been added for users who are more familiar with or |
---|
1725 | prefer LaTeX math formulas to the |
---|
1726 | http://www.methods.co.nz/asciidoc/asciimathml.html[ASCIIMathML] |
---|
1727 | notation (thanks to Arthur Sakellariou for the patch). |
---|
1728 | - The 'source highlight' and 'code' filters now process embedded |
---|
1729 | callouts. |
---|
1730 | - Added an `--attribute=ATTRIBUTE` option to `a2x(1)` for passing |
---|
1731 | attribute values to asciidoc(1) (a shortcut for `--asciidoc-opts="-a |
---|
1732 | ATTRIBUTE"`). |
---|
1733 | - Image block and inline macros prepend optional `{imagesdir}` |
---|
1734 | attribute to image link targets. |
---|
1735 | |
---|
1736 | |
---|
1737 | .Bug fixes |
---|
1738 | - Fixed an assertion error that occurred when a configuration file |
---|
1739 | containing an `include::[]` macro was loaded using the |
---|
1740 | `--conf-file` option and the configuration file name did not |
---|
1741 | include an explicit directory path -- patch submitted by Dmitry |
---|
1742 | Potapov. |
---|
1743 | - Asciidoc titles are only converted to lower case if all characters |
---|
1744 | are upper case otherwise case is left unchanged -- patch submitted |
---|
1745 | by Dmitry Potapov. |
---|
1746 | - Added a missing check that input is not stdin before loading |
---|
1747 | configuration files from the document directory -- patch submitted |
---|
1748 | by Dmitry Potapov. |
---|
1749 | - Attribute list items must evaluate to strings, numbers or None |
---|
1750 | (previously it was possible to evaluate to other object types which |
---|
1751 | resulted in surprising attribute values). |
---|
1752 | - If an AsciiDoc document has no title an empty XHTML 1.1 'title' |
---|
1753 | element is created -- previously the 'title' element was dropped |
---|
1754 | which resulted in invalid XHTML 1.1. |
---|
1755 | - The Vim syntax file no longer highlights escaped callouts. |
---|
1756 | - The Vim syntax highlighter now correctly highlights Double-dollar |
---|
1757 | passthroughs when they enclose dollar delimited ASCIIMathML and |
---|
1758 | LaTeXMathML formulas. |
---|
1759 | |
---|
1760 | |
---|
1761 | Version 8.2.1 (2007-04-06) |
---|
1762 | -------------------------- |
---|
1763 | .Additions and changes |
---|
1764 | - A number of improvements have been made to the Vim syntax |
---|
1765 | highlighter, for example the word C++ is no longer mistaken for the |
---|
1766 | start of an unconstrained monospace quote. |
---|
1767 | - Labeled list definitions have been tightened -- a list label can no |
---|
1768 | longer containing trailing spaces. The following example is no |
---|
1769 | longer recognized as a valid list label: |
---|
1770 | |
---|
1771 | Lorum ipsum :: |
---|
1772 | + |
---|
1773 | This change implements the originally intended behavior (as per the |
---|
1774 | AsciiDoc documentation and examples) so there should be very few |
---|
1775 | compatibility issues. |
---|
1776 | |
---|
1777 | .Bug fixes |
---|
1778 | |
---|
1779 | |
---|
1780 | Version 8.2.0 (2007-04-04) |
---|
1781 | -------------------------- |
---|
1782 | .Additions and changes |
---|
1783 | - A Vim syntax file is now included in the AsciiDoc distribution |
---|
1784 | (inspired by Felix Obenhuber's `asciidoc.vim` script). You can find |
---|
1785 | it (along with a Vim filetype detection script in the distribution |
---|
1786 | `./vim/` directory (the scripts are installed automatically by the |
---|
1787 | AsciiDoc installer `./install.sh`). See 'Appendix J' of the |
---|
1788 | 'AsciiDoc User Guide' for details. |
---|
1789 | - Added 'toclevel' attribute (1..4) which sets the number of title |
---|
1790 | levels reported in the table of contents. Defaults to 2 and must be |
---|
1791 | used with the 'toc' attribute. Example usage: |
---|
1792 | |
---|
1793 | $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt |
---|
1794 | |
---|
1795 | - Added a `listindex` attribute which is the current list item index |
---|
1796 | (1..). If this attribute appears outside a list its value is the |
---|
1797 | number of items in the most recently closed list. |
---|
1798 | - The single line titles syntax now accepts trailing suffixes -- this |
---|
1799 | syntax matches the title line syntax of a number of popular Wiki |
---|
1800 | markups. |
---|
1801 | - If a QuoteBlock has no attribution or citetitle then the DocBook |
---|
1802 | `<attribution>` element is not generated (previously generated empty |
---|
1803 | `<attribution>` element). |
---|
1804 | - If the text of a labeled list item is blank then no `texttag` is |
---|
1805 | written. |
---|
1806 | - An end of line backslash performs line continuation for horizontal |
---|
1807 | labeled list items. |
---|
1808 | - The Revision line now accommodates Subversion `$Id` markers (in |
---|
1809 | addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for |
---|
1810 | this patch. |
---|
1811 | - Implemented `a2x(1)` option `--skip-asciidoc` which allows `a2x(1)` |
---|
1812 | to convert DocBook XML files not derived from AsciiDoc sources. |
---|
1813 | - If `a2x(1) --doctype` option is not specified it defaults to |
---|
1814 | `manpage` if `--format=manpage` else defaults to `article` |
---|
1815 | (previously `--doctype` always defaulted to `article`). |
---|
1816 | - Added an 'External Resources' section to the |
---|
1817 | http://www.methods.co.nz/asciidoc/index.html[AsciiDoc home page]. |
---|
1818 | |
---|
1819 | .Bug fixes |
---|
1820 | |
---|
1821 | |
---|
1822 | Version 8.1.0 (2006-10-22) |
---|
1823 | -------------------------- |
---|
1824 | .Additions and changes |
---|
1825 | - AsciiDoc generated XHTML documents now display a table of contents |
---|
1826 | if the 'toc' attribute is defined (JavaScript needs to be enabled |
---|
1827 | for this to work). Thanks to Troy Hanson who contributed this |
---|
1828 | feature based on a JavaScript by Mihai Bazon. I've simplified things |
---|
1829 | somewhat to match Docbook XSL Stylesheets style, see Troy's |
---|
1830 | http://tpl.sourceforge.net/userguide.html[tpl User Guide] for a |
---|
1831 | fancier layout. Use the `-a toc -a numbered` command-line options to |
---|
1832 | produce a number table of contents. |
---|
1833 | - A http://www.methods.co.nz/asciidoc/music-filter.html[music filter] |
---|
1834 | is included in the distribution `./filters/` directory. It |
---|
1835 | translates music in http://lilypond.org/[LilyPond] or |
---|
1836 | http://abcnotation.org.uk/[ABC] notation to standard classical |
---|
1837 | notation in the form of a trimmed PNG image which is inserted into |
---|
1838 | the AsciiDoc output document. |
---|
1839 | - Incorporated Paul Melis's Win32 filter patch. This workaround |
---|
1840 | allows AsciiDoc to run filters under Windows. |
---|
1841 | - Added `uninstall.sh` script. |
---|
1842 | - Rather than proliferate a confusing number of filter block |
---|
1843 | delimiters the following convention has been adopted: delimiters |
---|
1844 | belonging to DelimitedBlock filters distributed with AsciiDoc will |
---|
1845 | consist of a word (normally a noun identifying the block content) |
---|
1846 | followed by four or more tilde characters. This has necessitated |
---|
1847 | changing existing filter delimiters (the old delimiters still work |
---|
1848 | but may be deprecated in future versions): |
---|
1849 | |
---|
1850 | * The example code filter block delimiter is now the word `code` |
---|
1851 | followed by four or more tilde characters. |
---|
1852 | * The source highlight filter block delimiter is now the word |
---|
1853 | `source` followed by four or more tilde characters. |
---|
1854 | |
---|
1855 | - Conditionally redefined subscript and superscripting so they use the |
---|
1856 | old replacements mechanism when asciidoc7compatible is defined |
---|
1857 | rather than the asciidoc 8 default unconstrained quoting (patch for |
---|
1858 | affected files attached). |
---|
1859 | - Moved the source highlight filter from `./examples/` to `./filter/`. |
---|
1860 | - Added `{verbose}` intrinsic attribute (useful for passing verbose |
---|
1861 | flag to filters). |
---|
1862 | - Added `{outdir}` intrinsic attribute. |
---|
1863 | - Renamed `{docdir}` intrinsic attribute to unambiguous `{indir}` |
---|
1864 | (`{docdir}` still works but may be removed in future release). |
---|
1865 | - If `asciidoc(1)` outputs to stdout then intrinsic attribute |
---|
1866 | `{docname}` is extracted from the input file name. |
---|
1867 | |
---|
1868 | |
---|
1869 | Version 8.0.0 (2006-08-27) |
---|
1870 | -------------------------- |
---|
1871 | ********************************************************************* |
---|
1872 | This is a major release because changes to quoting and index entry |
---|
1873 | handling may break existing documents (see 'Additions and changes' |
---|
1874 | below and 'Appendix A: Migration Notes' in the AsciiDoc User Guide). |
---|
1875 | |
---|
1876 | Please report any problems you encounter. |
---|
1877 | |
---|
1878 | mailto:srackham@gmail.com['Stuart Rackham'] |
---|
1879 | ********************************************************************* |
---|
1880 | |
---|
1881 | .Additions and changes |
---|
1882 | - Quoting can can occur within words (based on patch submitted by |
---|
1883 | Benjamin Klum). See the 'Unconstrained Quotes' sub-section in the |
---|
1884 | User Guide. |
---|
1885 | |
---|
1886 | - The underline and plus characters can be used as alternatives to the |
---|
1887 | existing apostrophe and backtick quote characters. They are arguably |
---|
1888 | better choices than the apostrophe and backtick as they are not |
---|
1889 | confused with punctuation. |
---|
1890 | |
---|
1891 | - The syntax for index entry macros have have been deprecated from |
---|
1892 | `+...+` and `++...++` to `((...))` and `(((...)))` respectively. |
---|
1893 | Rationale: |
---|
1894 | * Bracketing is consistent other with `[[...]]` and `<<...>>` |
---|
1895 | reference macros. |
---|
1896 | * To easily confused with triple plus passthroughs. |
---|
1897 | * To make way for the new monospace quoting. |
---|
1898 | |
---|
1899 | - Superscripts and subscripts are implemented as constrained quotes so |
---|
1900 | they can now be escaped with a leading backslash and prefixed with |
---|
1901 | with an attribute list. |
---|
1902 | |
---|
1903 | - An experimental LaTeX backend has been written by Benjamin Klum (a |
---|
1904 | number additions in this release are to accommodate the LaTeX |
---|
1905 | backend). |
---|
1906 | - `include` macro file names now expand environment variables and |
---|
1907 | tilde expansions. |
---|
1908 | - A configuration file `[quotes]` entry can be undefined by setting to |
---|
1909 | a blank value. |
---|
1910 | - Added `callto` inline macro for Skype 'callto' links. |
---|
1911 | - Added `colnumber` attribute for table data markup. |
---|
1912 | - A leading comment block or comment lines are now skipped (previously |
---|
1913 | a document had to start with either attribute entries or a document |
---|
1914 | Title). |
---|
1915 | - Experimental `rows` attribute (number of source lines in table) |
---|
1916 | available in table markup templates (used by experimental LaTeX |
---|
1917 | backend). |
---|
1918 | - Included install shell script written by mailto:jlm@ofb.net[Jacob |
---|
1919 | Mandelson] for installing the tarball distribution. |
---|
1920 | - Added INSTALL documentation file. |
---|
1921 | - Added 'replacements2' substitution options -- a second replacements |
---|
1922 | section. |
---|
1923 | - Added the ability to redefine 'normal' and 'verbatim' substitutions |
---|
1924 | with `subsnormal` and `subsverbatim` entries in configuration file |
---|
1925 | `[miscellaneous]` section. |
---|
1926 | - By default `AttributeEntry` values are substituted for |
---|
1927 | `specialcharacters` and `attributes`, if you want a different |
---|
1928 | AttributeEntry substitution set the `attributeentry-subs` attribute. |
---|
1929 | - The `name` in `name=value` configuration file entries can now end |
---|
1930 | with a backslash, just escape the trailing backslash with a |
---|
1931 | backslash. For example: |
---|
1932 | |
---|
1933 | abc\\=xyz |
---|
1934 | + |
---|
1935 | Results in `name=abc\` and `value=xyz` -- previously this would have |
---|
1936 | escaped the `=` character. |
---|
1937 | |
---|
1938 | - A blank configuration file section deletes any preceding section |
---|
1939 | with the same name (applies to non-markup template sections). |
---|
1940 | - A command-line attribute value with a `@` suffix does not override |
---|
1941 | existing document and configuration file attributes (normally |
---|
1942 | command-line attributes have precedence over document and |
---|
1943 | configuration file attributes). |
---|
1944 | - `localtime` attribute is now encoded from the native system encoding |
---|
1945 | to the output encoding. Patch submitted by |
---|
1946 | mailto:m_pupil@yahoo.com.cn[FKtPp] -- here's his description of the |
---|
1947 | problem: |
---|
1948 | + |
---|
1949 | ``I am a Chinese user of AsciiDoc and I find that when I use UTF-8 |
---|
1950 | (the default encoding) to write asciidoc documents in Windows platform |
---|
1951 | the resulting html footer line will get screwed. It was caused by a |
---|
1952 | localized tzname that was always encoded in the windows native |
---|
1953 | encoding, which in my case is 'cp936'.'' |
---|
1954 | |
---|
1955 | - a2x(1) can generate Open Document Text files using |
---|
1956 | http://open.comsultia.com/docbook2odf/[docbook2odf]. Currently |
---|
1957 | `docbook2odf(1)` only processes a subset of DocBook, unimplemented |
---|
1958 | elements are skipped. |
---|
1959 | - The a2x(1) format option defaults to `xhtml` (previously a format |
---|
1960 | had to be specified explicitly). |
---|
1961 | - The `-d, \--doctype=DOCTYPE` option has been added to a2x(1) which |
---|
1962 | is a shortcut for `--asciidoc-options="--doctype=DOCTYPE"`. |
---|
1963 | - Replaced a2x(1) `--no-icons` and `--no-copy` options with their |
---|
1964 | negated equivalents: `--icons` and `--copy` respectively. The |
---|
1965 | default behavior has also changed: copying and use of icons is |
---|
1966 | disabled by default. Rationale: |
---|
1967 | * To make the default behavior more consistent since use of icons |
---|
1968 | and CSS stylesheets does not apply to all formats. |
---|
1969 | * To make the default behavior less surprising (the creation of icon |
---|
1970 | and stylesheet output files must now be explicit). |
---|
1971 | |
---|
1972 | - a2x(1) has been bumped from version 0.1.1 to version 1.0.0. |
---|
1973 | |
---|
1974 | |
---|
1975 | .Bug fixes |
---|
1976 | - Removed duplicate `./doc/a2x.1.txt` from distribution tarball. |
---|
1977 | - Documentation errata. |
---|
1978 | - Attribute replacement is no longer performed twice in Titles and |
---|
1979 | AttributeEntrys. |
---|
1980 | - a2x(1) skipped asciidoc(1) execution when rerun with different |
---|
1981 | `--asciidoc-options` options, it now always executes asciidoc(1). |
---|
1982 | The problem was that previously asciidoc(1) was executed only if the |
---|
1983 | output file was missing or older than the source file. |
---|
1984 | |
---|
1985 | |
---|
1986 | Version 7.1.2 (2006-03-07) |
---|
1987 | -------------------------- |
---|
1988 | .Additions and changes |
---|
1989 | - Support for |
---|
1990 | http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] |
---|
1991 | has been added. See 'Appendix I: ASCIIMathML Support' in the User |
---|
1992 | Guide and the examples at |
---|
1993 | http://www.methods.co.nz/asciidoc/asciimath.html. |
---|
1994 | - You can now prefix quoted text with inline attributes lists. You |
---|
1995 | can use this to set font size and color (XHTML and HTML outputs). |
---|
1996 | - Added `##...##` quoting -- it does nothing -- it's purpose is to |
---|
1997 | allow inline attributes to be applied to normal text. |
---|
1998 | - An 'inline passthrough' mechanism has been implemented. |
---|
1999 | - Configuration file comment lines can be escaped with a backslash -- |
---|
2000 | this is to allows the inclusion of configuration lines that start |
---|
2001 | with a hash character. |
---|
2002 | - The `scriptsdir` attribute can be used to specify the name of the |
---|
2003 | directory containing linked JavaScripts (see the |
---|
2004 | link:userguide.html#X33[User Guide] for details. |
---|
2005 | - The BackendBlock has been renamed PassthroughBlock for consistency |
---|
2006 | with the new inline passthrough naming. |
---|
2007 | - `a2x(1)` now works with the older `bash(1)` version 2.05b. Patch |
---|
2008 | submitted by mailto:francis@daoine.org[Francis Daly]. |
---|
2009 | - Content included by the `include1::[]` system macro is no longer |
---|
2010 | subject to attribute substitution so that ambiguities no longer |
---|
2011 | arise when used to include CSS or JavaScript files. |
---|
2012 | |
---|
2013 | |
---|
2014 | Version 7.1.1 (2006-02-24) |
---|
2015 | -------------------------- |
---|
2016 | .Additions and changes |
---|
2017 | - The `caption` attribute can be used to customize admonition captions |
---|
2018 | as well as image, table and example block element title prefixes |
---|
2019 | (`xhtml11` and `html4` backends). |
---|
2020 | - You can now override the default icon image using the `icon` |
---|
2021 | attribute to specify the path of the linked image (xhtml11 and html4 |
---|
2022 | backends only). |
---|
2023 | - The deprecated `imagesdir` attribute is no longer recognized (use |
---|
2024 | `iconsdir` instead). |
---|
2025 | - Added 'Appendix H: Using AsciiDoc with non-English Languages' to the |
---|
2026 | AsciiDoc User Guide. |
---|
2027 | - Added 'Admonition Icons and Captions' subsection to the User Guide |
---|
2028 | explaining how to customize Admonition elements. |
---|
2029 | |
---|
2030 | .Bug fixes |
---|
2031 | - `a2x(1)` failed when configuration files were installed in the |
---|
2032 | global `/etc/asciidoc/` directory -- it was only searching the |
---|
2033 | directory containing the asciidoc executable (thanks to Christian |
---|
2034 | Wiese for finding and submitting a patch this bug). |
---|
2035 | - The html4 backend admonition caption now correctly displays the |
---|
2036 | admonition `caption` attribute (previously displayed the `style` |
---|
2037 | attribute). |
---|
2038 | |
---|
2039 | |
---|
2040 | Version 7.1.0 (2006-01-13) |
---|
2041 | -------------------------- |
---|
2042 | .Additions and changes |
---|
2043 | - `a2x(1)` toolchain wrapper utility. This overcomes the biggest |
---|
2044 | hurdle for new users which seems to be assembling and using a |
---|
2045 | working DocBook XML toolchain. With `a2x(1)` you can generate XHTML |
---|
2046 | (chunked and unchunked), PDF, man page, HTML Help and text file |
---|
2047 | outputs from an AsciiDoc input file with a single command. All you |
---|
2048 | need to install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL |
---|
2049 | Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you |
---|
2050 | want text). |
---|
2051 | - Block titles can now start with any non-space character (previously |
---|
2052 | where not allowed to start with `.~-_` characters). |
---|
2053 | - `./stylesheets/docbook.css` renamed to |
---|
2054 | `./stylesheets/docbook-xsl.css` to clarify its function. |
---|
2055 | - Renamed `./docbook-xsl/manpages.xsl` to `./docbook-xsl/manpage.xsl` |
---|
2056 | for consistency. |
---|
2057 | - Admonition and navigation icons moved to `./images/icons/` to |
---|
2058 | clarify usage and conform with a2x(1) usage. |
---|
2059 | - Renamed xhtml11 intrinsic attribute `imagesdir` to `iconsdir` to |
---|
2060 | keep vocab consistent and changed default value to `./images/icons` |
---|
2061 | (previously `./images`). `imagesdir` attribute still accepted but |
---|
2062 | deprecated. |
---|
2063 | - Unused image files have been weeded out of the distribution. |
---|
2064 | - Packager notes (appendix B) have been updated to reflect the needs |
---|
2065 | of `a2x(1)`. |
---|
2066 | |
---|
2067 | IMPORTANT: The renaming of the xhtml11 backend `imagesdir` intrinsic |
---|
2068 | attribute and it's new default value introduces a backward |
---|
2069 | compatibility issue: if you use the `icons` attribute you will need to |
---|
2070 | either move your icons to the new default `./images/icons` location or |
---|
2071 | include an `--attribute{nbsp}iconsdir="your_icons_path"` option in |
---|
2072 | your asciidoc commands. |
---|
2073 | |
---|
2074 | .Bug fixes |
---|
2075 | - Backslash line continuation is now observed in verbatim paragraphs. |
---|
2076 | - Fixed errors generated by example |
---|
2077 | `./examples/website/build-website.sh` script. |
---|
2078 | |
---|
2079 | |
---|
2080 | Version 7.0.4 (2005-12-08) |
---|
2081 | -------------------------- |
---|
2082 | .Additions and changes |
---|
2083 | - Added ternary conditional attributes |
---|
2084 | `{<name>@<regexp>:<value1>[:<value2>]}` and |
---|
2085 | `{<name>$<regexp>:<value1>[:<value2>]}`. |
---|
2086 | - Safety violations now generate errors (they previously generated |
---|
2087 | warnings). |
---|
2088 | - asciidoc(1) now defaults to safe mode, consequently the |
---|
2089 | `[miscellaneous]` safe mode entry and `--safe` command-line option |
---|
2090 | are no longer necessary (though for backward compatibility |
---|
2091 | asciidoc(1) still accepts the `--safe` option). |
---|
2092 | - Backend Blocks are now flagged unsafe (they could be used to include |
---|
2093 | arbitrary and hence potentially unsafe output content). |
---|
2094 | - Filters are no longer considered unsafe. There's not much point in |
---|
2095 | insisting on filter safety since the installation of an unsafe |
---|
2096 | filter would require the introduction of new or modified |
---|
2097 | configuration files -- if your application configurations can be |
---|
2098 | compromised you're in all sorts of trouble (safe mode protects |
---|
2099 | against unsafe input files not unsafe configuration). As with all |
---|
2100 | filters, before installing, you should verify that they can't be |
---|
2101 | coerced into generating malicious output or exposing sensitive |
---|
2102 | information. |
---|
2103 | |
---|
2104 | .Bug fixes |
---|
2105 | - Fixed a lot of glaring grammatical and factual errors in the User |
---|
2106 | Guide. |
---|
2107 | |
---|
2108 | |
---|
2109 | Version 7.0.3 (2005-12-01) |
---|
2110 | -------------------------- |
---|
2111 | .Additions and changes |
---|
2112 | - Added `--safe` and `--unsafe` command-line options -- AsciiDoc can |
---|
2113 | now be executed in a 'safe mode' which disallows the execution of |
---|
2114 | arbitrary code or the inclusion of arbitrary files (see |
---|
2115 | link:userguide.html#X39[Appendix C in the AsciiDoc User Guide]). |
---|
2116 | - Included link:source-highlight-filter.html[source-highlight filter] |
---|
2117 | in the distribution `./examples/source-highlight-filter/` directory |
---|
2118 | (based on filter submitted by mailto:trolocsis@gmail.com[Ryan |
---|
2119 | Phillips]). |
---|
2120 | - Included the DocBook XSL Stylesheets 1.69.1 customizations used to |
---|
2121 | generate the distributed AsciiDoc documentation (read the |
---|
2122 | `asciidoc-docbook-xsl.txt` file in the distribution `./docbook-xsl/` |
---|
2123 | directory). |
---|
2124 | - AsciiDoc DocBook XSL Stylesheet drivers moved from `./doc/` to |
---|
2125 | `./docbook-xsl/`. |
---|
2126 | - Modified `./doc/manpages.xsl` so only URL content is displayed in |
---|
2127 | manpages. |
---|
2128 | |
---|
2129 | .Bug fixes |
---|
2130 | - Explicitly set table CSS border style (`xhtml11` backend) to `solid` |
---|
2131 | because default border styles vary from browser to browser. |
---|
2132 | |
---|
2133 | |
---|
2134 | Version 7.0.2 (2005-08-28) |
---|
2135 | -------------------------- |
---|
2136 | .Additions and changes |
---|
2137 | - There are now long versions of all AsciiDoc options. |
---|
2138 | - If the `--backend` is not specified it defaults to `xhtml11`. |
---|
2139 | - Added CSS simulated frames layout to the examples website (see |
---|
2140 | `./examples/website/layout2/README-website.txt`). This layout does |
---|
2141 | not work with IE6 and the original tables based layout is still the |
---|
2142 | default. |
---|
2143 | - Support page added to AsciiDoc website. |
---|
2144 | |
---|
2145 | .Bug fixes |
---|
2146 | - Invalid options are now trapped gracefully. |
---|
2147 | - Documentation errata. |
---|
2148 | |
---|
2149 | |
---|
2150 | Version 7.0.1 (2005-06-24) |
---|
2151 | -------------------------- |
---|
2152 | .Additions and changes |
---|
2153 | - Reverted to use of `strong`, `em`, `tt` XHTML tags -- they're more |
---|
2154 | obvious and no less correct than `span` tags, besides, the generated |
---|
2155 | file sizes are smaller (the 'User Guide' was 11% smaller). |
---|
2156 | - Table title rendered with `caption` tag rather than a separate |
---|
2157 | `div`. |
---|
2158 | - The AsciiDoc 'stylesdir' attribute (if specified) is now recognized |
---|
2159 | when searching for embedded stylesheets (previously only searched |
---|
2160 | default `./stylesheets` directory). |
---|
2161 | - Default charset encoding changed from ISO-8859-1 to UTF-8 -- it's |
---|
2162 | less language specific and displays most common languages. |
---|
2163 | - `template::[]` macros now expand in all configuration file sections |
---|
2164 | previously only in markup template sections. |
---|
2165 | - Cleaned up example website layout CSS and configuration |
---|
2166 | (presentation has not been changed). |
---|
2167 | - Refactored `xhtml11.conf` configuration file. |
---|
2168 | - Set consistent and sensible permissions on distributed files. |
---|
2169 | - White space is now stripped from DSV formatted table cell data. |
---|
2170 | - `class="tableblock"` attribute added to tables generated by |
---|
2171 | `xhtml-deprecated-css.conf` to assist CSS. |
---|
2172 | |
---|
2173 | .Bug fixes |
---|
2174 | - Illegal character set encoder (specified by the AsciiDoc `encoding` |
---|
2175 | attribute) and character data are trapped gracefully. |
---|
2176 | - AsciiDoc table 'format' attribute in table attribute lists were not |
---|
2177 | recognized. |
---|
2178 | - The nested horizontal labeled list example in the 'AsciiDoc User |
---|
2179 | Guide' has been dropped -- it generated invalid DocBook markup. |
---|
2180 | |
---|
2181 | |
---|
2182 | Version 7.0.0 (2005-06-06) |
---|
2183 | -------------------------- |
---|
2184 | *************************************************** |
---|
2185 | This is a major release with many code and |
---|
2186 | documentation changes. |
---|
2187 | Please report any problems you encounter. |
---|
2188 | |
---|
2189 | mailto:srackham@gmail.com['Stuart Rackham'] |
---|
2190 | *************************************************** |
---|
2191 | |
---|
2192 | .Additions and changes |
---|
2193 | - A new 'xhtml11' backend generates XHTML 1.1 with integrated CSS2 |
---|
2194 | replacing the previous 'xhtml', 'css', and 'css-embedded' backends. |
---|
2195 | - The CSS stylesheets have finally been rewritten. |
---|
2196 | - The asciidoc(1) command help now includes user |
---|
2197 | link:userguide.html#X36[customizable help] topics. When asciidoc is |
---|
2198 | invoked with the `--help` option the command argument is |
---|
2199 | interpreted as a help topic. |
---|
2200 | - The previous example website has been replaced by the actual |
---|
2201 | AsciiDoc website (see `./examples/website/`. |
---|
2202 | - XHTML generation options now controlled by the following attributes: |
---|
2203 | 'badges', 'linkcss', 'icons', 'numbered', 'quirks', 'theme', |
---|
2204 | 'stylesdir', 'imagesdir' (see the link:userguide.html#X33[User |
---|
2205 | Guide] for details. |
---|
2206 | - By default HTML and XHTML are output as stand-alone documents (no |
---|
2207 | embedded CSS and no linked admonition icon images). |
---|
2208 | - Documents encoded with the UTF-8 Unicode character set are now |
---|
2209 | processed thanks to a patch supplied by |
---|
2210 | mailto:viktor@rbg.informatik.tu-darmstadt.de[Viktor Vasilev]. |
---|
2211 | - The `-a ^name` command-line syntax to undefine an attribute has been |
---|
2212 | deprecated in favor of the `-a name!` syntax. |
---|
2213 | - AttributeEntry syntax addition: `:name!:` to undefine `name` attribute. |
---|
2214 | - Added `template` system block macro to allow the inclusion of one |
---|
2215 | configuration file template section within another. |
---|
2216 | - A 'verse' style attribute can now be applied to literal paragraphs |
---|
2217 | and blocks to reproduce line breaks and white space from the source |
---|
2218 | document. |
---|
2219 | - Replacements and Special Words can now be escaped with leading |
---|
2220 | backslashes. |
---|
2221 | - Replacements are now processed in configuration file order (previous |
---|
2222 | ordering was indeterminate). |
---|
2223 | - System macros can now be used in the base `asciidoc.conf` |
---|
2224 | configuration file. |
---|
2225 | - Deprecated features that emitted warnings in prior versions are no |
---|
2226 | longer tolerated. |
---|
2227 | - The `eval` system attribute expression evaluates to `False` the |
---|
2228 | attribute is undefined, if it evaluates to `True` the result is an |
---|
2229 | empty string. |
---|
2230 | - The Paragraph and DelimitedBlock 'presubs' parameter can be aliased |
---|
2231 | as 'subs'. |
---|
2232 | - Added 'verbatim' substitutions option. |
---|
2233 | - Renamed 'List Continuation Block' to 'List Block' and renamed the |
---|
2234 | 'listcontinuation' option to 'list'. |
---|
2235 | - Deprecated 'default' substitutions option (use 'normal' instead). |
---|
2236 | - The 'section-numbers' section numbering attribute has be renamed |
---|
2237 | 'numbered'. |
---|
2238 | - Dropped the '\#UNDER CONSTRUCTION#' block macro. |
---|
2239 | - Rewrote Paragraph and DelimitedBlock handlers adding a |
---|
2240 | link:userguide.html#X23[styles] configuration entry. |
---|
2241 | |
---|
2242 | .Bug fixes |
---|
2243 | - Included files are no longer read inside conditionally excluded |
---|
2244 | content. |
---|
2245 | - Manpage command names containing dashes (in the manpage NAME |
---|
2246 | section) were misinterpreted as the spaced dash command name/purpose |
---|
2247 | separator. Bug report and patch supplied by |
---|
2248 | mailto:david@dgreaves.com[David Greaves]. |
---|
2249 | - Unexpected error following malformed author line error. |
---|
2250 | |
---|
2251 | |
---|
2252 | Version 6.0.3 (2005-04-20) |
---|
2253 | -------------------------- |
---|
2254 | .Additions and changes |
---|
2255 | - Special characters are now substituted in AttributeEntry element |
---|
2256 | values. |
---|
2257 | - Spaced and unspaced em dashes are now recognized (previously only |
---|
2258 | spaced em dashes were recognized). |
---|
2259 | - Replaced the table 'noborders' option with richer 'frame' and 'grid' |
---|
2260 | attributes. |
---|
2261 | - The `duplicate macro` warning message now only occurs when the |
---|
2262 | verbose (`-v`) option is enabled. |
---|
2263 | - Single lines starting with two forward slashes hard up against the |
---|
2264 | left margin are treated as comments and are not processed. |
---|
2265 | - Renamed 'section' delimited block option to 'sectionbody' to more |
---|
2266 | accurately reflect it's role. |
---|
2267 | - Added a List Continuation block -- a specialized delimited block |
---|
2268 | that is functionally equivalent to the List Item Continuation |
---|
2269 | feature except that the list contained within the block does not |
---|
2270 | require explicit '+' list item continuation lines. |
---|
2271 | - Dropped deprecated `<u>` tags from generated HTML. |
---|
2272 | - Literal Block delimiters must now consist of at least four points |
---|
2273 | (previously three) to avoid lone ellipsis ambiguity. |
---|
2274 | |
---|
2275 | .Bug fixes |
---|
2276 | - Some system attribute evaluation failures caused unexpected |
---|
2277 | exceptions to occur. |
---|
2278 | |
---|
2279 | |
---|
2280 | Version 6.0.2 (2005-03-30) |
---|
2281 | -------------------------- |
---|
2282 | .Additions and changes |
---|
2283 | - Three new 'system' block macros have been added -- `eval`, `sys` and |
---|
2284 | `sys2` which are the block macro equivalents to the same named |
---|
2285 | system attributes. |
---|
2286 | - 'Intrinsic' macros have been renamed 'system' macros along with |
---|
2287 | 'action' attributes which have been renamed 'system' attributes: |
---|
2288 | * To reflect their common (though contextually different) behavior. |
---|
2289 | * To avoid confusion with 'intrinsic attributes'. |
---|
2290 | |
---|
2291 | .Bug fixes |
---|
2292 | - Asciidoc now searches in `/etc/asciidoc/filters` for filters. |
---|
2293 | |
---|
2294 | |
---|
2295 | Version 6.0.1 (2005-03-06) |
---|
2296 | -------------------------- |
---|
2297 | .Additions and changes |
---|
2298 | - A global configuration file location `/etc/asciidoc` has been added |
---|
2299 | and is now processed before all other locations (patch supplied by |
---|
2300 | mailto:stone@debian.org[Fredrik Steen]). |
---|
2301 | - Recoded `tempfile.mktemp()` and other artifacts that are no longer |
---|
2302 | necessary or desirable (patches supplied by |
---|
2303 | mailto:stone@debian.org[Fredrik Steen]). |
---|
2304 | - Added BUGS file to the distribution. |
---|
2305 | |
---|
2306 | .Bug fixes |
---|
2307 | - Illegal comment syntax in `css-embedded-stylesheet.conf` resulted in |
---|
2308 | illegal CSS in files generated by the `css-embedded` backend. |
---|
2309 | |
---|
2310 | |
---|
2311 | Version 6.0.0 (2005-01-28) |
---|
2312 | -------------------------- |
---|
2313 | *************************************************** |
---|
2314 | This release has had some fairly major code and |
---|
2315 | documentation changes. Please report any problems |
---|
2316 | you encounter. |
---|
2317 | |
---|
2318 | mailto:srackham@gmail.com['Stuart Rackham'] |
---|
2319 | *************************************************** |
---|
2320 | |
---|
2321 | A lot of new stuff. A new major version number -- some regression |
---|
2322 | incompatibility (hopefully mitigated by 'deprecated' warnings). |
---|
2323 | |
---|
2324 | Went mad trying to rein in the current feature anarchy -- established |
---|
2325 | a unified notion of document attributes. Attempted to introduce a |
---|
2326 | consistent vocabulary -- renamed many poorly or inconsistently named |
---|
2327 | entities. |
---|
2328 | |
---|
2329 | Actually, deprecated syntax is still processed correctly in almost all |
---|
2330 | cases. One source of incompatibility that may arise if you have |
---|
2331 | customized CSS stylesheets is the change of AsciiDoc CSS class names |
---|
2332 | (see below). I guess the moral is if you've done a lot of |
---|
2333 | configuration file customization and are happy with version 5 then you |
---|
2334 | may want to stay put. |
---|
2335 | |
---|
2336 | NOTE: This version requires Python 2.3 or better to run. |
---|
2337 | |
---|
2338 | .Additions and changes |
---|
2339 | - 'Glossary entries' have been renamed 'attributes'. This eliminates |
---|
2340 | confusion with the accepted meaning of glossary. |
---|
2341 | - An `AttributeEntry` block element has been added so that document |
---|
2342 | attributes can be assigned from within an AsciiDoc document. |
---|
2343 | - The `AttributeList` block element has been added which is a more |
---|
2344 | general solution than the (now deprecated) DelimitedBlock arguments. |
---|
2345 | - An BlockId element has been added for setting block element anchor |
---|
2346 | (link target) IDs. |
---|
2347 | - Quoted text can now span multiple lines (thanks to James Bowlin for |
---|
2348 | this patch). |
---|
2349 | - Inline macros can now span multiple lines. |
---|
2350 | - \``double backtick / apostrophe'' quotes generate ``curly quotes''. |
---|
2351 | - A warning is now emitted for out of order list item (applies to |
---|
2352 | explicitly enumerated numbered list items). |
---|
2353 | - Added `include` action attribute. |
---|
2354 | - A line of three or more apostrophes generates an HTML horizontal |
---|
2355 | ruler (`<hr/>` tag). You will get a warning if processed with |
---|
2356 | non-HTML backend. |
---|
2357 | - An `{imagesdir}` attribute specifies image file location for images |
---|
2358 | referenced in configuration files when generating HTML (the default |
---|
2359 | location is `images`). |
---|
2360 | - An `{stylesdir}` attribute specifies the location of CSS |
---|
2361 | stylesheets when generating styled HTML (the default location for |
---|
2362 | configured markup is `.`). |
---|
2363 | - The use of the (often inappropriately named) `{caption}` attribute |
---|
2364 | list entry has been deprecated, use `{0}` instead. |
---|
2365 | - New 'ExampleBlock' delimited block along with associated variants |
---|
2366 | Note, Tip, Warning, Caution and Important. |
---|
2367 | - The `docbook.conf` file now facilitates the optional inclusion of a |
---|
2368 | DocBook revision history file. |
---|
2369 | - To better reflect their purpose the following block elements have |
---|
2370 | been renamed: `VerbatimBlock` to `ListingBlock`; `IndentedBlock` to |
---|
2371 | `LiteralBlock`; `IndentedParagraph` to `LiteralParagraph`; |
---|
2372 | `CustomBlock` to `BackendBlock`; `SimpleSection` to `SectionBody`. |
---|
2373 | Any corresponding CSS class names have also been changed which could |
---|
2374 | result in backward incompatibility in customized stylesheets. |
---|
2375 | - Swapped plain DocBook admonition icons for Jimmac's DocBook icons |
---|
2376 | (http://jimmac.musichall.cz/ikony.php3). The original plain icons |
---|
2377 | have been moved to `./images/plain`. |
---|
2378 | - Renamed `html` backend to `xhtml` to better reflect it's function |
---|
2379 | (former `html-4` backend renamed to `html`). |
---|
2380 | - A new inline anchor macro syntax `[[[<id>]]]` is available, it |
---|
2381 | displays `[<id>]` at the anchor location and is for anchoring |
---|
2382 | bibliography list entries. |
---|
2383 | - An optional 'single-line titles' syntax can be used. |
---|
2384 | - Tweaks to distributed CSS stylesheets and FOP `fo.xsl` customization |
---|
2385 | file. |
---|
2386 | - 'List Item Continuation' has been implemented which allows |
---|
2387 | additional block elements to be included in list items by separating |
---|
2388 | them from the preceding list item element with a line containing a |
---|
2389 | single plus character. |
---|
2390 | - A new 'Horizontal Labeled List' list type has been added. Generates |
---|
2391 | two column list -- the first column contains the list element |
---|
2392 | labels, the second contains the element text. Same syntax as |
---|
2393 | `Vertical Labeled Lists` except the double colon label suffix is |
---|
2394 | followed by the start of the list item text. |
---|
2395 | |
---|
2396 | .Bug fixes |
---|
2397 | - Fixed broken backslash line continuation. |
---|
2398 | - Labeled list end tags were not undergoing attribute substitution. |
---|
2399 | - Documents without any author information now generate legitimate |
---|
2400 | DocBook (previously if the author line was not included in the |
---|
2401 | document header then an empty (illegal) DocBook `author` element was |
---|
2402 | generated). |
---|
2403 | - Multiple spaces in filter command arguments were replaced by a |
---|
2404 | single space. The `./examples/asciidoc2text/asciidoc2text.sh` script |
---|
2405 | now indents text correctly. |
---|
2406 | |
---|
2407 | |
---|
2408 | Version 5.1.1 (2004-10-10) |
---|
2409 | -------------------------- |
---|
2410 | *15-December-2004: Interim update:* Updated `asciidoc.py` to fix |
---|
2411 | broken `join_lines` function -- no other changes. |
---|
2412 | |
---|
2413 | - PDF documentation is now produced from DocBook XML using XSLTLib and |
---|
2414 | FOP. Previously we processed DocBook SGML with `jw(1)` (which used |
---|
2415 | Dvips to convert DVI files to PDF). FOP has come a long way in the |
---|
2416 | last 12 months and produces very acceptable PDF under both Linux and |
---|
2417 | Windows. |
---|
2418 | - Sections detailing how to install and use the DocBook XSL |
---|
2419 | Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers |
---|
2420 | have been added to the User Guide. |
---|
2421 | - The PDF output from the he example article template has been |
---|
2422 | included in the distribution (`./doc/article.pdf`). |
---|
2423 | - Special characters are emitted using decimal Unicode character codes |
---|
2424 | (previously used named character entities which cannot be assumed |
---|
2425 | included in non-HTML documents). |
---|
2426 | - Added registered trademark (R) to `[replacements]`. |
---|
2427 | - CSS stylesheet tweaks. |
---|
2428 | - Admonitions (Note, Tip, Important, Warning, Caution) include icons |
---|
2429 | when generating css output. |
---|
2430 | |
---|
2431 | |
---|
2432 | Version 5.1.0 (2004-09-18) |
---|
2433 | -------------------------- |
---|
2434 | - Callouts have been implemented (see the 'Callouts' section of the |
---|
2435 | AsciiDoc User Guide for details). |
---|
2436 | - Added XSL drivers for generating XHTML, chunked XHTML and HTML Help |
---|
2437 | from DocBook XML using XSL stylesheets and xsltproc(1). |
---|
2438 | - Added CSS stylesheet for HTML generated from DocBook XML using XSL |
---|
2439 | stylesheets. |
---|
2440 | - Distribution contains HTML Help formatted User Guide |
---|
2441 | (`./doc/asciidoc.chm`), the User Guide tells you how it's generated. |
---|
2442 | - Images referred to by distributed stylesheets are now located in the |
---|
2443 | `./images` subdirectory (previously located in `.`). |
---|
2444 | - Filters path names are now handled properly under Cygwin. |
---|
2445 | - The usual documentation and examples additions, updates and |
---|
2446 | polishing. |
---|
2447 | |
---|
2448 | |
---|
2449 | Version 5.0.9 (2004-09-09) |
---|
2450 | -------------------------- |
---|
2451 | - The convention of using a `.asc` file extension for AsciiDoc files |
---|
2452 | has been dropped in favor of the familiar `.txt` extension. It makes |
---|
2453 | more sense in that AsciiDoc is a text presentation format and |
---|
2454 | because `.asc` clashed with the same extension used by other |
---|
2455 | applications. It's only a naming convention -- you don't have to |
---|
2456 | switch if you don't want to. |
---|
2457 | - Changed the subscript formatting character from underline to tilde |
---|
2458 | since underscores in file names are reasonably common (especially in |
---|
2459 | link and image macros). |
---|
2460 | - An alternative syntax for the index term inline macro has been |
---|
2461 | added: `++<primary>,<secondary>,<tertiary>++`. |
---|
2462 | - Index terms that have secondary and tertiary entries now |
---|
2463 | additionally generate separate index terms for the secondary and |
---|
2464 | tertiary entries. |
---|
2465 | - A `+<primary>+` index term inline macro has been added which |
---|
2466 | displays the term in the primary text flow. |
---|
2467 | - Added alternative variable list definition using double semi-colon |
---|
2468 | terminator as opposed to the standard double colon terminator so |
---|
2469 | variable lists can be nested to two levels. |
---|
2470 | - Footnotes now appear on a separate line in HTML and Linuxdoc |
---|
2471 | outputs. |
---|
2472 | - Python version compatibility is checked at startup. |
---|
2473 | - Preface and appendix section titles in multi-part Book documents are |
---|
2474 | meant to be out of sequence -- warnings are no longer emitted when |
---|
2475 | outputting HTML. |
---|
2476 | - Empty section warnings have been replaced by error messages and are |
---|
2477 | emitted only if invalid markup would result. |
---|
2478 | - Missing macro sections or invalid macro name warnings are only |
---|
2479 | generated at startup if the `-v` (verbose) option is set. Otherwise |
---|
2480 | they are deferred until a matching macro is encountered in the input |
---|
2481 | file. |
---|
2482 | - Missing or invalid table definition warnings are only generated at |
---|
2483 | startup if the `-v` (verbose) option is set. Otherwise they are |
---|
2484 | deferred until a matching table is encountered in the input file. |
---|
2485 | - AsciiDoc now makes more of an effort to continue in the face of |
---|
2486 | errors. |
---|
2487 | - Fixed broken `./examples/website/main.aap` script. |
---|
2488 | - Converted distribution text files DOS text format as a sop to |
---|
2489 | Windows users with challenged text editors. |
---|
2490 | - Documentation additions and corrections. |
---|
2491 | |
---|
2492 | |
---|
2493 | Version 5.0.8 (2004-05-15) |
---|
2494 | -------------------------- |
---|
2495 | - Spurious 'out of sequence' level 2 warnings no longer appear when |
---|
2496 | processing 'book' document multi-part book top level Preface and |
---|
2497 | Appendix sub-sections since they are (correctly) out of sequence. |
---|
2498 | - A warning is no longer emitted for empty Index sections since this |
---|
2499 | is normal when generating DocBook outputs. |
---|
2500 | - Fixed: `[quotes]` configuration file entries where not being |
---|
2501 | overridden by downstream configuration file entries. |
---|
2502 | - Footnote text is now output enclosed in square brackets in HTML |
---|
2503 | documents. |
---|
2504 | - Added superscripts and subscripts to the standard PRS configuration |
---|
2505 | files. |
---|
2506 | - Adjusted CSS stylesheets so list titles don't have so much space |
---|
2507 | between title and first list item (broken in IE6 due to poor CSS |
---|
2508 | compliance). Lessened sidebar title top margin. |
---|
2509 | |
---|
2510 | |
---|
2511 | Version 5.0.7 (2004-04-22) |
---|
2512 | -------------------------- |
---|
2513 | - The version 5.0.6 README incorrectly stated that AsciiDoc would run |
---|
2514 | under Python 2.0, in fact it requires Python 2.1 or better. The |
---|
2515 | README has been corrected. |
---|
2516 | - Documented techniques for combining and splitting AsciiDoc documents |
---|
2517 | and processing the combined and split parts (see the 'Tips and |
---|
2518 | Tricks' section of the User Guide). |
---|
2519 | - An example of marking up superscripts and subscripts is documented |
---|
2520 | in the 'Tips and Tricks' section of the User Guide (the example |
---|
2521 | configuration file is in the AsciiDoc `examples` directory). |
---|
2522 | - Added ellipsis to shipped `[replacements]`; three periods output an |
---|
2523 | ellipsis entity. |
---|
2524 | - Removed unused 'SectionClose' class. |
---|
2525 | - The AsciiDoc 'Preamble' element is output as a DocBook 'Preface' |
---|
2526 | when processed as a 'book' document type (in older AsciiDoc versions |
---|
2527 | a warning was issued and processing stopped). |
---|
2528 | - Fixed a quoting anomaly: quoted text can no longer begin or end with |
---|
2529 | with white space. |
---|
2530 | |
---|
2531 | |
---|
2532 | Version 5.0.6 (2004-03-07) |
---|
2533 | -------------------------- |
---|
2534 | - New 'image' macro implements optional image scaling and linking and |
---|
2535 | works in both inline and block contexts. The 'image' macro obsolesces |
---|
2536 | the existing 'graphic' block macro and 'icon' inline macro. |
---|
2537 | - Macro substitution section names now have `-inlinemacro` and |
---|
2538 | `-blockmacro` suffixes to resolve context ambiguity, make their |
---|
2539 | purpose clearer and relieve section namespace congestion. |
---|
2540 | - Header derived glossary entries can now be overridden from the |
---|
2541 | command-line. |
---|
2542 | - Special character substitution is now performed on AuthorLine |
---|
2543 | derived author names. |
---|
2544 | - A macro or block argument called 'options' can be used as a shortcut |
---|
2545 | for a list named arguments with zero length string values. |
---|
2546 | - Tables can be output without borders using the `options="noborders"` |
---|
2547 | argument. |
---|
2548 | - Table data lines that do not immediately follow a table section |
---|
2549 | underline can now be blank. This allows CSV data with embedded blank |
---|
2550 | lines to be processed correctly. |
---|
2551 | - Blank DSV format table data lines are silently skipped. |
---|
2552 | - Tightened up on enforcement of configuration file section names to |
---|
2553 | reduce the possibility of section content being seen as a section |
---|
2554 | header line. |
---|
2555 | - Section titles can be optionally suffixed with title arguments |
---|
2556 | enclosed in double square brackets. |
---|
2557 | - A replacement has been added to `asciidoc.conf` to replace inline |
---|
2558 | double dashes with the `—` entity. |
---|
2559 | - Changed the `.UNDER-CONSTRUCTION.` macro syntax to |
---|
2560 | `#UNDER-CONSTRUCTION#` so it is not mistaken for a BlockTitle. |
---|
2561 | Similarly changed the `.NEW.` replacement with |
---|
2562 | `#NEW#`. |
---|
2563 | - `#NEW#` and `#UNDER-CONSTRUCTION#` macros are now |
---|
2564 | included in the DocBook backend. |
---|
2565 | - Replaced shipped `smallnew.gif` with `smallnew.png`. |
---|
2566 | - Documentation tidy ups. |
---|
2567 | |
---|
2568 | |
---|
2569 | Version 5.0.5 (2004-02-25) |
---|
2570 | -------------------------- |
---|
2571 | - Fixed the disappearing paragraph titles problem that was caused by |
---|
2572 | Inline macros (incorrectly) processing BlockTitles. |
---|
2573 | - Tightened AuthorLine validation. Previously invalid email addresses |
---|
2574 | and embedded special characters in the AuthorLine resulted in |
---|
2575 | invalid output markup. |
---|
2576 | |
---|
2577 | |
---|
2578 | Version 5.0.4 (2004-02-09) |
---|
2579 | -------------------------- |
---|
2580 | - Reinstated missing `infile`, `outfile`, `filetype` and |
---|
2581 | `filetype-<filetype>` glossary entries. |
---|
2582 | - As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater, |
---|
2583 | this has now been documented. |
---|
2584 | |
---|
2585 | |
---|
2586 | Version 5.0.3 (2004-01-23) |
---|
2587 | -------------------------- |
---|
2588 | - Fixed problem that caused any filters directory file containing |
---|
2589 | `.conf` (not just those with the `.conf` extension) from being |
---|
2590 | loaded. |
---|
2591 | - All `[miscellaneous]` configuration file entries can now be |
---|
2592 | referenced like glossary entries (they are now processed internally |
---|
2593 | as glossary entries). |
---|
2594 | - The output file line terminator (previously hardwired to `\r\n` is |
---|
2595 | now set using the `newline` entry in the configuration file |
---|
2596 | `[miscellaneous]` section. |
---|
2597 | - The misspelt `blocktitles` configuration file entry name has been |
---|
2598 | corrected (to `blocktitle`). |
---|
2599 | - An `{empty}` glossary entry has been added to the default |
---|
2600 | configuration which is useful for outputting trailing blank lines |
---|
2601 | from configuration file substitution sections. |
---|
2602 | |
---|
2603 | |
---|
2604 | Version 5.0.2 (2003-12-18) |
---|
2605 | -------------------------- |
---|
2606 | - New (alternative) 'anchor' and 'xref' macro syntax (old syntax still |
---|
2607 | valid). |
---|
2608 | - DocBook `mediaobject` and `inlinemediaobject` tags are generated in |
---|
2609 | place of `graphic` and `inlinegraphic` tags by the AsciiDoc |
---|
2610 | `graphic` and `icon` macros. If a macro argument is specified it is |
---|
2611 | the alternative text output if the target document format does not |
---|
2612 | support the specified graphic file format. |
---|
2613 | - Dropped the LinuxDoc left and right square bracket special character |
---|
2614 | substitutions as they interfered with macro substitution. |
---|
2615 | - Documentation updates and corrections. |
---|
2616 | |
---|
2617 | |
---|
2618 | Version 5.0.1 (2003-12-09) |
---|
2619 | -------------------------- |
---|
2620 | - Fixed problem with anchor tag when generating CSS styled HTML. |
---|
2621 | |
---|
2622 | |
---|
2623 | Version 5.0 (2003-12-08) |
---|
2624 | ------------------------ |
---|
2625 | *************************************************** |
---|
2626 | This release has had some fairly major code and |
---|
2627 | documentation changes. Please report any problems |
---|
2628 | you encounter. |
---|
2629 | |
---|
2630 | mailto:srackham@gmail.com['Stuart Rackham'] |
---|
2631 | *************************************************** |
---|
2632 | |
---|
2633 | - AsciiDoc can now produce a full-blown multi-part DocBook book |
---|
2634 | including dedication, abstract, preface, colophon, glossary, |
---|
2635 | appendix, bibliography and book part elements using the new |
---|
2636 | `specialsections` configuration file section. |
---|
2637 | - All Section element children (Paragraph, DelimitedBlock, List, |
---|
2638 | Table, BlockMacro) can now be titled using the BlockTitle element. |
---|
2639 | A BlockTitle element is a single line containing a title and |
---|
2640 | beginning with a period. |
---|
2641 | - The `index` and `backmatter` macros have been dropped, superseded by |
---|
2642 | `specialsections`. |
---|
2643 | - The AsciiDoc 'Preface' element has been renamed 'Preamble' (to avoid |
---|
2644 | confusion with the DocBook book preface element). |
---|
2645 | - Out of sequence titles are now tolerated with a warning. This allows |
---|
2646 | book document level 0 sections to be processed. |
---|
2647 | - An 'anchor' inline macro has been added for document link target |
---|
2648 | creation. |
---|
2649 | - 'Note', 'Tip', 'Important' and 'Warning' paragraph types have been |
---|
2650 | added to support the corresponding DocBook elements. |
---|
2651 | - Title substitution is now performed in SidebarBlock titles. |
---|
2652 | - DocBook graphics now output as `figure` and `informalfigure` |
---|
2653 | elements rather than `mediaobjects`. This ensures numbered figures |
---|
2654 | and a lists of figures are produced by the DocBook toolchain. |
---|
2655 | - You can now escape block argument lines by appending a backslash. |
---|
2656 | Alternatively, if you embed arguments in the delimiter line AsciiDoc |
---|
2657 | does not check for an arguments line. |
---|
2658 | - The default DocBook backend file extension has been changed from |
---|
2659 | `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). |
---|
2660 | - Warnings are output by default (previously they only printed when |
---|
2661 | verbose option enabled). |
---|
2662 | - A Question and Answer variable list definition has been added to the |
---|
2663 | shipped configuration files, primarily to create DocBook `qanda` |
---|
2664 | DocBook elements. |
---|
2665 | - Fixed broken code-filter `-b linuxdoc` option. The asciidoc.asc User |
---|
2666 | Guide can now be processed by linuxdoc(1) (although tables are |
---|
2667 | dropped because LinuxDoc does not implement tables). |
---|
2668 | |
---|
2669 | .Compatibility issues: |
---|
2670 | 1. Table titles are no longer in the arguments line, use the new |
---|
2671 | BlockTitles. |
---|
2672 | 2. Graphic titles are no longer in the 'graphic' block macro caption, |
---|
2673 | use the new BlockTitles. |
---|
2674 | 3. The code-filter title must be placed in a preceding BlockTitle. |
---|
2675 | 4. SidebarBlock titles must be placed in a preceding BlockTitle. |
---|
2676 | 5. The DelimitedBlock option 'sidebar' has been renamed to 'section'. |
---|
2677 | 6. The default DocBook backend file extension has been changed from |
---|
2678 | `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). |
---|
2679 | |
---|
2680 | |
---|
2681 | Version 4.2 (2003-11-26) |
---|
2682 | ------------------------ |
---|
2683 | - The default HTML output is now XHTML 1.0 markup. To output the |
---|
2684 | former HTML 4 markup specify the `html-4` backend. |
---|
2685 | - The default DocBook output is now DocBook XML. To output the former |
---|
2686 | DocBook SGML specify the `docbook-sgml` backend. The associated |
---|
2687 | `docbook-sgml.conf` file illustrates how to support minor DTD |
---|
2688 | variations. Examples of using the `xmlto(1)` command for DocBook |
---|
2689 | conversion have been added to the User Guide. |
---|
2690 | - Glossary entries set using the command-line -g option can now be |
---|
2691 | referenced in configuration files. |
---|
2692 | - Configuration dumps (`-c` command-line option) no longer output |
---|
2693 | redundant undefined glossary entries. |
---|
2694 | - DelimitedBlock arguments can now be specified in a separate arguments |
---|
2695 | line immediately following the leading delimiter line, This is in |
---|
2696 | preference to the existing delimiter embedded arguments. Reasons: |
---|
2697 | * The syntax is in keeping with the Tables arguments syntax. |
---|
2698 | * It's easier to enter and implements line continuation. |
---|
2699 | - A new QuoteBlock DelimitedBlock definition has been added to the |
---|
2700 | distribution configuration files. |
---|
2701 | - The table arguments lines can be continued using the backslash line |
---|
2702 | continuation character. |
---|
2703 | - Added new calculated glossary reference type `{<name>%<value>}`. |
---|
2704 | - Double-quote characters can now appear in unquoted positional |
---|
2705 | arguments. |
---|
2706 | |
---|
2707 | |
---|
2708 | Version 4.1 (2003-11-13) |
---|
2709 | ------------------------ |
---|
2710 | - Added DSV (Delimiter Separated Values) tables format. |
---|
2711 | - `{eval:<expr>}` glossary references drop the containing line if |
---|
2712 | `<expr>` evaluates to `None`. |
---|
2713 | - Block, Table and Macro arguments can now be positional (quoted or |
---|
2714 | unquoted). |
---|
2715 | - Vocabulary change: DelimitedBlock, Table and Macro 'attributes' are |
---|
2716 | now referred to as 'arguments'. This makes more sense in light of the |
---|
2717 | extended syntax and avoids confusion with backend markup tag |
---|
2718 | attributes. |
---|
2719 | - 'tablewidth' table ruler parameter can now be expressed in percent |
---|
2720 | units (0..100). If between 0 and 1 then the original fractional unit |
---|
2721 | measure is applied. |
---|
2722 | - The use of quoting for generating footnotes and index entries has |
---|
2723 | been dropped in favor of 'footnote' and 'indexterm' inline macros. |
---|
2724 | - 'backmatter' inline macro included in distribution. |
---|
2725 | - Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant. |
---|
2726 | - Fixed: 'tablewidth' was processed incorrectly when passed as table |
---|
2727 | argument. |
---|
2728 | - Fixed: Glossary references like `{x=\{y}}` were one character off |
---|
2729 | if \{x] was defined and `{y}` was not. |
---|
2730 | |
---|
2731 | |
---|
2732 | Version 4.0 (2003-11-08) |
---|
2733 | ------------------------ |
---|
2734 | *************************************************** |
---|
2735 | This release has had some fairly major code and |
---|
2736 | documentation changes. Please report any problems |
---|
2737 | you encounter. |
---|
2738 | |
---|
2739 | 'Stuart Rackham' |
---|
2740 | *************************************************** |
---|
2741 | |
---|
2742 | - Added tables to AsciiDoc. |
---|
2743 | - Added two special 'subs' options: 'default' specifies the default |
---|
2744 | substitution options and 'none' specifies no substitution. These |
---|
2745 | options can only appear singly. |
---|
2746 | - Line continuation using a trailing backslash character is available |
---|
2747 | in Paragraphs, ListItems, Tables. |
---|
2748 | - The left and right quotes for quoted text can now be specified |
---|
2749 | separately. |
---|
2750 | - Shipped configuration files implement footnotes (only useful for |
---|
2751 | DocBook output) using \[[]] quoting. |
---|
2752 | - Shipped configuration files implement index terms (only useful for |
---|
2753 | DocBook and LinuxDoc output) using \(()) quoting. |
---|
2754 | - The shipped 'html' backend configuration now emits valid 'HTML 4.01 |
---|
2755 | Transitional'. |
---|
2756 | - Added new calculated glossary reference types `{<name>!<value>}` |
---|
2757 | and `{<name>#<value>}`. |
---|
2758 | - The DelimitedBlock 'params' option has been dropped in favor of the |
---|
2759 | new 'block attributes' mechanism. If you have customized block |
---|
2760 | params options you may need to adjust source files to use the |
---|
2761 | 'block attributes' syntax. The example code filter has been updated |
---|
2762 | to reflect these changes. |
---|
2763 | - The code filter now has a `-t tabsize` option. |
---|
2764 | - Replaced `-w` option with `-v` (verbose) option. The warnings option |
---|
2765 | was just to confusing. |
---|
2766 | - Named attributes can now be specified in macro calls. |
---|
2767 | - The 'tabsize' attribute is recognized in the built-in `include` |
---|
2768 | macros. A tabsize of zero suppresses tab expansion. |
---|
2769 | - The configuration file `[options]` section has been split into |
---|
2770 | `[miscellaneous]` and `[titles]`. If you have customized any of |
---|
2771 | these settings you will need to adjust the affected configuration |
---|
2772 | files. |
---|
2773 | - Configuration file `[miscellaneous]` entries can now also be set |
---|
2774 | using the command-line `-g` option. |
---|
2775 | - Fixed: error that occurred when attempting to use zero length |
---|
2776 | configuration and source files. |
---|
2777 | - Fixed: blocking filter halt problem. |
---|
2778 | - Fixed: inline macro escape prefix problem. |
---|
2779 | - Fixed: missing macros from configuration dump problem. |
---|
2780 | - Fixed: named macros were dumped incorrectly. |
---|
2781 | - Many documentation changes/additions/corrections. |
---|
2782 | |
---|
2783 | |
---|
2784 | Version 3.2.2 (2003-10-26) |
---|
2785 | -------------------------- |
---|
2786 | - Added `-n` option (synonym for `-g section-numbers`). |
---|
2787 | - Dropped the processing commentary (hey, this is Unix). |
---|
2788 | - Added new calculated glossary reference type `{<name>?<value>}`. |
---|
2789 | `<name>` is the glossary entry name and `<value>` is the text |
---|
2790 | substituted if the glossary entry is defined. `<value>` can only |
---|
2791 | contain literal text (no glossary references allowed). |
---|
2792 | - Added `asciidoc2text` to distribution `examples/asciidoc2text` |
---|
2793 | directory (converts AsciiDoc source to text file with section |
---|
2794 | numbering). |
---|
2795 | - Fixed incorrect nesting of Simple lists inside Variable lists. |
---|
2796 | - List definitions have been modified so that list items can be |
---|
2797 | indented. This allows a more intuitive indentation of nested lists |
---|
2798 | in AsciiDoc source. |
---|
2799 | - Lists must be separated from preceding paragraphs by a blank line. |
---|
2800 | This is to avoid paragraph lines being mistaken for list items. |
---|
2801 | - Corrected asciidoc man page documentation error: the`-f` option does |
---|
2802 | *not* search relative to source document directory for the |
---|
2803 | configuration file. |
---|
2804 | - Minor updates to various distribution `.conf` files. |
---|
2805 | - Included `badges.conf` in `examples` directory. |
---|
2806 | - `css-embedded-stylesheet.conf` now supports footer badges. |
---|
2807 | - The default in-line element processing order has been changed: |
---|
2808 | Glossary References are now processed before Inline Macros. This |
---|
2809 | allows glossary expansions to occur inside macro references. |
---|
2810 | - Glossary entries are now allowed in Author and Revision lines. |
---|
2811 | - Default List `subs` options and Paragraph `presubs` options are |
---|
2812 | assigned the following default value if not specified: |
---|
2813 | |
---|
2814 | specialcharacters,quotes,specialwords,replacements,glossary,macros |
---|
2815 | |
---|
2816 | - Documentation changes/additions/corrections. |
---|
2817 | |
---|
2818 | |
---|
2819 | Version 3.2 (2003-05-26) |
---|
2820 | ------------------------ |
---|
2821 | - Added a `-s` command-line option to suppress the output of |
---|
2822 | `[header]` and `[footer]` sections. |
---|
2823 | - Article document headers are no longer mandatory: this allows |
---|
2824 | AsciiDoc to process arbitrary chunks of text. When used in |
---|
2825 | conjunction with the new `-s` command-line option corresponding |
---|
2826 | chunks of backend markup can be generated. |
---|
2827 | - AsciiDoc now emits a warning message and continues when an out of |
---|
2828 | sequence section title is detected (previously it failed and |
---|
2829 | halted). This allows document sections to be processed separately. |
---|
2830 | - Optional 'presubs' and 'postsubs' entries have been added to |
---|
2831 | 'DelimitedBlock' and 'Paragraph' definitions. As a consequence |
---|
2832 | substitution options are no longer legal in 'options' entries. |
---|
2833 | - 'presubs' and 'postsubs' substitutions are processed in the order |
---|
2834 | the options are specified (rather than the fixed 'options' order of |
---|
2835 | previous versions). |
---|
2836 | - ./filters subdirectories are automatically searched for filter |
---|
2837 | commands. |
---|
2838 | - A 'title-subs' configuration option specifies the substitutions |
---|
2839 | performed on document Header and Section titles. |
---|
2840 | - A 'subs' entry in now included in List configuration file |
---|
2841 | definitions that specified substitutions performed on list entry |
---|
2842 | text. |
---|
2843 | - Configuration files are auto-loaded from ./filters subdirectories. |
---|
2844 | - Added example code filter (see ./examples/filters). |
---|
2845 | - Bug fix: if section was empty you may have got erroneous 'missing |
---|
2846 | tag "paragraph"' error. |
---|
2847 | - Internal code tidy up. |
---|
2848 | |
---|
2849 | |
---|
2850 | Version 3.1 (2003-05-18) |
---|
2851 | ------------------------ |
---|
2852 | - In version 3.0 a `[macros]` section entry of the form 'name' was |
---|
2853 | equivalent to 'name='. An entry of the form 'name' now undefines the |
---|
2854 | entry (to bring it in line with the behavior of other special |
---|
2855 | sections). |
---|
2856 | - Paragraphs have now been generalized (in the same way as Lists and |
---|
2857 | DelimitedBlocks). |
---|
2858 | - The 'indentsize' option has been dropped as as consequence of |
---|
2859 | paragraph generalization. |
---|
2860 | - Pipe | characters can be included in substituted tag and |
---|
2861 | substitution section text using the \{brvbar} (broken vertical bar) |
---|
2862 | glossary reference. |
---|
2863 | - Removed the restriction requiring substitution section text |
---|
2864 | placeholders | to be on a separate line. |
---|
2865 | - Added an `-e` asciidoc(1) command option that excludes implicit |
---|
2866 | configuration files (used in conjunction with `-c` generated |
---|
2867 | configuration files). |
---|
2868 | - Version 3.0 documentation has undergone a considerable cleanup. |
---|
2869 | - The dumping of quoted section entries (see `-c` option) now works |
---|
2870 | correctly. |
---|
2871 | - The format of special section entries has been made consistent: |
---|
2872 | `name` undefines the entry; `name=` sets the entry value to a blank |
---|
2873 | string; `name=value` sets the entry value to `value`. |
---|
2874 | - As a consequence of the previous change the caret prefix is no |
---|
2875 | longer used in glossary configuration file entries (although it is |
---|
2876 | still used when undefining an entry using the `-g` command-line |
---|
2877 | option). |
---|
2878 | |
---|
2879 | |
---|
2880 | Version 3.0 (2003-05-13) |
---|
2881 | ------------------------ |
---|
2882 | This version is the culmination of work begun in the 2.x releases |
---|
2883 | whereby fixed policy has been replaced by extensible mechanisms. |
---|
2884 | |
---|
2885 | - Added `-c` command-line option to dump a composite asciidoc(1) |
---|
2886 | configuration file to stdout. |
---|
2887 | - Lists and Delimited Blocks are now defined by a set of configuration |
---|
2888 | file parameter sections. The user can modify the default |
---|
2889 | definitions or add new ones. |
---|
2890 | - Block content can now be processed through external filters. |
---|
2891 | - The default behavior for Custom Blocks is to perform glossary |
---|
2892 | substitution (previously there was no substitution inside Custom |
---|
2893 | Blocks). |
---|
2894 | - The old 2.x style macros have been reimplemented; as with Lists and |
---|
2895 | Delimited Blocks there syntax and behavior can be configured by the |
---|
2896 | user. The default macro syntax remains the same but the semantics |
---|
2897 | are now (hopefully) a bit more intelligible. |
---|
2898 | - Block and Builtin macros use :: delimiter instead of the 2.x single |
---|
2899 | colon delimit (to distinguish them from inline macros). The 2.x |
---|
2900 | syntax is still supported for backward compatibility. |
---|
2901 | - Nested lists are now supported and IndentedParagraphs can be |
---|
2902 | included in list items. |
---|
2903 | - Conditional source inclusion can be specified using built in `ifdef`, |
---|
2904 | `ifndef` and `endif` macros. |
---|
2905 | - The new conditional source inclusion feature has been used to reduce |
---|
2906 | the number of default configuration files down to one per backend. |
---|
2907 | - A change of name: 2.x 'Substitutions' are now called 'Replacements' |
---|
2908 | and the 2.x `[substitutions]` configuration file section is now |
---|
2909 | called `[replacements]` (the old name is still recognized for |
---|
2910 | backward compatibility). |
---|
2911 | - The line break is now implemented as a 'Replacements' substitution. |
---|
2912 | - Inline 'icon' macro for inline images has been added to default |
---|
2913 | configuration files. |
---|
2914 | |
---|
2915 | Version 2.2 (2003-04-07) |
---|
2916 | ------------------------ |
---|
2917 | - The `master.conf` configuration file name has been deprecated in |
---|
2918 | favor of `asciidoc.conf`. |
---|
2919 | - The standard configuration files set is now loaded from the |
---|
2920 | `.asciidoc` folder in the users home directory (if it exists) and |
---|
2921 | then from the source document directory. Configuration files that |
---|
2922 | don't exist are silently skipped. |
---|
2923 | - Configuration files named like the source file will be automatically |
---|
2924 | loaded if they are found in the source file directory. For example |
---|
2925 | if the source file is `mydoc.asc` and the `-b html` option is used |
---|
2926 | then asciidoc(1) will look for `mydoc.conf` and `mydoc-html.conf` in |
---|
2927 | that order. |
---|
2928 | - The characters used to quote formatted text can be configured and |
---|
2929 | extended by the user (see the master.conf [quotes] section). |
---|
2930 | - Quoted text can now be escaped by prefixing a backslash character to |
---|
2931 | the leading quote. |
---|
2932 | - The double single-quote '' strong text quote has been deprecated in |
---|
2933 | favor of an asterisk * character. |
---|
2934 | - Added \{eval:expression}, \{sys:command} and \{sys2:command} |
---|
2935 | glossary reference actions. |
---|
2936 | - Trailing brace characters `}` are now allowed inside glossary |
---|
2937 | references provided they are escaped with a backslash character. |
---|
2938 | - Glossary entries can now be escaped by prefixing a backslash |
---|
2939 | character to the leading brace character (use this in preference to |
---|
2940 | placing the backslash inside the brace). |
---|
2941 | - The output macro has been deprecated (use the new include1 macro |
---|
2942 | inside a CustomBlock). |
---|
2943 | - The default document type is `article` (asciidoc no longer attempts |
---|
2944 | to guess). |
---|
2945 | - Files included within DelimitedBlocks are not searched for block |
---|
2946 | termination underlines. This ensures the entire file is part of the |
---|
2947 | DelimitedBlock. |
---|
2948 | - `include` macros can now be used in configuration files. |
---|
2949 | - Corrected \{infile} and \{outfile} glossary entry documentation. |
---|
2950 | - File inclusion is now limited to a depth of 5 to catch recursion |
---|
2951 | loops. |
---|
2952 | - Inline tags have been deprecated, they're not necessary and they |
---|
2953 | immediately make the source document backend specific. Use |
---|
2954 | CustomBlocks or Substitutions instead. |
---|
2955 | |
---|
2956 | Version 2.1 (2003-03-17) |
---|
2957 | ------------------------ |
---|
2958 | - Added section auto numbering `{sectnum}` glossary entry |
---|
2959 | (auto-numbering function contributed by Ludovico Magnocavallo). |
---|
2960 | - asciidoc(1) now correctly returns non-zero exit status if an error |
---|
2961 | occurs. |
---|
2962 | - An AsciiDoc example website has been included in the AsciiDoc |
---|
2963 | distribution `examples/website` directory. |
---|
2964 | - NOTE: The `asciidoc` wrapper script included in the 2.0 distribution |
---|
2965 | has been dropped, if you've symlinked or aliased to `asciidoc` you'll |
---|
2966 | need to change them to point directly to `asciidoc.py` instead. |
---|
2967 | - An RCS $Id$ marker can be used as the document header revision line |
---|
2968 | (based on a patch submitted by Ludovico Magnocavallo). |
---|
2969 | - In addition to the `name=value` glossary entry format two new ones |
---|
2970 | have been introduced: `name` (the default value is set to an empty |
---|
2971 | string) and `^name` (the glossary entry is undefined). |
---|
2972 | - The `-q` command-line option has been deprecated and the `-w level` |
---|
2973 | command-line option added. + |
---|
2974 | NOTE: By default skipped substitution warnings are now suppressed. |
---|
2975 | - If a configuration file specified with the `-f` command-line option |
---|
2976 | is not found relative to the current working directory then the |
---|
2977 | search is repeated relative to the asciidoc(1) directory. This |
---|
2978 | allows global configuration files to be used. |
---|
2979 | - Added `{infile}`, `{outfile}` predefined glossary entries. |
---|
2980 | - Added `under-construction` macro to HTML article configuration |
---|
2981 | files. |
---|
2982 | - Deprecated `{asciidoc_version}` glossary entry in favor of |
---|
2983 | `{asciidoc-version}` (to it consistent with other entries). |
---|
2984 | |
---|
2985 | Version 2.0 (2003-02-24) |
---|
2986 | ------------------------ |
---|
2987 | - The emphasized, strong and monospaced words options have been |
---|
2988 | generalized with the introduction of macro based 'special words' |
---|
2989 | lists. |
---|
2990 | - Glossary references can now appear in both the document and macro |
---|
2991 | bodies. |
---|
2992 | - All output files use `crlf` line termination (previously used UNIX |
---|
2993 | `lf` (newline) termination). |
---|
2994 | - Added [substitutions] section which implements arbitrary regular |
---|
2995 | expression based substitutions. |
---|
2996 | - An optional `master.conf` configuration file can be used for entries |
---|
2997 | that are not backend or document type specific. |
---|
2998 | - Special character definitions moved from the code to the new |
---|
2999 | [special_characters] configuration file section. |
---|
3000 | - Configuration file glossary added. |
---|
3001 | - Command-line -g glossary entry added. |
---|
3002 | - A new 'book' document type has been implemented for the 'docbook' |
---|
3003 | backend. It outputs DocBook 'book' documents. |
---|
3004 | - A major internal change has been the implementation of parametrized |
---|
3005 | user definable 'macros'. Internally most document elements are now |
---|
3006 | processed as macros. |
---|
3007 | - Configuration file macro variables can be specified with default |
---|
3008 | values (literals or other macro variables). |
---|
3009 | - An attempt has been made to tighten up the vocabulary used to |
---|
3010 | describe the AsciiDoc document syntax. |
---|
3011 | - The term abstract has been replaced by the more general term |
---|
3012 | 'preface' and a new preface section introduced into article |
---|
3013 | configuration files (replacing the synopsis sections). |
---|
3014 | - Any section elements can now be put in the document preface |
---|
3015 | (previous versions only allowed paragraphs). |
---|
3016 | - AsciiDoc Blocks have been unified and their behavior can be user |
---|
3017 | defined and parametrized. |
---|
3018 | - An 'output' inclusion allows an external file to be written directly |
---|
3019 | to the backend output file. |
---|
3020 | - A new CustomBlock has been added. Default behavior is to insert the |
---|
3021 | enveloped AsciiDoc source lines directly into the output file. |
---|
3022 | - A 'line break' tag can be inserted by terminating a line with a '+' |
---|
3023 | character (only really useful for HTML backends). |
---|
3024 | - An fourth section level has been introduced. |
---|
3025 | - The SidebarBlock delimiter line characters have been changed. The |
---|
3026 | deprecated underline is still accepted. |
---|
3027 | - Levels 2 and 3 title underline characters have been changed. The |
---|
3028 | deprecated underlines are still accepted. |
---|
3029 | - Lines with backend specific inline tags can be inserted into |
---|
3030 | AsciiDoc source files. |
---|
3031 | - Single words enveloped by underscores are no longer emphasized. This |
---|
3032 | feature was deprecated as it is redundant (use single quotes |
---|
3033 | instead) and was being applied to file names with underscores. |
---|
3034 | - A `-q` quiet option has been added to suppress warning messages. |
---|
3035 | - Badge images sourced locally. |
---|
3036 | - Added 'author' and 'author-mail' meta tags to HTML configuration |
---|
3037 | files. |
---|
3038 | |
---|
3039 | Version 1.5 (2003-01-08) |
---|
3040 | ------------------------ |
---|
3041 | - Implemented sidebar document elements. |
---|
3042 | - Explicit checks for user specified configuration files and input |
---|
3043 | file (rather than throwing exception). |
---|
3044 | |
---|
3045 | Version 1.4 (2003-01-04) |
---|
3046 | ------------------------ |
---|
3047 | - New configuration file options 'emphasizedwords' and 'strongwords'. |
---|
3048 | These allow the definition of words that will always be emphasized |
---|
3049 | or rendered in a strong font without inline formatting. |
---|
3050 | - Document and section titles are no long subject to inline |
---|
3051 | formatting. |
---|
3052 | - Multiple configuration files can be overlaid in a single command. |
---|
3053 | - Configuration file tags and options entries can now be overridden on |
---|
3054 | an entry by entry basis (previously the entire section was |
---|
3055 | overloaded). |
---|
3056 | - Configuration file tags and options entries are now cached this has |
---|
3057 | resulted in around 37% performance improvement over version 1.3. |
---|
3058 | - Variable lists can now contain multiple terms per list item. |
---|
3059 | - Placeholder paragraph eliminated from empty sections that contain |
---|
3060 | subsections. |
---|
3061 | - Added \{asciidoc_version} substitution variable. |
---|
3062 | - More documentation additions and tidy ups. |
---|
3063 | |
---|
3064 | Version 1.3 (2003-01-01) |
---|
3065 | ------------------------ |
---|
3066 | - A new 'strong' text formatting convention has been implemented: |
---|
3067 | Word phrases enclosed in pairs of single quote characters (acute |
---|
3068 | accents) are rendered in a strong font (usually bold). |
---|
3069 | - Paragraphs can now be followed immediately by Simple lists and |
---|
3070 | Ordered lists without an intervening blank line. |
---|
3071 | - A user specified configuration file (`asciidoc(1)` -f option) |
---|
3072 | overlays the default configuration file rather than replacing it. |
---|
3073 | Custom configuration files need only contain those sections |
---|
3074 | that have been customized. |
---|
3075 | - Comment Block delimiters have been relaxed slightly. They must start |
---|
3076 | with three forward slashes /// but the remainder can contain any |
---|
3077 | characters, this allows comments to be embedded in the delimiter line. |
---|
3078 | - Leading non-digit characters preceding revision number are now |
---|
3079 | ignored. |
---|
3080 | - Set default indentsize [option] from 2 to documented default value |
---|
3081 | of zero in HTML backend html-article.conf and html-manpage.conf |
---|
3082 | files. |
---|
3083 | - Fixed error that occurred when taking input from stdin without |
---|
3084 | explicitly specifying a document type. |
---|
3085 | - Restored file name and line number error message information. |
---|
3086 | - Changed deprecated -t option to -d in asciidoc --help and usage |
---|
3087 | command output. |
---|
3088 | - CSS styles tweaking. |
---|
3089 | - Code, configuration file and documentation tidy ups. |
---|
3090 | |
---|
3091 | Version 1.2 (2002-12-28) |
---|
3092 | ------------------------ |
---|
3093 | - Implemented 'include' URL to allow file inclusion. |
---|
3094 | - `fileextension` configuration file [option] renamed to more sensible |
---|
3095 | `outfilesuffix` (`fileextension` still accepted by this version but |
---|
3096 | will be dropped in future). |
---|
3097 | - Improved error reporting. |
---|
3098 | - CSS backends generate valid XHTML. |
---|
3099 | - New `css-embedded` backend generates HTML with embedded stylesheets |
---|
3100 | (use the `css` backend for linked stylesheets). The css-embedded |
---|
3101 | backend output contains no linked images so the generated html files |
---|
3102 | are completely self contained. |
---|
3103 | - Bug fixes. |
---|
3104 | |
---|
3105 | Version 1.1 (2002-12-03) |
---|
3106 | ------------------------ |
---|
3107 | - Added css (cascading style sheets) backend |
---|
3108 | - Implemented IndentedBlock document element. |
---|
3109 | - Tabsize command-line option has been deprecated in |
---|
3110 | favor of configuration file. |
---|
3111 | - Default indent width changed to zero. |
---|
3112 | - Added \{localdate} and \{localtime} substitution variables. |
---|
3113 | - Added optional [options] configuration file section with |
---|
3114 | fileextension, tabsize and indentsize options. |
---|
3115 | - Implemented \{authorinitials} substitution variable. |
---|
3116 | - Added https link type. |
---|
3117 | - Corrected [graphic] substitution from \{title} to \{caption} |
---|
3118 | in linuxdoc-article.conf configuration file. |
---|
3119 | - Fixed error that occurred when '==' title underline was |
---|
3120 | used. |
---|
3121 | |
---|
3122 | Version 1.0 (2002-11-25) |
---|
3123 | ------------------------ |
---|
3124 | First AsciiDoc public release along with AsciiDoc web site |
---|
3125 | (http://www.methods.co.nz/asciidoc/) and SourceForge.net project registration |
---|
3126 | (https://sourceforge.net/projects/asciidoc/[]). |
---|
3127 | |
---|
3128 | // vim: set syntax=asciidoc: |
---|