class

Asciidoctor::Document

Inherits Asciidoctor::AbstractBlock < Asciidoctor::Substitutors < Asciidoctor::AbstractNode < Asciidoctor::Logging < Reference < Object

The Document class represents a parsed AsciiDoc document.

Document is the root node of a parsed AsciiDoc document. It provides an abstract syntax tree (AST) that represents the structure of the AsciiDoc document from which the Document object was parsed.

Constructors

new(safe : Int32 = SafeMode::SECURE, backend : String = DEFAULT_BACKEND, doctype : String = DEFAULT_DOCTYPE, base_dir : String = ".", sourcemap : Bool = false, parent_document : Document | Nil = nil, options : Hash(String, String | Bool | Int32) = {} of String => String | Bool | Int32)

Instance methods

<<(block : AbstractBlock) : self

Append a content block to this block's list of blocks. If the child block is a Section, assign an index to it.

apply_attribute_value_subs(value : String) : String

Internal: Apply substitutions to the attribute value.

If the value is an inline passthrough macro (e.g., pass:<subs>[value]), apply the substitutions defined in <subs> to the value, or leave the value unmodified if no substitutions are specified. If the value is not an inline passthrough macro, apply header substitutions to the value.

attribute_locked?(name : String) : Bool

Check if the specified attribute is locked (set via overrides).

attribute_overrides

The attribute overrides (locked attributes).

author

Get the author.

authors

Get the Array of authors.

backend

The cached value of the backend attribute.

base_dir

The String base directory for converting this document.

basebackend?(base : String) : Bool

Check whether the current backend matches the base backend.

callouts

Get the callouts.

catalog

The document catalog Hash.

clear_playback_attributes(attrs : Hash(String, String)) : Nil

Internal: Delete any attributes stored for playback.

compat_mode?

The Boolean AsciiDoc compatibility mode.

content

Get the converted result of the child blocks.

convert(opts : Hash(String, String) = {} of String => String) : String | Nil

Convert the AsciiDoc document using the converter.

converter

The Converter associated with this document.

converter=(converter : Converter::Base | Nil)

The Converter associated with this document.

counter(name : String, seed : String | Int32 | Nil = nil) : String | Int32

Get the named counter and take the next number in the sequence.

counters

The Hash of document counters.

create_converter(backend_name : String) : Converter::Base

Internal: Create and initialize an instance of the converter for this document.

create_converter

Create or retrieve the converter for this document. Uses the DefaultRegistry to find a converter matching the backend.

delete_attribute(name : String) : Bool

Delete the specified attribute from the document if the name is not locked.

docinfo(location : Symbol = :head, suffix : String | Nil = nil) : String

Read the docinfo file(s) for inclusion in the document template.

doctitle(opts : Hash(Symbol, Bool) = {} of Symbol => Bool) : String | Nil

Get the doctitle as a String.

doctitle_as_title(separator : String = ":") : Title | Nil

Get the document title as a Title object.

doctype

The cached value of the doctype attribute.

document

embedded?

Check if the document is embedded.

extensions

The activated Extensions::Registry associated with this document.

extensions!

Get the extensions registry, raising if nil.

extensions=(extensions : Extensions::Registry | Nil)

The activated Extensions::Registry associated with this document.

extensions?

Check if the document has extensions.

fill_datetime_attributes(attrs : Hash(String, String), input_mtime : Time | Nil = nil) : Nil

Internal: Assign the local and document datetime attributes.

finalize_header(block_attrs : Hash(String, String), apply_header : Bool = true) : Hash(String, String)

Finalize the document header after parsing.

first_section

Get the first section of the document.

footnotes

Get the footnotes.

footnotes?

Check whether this document has footnotes.

header

The level-0 Section (i.e., doctitle).

increment_and_store_counter(counter_name : String, block : AbstractBlock | Nil = nil) : String

Increment and store a counter.

init_syntax_highlighter

Initialize the syntax highlighter based on the source-highlighter attribute.

max_attribute_value_size

The maximum attribute value size.

max_attribute_value_size=(max_attribute_value_size : Int32 | Nil)

The maximum attribute value size.

multipart?

Check if this is a multipart (book) document.

nested?

Check if the document is nested (i.e., has a parent document).

nofooter

Check if the document should not render a footer.

noheader

Check if the document should not render a header.

notitle

Check if the document should not render a title.

options

The Hash of resolved options.

outfilesuffix

The outfilesuffix defined at the end of the header.

parent_document

A reference to the parent Document of this nested document.

parse(data : Array(String) | String | Nil = nil) : self

Parse the AsciiDoc source stored in the Reader into an abstract syntax tree.

parsed

Whether the document has been parsed.

parsed=(parsed : Bool)

Whether the document has been parsed.

parsed?

Check whether the source has been parsed.

playback_attributes(attrs : Hash(String, String)) : Nil

Replay attribute assignments at the block level. Processes attr_entries stored in block attributes during parsing.

reader

The Reader associated with this document.

reader=(reader : Reader | Nil)

The Reader associated with this document.

register(type : Symbol, value : String | Array(String) | Tuple(String, AbstractNode)) : AbstractNode | Nil

Register a reference in the document catalog.

resolve_id(text : String) : String | Nil

Resolve a string to an id.

restore_attributes

Restore the attributes to the previously saved state (attributes in header).

revdate

Get the revision date.

safe

A read-only integer value indicating the level of security.

save_attributes

Internal: Branch the attributes so that the original state can be restored at a future time.

save_to(output : String, target : String) : Nil

Write the output to the specified file.

sections?

Check whether this Document has any child Section objects.

set_attribute(name : String, value : String = "") : String | Nil

Set the specified attribute on the document if the name is not locked.

set_header_attribute(name : String, value : String = "", overwrite : Bool = true) : Bool

Assign a value to the specified attribute in the document header.

source

Make the raw source for the Document available.

source_lines

Get the source lines of the document.

sourcemap=(sourcemap : Bool)

Whether source map information should be tracked by the parser.

sourcemap?

Whether source map information should be tracked by the parser.

syntax_highlighter

The SyntaxHighlighter associated with this document.

syntax_highlighter=(syntax_highlighter : SyntaxHighlighterBase | Nil)

The SyntaxHighlighter associated with this document.

update_backend_attributes(new_backend : String, init : Bool = false) : String | Nil

Internal: Update the backend attributes to reflect a change in the active backend.

update_doctype_attributes(new_doctype : String) : String | Nil

Internal: Update the doctype attributes to reflect a change in the active doctype.

write(output : String | Nil, target : String) : Nil

Write the output to the specified file.

xreftext(xrefstyle : String | Nil = nil) : String | Nil

Generate cross reference text for this document.

Nested types