Version 10.2.0 (2022-05-22)
---------------------------
.Future feature
As part of the intended 10.3.0 release, the following document attribute flags will be reserved for modifying asciidoc-py runtime behavior:
- `future-compat`
- `legacy-compat`
- `compat-mode`
Please see https://github.com/asciidoc-py/asciidoc-py/issues/254[GH issue #254] for more information.
.Bug fixes
- Fix verbose output not working when using a2x or asciidoc entry points
.Miscellaneous
- Automate publishing asciidoc-py website as part of release process
Version 10.1.4 (2022-03-01)
---------------------------
.Bug fixes
- Add missing test py files to dist archives
- Fix DeprecationWarnings in a2x regexes
Version 10.1.2 (2022-02-17)
---------------------------
.Bug fixes
- DESTDIR passed to pip as part of make install
- Add number of missing files to release tarballs
- Fix parsing asciidoc_opt values with spaces for a2x
.Miscellaneous
- Cleanup unused parts of Makefile
- Website files removed from main asciidoc-py repo
Version 10.1.1 (2021-12-20)
---------------------------
.Bug fixes
- Fix RuntimeWarning when executing asciidoc or a2x within repository
- Fix index out of range error in a2x (thanks @osmith42)
Version 10.1.0 (2021-12-17)
---------------------------
.Features
- Add top-level `__version__` and `VERSION` module exports (thanks @tbpassin)
.Bug fixes
- Fix self reference errors in AsciiDocApi (thanks @tbpassin)
- Add back asciidoc execute print in a2x verbose
Version 10.0.2 (2021-11-12)
---------------------------
.Bug fixes
- Fix errors not displaying when called via a2x (thanks @osmith42)
- Fix incorrect parsing of asciidoc_opts in a2x (thanks @lmarz)
.Miscellaneous
- Fix automating homebrew release updates
Version 10.0.1 (2021-10-28)
---------------------------
.Bug fixes
- Fix running make docs
- Fix warning in music filter when using GraphicsMagick
- Fix handling escaped attributes inside of macros
- Include *.xsl and *.sty files in pip installations
Version 10.0.0 (2021-10-16)
---------------------------
.Breaking Changes
AsciiDoc.py has been rewritten to be a https://pypi.org/project/asciidoc/[proper Python package], installable via pip. Downloading and running asciidoc from the repo is not recommended, but can be done through `python3 -m asciidoc` or `python3 -m asciidoc.a2x`. CLI usage should remain the same where both `asciidoc` and `a2x` CLI commands are available after pip installation. Support for overriding the bundled *.conf files is done through CLI flags, environment variables, etc., and not through directly editing the files within the installation. Importing asciidoc should no longer require the `asciidocapi.py` script, and can be done through regular python import, e.g. `import asciidoc; asciidoc.execute(...)`.
The APIs of the asciidoc and a2x scripts are now considered "provisional" with no guarantee of BC between releases with the exception of the `asciidoc.execute` method. Please post an issue on our tracker for any method you directly rely on and would like to have BC for.
.Features
- Install using `pip install asciidoc`
.Miscellaneous
- Changed website domain to https://asciidoc-py.github.io/. The old domain will redirect for a period of time, but will be updated at some point to point at website created by the https://asciidoc-wg.eclipse.org/[AsciiDoc Working Group].
.Testing
- Test against 3.10 stable
Version 10.1.1 (2021-12-20)
---------------------------
.Bug fixes
- Fix RuntimeWarning when executing asciidoc or a2x within repository
- Fix index out of range error in a2x (thanks @osmith42)
Version 10.1.0 (2021-12-17)
---------------------------
.Features
- Add top-level `__version__` and `VERSION` module exports (thanks
@tbpassin)
.Bug fixes
- Fix self reference errors in AsciiDocApi (thanks @tbpassin)
- Add back asciidoc execute print in a2x verbose
Version 10.0.2 (2021-11-12)
---------------------------
.Bug fixes
- Fix errors not displaying when called via a2x (thanks @osmith42)
- Fix incorrect parsing of asciidoc_opts in a2x (thanks @lmarz)
.Miscellaneous
- Fix automating homebrew release updates
Version 10.0.1 (2021-10-28)
---------------------------
.Bug fixes
- Fix running make docs
- Fix warning in music filter when using GraphicsMagick
- Fix handling escaped attributes inside of macros
- Include *.xsl and *.sty files in pip installations
Version 10.0.0 (2021-10-16)
---------------------------
.Breaking Changes
AsciiDoc.py has been rewritten to be a
https://pypi.org/project/asciidoc/[proper Python package], installable
via pip. Downloading and running asciidoc from the repo is not
recommended, but can be done through `python3 -m asciidoc` or
`python3 -m asciidoc.a2x`. CLI usage should remain the same where
both `asciidoc` and `a2x` CLI commands are available after pip
installation. Support for overriding the bundled *.conf files is
done through CLI flags, environment variables, etc., and not through
directly editing the files within the installation. Importing
asciidoc should no longer require the `asciidocapi.py` script, and
can be done through regular python import, e.g. `import asciidoc;
asciidoc.execute(...)`.
The APIs of the asciidoc and a2x scripts are now considered
"provisional" with no guarantee of BC between releases with the
exception of the `asciidoc.execute` method. Please post an issue
on our tracker for any method you directly rely on and would like
to have BC for.
.Features
- Install using `pip install asciidoc`
.Miscellaneous
- Changed website domain to https://asciidoc-py.github.io/. The
old domain will redirect for a period of time, but will be updated
at some point to point at website created by the
https://asciidoc-wg.eclipse.org/[AsciiDoc Working Group].
.Testing
- Test against 3.10 stable
All checksums have been double-checked against existing RMD160 and
SHA512 hashes
Unfetchable distfiles (fetched conditionally?):
./textproc/convertlit/distinfo clit18src.zip
Version 9.1.0 (2021-02-08)
--------------------------
.Features
- Can specify a line range when using the `include` macro.
- Setting the `SGML_CATALOG_FILES` environment variable will set `--catalogs` on xmllint within a2x.
Version 9.0.5 (2021-01-24)
--------------------------
.Bug fixes
- Use config newline setting in system attribute evaulation (thanks @hoadlck)
.Testing
- Update to deadsnakes/python@v2.0.2
Version 9.0.4 (2020-10-20)
--------------------------
.Bug fixes
- Fix listing out installed plugins (e.g. --filter list)
- Fix python version check failing on 3.10 (thanks @hoadlck)
.Testing
- Update to deadsnakes/python@v2.0.0 for testing dev python versions
- Move from testing against 3.9-dev to stable 3.9
- Add 3.10-dev test target
Version 9.0.3 (2020-10-05)
--------------------------
.Bug fixes
- Fix extra newline characters inserted into generated source (thanks @hoadlck)
.Testing
- Validate line endings as part of test suite
Version 9.0.1 (2020-06-26)
Bug fixes
- Fix a2x crashing on decoding generated HTML pages
Building
- Fix generated tar.gz not having files under top-level asciidoc folder
Testing
- Test against Python 3.9
Version 9.0.0 (2020-06-02)
Additions and changes
- Port asciidoc to run on Python 3.5+ (see
https://github.com/asciidoc/asciidoc for the EOL Python 2 implementation)
- Drop internal implementation of OrderedDict and use the standard library
collections.OrderedDict instead
- Implement Dockerfile for running asciidoc
- Add Catalan translation
- Add docbook5 backend
- Fix misspellings in various files and documents
- Use UTC for testing instead of Pacific/Auckland (which observes daylight
saving time)
- Use "with" context statement for opening and closing files instead of older
try/finally pattern
- Search sibling paths before system wide paths in asciidocapi
- Add manpage for testasciidoc.py
- Use argparse instead of optparse for argument parsing
- Add simplified Chinese translation (thanks @muirmok)
- vim-asciidoc: speed up the refresh process for big files (thanks
@aerostitch)
- Allow specifying floatstyle attribute for figures, tables, equations,
examples in docbook (thanks @psaris)
- Use trans python module (if available) to better handle character
decomposition to ascii for ascii-ids (thanks @rkel)
- Use lru_cache to memoize repeated calls to macro look-up, giving potential
~15% speed-up on parsing
Bug fixes
- Fix index terms requiring two characters instead of just one (see
https://github.com/asciidoc/asciidoc-py3/pull/2#issuecomment-392605876)
- Properly capture and use colophon, dedication, and preface for docbooks in
Japanese (see
https://github.com/asciidoc/asciidoc-py3/pull/2#issuecomment-392623181)
- make install did not include the unwraplatex.py filter
- Fix a2x option collection from input file with non-ascii encoding
- Fix options attribute not being properly parsed in Delimited Blocks
attribute list
Building
- Migrate from hierarchical A-A-P build system to top-level Makefile
- Add make help target that prints out usage message for make
- Fix double slash issue in Makefile when installing asciidoc or its docs
Testing
- Commit generated test files to the repository for continuous integration
- Test against Python 3.5+ on Travis-CI
- Remove symlink tests/asciidocapi.py in favor of just appending to sys.path
- Add requires directive to testasciidoc.conf to indicate necessary external
dependencies (e.g. source-highlight)
Version 8.6.10:
Additions and changes
- Improve reproducibility of builds (e.g. support SOURCE_DATE_EPOCH)
- Add SVG output support
- Improve documentation
- Update translations
Problems found locating distfiles:
Package cabocha: missing distfile cabocha-0.68.tar.bz2
Package convertlit: missing distfile clit18src.zip
Package php-enchant: missing distfile php-enchant/enchant-1.1.0.tgz
Otherwise, existing SHA1 digests verified and found to be the same on
the machine holding the existing distfiles (morden). All existing
SHA1 digests retained for now as an audit trail.
either because they themselves are not ready or because a
dependency isn't. This is annotated by
PYTHON_VERSIONS_INCOMPATIBLE= 33 # not yet ported as of x.y.z
or
PYTHON_VERSIONS_INCOMPATIBLE= 33 # py-foo, py-bar
respectively, please use the same style for other packages,
and check during updates.
Use versioned_dependencies.mk where applicable.
Use REPLACE_PYTHON instead of handcoded alternatives, where applicable.
Reorder Makefile sections into standard order, where applicable.
Remove PYTHON_VERSIONS_INCLUDE_3X lines since that will be default
with the next commit.
Whitespace cleanups and other nits corrected, where necessary.
Upstream changes:
=================
Version 8.6.9 (2013-11-09)
Additions and changes
html5, xhtml11 and slidy outputs now wrap pre element contents at right margin
Vim syntax file: highlight line breaks in lists (patch submitted by Alex Efros).
Vim syntax file: fixed highlighting of lines with spaces preceding an indented paragraph.
Vim syntax file: dropped ) from list of illegal characters following opening quote.
Added + intrinsic attribute.
Allow tabsize=0 in configuration file.
Removed wordpress backend into the blogpost project (where it belongs) as an AsciiDoc backend plugin.
Added HTML5 footer badges.
Added favicon to AsciiDoc website.
Changed AsciiDoc website domain to asciidoc.org.
Vim syntax file: closing quote character cannot be immediately followed by same closing quote character.
Documentation updates.
If admonition icons are embedded using the Data URI Scheme and the icons directory is undefined or does not exist then the iconsdir attribute is set to the location of the icons installed in the AsciiDoc configuration directory.
Updated ./stylesheets/pygments.css from pygments 1.4.
HTML backends: Align inline images to text-bottom.
html4 backend: Added hr attribute to make the inter-section horizontal ruler element optional.
Documented Callout lists cannot be used within tables.
Removed Vim related stuff from the installer makefile.
Dropped vim/ftdetect/asciidoc_filetype.vim from distribution, the file detection was broken and the default settings satisfied noone.
Vim syntax highlighter: increase sync backtracking to catch changes to large block elements.
Added Romanian language configuration file. Contributed by Vitalie Lazu.
Added ruler and line-break outputs to HTML Help outputs. Patch submitted by DonM.
Added Czech language configuration file. Contributed by Petr Klíma.
html4 backend: allow embedded images and icons (data-uri attribute).
html4 backend: table and example block caption place at bottom for consistency.
html4 backend: dropped border around example block.
html4 backend: cellpaddings made equal to 4 for consistency.
Vim syntax highligher: Highlight closing OpenBlock delimiter when it immediately follows a list.
Updated html5 backend (previous commit was xhtml11 only).
Embedded data-uri images now figure file mimetype from file contents rather than the file extension. Patch submitted by Lex Trotman.
Bug fixes
indexterm2:[ ] macro syntax now recognized.
Synthesised *-option attributes for options set in table conf file style entries.
Makefile: Fixed sh compatibility issue.
Upstream changes:
-----------------
Release highlights
------------------
Added full complement of styles to Open Blocks and Normal Paragraphs???those
with a minimalist bent could construct virtually any document using just Title,
Normal Paragraph and Open Block syntaxes.
Other additions and changes
---------------------------
Increased default maximum include depth from 5 to 10.
Emit warning if maximum include depth is exceeded.
Suppress repeated console messages.
Music filter: removed --beams=None option from abc2ly invocation because it
is broken on LilyPond 2.14 (Ubuntu 12.04).
Replaced obsolete <tt> tag with <code> in HTML backends.
Allow configuration attribute entries to create a new section (previously
you could only modify existing sections). See: discussion list.
Documented {wj} (word-joiner) attribute and updated FAQ. See: discussion
list.
FAQ: Added How can I place a footnote immediately following quoted text?
See discussion list.
Added Greek language configuration file. Contributed by Michael
Dourmousoglou. See discussion list.
FAQ: Added Using roles to select fonts for PDF. Submitted by Lex Trotman
and based on solution by Antonio Borneo. See: discussion list.
Apply same monospaced font size to all monospaced text.
Changed 0 number padding to spaces in numbered GNU source-highlight
outputs.
Allow highlight source highlighter to use python for Python {language}
name. r1142: Update the AsciiDoc source filter to allow the use of the
highlight source code highlighter. See discussion list.
Vim syntax highlighter: Don?t confuse trailing open block delimiter with
section underline.
Added skip option to paragraphs (c.f. Delimited Block skip option).
Bug fixes
FIXED: latex, music and graphviz filters: When the filter output image is
data-uri encoded write it to the indir (instead of the outdir) so that encoder
can find it. See discussion list.
FIXED: Escape the ] character inside inline macros. See discussion list.
FIXED: source highlighter filter: Pass role attribute to HTML backends.
FIXED: source highlight filter: docbook backend: role attribute was not
passed to listings without a title. Patch submitted by Lex Trotman. See
discussion list.
FIXED: music2png.py: FOPException: Raster ByteInterleavedRaster error (FOP
1.0, ImageMagick 6.6.9-7).
Upstream changes:
No major enhancements but quite a few bug fixes which, among other things,
fixes Jython compatibility and improves Windows compatibility.
All additions and changes
Vim syntax highlighter: highlight entity refs in macro arguments.
Added files with .asciidoc extension to Vim file type detection. Patch
submitted by Dag Wiers.
Added replacement3 substitution to enable ODT whitespace processing.
Added unbreakable option to XHTML and HTML 5 backends.
Implemented toc::[] block macro and toc-placement attribute for HTML
backends to allow the Table of Contents placement to be set manually by the
author.
Added FAQs: How can I control page breaks when printing HTML outputs? and
Is it possible to reposition the Table of Contents in HTML outputs?.
Added --backend and --backend-opts options to the a2x command to allow a2x
to use backend plugin code extensions. Patch submitted by Lex Trotman.
Added args block attribute to source highlight blocks to allow arbitrary
parameters to be passed to the source highlighters.
If the ascii-ids attribute is defined then non-ascii characters in
auto-generated IDs are replaced by their nearest ascii equivalents (to work
around DocBook processor limitations).
Added global blockname attribute which is dynamically updated to identify
the current block. See discussion list.
xhtml11, html5 backends: Include book part TOC entries for multi-part
books. Patch submitted by Loïc Paillotin.
Removed code filter example from the AsciiDoc User Guide so that backends
implemented as external plugins can compile the manual. See discussion list.
If the delimited block skip option is set then do not consume block title
and attributes. This makes it possible for the comment delimited blocks to use
an attribute list (previously the comment delimited block was hardwired to skip
preceding attributes and titles). See discussion list.
Added backend-confdir intrinsic attribute.
Bug fixes:
FIXED: slidy backend: broken stylesheet attribute. Patch submitted by
Micheal Hackett.
FIXED: Restored missing themes to zip file distribution archive.
FIXED: Grammatical error in error messages. Patch submitted by Dag Wieers.
FIXED: Use configured normal substitution in preference to the default one.
FIXED: The eval block macro would execute multiple times if it evaluated to
None.
FIXED: Duplicated entries in TOC of large document. Patch submitted by
Sebastien Helleu.
FIXED: Python 2.4 backward incompatibility.
FIXED: 8.6.6 regression broke Jython compatibility. See discussion list.
FIXED: Leaky file handles in a2x and music and latex filters which created
incompatibility problems for Jython.
FIXED: All Python filters are executed with the same Python interpreter
that executes the asciidoc parent (previously filters were hardwired to execute
the python interpreter). This prevents Python mix-ups.
FIXED: Microsoft Windows shelled command-line truncation that caused
shelled commands to fail e.g. the data-uri attribute failure.
Release highlights
The AsciiDoc plugin architecture has been enhanced, unified and extended:
- Plugin commands have been added to the asciidoc(1) --backend option.
- An asciidoc(1) --theme option has been implemented to specify a
theme and to manage theme plugins.
- A plugin build command (for creating plugins) added.
- build, install, list and remove plugin commands are all recognized
by asciidoc(1) --backend, --filter and --theme options.
A security update by Kenny MacDermid removes the use of eval() on
untrusted input (to disallow code malicious execution).
Complete changelog can be accessed here:
http://www.methods.co.nz/asciidoc/CHANGELOG.html
Release highlights:
* The addition of an html5 backend to generate HTML 5 output. Apart from the
inclusion of audio and video block macros the html5 backend is functionally
identical to the xhtml11 backend.
* A new flask theme for xhtml11 and html5 backends inspired by the Flask
website styling (see toc2 example in the next item below).
* The new toc2 attribute generates a table of contents in the left hand
margin (xhtml11 and html5 backends).
* a2x(1) now has a flexible mechanism for copying arbitrary resource files
to HTML based outputs#-#this is very handy for generating EPUB files with
embedded fonts and other resources.
o The a2x(1) --resource option can be used to inject any file into
EPUB output documents e.g. CSS resources such as fonts and background images.
o Explicitly specified resources are added to the EPUB OPF manifest
automatically.
o You can explicitly specify file extension MIME types.
o The enhanced resource processing works around a couple of DocBook
XSL bugs (see EPUB Notes).
Read the CHANGELOG for a full list of all additions, changes and bug fixes.
Upstream changes:
Additions and changes
* Added text foreground and background color along with text size CSS styles for
XHTML outputs.
* Vim syntax highlighter: highlight macros that start with an attribute
reference (a common idiom).
* Vim syntax highlighter: highlight attribute references in macro attribute lists.
* Attribute entries can be used to set configuration markup templates.
* Double-width East Asian characters in titles now correctly match the title
underline widths.
* Implemented asciidoc(1) filter commands.
* User's home directory now calculated in a platform independent manner.
* Added double-quote characters to French language file.
* Vim Syntax highlighter: Highlight closing OpenBlocks which immediately follow
a literal paragraph.
* Changed UNIX /dev/null to OS independent os.devnull in filters code.
* Vim syntax highlighter: Single and double quoted text now highlights correctly
when preceded by an attributes list.
* Added Ukrainian language file (lang-uk.conf). Added double-quote characters to
Russian language file.conf).
* Single and double quote characters are now set using the {lsquo}, {rsquo},
{ldquo} and {rdquo} attributes. This makes is easy to customise language specific
quotes.
* Implemented conf-files attribute to allow configuration files to be specified
in the source document.
Bug fixes
* FIXED: Auto-generated section title ids are now Unicode aware.
* FIXED: Setting quotes configuration entries using document attribute entries
failed if the attribute entry was not in the document header.
* FIXED: If the input and output file names were different then the output file
name was incorrectly used to synthesize docinfo file names.
* FIXED: An error can occur when more than one consecutive quotes are defined as
a blank string.
* FIXED: Encoding error in automatically generated author initials.
This release was intended primarily to fix regressions introduced by 8.6.2, but
the incubation period was longer than expected and it now also includes a number
of enhancements an few other bug fixes.
Complete CHANGELOG at: http://www.methods.co.nz/asciidoc/CHANGELOG.html
pkgsrc changes:
- take MAINTAINERship (ok gdt@)
upstream changes:
Version 8.6.2 (2010-10-03)
Additions and changes
* docbook45: Enclosed bibliographic lists in a bibliodiv - you can now
include block titles with bibliographic lists.
* Added optional keywords, description and title document header meta-data
attributes to HTML backends for SEO.
* AttributeEntry values can span multiple lines with a ' +' line
continuation.
* Added slidy backend (based on Phillip Lord's slidy backend
https://phillordbio-asciidoc-fixes.googlecode.com/hg/).
* Implemented OpenBlock partintro style for book part introductions.
* Comment lines substitute special characters only.
* Backend specific global configuration files (all except asciidoc.conf)
are loaded after the header has been parsed - virtually any attribute can
now be specified in the document header.
* xhtml11: Volnitsky theme: allow bulleted lists to have intervening
children.
* xhtml11: refactored CSS font-family rules to start of file.
* xhtml11: list bullets colored gray.
* ifdef and ifndef system block macros accept multiple attribute names:
multiple names separated by commas are ored; multiple attribute names
separated by pluses are anded.
* xhtml11: Volnitsky theme: set max-width on labeled lists.
* Vim syntax highlighter: Entities inside quoted text are now highlighted.
* Added role and id attributes to HTML outputs generated by OpenBlocks.
* Allow floating titles to generate h1 (level 0) titles in HTML outputs.
* Added a start attribute to numbered lists to set the start number.
See: http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5
* Added two more docinfo attributes docinfo1 and docinfo2 to allow and
control inclusion of a shared docinfo file.
See http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24
* Vim syntax highlighter highlights multi-name conditional attributes.
* LaTeX backend patch submitted by Andreas Hermann Braml
(see http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5).
* Implemented backend aliases; renamed docbook.conf to docbook45.conf and
aliased docbook45 backend to docbook; aliased xhtml11 to html.
Bug fixes
* FIXED: Filter commands located in filter directories local to the source
document that where not in the search PATH where not found.
* FIXED: Volnitsky theme: Verseblock font set normal instead of monospaced.
* FIXED: xhtml11: Callout icons were not rendered as Data URIs when icons
and data-uri attributes were specified.
* FIXED: Long standing bug: nested include macros did not restore the
parent document infile and indir attributes.
See: http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7
* FIXED: html4: set preamble ID anchor.
* FIXED: xhtml11: dropped unusable id and role attributes from preamble template.
* FIXED: Bug in multi-name conditional attributes e.g. {x,y#} fails if x or
y is undefined.
* FIXED: latex filter not being installed by Makefile. Thanks to Grant
Edwards for this patch.
See http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8
* FIXED: a2x: Long-standing bug in a2x which always passes --string-param
navig.graphics 0 to xsltproc, regardless of whether icons are enabled or not.
Reported by Michael Wild:
http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58
