ReferenceElements — Basicdoc Models

BasicElement¶

class models/inline/BasicElement.lml

Container of inline content in BasicDocument.

Attribute	Type	Cardinality	Definition
`+contribMetadata`	ContributionElementMetadata	0..*	Metadata of the contributor responsible for the action.
`+attributes`	Attribute	0..*	Entries from the generic attribute register: an open key-value set that markup languages bind their own attribute types into.

ReferenceElement¶

class models/inline/reference/ReferenceElement.lml

Inline element, which references an identifier of a document, a block in a document, or an element in a document.

Attribute	Type	Cardinality	Definition
`+type`	ReferenceFormat	1	The type of Reference Element, prescribing how it is to be rendered.
`+text`	BasicElement	0..1	The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `<xx>my link text</xx>`)
`+alt`	`String`	0..1	Alternate text, used for accessibility.

Citation¶

class <<Bibliography>> models/inline/reference/Citation.lml

A reference to a bibliographic entity, as modelled in Relaton.

ReferenceToIdElement¶

class models/inline/reference/ReferenceToIdElement.lml

An internal reference to an element of the current document.

Attribute	Type	Cardinality	Definition
`+target`	IdElement	1	The identifier of a section, block or inline element being referenced.

IndexXrefElement¶

class models/inline/reference/IndexXrefElement.lml

A reference to an index term, cross-referenced within an index as an alternative index entry, either as a "see" or a "see also" cross-reference. The text in the inline element is the primary index term to be be cross-referenced.

Attribute	Type	Cardinality	Definition
`+secondary`	`String`	0..1	The secondary index term to be be cross-referenced.
`+tertiary`	`String`	0..1	The tertiary index term to be be cross-referenced.
`+target`	`String`	1	The index term to be cross-referenced to.
`+also`	`Boolean`	1	The cross-reference is to be treated as "see also" rather than as "see".

ReferenceToLinkElement¶

class models/inline/reference/ReferenceToLinkElement.lml

A reference to an external document or resource.

Attribute	Type	Cardinality	Definition
`+target`	Uri	1	The location or online identifier of the external document or resource.

ReferenceToCitationElement¶

class models/inline/reference/ReferenceToCitationElement.lml

An external reference to a bibliographic entity.

Attribute	Type	Cardinality	Definition
`+normative`	`Boolean`	0..1	Whether the reference is to be treated as normative or informative, particularly in the context of normative documents such as standards.
`+citeAs`	TextElement	0..*	Form that the bibliographic citation should take when it is rendered.

ReferenceToIdWithParagraphElement¶

class models/inline/reference/ReferenceToIdWithParagraphElement.lml

Inline reference to a paragraph or paragraphs: element combining the reference and the referenced content in the one element.

Attribute	Type	Cardinality	Definition
`+content`	ParagraphBlock	1..*	The paragraph or paragraphs referenced in this element.

Callout¶

class models/inline/reference/Callout.lml

Inline reference to a paragraph or paragraphs, appearing as annotation of source code. The target of the callout is understood to be the location of the callout within the source code; the extent of the target is not expressed overtly.

Attribute	Type	Cardinality	Definition
`+type`	`"callout"`	fixed
`+text`	`String`	1	The label of the callout, used to identify its target within the source code.

Footnote¶

class models/inline/reference/Footnote.lml

Inline reference to a paragraph or paragraphs, appearing as a footnote.

Attribute	Type	Cardinality	Definition
`+type`	`"footnote"`	fixed
`+reference`	`String`	1	The number of the footnote, used to identify it visually.

ReferenceFormat¶

enum models/inline/reference/ReferenceFormat.lml

definition
external
definition
inline
definition
footnote
definition
callout
definition

ReferenceToVariable¶

class models/inline/reference/ReferenceToVariable.lml

Reference to a variable: resolves, at processing time, to the value registered under the given key in the attribute register. This is the model home for attribute references (AsciiDoc {attr}), substitutions (RST |substitution|), and template variables.

Attribute	Type	Cardinality	Definition
`+name`	`String`	1	Key of the referenced variable in the attribute register.

Model definitions