Asciidoc

------------------------
This version is the culmination of work begun in the 2.x releases
whereby fixed policy has been replaced by extensible mechanisms.

- Added `-c` command-line option to dump a composite asciidoc(1)
configuration file to stdout.
- Lists and Delimited Blocks are now defined by a set of configuration
file parameter sections. The user can modify the default
definitions or add new ones.
- Block content can now be processed through external filters.
- The default behavior for Custom Blocks is to perform glossary
substitution (previously there was no substitution inside Custom
Blocks).
- The old 2.x style macros have been reimplemented; as with Lists and
Delimited Blocks there syntax and behavior can be configured by the
user. The default macro syntax remains the same but the semantics
are now (hopefully) a bit more intelligible.
- Block and Builtin macros use :: delimiter instead of the 2.x single
colon delimit (to distinguish them from inline macros). The 2.x
syntax is still supported for backward compatibility.
- Nested lists are now supported and IndentedParagraphs can be
included in list items.
- Conditional source inclusion can be specified using built in `ifdef`,
`ifndef` and `endif` macros.
- The new conditional source inclusion feature has been used to reduce
the number of default configuration files down to one per backend.
- A change of name: 2.x 'Substitutions' are now called 'Replacements'
and the 2.x `[substitutions]` configuration file section is now
called `[replacements]` (the old name is still recognized for
backward compatibility).
- The line break is now implemented as a 'Replacements' substitution.
- Inline 'icon' macro for inline images has been added to default
configuration files.

------------------------
- The `master.conf` configuration file name has been deprecated in
favor of `asciidoc.conf`.
- The standard configuration files set is now loaded from the
`.asciidoc` folder in the users home directory (if it exists) and
then from the source document directory. Configuration files that
don't exist are silently skipped.
- Configuration files named like the source file will be automatically
loaded if they are found in the source file directory. For example
if the source file is `mydoc.asc` and the `-b html` option is used
then asciidoc(1) will look for `mydoc.conf` and `mydoc-html.conf` in
that order.
- The characters used to quote formatted text can be configured and
extended by the user (see the master.conf [quotes] section).
- Quoted text can now be escaped by prefixing a backslash character to
the leading quote.
- The double single-quote '' strong text quote has been deprecated in
favor of an asterisk * character.
- Added \{eval:expression}, \{sys:command} and \{sys2:command}
glossary reference actions.
- Trailing brace characters `}` are now allowed inside glossary
references provided they are escaped with a backslash character.
- Glossary entries can now be escaped by prefixing a backslash
character to the leading brace character (use this in preference to
placing the backslash inside the brace).
- The output macro has been deprecated (use the new include1 macro
inside a CustomBlock).
- The default document type is `article` (asciidoc no longer attempts
to guess).
- Files included within DelimitedBlocks are not searched for block
termination underlines. This ensures the entire file is part of the
DelimitedBlock.
- `include` macros can now be used in configuration files.
- Corrected \{infile} and \{outfile} glossary entry documentation.
- File inclusion is now limited to a depth of 5 to catch recursion
loops.
- Inline tags have been deprecated, they're not necessary and they
immediately make the source document backend specific. Use
CustomBlocks or Substitutions instead.

------------------------
- Added section auto numbering `{sectnum}` glossary entry
(auto-numbering function contributed by Ludovico Magnocavallo).
- asciidoc(1) now correctly returns non-zero exit status if an error
occurs.
- An AsciiDoc example website has been included in the AsciiDoc
distribution `examples/website` directory.
- NOTE: The `asciidoc` wrapper script included in the 2.0 distribution
has been dropped, if you've symlinked or aliased to `asciidoc` you'll
need to change them to point directly to `asciidoc.py` instead.
- An RCS $Id$ marker can be used as the document header revision line
(based on a patch submitted by Ludovico Magnocavallo).
- In addition to the `name=value` glossary entry format two new ones
have been introduced: `name` (the default value is set to an empty
string) and `^name` (the glossary entry is undefined).
- The `-q` command-line option has been deprecated and the `-w level`
command-line option added. +
NOTE: By default skipped substitution warnings are now suppressed.
- If a configuration file specified with the `-f` command-line option
is not found relative to the current working directory then the
search is repeated relative to the asciidoc(1) directory. This
allows global configuration files to be used.
- Added `{infile}`, `{outfile}` predefined glossary entries.
- Added `under-construction` macro to HTML article configuration
files.
- Deprecated `{asciidoc_version}` glossary entry in favor of
`{asciidoc-version}` (to it consistent with other entries).

------------------------
- The emphasized, strong and monospaced words options have been
generalized with the introduction of macro based 'special words'
lists.
- Glossary references can now appear in both the document and macro
bodies.
- All output files use `crlf` line termination (previously used UNIX
`lf` (newline) termination).
- Added [substitutions] section which implements arbitrary regular
expression based substitutions.
- An optional `master.conf` configuration file can be used for entries
that are not backend or document type specific.
- Special character definitions moved from the code to the new
[special_characters] configuration file section.
- Configuration file glossary added.
- Command-line -g glossary entry added.
- A new 'book' document type has been implemented for the 'docbook'
backend. It outputs DocBook 'book' documents.
- A major internal change has been the implementation of parametrized
user definable 'macros'. Internally most document elements are now
processed as macros.
- Configuration file macro variables can be specified with default
values (literals or other macro variables).
- An attempt has been made to tighten up the vocabulary used to
describe the AsciiDoc document syntax.
- The term abstract has been replaced by the more general term
'preface' and a new preface section introduced into article
configuration files (replacing the synopsis sections).
- Any section elements can now be put in the document preface
(previous versions only allowed paragraphs).
- AsciiDoc Blocks have been unified and their behavior can be user
defined and parametrized.
- An 'output' inclusion allows an external file to be written directly
to the backend output file.
- A new CustomBlock has been added. Default behavior is to insert the
enveloped AsciiDoc source lines directly into the output file.
- A 'line break' tag can be inserted by terminating a line with a '+'
character (only really useful for HTML backends).
- An fourth section level has been introduced.
- The SidebarBlock delimiter line characters have been changed. The
deprecated underline is still accepted.
- Levels 2 and 3 title underline characters have been changed. The
deprecated underlines are still accepted.
- Lines with backend specific inline tags can be inserted into
AsciiDoc source files.
- Single words enveloped by underscores are no longer emphasized. This
feature was deprecated as it is redundant (use single quotes
instead) and was being applied to file names with underscores.
- A `-q` quiet option has been added to suppress warning messages.
- Badge images sourced locally.
- Added 'author' and 'author-mail' meta tags to HTML configuration
files.

------------------------
- Implemented sidebar document elements.
- Explicit checks for user specified configuration files and input
file (rather than throwing exception).

------------------------
- New configuration file options 'emphasizedwords' and 'strongwords'.
These allow the definition of words that will always be emphasized
or rendered in a strong font without inline formatting.
- Document and section titles are no long subject to inline
formatting.
- Multiple configuration files can be overlaid in a single command.
- Configuration file tags and options entries can now be overridden on
an entry by entry basis (previously the entire section was
overloaded).
- Configuration file tags and options entries are now cached this has
resulted in around 37% performance improvement over version 1.3.
- Variable lists can now contain multiple terms per list item.
- Placeholder paragraph eliminated from empty sections that contain
subsections.
- Added \{asciidoc_version} substitution variable.
- More documentation additions and tidy ups.