Module parser 

The Parser struct and its related structs allow a caller to configure how AsciiDoc parsing occurs and then to initiate the parsing process.

Structs

CalloutRenderParams

Provides parameters for rendering a callout number.

CatalogResolver

The default single-document ReferenceResolver, backed by one Catalog.

DefaultPathResolver

The default PathResolver implementation, mirroring the Ruby Asciidoctor PathResolver class.

DerivedReference

The destination a cross-reference target resolves to on its own, without consulting any catalog.

FootnoteRenderParams

Provides parameters for rendering the inline marker of a footnote macro.

HtmlSubstitutionRenderer

Implementation of InlineSubstitutionRenderer that renders substitutions for common HTML-based applications.

IconRenderParams

Provides parsed parameters for an icon to be rendered.

ImageRenderParams

Provides parsed parameters for an image to be rendered.

IncludeContent

The content returned by an IncludeFileHandler for an include:: directive, together with the metadata the parser needs to finish processing the include.

IndexTermRenderParams

Provides parameters for rendering an index term.

LinkRenderParams

Provides parsed parameters for an icon to be rendered.

MenuRenderParams

Provides parameters for rendering a menu UI macro.

Origin

The origin of a position in the preprocessed source: the input file, line, and (where recoverable) column the author actually wrote, together with the Fidelity of the mapping.

Parser

The Parser struct and its related structs allow a caller to configure how AsciiDoc parsing occurs and then to initiate the parsing process.

ReferenceTime

A fixed reference instant used to compute the time-dependent document attributes (docdate, doctime, docdatetime, docyear, and their local* siblings).

ReferenceWarning

A warning produced while resolving cross-references.

ResolutionContext

Describes a single cross-reference that needs to be resolved.

ResolvedReference

The resolved destination of a cross-reference.

SourceLine

A SourceLine represents the original file and line number where a line of AsciiDoc text was found before include file and conditional pre-processing occurred.

SourceMap

Generated by the preprocessor: a map from a line number in the preprocessed, unified source (Span) back to the original input file and line it came from. This lets a consumer work backwards from a parsed element’s Span to the file and line the author actually wrote.

XrefRenderParams

Provides parameters for rendering a cross-reference.

XrefSignifier

A referenceable target’s signifier and reference number, used to build the automatic text of a cross-reference for the Full and Short styles (and to emphasize a chapter or appendix title under Basic).

Enums

AllowableValue

Allowable values for the attribute.

CalloutGuard

Describes the characters that guard (hide) a callout number in verbatim source.

CharacterReplacementType

Specifies which character replacement is being rendered.

Fidelity

Describes how a preprocessed line relates to the origin line it maps to, so a consumer can tell whether a column (and the line content itself) can be trusted to match the original file.

IncludeResolution

The outcome of an IncludeFileHandler::resolve_target call: either the resolved content, or the reason resolution failed.

ModificationContext

Allowable context(s) for modification of this attribute value.

QuoteScope

Specifies whether the block is aligned to word boundaries or not.

QuoteType

Specifies which quote type is being rendered.

ReferenceWarningKind

The kind of problem described by a ReferenceWarning.

SafeMode

Describes the safe mode under which a document is parsed and rendered.

SpecialCharacter

Specifies which special character is being replaced in a call to InlineSubstitutionRenderer::render_special_character.

Transform

Identifies which preprocessor transform is responsible for a non-verbatim line. Informational: it tells a consumer why a column is unavailable.

XrefStyle

The cross-reference text style selected by the xrefstyle attribute.

Traits

DocinfoFileHandler

A DocinfoFileHandler is responsible for providing the text content of a docinfo file when one is requested while resolving a document’s docinfo.

ImageFileHandler

An ImageFileHandler is responsible for providing the raw bytes of an image file when a referenced image must be embedded directly in the output as a data: URI (i.e. when the data-uri document attribute is set and the safe mode is below SafeMode::Secure).

IncludeFileHandler

An IncludeFileHandler is responsible for providing the text content for an include:: directive when encountered.

InlineSubstitutionRenderer

An implementation of InlineSubstitutionRenderer is used when converting the basic raw text of a simple block to the format which will ultimately be presented in the final converted output.

PathResolver

A PathResolver handles all operations for resolving, cleaning, and joining paths, covering both web paths (request URIs) and system paths.

ReferenceResolver

Resolves cross-reference targets to their destinations.

SvgFileHandler

An SvgFileHandler is responsible for providing the raw contents of an SVG file when an inline image macro requests that the SVG be embedded directly in the output (image:target.svg[opts=inline]).