Package org.asciidoctor.ast
Interface Catalog
-
- All Known Implementing Classes:
CatalogImpl
public interface Catalog
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<Footnote>
getFootnotes()
Note that footnotes are only available after `Document.getContent()` has been called.java.util.Map<java.lang.String,java.lang.Object>
getRefs()
Refs is a map of asciidoctor ids to asciidoctor document elements.
-
-
-
Method Detail
-
getFootnotes
java.util.List<Footnote> getFootnotes()
Note that footnotes are only available after `Document.getContent()` has been called. A converter uses cataloged footnotes to render them, presumably, at the bottom of a document.- Returns:
- footnotes occurring in document.
-
getRefs
java.util.Map<java.lang.String,java.lang.Object> getRefs()
Refs is a map of asciidoctor ids to asciidoctor document elements. For example, by default, each section is automatically assigned an id. In this case the id would map to aSection
element. Ids can also be explicitly assigned by document authors to any document element. See https://asciidoctor.org/docs/user-manual/#id A converter might use cataloged refs to lookup ids to support rendering inline anchors.- Returns:
- a map of ids to elements that asciidoctor has collected from the document.
-
-