Understanding the AST Classes
To write extensions or converters for AsciidoctorJ understanding the AST (abstract syntax tree) classes is key. The AST classes are the intermediate representation of the document that Asciidoctor creates before rendering to the target format.
The following example document demonstrates how an AST will look like to give you an idea how the document and the AST are connected.
= Test document Foo Bar <email@example.com> This document demonstrates the AST of an Asciidoctor document == The first section A section has some nice paragraphs and maybe lists: === A subsection - One - Two - Three Or even tables |=== | Key | Value |=== and sources as well [source,ruby] ---- puts 'Hello, World!' ----
The following image shows the AST and some selected members of the node objects. The indentation of a line visualizes the nesting of the nodes like a tree.
Document context: document Block context: preamble Block context: paragraph This document demon... Section context: section level: 1 Block context: paragraph A section has some ... Section context: section level: 2 List context: ulist ListItem context: list_item One ListItem context: list_item Two ListItem context: list_item Three Block context: paragraph Or even tables Table context: table style: table Block context: paragraph and sources as well Block context: listing style: source puts 'Hello, World!'
The AST is built from the following types:
This is always the root of the document. It owns the blocks and sections that make up the document and holds the document attributes.
This class models sections in the document. The member
levelindicates the nesting level of this section, that is if level is 1 the section is a section, with level 2 it is a subsection, etc.
Blocks are content in a section, like paragraphs, source listings, images, etc. The concrete form of the block is available in the field
context. Among the possible values are:
The list node is the container for ordered and unordered lists. The type of list is available in the field
ulistfor unordered lists and
olistfor ordered lists.
A list item represents a single item of a list.
The description list node is the container for description lists. The context of the node is
A list entry represents a single item of a description list. It has multiple terms that are again instances of
org.asciidoctor.ast.ListItemand a description that is also an instance of
This represents a table and is probably the most complex node type. It owns a list of columns and lists of header, body and footer rows.
A column defines the style for the column of a table, the width and alignments.
A row in a table is only a simple owner of a list of table cells.
A cell in a table holds the cell content and formatting attributes like colspan, rowspan and alignment as appropriate. A special case are cells that have the
asciidoctorstyle. These do not contain simple text content, but have another full
Documentin their member
This type is a special case. It does not appear in the AST itself as Asciidoctor does not really parse into the block itself. Phrase nodes are usually created by inline macro extensions that process macros like
issue:1234and create links from them.
Nodes are in general only created from within extensions.
Therefore the abstract base class of all extensions,
org.asciidoctor.extension.Processor, has factory methods for every node type.
Now that you have learned about the AST structure you can go into the details of writing the extensions.