1. Version 8.3.3 (2009-01-02)
This release supercedes 8.3.2.
Bug fixes
* The broken and confusing numeration and numeration2 numbered list
attributes have been dropped, use the style attribute instead.
__________________________________________________________________
2. Version 8.3.2 (2009-01-01)
Additions and changes
* Added Gouichi Iisaka's Graphviz filter to distribution.
* The SidebarBlock element can now be rendered with an abstract
style.
* Reorganized filters into a separate subdirectory for each filter.
* Updated Makefile.in and MANIFEST files to reflect new filters
organization.
* Added listing style to LiteralBlock element so listings with nested
listing blocks can be rendered as a listing block.
* Changed example code filter to use preferred ListingBlock syntax
(the old ~ delimited filter syntax is no longer used).
* Implemented enumeration and enumeration2 numbered list attributes
for specifying the list numbering style (arabic, loweralpha,
upperalpha, lowerroman and upperroman).
* AsciiDoc now recognizes upperalpha, lowerroman and upperroman
numbers in listdef-numbered2 numbered lists and sets the number
style based on the style of the first numbered list item
(alternative to setting enumeration2 attribute).
* Updated formatlistpat definition in .vimrc example in User Guide.
* You can now backslash escape system block macros.
* Added Pychart FAQ.
* Drop paragraph text and list text, index and label match groups
from attributes -- they are included in the element's text and we
don't want them processed a second time as attributes.
* Changed comment line block macro to a passthrough block macro to
ensure no substitutions.
* A subslist no longer has to be appended to a PassthroughBlock macro
definition, if omitted no substitutions are performed.
* Code tidy up: replaced deprecated <> operator with !=.
* Removed unused linuxdoc code.
* Code tidy ups: dropped old types module reference; replaced
has_key() with preferred in operator.
Bug fixes
* Old syntax source highlight filter regression: special characters
where not escaped in DocBook outputs.
__________________________________________________________________
3. Version 8.3.1 (2008-12-14)
Additions and changes
* Replaced the install.sh script with Ben Walton's updated autoconf
scripts -- see [1]INSTALL for details.
* Added a generalized AttributeEntry syntax to allow arbitrary
configuration file entries to be set from within an AsciiDoc
document (suggested by Henrik Maier).
* Listing delimited blocks in DocBook outputs now support IDs; IDs of
titled Listing and Literal delimited blocks have been moved to the
enclosing DocBook example tag (thanks to Vijay Kumar for this
patch).
* Replaced vertical typewriter apostrophe with punctuation apostrophe
(thanks to Noah Slater).
Bug fixes
* Regression: Excluding double-quotes from unquoted attribute values
resulted in backward incompatibility, double-quotes in unquoted
attribute values has been reinstated.
* Regression: Text like &...; was sometimes mistaken for an entity
reference -- tightened up entity reference matching.
__________________________________________________________________
4. Version 8.3.0 (2008-11-29)
Additions and changes
* [2]AsciiDoc new tables is a complete redesign of the tables syntax
and generation. The new syntax and features are a huge improvement
over the old tables. The old tables syntax has been deprecated but
is currently still processed.
* [3]Lists can now be styled like other block elements. This allows a
single list syntax for glossary, qanda (Question and Answer) and
bibliography lists instead of having to remember a different syntax
for each type.
* Inline passthroughs macros have been improved and block passthrough
macros added. Attribute substitution can be optionally specified
when the macro is called.
* The passthrough block has a fully transparent passthrough delimited
block block style called pass.
* The asciimath and latexmath [4]passthrough macros along with
asciimath and latexmath [5]passthrough blocks provide a (backend
dependent) mechanism for rendering mathematical formulas. There are
[6]LaTeX Math, [7]AsciiMathML and [8]LaTeXMathML examples on the
AsciiDoc website.
* Reimplemented and cleaned up filter processing based on a patch
submitted by Kelly Anderson. Uses the newer subprocess module
instead of the deprecated popen2 module. Now works in Win32 command
shell.
* Addition FAQs, more documentation updates.
* Arbitrary HTML/XML entities can be entered in AsciiDoc source.
* Did away with the need for the shaded-literallayout.patch (thanks
to Henrik Maier for this patch).
* Implemented page break block macro.
* Added line breaks and ruler processing instructions to DocBook
outputs (thanks to Henrik Maier for this patch).
* Added deg (degree) and wj (word joiner) entity attributes (thanks
to Henrik Maier).
* Tweaked DocBook indexterm2 macro to avoid white space preceding the
term when used in table cells (thanks to Henrik Maier for this
patch).
* Title elements now process the options attribute like other block
elements.
* Added `single quoted' element.
* Spaces on both sides of a -- em-dash are translated to thin space
characters.
* Improved detection and reporting of malformed attribute lists.
* The list compact style is now a list option.
* Added strong labeled list option which makes the labels bold (HTML
outputs only).
* Dropped unsupported linuxdoc backend.
* Dropped deprecated xhtml-deprecated (version 6) backend.
* Added breakable and unbreakable attribute options to tables to
control table breaking across page boundaries (DocBook XSL/FO
outputs). By and in collaboration with Henrik Maier.
* Added pgwide attribute option to tables to table, block image,
horizontal labeled lists. Specifies that the element should be
rendered across the full text width of the page irrespective of the
current indentation (DocBook XSL/FO outputs). Thanks to Henrik
Maier for this patch.
* Vim syntax highlighter: spaces before/after bullets no longer
highlighted (which is ugly if using a theme that highlights with
underlines). Thanks to Donald Chai for this patch.
* Added a2x(1) --fop option.
* Added a2x(1) --no-xmllint option.
* Highlighted labelled list terms with the navy color in XHTML
outputs.
* Use w3m(1) as default a2x(1) text format generator (fallback to
lynx(1)).
* Changed callout formats in html4 and xhtml11 outputs to angle
brackets to match source highlighter rendering.
* Macros now inject user defined <optionname>-option attributes into
markup.
* Added IRC URLs to AsciiDoc inline macros.
* Added depth attribute to include::[] system macro.
* Added footnoteref inline macro.
* Added stylesheet XHTML attribute to specify additional custom CSS
stylesheet.
* If a paragraph style is specified it will be added to the XHTML
class attribute and DocBook role attribute.
* Replacements can be set in a document using the reserved
AttributeEntry name replacement.
* The prefix for auto-generated section name IDs can be set with the
idprefix attribute.
Bug fixes
* Escaped quote skipped over leading and trailing quote instead of
just the leading quote.
* Fixed bug that was causing false negative safe mode warnings (patch
submitted by Julien Palmas).
* Placed priority of AttributeEntry, AttributeList and BlockTitle
above Title. This ensures an AttributeEntry, AttributeList or
BlockTitle followed by a same length leading ListingBlock delimiter
is not mistaken for a two-line title.
* Vim syntax highlighter: fixed multi-line quoted text.
* Contstrained quote termination after non-space character enforced.
* Vim syntax highlighter: unterminated quoted text is no longer
highlighted.
* Vim syntax highlighter: passthroughs now exactly match AsciiDoc
semantics.
* Vim syntax highlighter: escaped quoted text, attribute references
and inline macros are not highlighted.
* Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks
to Scott Wall); non-greedy $$...$$.
* Vim syntax highlighter: Comment lines mistaken for vertical list
labels (thanks to Scott Wall).
* Vim syntax highlighter: Single unmatched $$ mistakenly highlighted
remaining text (patch contributed by Scott Wall).
* Callouts now work in source highlighted listing generated by
dblatex.
* Fixed exception that occured if undefined attribute was present in
filter command.
* AttributeList block can now follow a paragraph without intervening
blank line.
* The include macro tabsize attribute is no longer propagated to
nested includes.
Omissions
The following features were implemented but then but removed from this
release:
* pi, cdata and comment passthrough macros and passthrough block
styles (creeping featurism, use pass macros instead).
* Generic tag inline macro (creeping featurism, use pass macros
instead).
4.1. Compatibility issues
Version 8.3.0 has a number of backward incompatibilities with respect
to the previous 8.2.7 release:
* The old table syntax is still processed but a DEPRECATED warning is
issued.
* Entity references have to be escaped with a backslash.
* You have to explicitly precede horizontal style labeled lists with
the [horizontal] style attribute -- by default all labeled lists
are rendered vertically.
* The list compact style has been dropped and is now a list option
(use options="compact" in attribute lists).
* AsciiDoc version 6 sytnax no longer supported.
* Linuxdoc been removed from the distribution.
* The unsupported experimental latex backend has not been tested on
this release.
* The introduction of single-quote quoting requires that double-quote
quoting is escaped with two backslashes.
__________________________________________________________________
5. Version 8.2.7 (2008-07-04)
Additions and changes
* Added dvi, ps and tex output format options to a2x(1).
* Added --dblatex option to a2x(1) so dblatex(1) can be used to
generate PDFs.
* Added custom dblatex(1) configuration files (in distribution
./dblatex directory) that are used by a2x(1).
* dblatex(1) is now used to generate the distributed PDF version of
the AsciiDoc User Guide.
* If you don't need a customized the link caption you can enter the
http, https, ftp, file URLs and email addresses without any special
macro syntax -- you get the links by just cutting and pasting URLs
and emails addresses. This also makes it easier to open links
directly form AsciiDoc source ( most editors allow you to open URLs
directly). The Vim syntax highlighter has been updated to reflect
these changes.
* Highlighted source code paragraphs have been implemented -- it's a
much more convenient way to enter short code examples (see [9]the
online docs).
* The source highlighter and music filter syntax has changed -- they
now used the ListingBlock syntax customized with source and music
style attribute values. This follows the Paragraph styling
convention introduced by the source paragraph (previous item) and
is easier to read. The old syntax still works but has been
deprecated.
* QuoteBlocks now have a verse style -- you no longer have to nest a
verse LiteralBlock inside a QuoteBlock for verses. The verse style
on the LiteralBlock has been deprecated (still works though) and
the style attribute is positional attribute 1, pushing attribution
and citetitle attributes to the right (you'll need to insert a
quote attribute into your existing QuoteBlocks).
* It is no up to the DocBook processor to highlight source code
syntax in <programlisting> elements rather than GNU Highlighter --
this is the correct way to handle it, plus dblatex(1) makes a much
better job.
* scaledwidth and align attributes have been added to the image
macro. They apply to DocBook outputs (specifically for PDF
documents). scaledwidth sets the image size as a percent of the
available page width; align applies left, center or right
horizontal image justification.
* Added a2x(1) --fop-opts=FOP_OPTS option (patch submitted by Miklos
Vajna).
* Added a2x(1) --dblatex-opts=DBLATEX_OPTS option.
* Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing
fo.xsl problem and allows PDF's to be generated with FOP 0.95
(previously had to use FOP 0.20.5).
* The User Guide has been updated and outdated FOP configuration and
installation sections removed.
Bug fixes
* Fixed stylesheets/xhtml11-manpage.css not being included when
linkcss attribute was used.
* Configuration file *-style attributes are now dumped correctly.
* Fixed FAILED: malformed section entry LaTeX backend error.
See the also the [10]AsciiDoc repository changelog.
bugfixes);
* asciidoc(1) and a2x(1) man pages formatted to conform to
man-pages(7) recommendations.
* Old code-filter syntax (pre-8.1.0) is no longer recognized so that
malformed two-line level 2 titles are no longer confused with
code-filter block delimiters.
- assume that Python 2.4 and 2.5 are compatible and allow checking for
fallout.
- remove PYTHON_VERSIONS_COMPATIBLE that are obsoleted by the 2.3+
default. Modify the others to deal with the removals.
1. Version 8.2.5 (2007-11-18)
Bug fixes
* Fixed exception thrown by illegal command-line arguments.
* Rolled back the with warning bug fix introduced in 8.2.4 -- it was
incompatible with Python <2.5.
__________________________________________________________________
2. Version 8.2.4 (2007-11-10)
Additions and changes
* You can now use the lang attribute to set the DocBook language
attribute.
* Attribute values can now contain attribute references.
* If the lang attribute is defined then configuration files named
like lang-<lang>.conf will be loaded automatically.
* The help file name help-<lang>.conf is based on the AsciiDoc lang
attribute, defaults to help.conf (English).
* Admonition, figure and table captions have been factored into a
predefined set of caption_* attributes. They only apply to directly
generated (X)HTML outputs (DocBook stylesheets generate their own
language specific captions based on the lang attribute).
* Dropped platform dependent doc/asciidoc.chm file from distribution
documentation formats.
Bug fixes
* The spurious warning with will become a reserved keyword in Python
2.6 has been suppressed.
__________________________________________________________________
3. Version 8.2.3 (2007-09-12)
Additions and changes
* Added VMiklos's permalink patch for auto-generated section IDs
(enabled by default by the sectids attribute).
* Added [1]FAQ to website.
* Changed format of {localdate} attribute to ISO 8601 (%Y-%m-%d).
* Added abc2ly --beams=None option to make music2png.py conform to
ABC's notion of beams.
* XHTML level 2 section headings are now styled with an underlining
border.
* XHTML links to AsciiDoc title elements are now implemented with
title ID attributes (previously separate <a> element targets were
generated.
* Multi-word first, middle and last names can be entered in the
header author line using the underscore as a word separator.
* The nested inline macros restriction has now been lifted, for
example you can now include links and inline images inside
footnotes.
* Help topic names can be shortened (so long as they are not
ambiguous). For example asciidoc -hm will print the AsciiDoc man
page.
* Added {two_colons} and {two_semicolons} attributes for escaping
labeled list ambiguity.
* If quirks mode is disabled the XHTML Mime Type is set to the
recommended application/xhtml+xml (rather than text/html).
Bug fixes
* Author information is now correctly set when using attribute
entries in the header instead of an author line (previously the
author attribute was not being calculated correctly and there were
attribute substitution problems).
__________________________________________________________________
4. Version 8.2.2 (2007-07-22)
Additions and changes
* [2]LaTeXMathML capability has been added for users who are more
familiar with or prefer LaTeX math formulas to the [3]ASCIIMathML
notation (thanks to Arthur Sakellariou for the patch).
* The source highlight and code filters now process embedded
callouts.
* Added an --attribute=ATTRIBUTE option to a2x(1) for passing
attribute values to asciidoc(1) (a shortcut for --asciidoc-opts="-a
ATTRIBUTE").
* Image block and inline macros prepend optional {imagesdir}
attribute to image link targets.
Bug fixes
* Fixed an assertion error that occurred when a configuration file
containing an include::[] macro was loaded using the --conf-file
option and the configuration file name did not include an explicit
directory path -- patch submitted by Dmitry Potapov.
* Asciidoc titles are only converted to lower case if all characters
are upper case otherwise case is left unchanged -- patch submitted
by Dmitry Potapov.
* Added a missing check that input is not stdin before loading
configuration files from the document directory -- patch submitted
by Dmitry Potapov.
* Attribute list items must evaluate to strings, numbers or None
(previously it was possible to evaluate to other object types which
resulted in surprising attribute values).
* If an AsciiDoc document has no title an empty XHTML 1.1 title
element is created -- previously the title element was dropped
which resulted in invalid XHTML 1.1.
* The Vim syntax file no longer highlights escaped callouts.
* The Vim syntax highlighter now correctly highlights Double-dollar
passthroughs when they enclose dollar delimited ASCIIMathML and
LaTeXMathML formulas.
__________________________________________________________________
5. Version 8.2.1 (2007-04-06)
Additions and changes
* A number of improvements have been made to the Vim syntax
highlighter, for example the word C++ is no longer mistaken for the
start of an unconstrained monospace quote.
* Labeled list definitions have been tightened -- a list label can no
longer containing trailing spaces. The following example is no
longer recognized as a valid list label:
Lorum ipsum ::
This change implements the originally intended behavior (as per the
AsciiDoc documentation and examples) so there should be very few
compatibility issues.
__________________________________________________________________
6. Version 8.2.0 (2007-04-04)
Additions and changes
* A Vim syntax file is now included in the AsciiDoc distribution
(inspired by Felix Obenhuber's asciidoc.vim script). You can find
it (along with a Vim filetype detection script in the distribution
./vim/ directory (the scripts are installed automatically by the
AsciiDoc installer ./install.sh). See Appendix J of the AsciiDoc
User Guide for details.
* Added toclevel attribute (1..4) which sets the number of title
levels reported in the table of contents. Defaults to 2 and must be
used with the toc attribute. Example usage:
$ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt
* Added a listindex attribute which is the current list item index
(1..). If this attribute appears outside a list its value is the
number of items in the most recently closed list.
* The single line titles syntax now accepts trailing suffixes -- this
syntax matches the title line syntax of a number of popular Wiki
markups.
* If a QuoteBlock has no attribution or citetitle then the DocBook
<attribution> element is not generated (previously generated empty
<attribution> element).
* If the text of a labeled list item is blank then no texttag is
written.
* An end of line backslash performs line continuation for horizontal
labeled list items.
* The Revision line now accommodates Subversion $Id markers (in
addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for
this patch.
* Implemented a2x(1) option --skip-asciidoc which allows a2x(1) to
convert DocBook XML files not derived from AsciiDoc sources.
* If a2x(1) --doctype option is not specified it defaults to manpage
if --format=manpage else defaults to article (previously --doctype
always defaulted to article).
* Added an External Resources section to the [4]AsciiDoc home page.
Mention docbook and LaTeX in DESCRiption.
Add sourceforge to MASTER_SITES.
Add more directories to INSTALLATION_DIRS (maybe some are redundant).
Also install a2x.
Install man pages.
Install various configs and icons.
Add do-test target.
Following is from the AsciiDoc ChangeLog:
1. Version 8.1.0 (2006-10-22)
* AsciiDoc generated XHTML documents now display as table of
contents if the toc attribute is defined (JavaScript needs to be
enabled for this to work). Thanks to Troy Hanson who contributed
this feature based on a JavaScript by Mihai Bazon. I've simplified
things somewhat to match Docbook XSL Stylesheets style, see Troy's
[1]tpl User Guide for a fancier layout. Use the -a toc -a numbered
command-line options to produce a number table of contents.
* A [2]music filter is included in the distribution ./filters/
directory. It translates music in [3]LilyPond or [4]ABC notation
to standard classical notation in the form of a trimmed PNG image
which is inserted into the AsciiDoc output document.
* Incorporated Paul Melis's Win32 filter patch. This workaround
allows AsciiDoc to run filters under Windows.
* Added uninstall.sh script.
* Rather than proliferate a confusing number of filter block
delimiters the following convention has been adopted: delimiters
belonging to DelimitedBlock filters distributed with AsciiDoc will
consist of a word (normally a noun identifying the block content)
followed by four or more tilde characters. This has necessitated
changing existing filter delimiters (the old delimiters still work
but may be deprecated in future versions):
+ The example code filter block delimiter is now the word code
followed by four or more tilde characters.
+ The source highlight filter block delimiter is now the word
source followed by four or more tilde characters.
* Conditionally redefined subscript and superscripting so they use
the old replacements mechanism when asciidoc7compatible is defined
rather than the asciidoc 8 default unconstrained quoting (patch
for affected files attached).
* Moved the source highlight filter from ./examples/ to ./filter/.
* Added {verbose} intrinsic attribute (useful for passing verbose
flag to filters).
* Added {outdir} intrinsic attribute.
* Renamed {docdir} intrinsic attribute to unambiguous`{indir}
({docdir}` still works but may be removed in future release).
* If asciidoc(1) outputs to stdout then instrinsic attribute
{docname} is extracted from the input file name.
_________________________________________________________________
2. Version 8.0.0 (2006-08-27)
This is a major release because changes to quoting and index entry
handling may break existing documents (see Additions and changes below
and Appendix A: Migration Notes in the AsciiDoc User Guide).
Please report any problems you encounter.
[5]Stuart Rackham
Additions and changes
* Quoting can can occur within words (based on patch submitted by
Benjamin Klum). See the Unconstrained Quotes sub-section in the
User Guide.
* The underline and plus characters can be used as alternatives to
the existing apostrophe and backtick quote characters. They are
arguably better choices than the apostrophe and backtick as they
are not confused with punctuation.
* The syntax for index entry macros have have been deprecated from
+...+ and +...+ to ((...)) and (((...))) respectively. Rationale:
+ Bracketing is consistent other with [[...]] and <<...>>
reference macros.
+ To easily confused with triple plus passthroughs.
+ To make way for the new monospace quoting.
* Superscripts and subscripts are implemented as constrained quotes
so they can now be escaped with a leading backslash and prefixed
with with an attribute list.
* An experimental LaTeX backend has been written by Benjamin Klum (a
number additions in this release are to accommodate the LaTeX
backend).
* include macro file names now expand environment variables and
tilde expansions.
* A configuration file [quotes] entry can be undefined by setting to
a blank value.
* Added callto inline macro for Skype callto links.
* Added colnumber attribute for table data markup.
* A leading comment block or comment lines are now skipped
(previously a document had to start with either attribute entries
or a document Title).
* Experimental rows attribute (number of source lines in table)
available in table markup templates (used by experimental LaTeX
backend).
* Included install shell script written by [6]Jacob Mandelson for
installing the tarball distribution.
* Added INSTALL documentation file.
* Added replacements2 substitution options -- a second replacements
section.
* Added the ability to redefine normal and verbatim substitutions
with subsnormal and subsverbatim entries in configuration file
[miscellaneous] section.
* By default AttributeEntry values are substituted for
specialcharacters and attributes, if you want a different
AttributeEntry substitution set the attributeentry-subs attribute.
* The name in name=value configuration file entries can now end with
a backslash, just escape the trailing backslash with a backslash.
For example:
abc\\=xyz
Results in name=abc\ and value=xyz -- previously this would have
escaped the = character.
* A blank configuration file section deletes any preceding section
with the same name (applies to non-markup template sections).
* A command-line attribute value with a @ suffix does not override
existing document and configuration file attributes (normally
command-line attributes have precedence over document and
configuration file attributes).
* localtime attribute is now encoded from the native system encoding
to the output encoding. Patch submitted by [7]FKtPp -- here's his
description of the problem:
"I am a Chinese user of AsciiDoc and I find that when I use UTF-8
(the default encoding) to write asciidoc documents in Windows
platform the resulting html footer line will get screwed. It was
caused by a localized tzname that was always encoded in the
windows native encoding, which in my case is cp936."
* a2x(1) can generate Open Document Text files using [8]docbook2odf.
Currently docbook2odf(1) only processes a subset of DocBook,
unimplemented elements are skipped.
* The a2x(1) format option defaults to xhtml (previously a format
had to be specified explicitly).
* The -d, --doctype=DOCTYPE option has been added to a2x(1) which is
a shortcut for --asciidoc-options="--doctype=DOCTYPE".
* Replaced a2x(1) --no-icons and --no-copy options with their
negated equivalents: --icons and --copy respectively. The default
behavior has also changed: copying and use of icons is disabled by
default. Rationale:
+ To make the default behavior more consistent since use of
icons and CSS stylesheets does not apply to all formats.
+ To make the default behavior less surprising (the creation of
icon and stylesheet output files must now be explicit).
* a2x(1) has been bumped from version 0.1.1 to version 1.0.0.
Bug fixes
* Removed duplicate ./doc/a2x.1.txt from distribution tarball.
* Documentation errata.
* Attribute replacement is no longer performed twice in Titles and
AttributeEntrys.
* a2x(1) skipped asciidoc(1) execution when rerun with different
--asciidoc-options options, it now always executes asciidoc(1).
The problem was that previously asciidoc(1) was executed only if
the output file was missing or older than the source file.
