nodes#

Nodes that make up the manuscript tree.

The manuscript tree semantically represents each element in the manuscript such as sections, paragraphs, special regions, figures, etc.

This is opposed to the syntax tree output by tree-sitter whose nodes represent elements with syntactic meaning such as tags, delimiters, etc.

There are two main classes of interest: Node and NodeWithChildren. They implement 95% of the entire API of this module. Other classes are mostly dummy subclasses whose only purpose is to differentiate themselves from others via their type.

Classes

Abstract

Manuscript abstract.

Algorithm

Algorithm pseudocode.

Appendix

Mark the start of the Appendix sections.

Author

An author of the manuscript.

BaseParagraph

Foo.

BaseReference

Bibitem

Bibliography

Caption

Cite

ClaimBlock

Code

CodeBlock

Construct

Contents

Definition

Draft

Enumerate

Error

Error node.

Figure

Heading

Item

Itemize

Keyword

Lemma

Manuscript

Math

MathBlock

Node

A node in the manuscript tree.

NodeWithChildren

A Node that may have children Nodes.

Note

Paragraph

PendingCite

PendingPrev

PendingReference

Proof

Proposition

Reference

Remark

Section

Sketch

SourceCode

Span

Statement

Step

Subproof

Subsection

Subsubsection

Table

TableBody

TableDatum

TableHead

TableRow

Text

Plain text node.

Theorem

URL

UnknownBibitem

Exceptions

RSMNodeError