The dom.tex module

Elements needed for Latex documents.

Note

This module does not create DOM nodes for all Latex content.

You can build a full Latex document from scratch using the available nodes, but parce supports much more syntax than makes sense to build DOM nodes for.

LilyPond music is always in a lily.Document nodes, and can occur in a braced command or an environment.

class Document(*children, **attrs)

Bases: quickly.dom.base.Document

A full LaTeX source document.

space_between = ''

class Option(*children, **attrs)

Bases: quickly.dom.element.BlockElement

An option block: [ … ].

head = '['

tail = ']'

class Brace(*children, **attrs)

Bases: quickly.dom.element.BlockElement

A braced expression: { … }.

head = '{'

tail = '}'

class Math(*children, **attrs)

Bases: quickly.dom.element.BlockElement

Abstract Math block. Subclasses define the start/end delimiters.

class MathInlineParen(*children, **attrs)

Bases: quickly.dom.tex.Math

Inline math \(...\).

head = '\\('

tail = '\\)'

class MathInlineDollar(*children, **attrs)

Bases: quickly.dom.tex.Math

Inline math $...$.

head = '$'

tail = '$'

class MathDisplayBracket(*children, **attrs)

Bases: quickly.dom.tex.Math

Display math \[...\].

head = '\\['

tail = '\\]'

class MathDisplayDollar(*children, **attrs)

Bases: quickly.dom.tex.Math

Display math $$...$$ (discouraged).

head = '$$'

tail = '$$'

class Command(head, *children, **attrs)

Bases: quickly.dom.base.BackslashCommand

A backslash-prefixed command.

The backslash is not in the head value, but added on write().

Arguments may be appended as children.

class Text(head, *children, **attrs)

Bases: quickly.dom.element.TextElement

Common text.

class Environment(*children, **attrs)

Bases: quickly.dom.element.Element

A LaTeX environment.

Starts with a Command \begin, with zero or more Option nodes, then an EnvironmentName; then the contents, and finally an \end Command with and again an EnvironmentName().

space_before = '\n'

space_after = '\n'

classmethod with_name(name, *children, **kwargs)

Convenience method to create an Environment.

Zero or more child nodes can be specified, and keyboard arguments are given to the constructor.

class EnvironmentName(head, *children, **attrs)

Bases: quickly.dom.element.TextElement

The name of an environment.

The name is in the head value, the braces are added on write().

classmethod read_head(origin)

Return the value as computed from the specified origin Tokens.

The default implementation concatenates the text from all tokens.

write_head()

Return the textual output that represents our head value.

The default implementation just returns the head attribute, assuming it is text.

class Comment(head, *children, **attrs)

Bases: quickly.dom.base.SinglelineComment

A singleline comment after %.

space_after = '\n'

classmethod read_head(origin)

Return the value as computed from the specified origin Tokens.

The default implementation concatenates the text from all tokens.

write_head()

Return the textual output that represents our head value.

The default implementation just returns the head attribute, assuming it is text.