TextElements — 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.

TextElement¶

class models/inline/text/TextElement.lml

Any inline element containing text and associated formatting information. Includes inline elements that are identifiers or references to identifiers.

Attribute	Type	Cardinality	Definition
`+content`	TextElementType	1	Content of the Text Element. May recursively contain other Text Elements.

TextElementType¶

class models/inline/text/TextElementType.lml

Content of the Text Element.

Attribute	Type	Cardinality	Definition
`+content`	LocalizedString	0..*	Textual content of the Text Element.
`+elements`	TextElement	0..*	May recursively contain other Text Elements.

PureTextElement¶

class models/inline/text/PureTextElement.lml

Inline element containing text and associated formatting information, but which does not contain any associated identifiers or references to identifiers. Restricted to contain only other such inline elements with no identifiers or references to identifiers.

Attribute	Type	Cardinality	Definition
`+content`	PureTextElementType	1	Content of the Text Element. May recursively contain other Pure Text Elements.

PureTextElementType¶

class models/inline/text/PureTextElementType.lml

Content of the Pure Text Element.

Attribute	Type	Cardinality	Definition
`+content`	LocalizedString	0..*	Textual content of the Pure Text Element.
`+elements`	PureTextElement	0..*	May recursively contain other Pure Text Elements.

MonospaceElement¶

class models/inline/text/MonospaceElement.lml

Monospace text. Corresponds to HTML `tt`, `code`.

KeywordElement¶

class models/inline/text/KeywordElement.lml

Keyword text.

EmphasisElement¶

class models/inline/text/EmphasisElement.lml

Emphasised text. Corresponds to HTML `em`, `i`.

SubscriptElement¶

class models/inline/text/SubscriptElement.lml

Subscript text. Corresponds to HTML `sub`.

StrongElement¶

class models/inline/text/StrongElement.lml

Strong text. Corresponds to HTML `strong`, `b`.

StemElement¶

class models/inline/text/StemElement.lml

Mathematically formatted text.

Attribute	Type	Cardinality	Definition
`+stemType`	StemType	1	The notation used to mathematically format the text.
`+stemValue`	StemValue	1	The content of the mathematically formatted text.

SuperscriptElement¶

class models/inline/text/SuperscriptElement.lml

Superscript text. Corresponds to HTML `sup`.

StrikeElement¶

class models/inline/text/StrikeElement.lml

Strikethrough text. Corresponds to HTML 4 `s`.

SmallCapsElement¶

class models/inline/text/SmallCapsElement.lml

Small caps text.

UnderlineElement¶

class models/inline/text/UnderlineElement.lml

Underlined text. Corresponds to HTML 4 `u`.

Attribute	Type	Cardinality	Definition
`+style`	`String`	0..1	CSS style to apply to underline (intended for text-decoration-style attribute keyword values: solid double dotted dashed wavy)

StemValue¶

class models/inline/text/StemValue.lml

The content of mathematically formatted text.

RubyElement¶

class models/inline/text/RubyElement.lml

Text with Ruby annotations in East Asian languages. Corresponds to HTML `ruby`.

Attribute	Type	Cardinality	Definition
`+pronunciation`	RubyPronunciation	0..1	Ruby annotation giving pronunciation. Mutually exclusive with annotation.
`+annotation`	RubyAnnotation	0..1	Ruby annotation giving other (semantic) information. Mutually exclusive with pronunciation.
`+text`	`String`	0..1	Ruby annotated text which contains no further annotations. Mutually exclusive with ruby.
`+ruby`	RubyElement	0..1	Ruby annotated text which itself contains other Ruby annotations. Mutually exclusive with text.

RubyPronunciation¶

class models/inline/text/RubyPronunciation.lml

Ruby annotation giving pronunciation of text.

Attribute	Type	Cardinality	Definition
`+value`	`String`	1	Ruby annotation value.
`+script`	`String`	0..1	Indication of script of annotation.
`+lang`	`String`	0..1	Indication of language of annotation.

RubyAnnotation¶

class models/inline/text/RubyAnnotation.lml

Ruby annotation giving information other than pronunciation of text.

Attribute	Type	Cardinality	Definition
`+value`	`String`	1	Ruby annotation value.
`+script`	`String`	0..1	Indication of script of annotation.
`+lang`	`String`	0..1	Indication of language of annotation.

MathML¶

class models/inline/text/MathML.lml

Mathematical text formatted in MathML.

Attribute	Type	Cardinality	Definition
`+value`	`String`	1	MathML content.

AsciiML¶

class models/inline/text/AsciiML.lml

Mathematical text formatted in AsciiMath.

Attribute	Type	Cardinality	Definition
`+value`	`String`	1	AsciiMath content.

LaTeX¶

class models/inline/text/LaTeX.lml

Mathematical text formatted in LaTeX.

Attribute	Type	Cardinality	Definition
`+value`	`String`	1	LaTeX content.

StemType¶

enum models/inline/text/StemType.lml

definition
definition
definition
definition

IdElement¶

class models/inline/id/IdElement.lml

`BasicElement` with an identifier, to be used in crossreferencing by Reference Elements. The `IdElement` itself acts as a reference point, such as in a `SourcecodeBlock` for callout references (the `IdElement` is the location), and for delimiting `ReviewComment` start/end places.

Attribute	Type	Cardinality	Definition
`+id`	`String`	1	Identifier of BasicElement.

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.

Model definitions