D.11 Module LaTeXML-structure

The document root.

Attributes:

Sectional.attributes

Content:

((FrontMatter.class  |  SectionalFrontMatter.class  |  Meta.class  |  titlepage)^*, (document.body.class  |  BackMatter.class)^*)

The content allowable as the main body of the document.

Content:

(Para.model  |  paragraph  |  subsubsection  |  subsection  |  section  |  chapter  |  part  |  slide  |  slidesequence  |  sidebar  |  sectional-block)

Used by:

document, inline-sectional-block, sectional-block

|=

inline-sectional-block

A block containing sectional material. Note that this may tend to break the overall heirarchy.

Attributes:

Sectional.attributes

Content:

document.body.class^*

Used by:

document.body.class

A block containing sectional material. Note that this may tend to break the overall heirarchy.

Attributes:

Sectional.attributes

Content:

document.body.class^*

Used by:

Misc.class

A part within a document.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, (part.body.class  |  BackMatter.class)^*)

Used by:

document.body.class

The content allowable as the main body of a part.

Content:

(Para.model  |  subparagraph  |  paragraph  |  subsubsection  |  subsection  |  section  |  chapter  |  slide  |  slidesequence  |  sidebar)

Used by:

part

A Chapter within a document.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, (chapter.body.class  |  BackMatter.class)^*)

Used by:

document.body.class, part.body.class

The content allowable as the main body of a chapter.

Content:

(Para.model  |  subparagraph  |  paragraph  |  subsubsection  |  subsection  |  section  |  slide  |  slidesequence  |  sidebar)

Used by:

chapter

A Section within a document.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, (section.body.class  |  BackMatter.class)^*)

Used by:

appendix.body.class, chapter.body.class, document.body.class, part.body.class

The content allowable as the main body of a section.

Content:

(Para.model  |  subparagraph  |  paragraph  |  subsubsection  |  subsection  |  slide  |  slidesequence  |  sidebar)

Used by:

section

A Subsection within a document.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, (subsection.body.class  |  BackMatter.class)^*)

Used by:

appendix.body.class, chapter.body.class, document.body.class, part.body.class, section.body.class

The content allowable as the main body of a subsection.

Content:

(Para.model  |  subparagraph  |  paragraph  |  subsubsection  |  slide  |  slidesequence  |  sidebar)

Used by:

subsection

A Subsubsection within a document.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, (subsubsection.body.class  |  BackMatter.class)^*)

Used by:

appendix.body.class, chapter.body.class, document.body.class, part.body.class, section.body.class, subsection.body.class

The content allowable as the main body of a subsubsection.

Content:

(Para.model  |  subparagraph  |  paragraph  |  slide  |  slidesequence  |  sidebar)

Used by:

subsubsection

A Paragraph within a document. This corresponds to a ‘formal’ marked, possibly labelled LaTeX Paragraph, in distinction from an unlabelled logical paragraph.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, (paragraph.body.class  |  BackMatter.class)^*)

Used by:

appendix.body.class, chapter.body.class, document.body.class, part.body.class, section.body.class, subsection.body.class, subsubsection.body.class

The content allowable as the main body of a paragraph.

Content:

(Para.model  |  subparagraph  |  slide  |  slidesequence  |  sidebar)

Used by:

paragraph

A Subparagraph within a document.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, (subparagraph.body.class  |  BackMatter.class)^*)

Used by:

appendix.body.class, chapter.body.class, paragraph.body.class, part.body.class, section.body.class, subsection.body.class, subsubsection.body.class

The content allowable as the main body of a subparagraph.

Content:

(Para.model  |  slide  |  slidesequence  |  sidebar)

Used by:

subparagraph

A slidesequence within a slideshow. Each slide contains a set slides, typically those that are revealed constructively.

Attributes:

Sectional.attributes

Content:

slide^*

Used by:

chapter.body.class, document.body.class, paragraph.body.class, part.body.class, section.body.class, subparagraph.body.class, subsection.body.class, subsubsection.body.class

A Slide within a slideshow, that may or may not be contained within a slidesequence.

Attributes:

Sectional.attributes

Attribute overlay

= text

overlay is the number of the current overlay. This must be specified when part of a slidesequence, else it may be omitted. Should be unique and rising within a slidesequence.

Content:

((SectionalFrontMatter.class  |  subtitle)^*, (slide.body.class  |  BackMatter.class)^*)

Used by:

appendix.body.class, chapter.body.class, document.body.class, paragraph.body.class, part.body.class, section.body.class, subparagraph.body.class, subsection.body.class, subsubsection.body.class, slidesequence

The content allowable as the main body of a slide.

Content:

Para.model

Used by:

slide

A Sidebar; a short section-like object that floats outside the main flow.

Attributes:

Sectional.attributes

Content:

((FrontMatter.class  |  SectionalFrontMatter.class)^*, (sidebar.body.class  |  BackMatter.class)^*)

Used by:

appendix.body.class, chapter.body.class, document.body.class, paragraph.body.class, part.body.class, section.body.class, subparagraph.body.class, subsection.body.class, subsubsection.body.class

The content allowable as the main body of a sidebar.

Content:

Para.model

Used by:

sidebar

An Appendix within a document.

Attributes:

Sectional.attributes

Content:

(SectionalFrontMatter.class^*, appendix.body.class^*)

Used by:

BackMatter.class

The content allowable as the main body of a chapter.

Content:

(Para.model  |  subparagraph  |  paragraph  |  subsubsection  |  subsection  |  section  |  slide  |  sidebar)

Used by:

appendix

A Bibliography within a document.

Attributes:

Sectional.attributes, Listing.attributes

Attribute files

= text

the list of bib files used to create the bibliography.

Attribute bibstyle

= text

the bibliographic style to be used to format the bibliography (presumably a BibTeX bst file name)

Attribute citestyle

= text

the citation style to be used when citing items from the bibliography

Attribute sort

= boolean

whether the bibliographic items should be sorted or in order of citation.

Content:

(FrontMatter.class^*, SectionalFrontMatter.class^*, bibliography.body.class^*)

Used by:

BackMatter.class

The content allowable as the main body of a chapter.

Content:

(Para.model  |  biblist)

Used by:

bibliography

An Index within a document.

Attributes:

Sectional.attributes, Listing.attributes

Attribute role

= text

The kind of index (obsolete?)

Content:

(SectionalFrontMatter.class^*, index.body.class^*)

Used by:

BackMatter.class

The content allowable as the main body of a chapter.

Content:

(Para.model  |  indexlist)

Used by:

index

A heirarchical index structure typically generated during postprocessing from the collection of indexmark in the document (or document collection).

Attributes:

Common.attributes, ID.attributes

Content:

indexentry^*

Used by:

index.body.class, indexentry

An entry in an indexlist consisting of a phrase, references to points in the document where the phrase was found, and possibly a nested indexlist represented index levels below this one.

Attributes:

Common.attributes, ID.attributes

Content:

(indexphrase, indexrefs^?, indexlist^?)

Used by:

indexlist

A container for the references (ref) to where an indexphrase was encountered in the document. The model is Inline to allow arbitrary text, in addition to the expected ref’s.

Attributes:

Common.attributes

Content:

Inline.model

Used by:

glossaryentry, indexentry

An Glossary within a document.

Attributes:

Sectional.attributes, Listing.attributes

Attribute role

= text

The kind of glossary

Content:

(SectionalFrontMatter.class^*, glossary.body.class^*)

Used by:

BackMatter.class

The content allowable as the main body of a chapter.

Content:

(Para.model  |  glossarylist)

Used by:

glossary

A glossary list typically generated during postprocessing from the collection of glossaryphrase’s in the document (or document collection).

Attributes:

Common.attributes, ID.attributes

Content:

glossaryentry^*

Used by:

glossary.body.class

An entry in an glossarylist consisting of a phrase, (one or more, presumably in increasing detail?), possibly a definition, and references to points in the document where the phrase was found.

Attributes:

Common.attributes, ID.attributes

Attribute role

= text

The kind of glossary

Attribute key

= text

a flattened form of the phrase for generating an ID.

Content:

(glossaryphrase^*, indexrefs^?)

Used by:

glossarylist

The title of a document, section or similar document structure container.

Attributes:

Common.attributes, Fontable.attributes, Colorable.attributes, Backgroundable.attributes

Content:

(tag  |  text  |  Inline.class  |  Misc.class  |  Meta.class)^*

Used by:

SectionalFrontMatter.class, TOC, proof, theorem

The short form of a title, for use in tables of contents or similar.

Attributes:

Common.attributes

Content:

(tag  |  text  |  Inline.class  |  Misc.class  |  Meta.class)^*

Used by:

SectionalFrontMatter.class

A subtitle, or secondary title.

Attributes:

Common.attributes

Content:

Inline.model

Used by:

FrontMatter.class, slide

Generalized document creator.

Attributes:

Common.attributes, FrontMatter.attributes

Attribute role

= (author  |  editor  |  translator  |  contributor  |  translator  |  text)

indicates the role of the person in creating the docment. Commonly useful values are specified, but is open-ended to support extension.

Attribute before

= text

specifies opening text to display before this creator in a formatted titlepage. This would be typically appear outside the author information, like ”and”.

Attribute after

= text

specifies closing text, punctuation or conjunction to display after this creator in a formatted titlepage.

Content:

(Person.class  |  Misc.class)^*

Used by:

SectionalFrontMatter.class

The content allowed in authors, editors, etc.

Content:

(personname  |  contact)

Used by:

creator

A person’s name.

Attributes:

Common.attributes, Refable.attributes

Content:

Inline.model

Used by:

Person.class

Generalized contact information for a document creator. Note that this element can be repeated to give different types of contact information (using role) for the same creator.

Attributes:

Common.attributes, FrontMatter.attributes, Refable.attributes

Attribute role

= (affiliation  |  address  |  current_address  |  email  |  url  |  thanks  |  dedicatory  |  orcid  |  text)

indicates the type of contact information contained. Commonly useful values are specified, but is open-ended to support extension.

Content:

Inline.model

Used by:

Person.class

Generalized document date. Note that this element can be repeated to give the dates of different events (using role) for the same document.

Attributes:

Common.attributes, FrontMatter.attributes

Attribute role

= (creation  |  conversion  |  posted  |  received  |  revised  |  accepted  |  text)

indicates the relevance of the date to the document. Commonly useful values are specified, but is open-ended to support extension.

Content:

Inline.model

Used by:

FrontMatter.class

A document abstract.

Attributes:

Common.attributes, FrontMatter.attributes

Content:

Block.model

Used by:

FrontMatter.class

Acknowledgements for the document.

Attributes:

Common.attributes, FrontMatter.attributes

Content:

Inline.model

Used by:

BackMatter.class, FrontMatter.class

Keywords for the document. The content is freeform.

Attributes:

Common.attributes, FrontMatter.attributes

Content:

Inline.model

Used by:

FrontMatter.class

A classification of the document.

Attributes:

Common.attributes, FrontMatter.attributes

Attribute scheme

= text

indicates what classification scheme was used.

Content:

Inline.model

Used by:

FrontMatter.class

block of random stuff marked as a titlepage

Attributes:

Sectional.attributes

Content:

(FrontMatter.class  |  SectionalFrontMatter.class  |  Block.class)^*

Used by:

document

(Generalized) Table Of Contents, represents table of contents as well as list of figures, tables, and other such things. This will generally be placed by a $\backslash$tableofcontents command and filled in by postprocessing.

Attributes:

Common.attributes, FrontMatter.attributes

Attribute lists

= text

indicates the kind of lists; space separated names of lists like ”toc”,”lof”, etc.

Attribute select

= text

indicates what kind of document elements to list, in the form of one or more tags such as ltx:chapter separated by | (suggestive of an xpath expression).

Attribute scope

= (current  |  global  |  text)

indicates the scope set of elements to include: current (default) is all in current document; global indicates all in the document set; otherwise an xml:id

Attribute show

= text

indicates what things to show in each entry

Attribute format

= (normal  |  short  |  veryshort  |  text)

indicates how to format the listing

Content:

(title^?, toclist^?)

Used by:

Para.class, navigation

The actual table of contents list, filled in.

Attributes:

Common.attributes

Content:

tocentry^*

Used by:

TOC, tocentry

An entry in a toclist.

Attributes:

Common.attributes

Content:

(ref  |  toclist)^*

Used by:

toclist

Attributes shared by all sectional elements

Attributes:

Common.attributes, Labelled.attributes, Backgroundable.attributes

Attribute rdf-prefixes

= text

Stores RDFa prefixes as space separated pairs, with the pairs being prefix and url separated by a colon; this should only appear at the root element.

Used by:

appendix, bibliography, chapter, document, glossary, index, inline-sectional-block, paragraph, part, section, sectional-block, sidebar, slide, slidesequence, subparagraph, subsection, subsubsection, titlepage

Attributes for other elements that can be used in frontmatter.

Attribute name

= text

Records the name of the type of object this is to be used when composing the presentation. The value of this attribute is often set by language localization packages.

Used by:

TOC, abstract, acknowledgements, classification, contact, creator, date, keywords

The content allowed for the front matter of each sectional unit, and the document.

Content:

(tags^?  |  title  |  toctitle  |  creator)

Used by:

appendix, bibliography, chapter, document, glossary, index, paragraph, part, section, sidebar, slide, subparagraph, subsection, subsubsection, titlepage

The content allowed (in addition to SectionalFrontMatter.class) for the front matter of a document.

Content:

(subtitle  |  date  |  abstract  |  acknowledgements  |  keywords  |  classification)

Used by:

bibliography, document, sidebar, titlepage

The content allowed a the end of a document. Note that this includes random trailing Block and Para material, to support articles with figures and similar data appearing ‘at end’.

Content:

(bibliography  |  appendix  |  index  |  glossary  |  acknowledgements  |  Para.class  |  Meta.class)

Used by:

chapter, document, paragraph, part, section, sidebar, slide, subparagraph, subsection, subsubsection

|=

TOC