Asciidoc

--------------------------
.Additions and changes
- Added VMiklos's 'permalink' patch for auto-generated section IDs
(enabled by default by the `sectids` attribute).
- Added http://asciidoc.org/faq.html[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).

--------------------------
.Additions and changes
- http://www.maths.nottingham.ac.uk/personal/drw/lm.html[LaTeXMathML]
capability has been added for users who are more familiar with or
prefer LaTeX math formulas to the
http://asciidoc.org/asciimathml.html[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.

--------------------------
.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.

.Bug fixes

--------------------------
.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
http://asciidoc.org/index.html[AsciiDoc home page].

.Bug fixes

--------------------------
.Additions and changes
- AsciiDoc generated XHTML documents now display a 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
http://tpl.sourceforge.net/userguide.html[tpl User Guide] for a
fancier layout. Use the `-a toc -a numbered` command-line options to
produce a number table of contents.
- A http://asciidoc.org/music-filter.html[music filter]
is included in the distribution `./filters/` directory. It
translates music in http://lilypond.org/[LilyPond] or
http://abcnotation.org.uk/[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 intrinsic attribute
`{docname}` is extracted from the input file name.

--------------------------
*********************************************************************
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.

mailto:srackhamgmail.com['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 mailto:jlmofb.net[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
mailto:m_pupilyahoo.com.cn[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
http://open.comsultia.com/docbook2odf/[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.