Expand description
The Parser struct and its related structs allow a caller to configure
how AsciiDoc parsing occurs and then to initiate the parsing process.
Structs§
- Callout
Render Params - Provides parameters for rendering a callout number.
- Catalog
Resolver - The default single-document
ReferenceResolver, backed by oneCatalog. - Default
Path Resolver - The default
PathResolverimplementation, mirroring the Ruby AsciidoctorPathResolverclass. - Derived
Reference - The destination a cross-reference target resolves to on its own, without consulting any catalog.
- Footnote
Render Params - Provides parameters for rendering the inline marker of a
footnotemacro. - Html
Substitution Renderer - Implementation of
InlineSubstitutionRendererthat renders substitutions for common HTML-based applications. - Icon
Render Params - Provides parsed parameters for an icon to be rendered.
- Image
Render Params - Provides parsed parameters for an image to be rendered.
- Include
Content - The content returned by an
IncludeFileHandlerfor aninclude::directive, together with the metadata the parser needs to finish processing the include. - Index
Term Render Params - Provides parameters for rendering an index term.
- Link
Render Params - Provides parsed parameters for an icon to be rendered.
- Menu
Render Params - 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
Fidelityof the mapping. - Parser
- The
Parserstruct and its related structs allow a caller to configure how AsciiDoc parsing occurs and then to initiate the parsing process. - Reference
Time - A fixed reference instant used to compute the time-dependent document
attributes (
docdate,doctime,docdatetime,docyear, and theirlocal*siblings). - Reference
Warning - A warning produced while resolving cross-references.
- Resolution
Context - Describes a single cross-reference that needs to be resolved.
- Resolved
Reference - The resolved destination of a cross-reference.
- Source
Line - A
SourceLinerepresents the original file and line number where a line of AsciiDoc text was found before include file and conditional pre-processing occurred. - Source
Map - 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’sSpanto the file and line the author actually wrote. - Xref
Render Params - Provides parameters for rendering a cross-reference.
- Xref
Signifier - A referenceable target’s signifier and reference number, used to build the
automatic text of a cross-reference for the
FullandShortstyles (and to emphasize a chapter or appendix title underBasic).
Enums§
- Allowable
Value - Allowable values for the attribute.
- Callout
Guard - Describes the characters that guard (hide) a callout number in verbatim source.
- Character
Replacement Type - 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.
- Modification
Context - Allowable context(s) for modification of this attribute value.
- Quote
Scope - Specifies whether the block is aligned to word boundaries or not.
- Quote
Type - Specifies which quote type is being rendered.
- Reference
Warning Kind - The kind of problem described by a
ReferenceWarning. - Safe
Mode - Describes the safe mode under which a document is parsed and rendered.
- Special
Character - 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.
- Xref
Style - The cross-reference text style selected by the
xrefstyleattribute.
Traits§
- Docinfo
File Handler - A
DocinfoFileHandleris responsible for providing the text content of a docinfo file when one is requested while resolving a document’s docinfo. - Image
File Handler - An
ImageFileHandleris responsible for providing the raw bytes of an image file when a referenced image must be embedded directly in the output as adata:URI (i.e. when thedata-uridocument attribute is set and the safe mode is belowSafeMode::Secure). - Include
File Handler - An
IncludeFileHandleris responsible for providing the text content for aninclude::directive when encountered. - Inline
Substitution Renderer - An implementation of
InlineSubstitutionRendereris used when converting the basic raw text of a simple block to the format which will ultimately be presented in the final converted output. - Path
Resolver - A
PathResolverhandles all operations for resolving, cleaning, and joining paths, covering both web paths (request URIs) and system paths. - Reference
Resolver - Resolves cross-reference targets to their destinations.
- SvgFile
Handler - An
SvgFileHandleris 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]).