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