LaTeXML The Manual
F Schema

F.3 Module LaTeXML-inline

Add to Inline.class

The inline module defines basic inline elements used throughout

|=

(text  |  emph  |  acronym  |  rule  |  anchor  |  ref  |  cite  |  bibref)

Add to Meta.class

Additionally, it defines these meta elements. These are generally hidden, and can appear in inline and block contexts.

|=

(note  |  indexmark  |  ERROR)

Element text

General container for styled text. Attributes cover a variety of styling and position shifting properties.

Used by:
Pattern text_attributes

Attributes for text.

Attributes:
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 size

= (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.

Attribute color

= text

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

Attribute framed

= (rectangle  |  underline  |  text)

the kind of frame or outline for the text.

Pattern text_model

Content model for text.

Content:
Element emph

Emphasized text.

Used by:
Pattern emph_attributes

Attributes for emph.

Attributes:
Pattern emph_model

Content model for emph.

Content:
Element acronym

Represents an acronym.

Used by:
Pattern acronym_attributes

Attributes for acronym.

Attributes:
Attribute name

= text

should be used to indicate the expansion of the acronym.

Pattern acronym_model

Content model for acronym.

Content:
Element rule

A Rule.

Used by:
Pattern rule_attributes

Attributes for rule.

Attributes:
Pattern rule_model

Content model for rule.

Content:

empty

Element ref

A hyperlink reference to some other object. When converted to HTML, the content would be the content of the anchor. The destination can be specified by one of the attributes labelref, idref or href; Missing fields will usually be filled in during postprocessing, based on data extracted from the document(s).

Used by:
Pattern ref_attributes

Attributes for ref.

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.

Attribute show

= text

a pattern encoding how the text content should be filled in during postprocessing, if it is empty. It consists of the words type (standing for the object type, eg. Ch.), refnum and title mixed with arbitrary characters. The It can also be fulltitle, which indicates the title with prefix and type if section numbering is enabled.

Attribute title

= text

gives a longer form description of the target, this would typically appear as a tooltip in HTML. Typically filled in by postprocessor.

Pattern ref_model

Content model for ref.

Content:
Element anchor

Inline anchor.

Used by:
Pattern anchor_attributes

Attributes for anchor.

Attributes:
Pattern anchor_model

Content model for anchor.

Content:
Element cite

A container for a bibliographic citation. The model is inline to allow arbitrary comments before and after the expected bibref(s) which are the specific citation.

Used by:
Pattern cite_attributes

Attributes for cite.

Attributes:
Pattern cite_model

Content model for cite.

Content:
Element bibref

A bibliographic citation refering to a specific bibliographic item.

Used by:
Pattern bibref_attributes

Attributes for bibref.

Attributes:
Attribute bibrefs

= text

a comma separated list of bibliographic keys. (See the key attribute of bibitem and bibentry)

Attribute show

= text

a pattern encoding how the text content (of an empty bibref) will be filled in. Consists of strings author, fullauthor, year, number and title (to be replaced by data from the bibliographic item) mixed with arbitrary characters.

Attribute separator

= text

separator between formatted references

Attribute yyseparator

= text

separator between formatted years when duplicate authors are combined.

Pattern bibref_model

Content model for bibref.

Content:
Element note

Metadata that covers several ‘out of band’ annotations. It’s content allows both inline and block-level content.

Used by:
Pattern note_attributes

Attributes for note.

Attributes:
Attribute mark

= text

indicates the desired visible marker to be linked to the note.

Attribute role

= (footnote  |  text)

indicates the kind of note

Pattern note_model

Content model for note.

Content:
Element ERROR

error object for undefined control sequences, or whatever

Used by:
Pattern ERROR_attributes

Attributes for ERROR.

Attributes:
Pattern ERROR_model

Content model for ERROR.

Content:

text*

Element indexmark

Metadata to record an indexing position. The content is a sequence of indexphrase, each representing a level in a multilevel indexing entry.

Used by:
Pattern indexmark_attributes

Attributes for indexmark.

Attributes:
Attribute see_also

= text

a flattened form (like key) of another indexmark, used to crossreference.

Attribute style

= text

NOTE: describe this.

Pattern indexmark_model

Content model for indexmark.

Content:
Expansion:
Element indexphrase

A phrase within an indexmark

Used by:
Pattern indexphrase_attributes

Attributes for indexphrase.

Attributes:
Attribute key

= text

a flattened form of the phrase for generating an ID.

Pattern indexphrase_model

Content model for indexphrase.

Content:
Element indexsee

A see-also phrase within an indexmark

Used by:
Pattern indexsee_attributes

Attributes for indexsee.

Attributes:
Attribute key

= text

a flattened form of the phrase for generating an ID.

Attribute name

= text

a name for the see phrase, such as ”see also”.

Pattern indexsee_model

Content model for indexsee.

Content:
May 25, 2011