Kotoba.Nodes.FootnoteDefinition (Kotoba v0.5.0)

The text of a footnote (type "footnotedefinition"): Markdown's [^label]: text. The JSON key is label. It holds blocks, and is valid only under the root.

In HTML, the footnotes of a document are one list at its end (section.kotoba-footnotes), numbered in the order of their first reference (see Kotoba.Nodes.FootnoteReference); a footnote with no reference comes last. In Markdown, a footnote is [^label]: and its blocks, the blocks after the first indented by four spaces.

Summary

Types

t()

Functions

id(label)

Returns the HTML id of the footnote with label.

Types

t()

@type t() :: %Kotoba.Nodes.FootnoteDefinition{
  children: term(),
  direction: term(),
  extra: term(),
  format: term(),
  indent: term(),
  label: term(),
  version: term()
}

Functions

id(label)

@spec id(String.t()) :: String.t()

Returns the HTML id of the footnote with label.

Examples

iex> Kotoba.Nodes.FootnoteDefinition.id("my note")
"kotoba-fn-my-note"