AncillaryBlocks — Basicdoc Models

BasicBlock¶

class models/blocks/BasicBlock.lml

Block of textual content in BasicDocument.

Attribute	Type	Cardinality	Definition
`+notes`	NoteBlock	0..*	Notes whose scope is the current block.
`+contribMetadata`	ContributionElementMetadata	0..*	Attribution of the block to a specific contributor, to be used in change management of documents.
`+attributes`	Attribute	0..*	Entries from the generic attribute register: an open key-value set that markup languages bind their own attribute types into.

FigureBlock¶

class models/blocks/ancillaryblocks/FigureBlock.lml

Block containing a figure: a visual rather than textual asset, possibly with accompanying text.

Attribute	Type	Cardinality	Definition
`+source`	`String`	0..1	A URI or other reference intended to link to an externally hosted image (or equivalent).
`+name`	TextElement	0..*	The caption of the block.
`+image`	Image	0..1	The image file to be included in the figure as its main content.
`+video`	Video	0..1	The video file to be included in the figure as its main content.
`+audio`	Audio	0..1	The audio file to be included in the figure as its main content.
`+figure`	Subfigure	0..*	Figures embedded within the main figure.
`+definitions`	DefinitionList	0..1	An optional definitions list defining any symbols used in the figure.
`+footnotes`	ReferenceToIdWithParagraphElement	0..*	Optional footnotes specific to the figure.

Subfigure¶

class models/blocks/ancillaryblocks/Subfigure.lml

A figure embedded within another figure. Subfigures only occur within figures.

SourcecodeBlock¶

class models/blocks/ancillaryblocks/SourcecodeBlock.lml

Block containing computer code or comparable text.

Attribute	Type	Cardinality	Definition
`+name`	TextElement	0..*	The caption of the block.
`+filename`	`String`	0..1	A file name associated with the source code (and which could be used to extract the source code fragment to from the document, or to populate the source code fragment with from the external file, in automated processing of the document).
`+lang`	`String`	0..1	The computer language or other notational convention that the source code is expressed in.
`+content`	`String`	1	The computer code or other such text presented in the block, as a single unformatted string. (The string should be treated as pre-formatted text, with whitespace treated as significant.)
`+callouts`	ReferenceToIdElement	0..*	Zero or more cross-references; these are intended to be embedded within the `content` string, and link to annotations.
`+calloutAnnotations`	ParagraphBlock	0..*	Annotations to the source code; each annotation consists of zero or more paragraphs, and is intended to be referenced by a callout within the source code.

FormulaBlock¶

class models/blocks/ancillaryblocks/FormulaBlock.lml

Block containing a mathematical expression or other formulas.

Attribute	Type	Cardinality	Definition
`+stem`	StemElement	1	The content of the formula, as a mathematical expression.
`+inequality`	`Boolean`	0..1	Indication that the formula is to be labelled as an Inequality, if inequalities are differentiated from equations.
`+definitions`	DefinitionList	0..1	A definitions list defining any symbols used in the formula.

ExampleBlock¶

class models/blocks/ancillaryblocks/ExampleBlock.lml

Block containing an example illustrating a claim made in the main flow of text.

Attribute	Type	Cardinality	Definition
`+name`	TextElement	0..*	The caption of the block.
`+content`	BasicBlock	0..*	Relaxed block content; an extension point that higher layers may extend additively.

LiteralBlock¶

class models/blocks/ancillaryblocks/LiteralBlock.lml

Pre-formatted blocks are wrappers for text to be rendered with fixed-width typeface, and preserving spaces including line breaks. They are intended for a restricted number of functions, most typically ASCII Art (which is still in prominent use in some standards documents), and computer output. In most cases, Sourcecode blocks are more appropriate in markup, as it is more clearly motivated semantically.

Attribute	Type	Cardinality	Definition
`+alt`	`String`	0..1	Accessible description of the preformatted text.
`+name`	TextElement	0..*	The caption of the block.
`+content`	`String`	1	The pre-formatted text presented in the block, as a single unformatted string. (Whitespace is treated as significant.)

Model definitions