Asciidoc

Latest version: v10.2.1

Safety actively analyzes 714973 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 7 of 16

8.4.2

--------------------------
.Additions and changes
- Added {website}testasciidoc.html[testasciidoc], a tool to verify
AsciiDoc conformance.
- A warning is issued if nested inline passthroughs are encountered.
- 'asciidocapi': setting an attribute value to `None` will undefine
(delete) the attribute (this in addition to the `name!` attribute
name format that the `asciidoc(1)` command uses).

.Bug fixes

8.4.1

--------------------------
.Additions and changes
- AsciiDoc now has a {website}asciidocapi.html[Python API]. The
following minimal example compiles `mydoc.txt` to `mydoc.html`:
+
[source,python]
-------------------------------------------------------------------------------
from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI()
asciidoc.execute('mydoc.txt')
-------------------------------------------------------------------------------

- Backtick quoting for monospaced text is now implemented as an
'inline literal' passthrough. This makes more sense since monospace
text is usually intended to be rendered literally. See
<<X2,Regression issues>> below for the impact this may have on
existing documents. Here are some examples that would previously
have had to be escaped:

The `++i` and `++j` auto-increments.
Paths `~/.vim` and `~/docs`.
The `__init__` method.
The `{id}` attribute.

- Added `--doctest` option to `asciidoc(1)` command.
- Added an optional second argument to 'BlockId' element, this sets
the `{reftext}` attribute which in turn is used to set the `xreflabel`
attribute in DocBook elements.
- Added lists to `--help` syntax summary.
- `{infile}` and `{indir}` attributes reflect the current input file
(previously always referred to the root document).
- `{docfile}` (new) and `{docdir}` (previously deprecated) attributes
refer to the root document specified on the `asciidoc(1)`
command-line.
- Vim syntax highlighter improvements.
- Syntax summary command (`asciidoc -h syntax`) additions.
- Admonition icons now have transparent backgrounds.
- Changed yellow W3C badges to blue ones in page footers.

.Bug fixes
- Dropped `asciidoc(1)` broken undocumented `--profile` option.
- Em dash replacement now recognized at start of block.

Regression issues
~~~~~~~~~~~~~~~~~
Replacing backtick quoting with the 'inline literal' passthrough
raises two regression scenarios for existing documents:

1. You have escaped the expansion of enclosed inline elements, for
example: `\{id}`. You would need to delete the backslashes: `{id}`
(if you don't the backslashes will be printed). Mostly it's just a
case of interactively finding and replacing of all occurrences of
`\.

2. There are enclosed inline elements, for example: `some *bold*
monospaced`. You would need to switch to plus character monospace
quoting: `+some *bold* monospaced+` (if you don't the enclosed
elements won't be expanded).

If your existing documents include these cases and you don't want to
upgrade then use the `-a no-inline-literal` command-line option,
alternatively put this in `~/.asciidoc/asciidoc.conf`:

[attributes]
no-inline-literal=

8.3.5

--------------------------
.Additions and changes
- Cached compiled regular expression delimiters (speed up 'User
Manual' compilation by 250%).
- Created distinct list definitions for each numbered list style to
allow nesting of all styles.
- Roman numbers in numbered lists are followed by a closing
parenthesis instead of a period to eliminate 'i', 'v', 'x' item
ambiguity with respect to alpha numbered list items.
- Added `**`, `***`, `****`, `*****`
bulleted lists.
- Added `...`, `....`, `.....` implicit numbered
lists.
- Added `:::`, `::::` labeled lists.
- Updated User Guide for new list syntaxes.
- Optimized paragraph and list termination detection with separate
precompiled regular expressions for performance and to prevent
reaching Python 100 named group limit.
- Updated Vim syntax highlighter for new list syntaxes.
- Allow `template::[]` macros in conf file entries sections (not just
in template sections).
- Dropped unused `[listdef-numbered2]` conf file sections.
- Renamed 'ListBlock' to more appropriate 'OpenBlock'.
- Implemented single-line versions of `ifdef::[]` and `ifndef::[]`
macros.
- 'html4' backend styling:
* Underlined admonition captions.
* Added side border to Example Blocks.
- 'xhtml11' backend styling:
* Dropped right hand margin from all but quote and verse blocks.
* html4 backend: corrected over-sized width of caption in admonition
block.

.Bug fixes
- Fixed broken numbered list nesting.

Compatibility issues
~~~~~~~~~~~~~~~~~~~~
The roman numbered list parenthesis syntax is incompatible with the
potentially ambiguous roman period syntax introduced in 8.3.2.

8.3.4

--------------------------
.Additions and changes
- Implemented a title 'float' style. A floating title (or bridgehead)
is rendered just like a normal section but is not formally
associated with a text body and is not part of the regular section
hierarchy so the normal ordering rules do not apply.
- Implemented inline comment macro so comment lines can now appear
inside block elements.
- Comment lines are sent to the output if the 'showcomments' attribute
is defined (comment blocks are never sent to the output).
- Single quoting attribute values in 'AttributeList' elements causes
them to be substituted like normal inline text (without single
quoting only attribute substitution is performed).
- Rewrote list item processing (was very crufty). List continuation
and list blocks now work as expected. Updated and clarified list
documentation in User Guide.
- The 'revision' attribute now recognizes the RCS $Id$ marker format.
- An RCS $Id$ marker formatted revision line in the header does not
need to be preceded by an author line.
- If an RCS $Id$ formatted revision is specified and the author name
has not already been set then the author name in the $Id$ marker
will be used.
- Updated Gouichi Iisaka's Graphviz filter to version 1.1.3.
- Added 'autowidth' table attribute option for (X)HTML outputs.
- DocBook backend now puts 'orgname' optional attribute in DocBook
header.
- Deprecated undocumented 'companyname' attribute in favor of
DocBook's 'corpname'.
- Removed explicit closing backslash from HTML4 self-closing tags to
comply with WC3 recommendation.

.Bug fixes
- Fixed 8.3.3 regression whereby adjacent lists with the same syntax
but different list styles were incorrectly treated as a single list.

8.3.3

--------------------------
This release supersedes 8.3.2.

.Bug fixes
- The broken and confusing numeration and numeration2 numbered list
attributes have been dropped, use the style attribute instead.

8.3.2

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

Page 7 of 16

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.