AST (abstract syntax tree)#

An AST (Abstract Syntax Tree) is an abstract syntactic structure of text. Each node of the tree denotes a construct occurring in the XML file. Every element the AST contains can be edited using properties and functions to obtain the desired rendering.

The following classes are used to create the AST:

BlockQuote(element[, parse_children])

Provides the block quote element.

Caution(element[, parse_children])

Provides the caution element.

Chapter(element[, parse_children])

Provides the chapter element.

Code(element[, parse_children])

Provides the code element.

Command(element[, parse_children])

Provides the command element.

ComputerOutput(element[, parse_children])

Provides the computer output element.

Element(element[, parse_children])

Provides the base element.

Emphasis(element[, parse_children])

Provides the emphasis element.

Entry(element[, parse_children])

Provides the entry element.

Example(element[, parse_children])

Provides the example element.

Figure(element[, parse_children])

Provides the figure element.

FileName(element[, parse_children])

Provides the filename element.

Function(element[, parse_children])

Provides the function element.

Graphic(element[, parse_children])

Provides the graphic element.

GuiLabel(element[, parse_children])

Provides the GUI label element.

GuiMenu(element[, parse_children])

Provides the GUI menu element.

GuiMenuItem(element[, parse_children])

Provides the GUI menu item element.

IndexTerm(element[, parse_children])

Provides the index term element.

InformalExample(element[, parse_children])

Provides the informal example element.

InformalTable(element[, parse_children])

Provides the informal table element.

InlineEquation(element)

Provides the inline equation element.

InlineGraphic(element[, parse_children])

Provides the inline graphic element.

ItemizedList(element[, parse_children])

Provides the itemized list element.

Link(element)

Provides the link element.

ListItem(element[, parse_children])

Provides the list item element.

Literal(element[, parse_children])

Provides the literal output element.

Math(element)

Provides the math element.

Member(element[, parse_children])

Provides the member element for a simple itemized list.

Note(element[, parse_children])

Provides the note element.

OLink(element)

Provides the external link element.

OrderedList(element[, parse_children])

Provides the ordered list element.

Paragraph(element[, parse_children])

Provides the paragraph element.

Phrase(element[, parse_children])

Provides the phrase element.

Primary(element[, parse_children])

Provides the primary element.

ProgramListing(element[, parse_children])

Provides the program listing element.

Quote(element)

Provides the quote element.

Refentrytitle(element[, parse_children])

Provides the title of the reference entry.

RefMeta(element[, parse_children])

Provides the reference metadata element.

Refname(element[, terms])

Provides the refname element which contains the name of a reference.

Refnamediv(element[, terms])

Provides the refnamediv element, which contains the name, purpose, and classification of a reference.

Refpurpose(element[, parse_children])

Provides the refpurpose element, which contains a short synopsis of a reference.

RefSection(element[, parse_children])

Provides the reference section element.

Replaceable(element[, parse_children])

Provides the replaceable element.

Row(element[, parse_children])

Provides the row element.

Screen(element[, parse_children])

Provides the screen element.

SimpleList(element[, parse_children])

Provides the simple itemized list element.

Structname(element[, parse_children])

Provides the structure name element.

SubScript(element)

Provides the subscript element.

SuperScript(element[, parse_children])

Provides the superscript element.

Table(element[, parse_children])

Provides the table element

TBody(element[, parse_children])

Provides the tbody element.

Term(element[, parse_children])

Provides the term element.

TGroup(element[, parse_children])

Provides the tgroup element, which contains the header and body rows of a table.

THead(element[, parse_children])

Provides the thead element.

Title(element[, parse_children])

Provides the title element.

UserInput(element[, parse_children])

Provides the user input element.

Variablelist(element[, parse_children])

Provides the variable list.

VarlistEntry(element[, parse_children])

Provides the variable list entry element.

XRef(element)

Provides the cross reference element.