Anchors
Documenter.Anchor — TypeStores an arbitrary object called .object and it's location within a document.
Fields
object– the stored object.order– ordering ofobjectwithin the entire document.file– the destination file, inbuild, where the object will be written to.id– the generated "slug" identifying the object.nth– integer that unique-ifies anchors with the sameid.
Documenter.AnchorMap — TypeTree structure representing anchors in a document and their relationships with each other.
Object Hierarchy
id -> file -> anchorsEach id maps to a file which in turn maps to a vector of Anchor objects.
Documenter.anchor — Methodanchor(m, id)
Returns the Anchor object matching id. file and n may also be provided. An Anchor is returned, or nothing in case of no match.
Documenter.anchor_add! — Methodanchor_add!(m, anchor, id, file)
Adds a new Anchor to the AnchorMap for a given id and file.
Either an actual Anchor object may be provided or any other object which is automatically wrapped in an Anchor before being added to the AnchorMap.
Documenter.anchor_exists — Methodanchor_exists(m, id, file, n)
Does the given id exist within the AnchorMap? A file and integer n may also be provided to narrow the search for existence.
Documenter.anchor_fragment — MethodCreate an HTML fragment from an anchor.
Documenter.anchor_isunique — Methodanchor_isunique(m, id)
Is the id unique within the given AnchorMap? May also specify the file.
Documenter.anchor_label — MethodCreate a label from an anchor.