Fields

• hasFlagged :: Bool

  Is set True at every (Flagged ...); used to determine if current Flagged has any Flagged children

• currentSuperSectionID :: Int

  Tracks the current super-section number

• currentSectionID :: Int

  Tracks the current section number

• currentInsertedSectionID :: Int

  Tracks the current inserted section number

• currentParagraphID :: Int

  Tracks the current paragraph number in the current section

• currentSentenceID :: Int

  Tracks the current sentence number in the current paragraph

• currentEnumItemID :: Int

  Tracks the current enum item number in the current enumeration

• currentFootnoteID :: Int

  Tracks the id of the next footnote

• usedFootnoteMap :: FootnoteMap

  Maps all used footnotes labels to their id as an Int as Html and their text as Delayed Html, since they can also include references; This map is build during rendering with entries from "footnoteMap" from ReaderState and an additional id; Note: This map is document-scoped. Thus, it is reset when entering the next document.

• locallyUsedFootnotes :: FootnoteSet

  Holds a set of all footnotes that were used in the current section. When leaving a section, this is reset to the intial value. It is used to collect footnotes that should be rendered at the end of the current section (in ascending order of their footnote id).

• labels :: [(Label, Html ())]

  Holds all labels and the Html element that should be displayed when this label is referenced

• tableOfContents :: ToC

  Holds all entries for the table of contents as (Maybe key (e.g. § 1), title, HTML id as anchor link, category). The title is wrapped into Result. In case of an parse error this title will be set to an Error title. The Left constructor holds metadata for the Frontend, which is ignored when rendering the ToC.

• mangledLabelName :: Text

  Mangled prefix name for generating new label names that do not exist in source language

• mangledLabelID :: Int

  Mangled postfix ID which is incremented and added to mangledLabelName to create unique htmlID

• enumStyles :: EnumStyleMap

  Maps EnumFormats to their css class name which implements the fitting Counter

• mangledEnumCounterName :: Text

  Holds prefix for generating new css class names for enum counter styles

• mangledEnumCounterID :: Int

  Holds postfix id which makes enum counter class name unique

• exportSections :: [(Text, Delayed Text, Delayed (Html ()))]

  Collects all (non-super) sections as their their htmlID, their Html and their title

• documentFallbackTitle :: Fallback NavTocHeading

  Holds a fallback ToC title to send to the Frontend, if parsing the main Document failes. This is set by the DocumentContainer.

• mainDocumentTitleHtml :: Delayed (Html ())

  Styled title of the main Document for building exported sections

• mainDocumentTitle :: Delayed Text

  Raw title of the main Document for building HTML headers

• hasErrors :: Bool

  True if any error occured while parsing; Note: "soft" errors like undefined labels are not catched

Fields

• shouldRender :: Bool

  Is set True at every (Flagged True ...); to tell child Flagged to render

• hasGlobalToC :: Bool

  Signals if a Document should have a global or local ToC (if it has any); Is set by the DocumentContainer

• appendixHasGlobalToC :: Bool

  Should Documents inside of an AppendixSection should have a global ToC? This also means all Headings of those Documents appear in the global ToC

• currentAppendixElementID :: Int

  Tracks the current appendix element (document) id; This is in ReaderState, since it is controlled from the AppendixSection

• appendixElementIdFormat :: IdentifierFormat

  Tracks the identifier format of the current appendix element (document)

• appendixElementTocKeyFormat :: TocKeyFormat

  Tracks the toc key format of the current appendix element (document)

• appendixElementMLabel :: Maybe Label

  Holds the Maybe Label of the current (Node Document) in appendices; Used as a jump id inside the Document Heading

• documentHeadingFormat :: Either (HeadingFormat 'False) (HeadingFormat 'True)

  Holds format for current document heading (comes from DocumentContainer or AppendixSection)

• localSectionFormat :: SectionFormat

  Defines the local SectionFormat; is set by the SectionFormatted wrapper

• isSingleParagraph :: Bool

  Signals the child paragraph that it is the only child and thus should not have an visible identifier

• currentEnumIDFormatString :: IdentifierFormat

  Holds the FormatString that describes how the current enum item shoud be referenced

• footnoteMap :: Map Label Footnote

  Holds a map of all footnotes in the current document; This is generated by the parser; some footnotes in this map might never be rendered (if they are not referenced from any section)

• labelWrapperFunc :: LabelWrapper

  Wrapper around the Reference Html inside the TextTree (e.g. for adding anchor links)

• footnoteWrapperFunc :: LabelWrapper

  Wrapper around Footnote reference Html inside the TextTree (e.g. for adding anchor links)

• tocEntryWrapperFunc :: TocEntryWrapper

  Wrapper around an ToC entry (e.g. for adding anchor links)

• tocButtonWrapperFunc :: TocEntryWrapper

  Wrapper around the button in the right column of the ToC (e.g. for adding page links)

• exportLinkWrapper :: LabelWrapper

  Wrapper around the ID of a section at the end of it (e.g. for adding export links)

Fields

• unNumLabel :: (Int, Label)