package cmarkit

  1. Overview
  2. Docs

Module Block.FootnoteSource

Footnotes.

Footnotes

Sourcetype block := t
Sourcetype t

The type for footnotes.

Sourceval make : ?indent:Layout.indent -> ?defined_label:Label.t option -> Label.t -> block -> t

make label b is a footnote for label label with content b. defined_label defaults to label.

Sourceval indent : t -> Layout.indent

indent fn is the indentation to the label found on the first line.

Sourceval label : t -> Label.t

label fn is the footnote definition label as found in the source text. It includes the ^. See also defined_label.

Sourceval defined_label : t -> Label.t option

defined_label fn is the label determined by the Label.resolver for the footnote. The label as found in the source text is in label. If this is None the resolver deleted the label definition.

Sourceval block : t -> block

block fn is the footnote content.

As label definitions

Sourcetype Label.def +=
  1. | Def of t node

A label definition for footnotes.