# F.2 Module LaTeXML-common

Pattern Inline.class

All strictly inline elements.

Expansion:

(text  |  emph  |  del  |  sub  |  sup  |  acronym  |  rule  |  anchor  |  ref  |  cite  |  bibref  |  Math)

Used by:
Pattern Block.class

All ‘physical’ block elements. A physical block is typically displayed as a block, but may not constitute a complete logical unit.

Expansion:
Used by:
Pattern Misc.class

Additional miscellaneous elements that can appear in both inline and block contexts.

Expansion:
Used by:
Pattern Para.class

All logical block level elements. A logical block typically contains one or more physical block elements. For example, a common situation might be p,equation,p, where the entire sequence comprises a single sentence.

Expansion:
Used by:
Pattern Meta.class

All metadata elements, typically representing hidden data.

Expansion:
Used by:
Pattern Length.type

The type for attributes specifying a length. Should be a number followed by a length, typically px. NOTE: To be narrowed later.

Content:

text

Used by:
Pattern Color.type

The type for attributes specifying a color. NOTE: To be narrowed later.

Content:

text

Pattern Common.attributes

Attributes shared by ALL elements.

Attributes:
Attribute class

NMTOKENS

a space separated list of tokens, as in CSS. The class can be used to add differentiate different instances of elements without introducing new element declarations. However, this generally shouldn’t be used for deep semantic distinctions. This attribute is carried over to HTML and can be used for CSS selection. [Note that the default XSLT stylesheets for html and xhtml add the latexml element names to the class of html elements for more convenience in using CSS.]

Attribute cssstyle

text

CSS styling rules. These will only be effective when the target system supports CSS.

Used by:
Pattern ID.attributes

Attributes for elements that can be cross-referenced from inside or outside the document.

Attribute xml:id

ID

the unique identifier of the element, usually generated automatically by the latexml.

Used by:
Pattern IDREF.attributes

Attributes for elements that can cross-reference other elements.

Attribute idref

IDREF

the identifier of the referred-to element.

Used by:
Pattern Labelled.attributes

Attributes for elements that can be labelled from within LaTeX. These attributes deal with assigning a label and generating cross references. The label migrates to an xml:id and href and the element can serve as a hypertext target.

Attributes:
Attribute labels

text

Records the various labels that LaTeX uses for crossreferencing. (note that $\backslash$label can associate more than one label with an object!) It consists of space separated labels for the element. The $\backslash$label macro provides the label prefixed by LABEL:; Spaces in a label are replaced by underscore. Other mechanisms (like acro?) might use other prefixes (but ID: is reserved!)

Attribute refnum

text

the reference number (ie. section number, equation number, etc) of the object.

Attribute frefnum

text

the formatted reference number of the object as it would appear when labelling the object, typically this is the refnum with the object type prepended, such as ”Chapter 2”. This is what eg, $\backslash$labelenumi or $\backslash$fnum@table would produce. This attribute is only needed when different from refnum.

Attribute rrefnum

text

the referencing reference number of the object as it might appear when referencing the object, such as an equation number with parentheses. This is useful for generated references to clarify the type of object, but is not used with LaTeX’s usual $\backslash$ref. And, note that $\backslash$eqnref puts its own parentheses. This attribute is only needed when different from both frefnum and refnum.

Used by:
Pattern Refable.attributes

Attributes for elements that can be referred to from within LaTeX. Such elements may serve as the starting point of a hypertext link. The reference can be made using label, xml:id or href; these attributes will be converted, as needed, from the former to the latter.

Attributes:
Attribute labelref

text

reference to a LaTeX labelled object; See the labels attribute of Labelled.attributes.

Attribute href

text

reference to an arbitrary url.

Used by:
Pattern Fontable.attributes

Attributes for elements that contain (indirectly) text whose font can be specified.

Attribute font

text

Indicates the font to use. It consists of a space separated sequence of values representing the family (serif, sansserif, math, typewriter, caligraphic, fraktur, script, …), series (medium, bold, …), and shape (upright, italic, slanted, smallcaps, …). Only the values differing from the current context are given. Each component is open-ended, for extensibility; it is thus unclear whether unknown values specify family, series or shape. In postprocessing, these values are carried to the class attribute, and can thus be effected by CSS.

Attribute fontsize

= (Huge  |  huge  |  LARGE  |  Large  |  large  |  normal  |  small  |  footnote  |  tiny  |  text)

Indicates the text size to use. The values are modeled after the more abstract LaTeX font size switches, rather than point-sizes. The values are open-ended for extensibility; In postprocessing, these values are carried to the class attribute, and can thus be effected by CSS.

Used by:
Pattern Colorable.attributes

Attributes for elements that draw something, text or otherwise, that can be colored.

Attribute color

text

the color to use (for foreground material); any CSS compatible color specification. In postprocessing, these values are carried to the class attribute, and can thus be effected by CSS.

Attribute opacity

float

the opacity of foreground material; a number between 0 and 1.

Used by:
Pattern Backgroundable.attributes

Attributes for elements that take up space and make sense to have a background color. This is independent of the colors of any things that it may draw.

Attribute backgroundcolor

text

the color to use for the background of the element; any CSS compatible color specification. In postprocessing, these values are carried to the class attribute, and can thus be effected by CSS; the background will presumably correspond to a bounding rectangle, but is determined by the CSS rendering engine.

Used by:
Pattern Positionable.attributes

Attributes shared by low-level, generic inline and block elements that can be sized or shifted.

Attribute width

the desired width of the box

Attribute height

the desired height of the box

Attribute depth

the desired depth of the box

extra width beyond the boxes natural size.

extra height beyond the boxes natural size.

Attribute xoffset

horizontal shift the position of the box.

Attribute yoffset

vertical shift the position of the box.

Attribute align

= (left  |  center  |  right  |  justified)

alignment of material within the box.

Attribute vattach

= (top  |  middle  |  bottom)

specifies which line of the box is aligned to the baseline of the containing object.

Attribute float

= (right  |  left  |  text)

the horizontal floating placement parameter that determines where the object is displayed.

Attribute framed

= (rectangle  |  underline  |  text)

the kind of frame or outline for the box.

Attribute framecolor

text

the color of the frame or outlie for the box.

Used by:
Pattern Imageable.attributes

Attributes for elements that may be converted to image form during postprocessing, such as math, graphics, pictures, etc. Note that these attributes are generally not filled in until postprocessing, but that they could be init

Attribute imagesrc

anyURI

the file, possibly generated from other data.

Attribute imagewidth

nonNegativeInteger

the width in pixels of imagesrc.

Attribute imageheight

nonNegativeInteger

the height in pixels of imagesrc. Note that, unlike TeX, this is the total height, including the depth (if any).

Attribute imagedepth

integer

the depth in pixels of imagesrc, being the location of the baseline of the content shown in the image. When displayed inilne, an image with a positive depth should be shifted down relative to the baseline of neighboring material.

Attribute description

text

a description of the image

Used by:
Pattern RDF.attributes

Attributes for RDFa (Resource Description Framework), following RDFa Core 1.1 http://www.w3.org/TR/rdfa-syntax/. The following descriptions give a short overview of the usage of the attributes, but see the specification for the complete details, which are sometimes complex.

Attribute vocab

text

indicates the default vocabulary (generally should be managed by LaTeXML and only appear on root node)

Attribute prefix

text

specifies a mapping between CURIE prefixes and IRI (URI). (generally should be managed by LaTeXML and only appear on root node)

text

indicates the subject for predicates appearing on the same or descendant nodes.

text

gives the label for the document element that serves as the subject; it will be converted to aboutidref and about during post-processing.

text

gives the id for the document element that serves as the subject; it will be converted to about during post-processing.

Attribute resource

text

indicates the subject for predicates appearing on descendant nodes, and also indicates the object for predicates when property appears on the same node, or when rel or rev appears on an ancestor.

Attribute resourcelabelref

text

gives the label for the document element that serves as the resource object; it will be converted to resourceidref and resource during post-processing.

Attribute resourceidref

text

gives the id for the document element that serves as the resource object; it will be converted to resource during post-processing.

Attribute property

text

indicates the predicate and asserts that the subject is related by that predicate to the object. The subject is determined by one of about on same node, resource or typeof on an ancestor node, or by the document root. The object is determined by one of resource, href, content or typeof on the same node, or by the text content of the node.

Attribute rel

text

indicates the predicate exactly as property except that it can assert multiple RDF triples where the objects are the nearest descendent resources.

Attribute rev

text

indicates the predicate exactly as rel except that it indicates the reverse relationship (with subject and object swapped).

Attribute typeof

text

indicates the type of the resource and thus implicitly asserts a relation that the object has the given type. Additionally, if no resource was given on the same node, indicates an anonymous subject and or object exactly as resource

Attribute datatype

text

indicates the datatype of the target resource;

Attribute content

text

indicates the content of the property to be used as the object, to be used instead of the content of the element itself;

Used by: