Skip to content

AsciiDoc Compatibility Matrix

Guillem Marpons edited this page Jun 9, 2021 · 2 revisions

The list of features is taken from the table of contents of the documentation for Asciidoctor.

When a release or pre-release of an official AsciiDoc Specification appears, this page will be adapted to reflect the structure and contents of the standard.

Document processing

Feature Support Notes

Document processing

PARTIAL

   Encodings

PARTIAL

      UTF-8 encoding

FULL

      UTF-16 encoding with BOM

??

   Normalization

??

Blocks

Feature Support Notes

Blocks

PARTIAL

   Basic blocks

PARTIAL

Not all block types are supported, yet.

      Delimited blocks

PARTIAL

Not all block types are supported, yet.

      Build a block using a block style attribute

NONE

   Add a title to a block

FULL

      Add a title to a delimited block

FULL

      Add a title to a block with attributes

FULL

   Assign an ID to a block

PARTIAL

No repeated ID checking, yet.

   Block Style Attribute

PARTIAL

   Nesting blocks

FULL

   Masquerading blocks

??

Document attributes

Feature Support Notes

Document attributes

NONE

Element attributes

Feature Support Notes

Element attributes (attribute lists)

PARTIAL

   Positional and named attributes

PARTIAL

      Positional attribute

FULL

      Named attribute

FULL

      Substitutions

??

      Attribute list parsing

PARTIAL

   ID attribute

PARTIAL

No repeated ID checking, yet.

      Block assignment

FULL

      Inline assignment

??

      Use ID as an anchor

??

   Options attribute

FULL

   Role attribute

FULL

      Assign roles to blocks

FULL

      Shorthand role syntax for blocks

FULL

      Formal role syntax for blocks

FULL

      Assign roles to formatted inline elements

FULL

Document header

Feature Support Notes

Document header

NONE

Document types

Feature Support Notes

Document types

NONE

Sections

Feature Support Notes

Sections

PARTIAL

   Section titles and levels

PARTIAL

Section scope and nesting not computed, yet.

      Markdown syntax (#)

NONE

      Activate section title links

NONE

      Discrete headings

FULL

   Autogenerated section IDs

NONE

Should be easy through Pandoc, once asciidoc-hs is integrated as an official Reader.

      Change the ID prefix and separator

NONE

   Assign custom IDs and reference text

PARTIAL

      Assign additional IDs

??

   Section numbers

PARTIAL

Through Pandoc’s --number-sections and unnumbered class.

      Specify the section levels that are numbered

NONE

   Section styles for articles and books

NONE

Paragraphs

Feature Support Notes

Paragraphs

PARTIAL

   Hard line breaks

NONE

   Preamble and lead style

PARTIAL

      Preamble

NONE

      Lead role

FULL

If CSS has the lead class defined (for example the Asciidoctor’s default CSS).

   Paragraph alignment

??

Breaks

Feature Support Notes

Breaks

NONE

   Thematic breaks

NONE

   Page breaks

NONE

Text formatting and punctuation

Feature Support Notes

Text formatting and punctuation

PARTIAL

   Constrained formatting

FULL

   Unconstrained formatting

FULL

   Bold

FULL

      Mixing bold with other formatting

FULL

No need of a specific order.

   Italic

FULL

      Mixing bold with other formatting

FULL

No need of a specific order.

   Monospace

PARTIAL

Support for HTML output through class .monospace. Pandoc does not support nested formatting inside <code> elements.

      Mixed formatting

PARTIAL

No need of a specific order if output is HTML.

      Literal monospace

NONE

   Highlight

FULL

   Quotation marks and apostrophes

NONE

      Single and double quotation mark syntax

NONE

      Apostrophe syntax

NONE

   Subscript and superscript

NONE

   Custom inline styles

FULL

Styles need to be supported by CSS.

Lists

Feature Support Notes

Lists

PARTIAL

   Unordered lists

PARTIAL

      Basic unordered list

FULL

      Nested unordered list

FULL

      Custom markers

NONE

   Separating lists

NONE

   Ordered lists

NONE

   Checklists

NONE

   List continuation

PARTIAL

      Indented lines

FULL

      List continuation syntax (+)

FULL

      Dropping the principal text

NONE

Attribute substitution is not implemented, yet.

      Attaching to an ancestor list

NONE

Description lists

Feature Support Notes

Description lists

NONE

Feature Support Notes

Links

NONE

Cross references

Feature Support Notes

Cross references

NONE

Footnotes

Feature Support Notes

Footnotes

NONE

Images

Feature Support Notes

Images

NONE

Audio and video

Feature Support Notes

Audio and video

NONE

Icons

Feature Support Notes

Icons

NONE

Keyboard macro

Feature Support Notes

Keyboard macro

NONE

Button and menu UI macros

Feature Support Notes

Button and menu UI macros

NONE

Admonitions

Feature Support Notes

Admonitions

NONE

Sidebars

Feature Support Notes

Sidebars

PARTIAL

   Sidebar style syntax

NONE

   Delimited sidebar syntax

FULL

Example blocks

Feature Support Notes

Example blocks

PARTIAL

   Example style syntax

NONE

   Delimited examle syntax

FULL

Blockquotes

Feature Support Notes

Blockquotes

NONE

Verses

Feature Support Notes

Verses

NONE

Verbatim and source blocks

Feature Support Notes

Verbatim and source blocks

NONE

   Source blocks

NONE

   Listing blocks

NONE

   Literal blocks

NONE

   Callouts

NONE

Tables

Feature Support Notes

Tables

NONE

Equations and formulas

Feature Support Notes

Equations and formulas

NONE

Counters

Feature Support Notes

Counters

NONE

Open blocks

Feature Support Notes

Open blocks

NONE

Comments

Feature Support Notes

Comments

FULL

   Comment lines

FULL

   Comment blocks

FULL

Automatic table of contents

Feature Support Notes

Automatic table of contents

NONE

Includes

Feature Support Notes

Includes

NONE

Conditionals

Feature Support Notes

Conditionals

NONE

Substitutions

Passthroughs

Feature Support Notes

Passthroughs

NONE

   Inline passthroughs

NONE

   Passthrough blocks

NONE