pub struct FootnoteNode {
pub id: String,
pub name: Option<String>,
pub role: Option<String>,
pub marker: Option<String>,
pub spans: Vec<TextSpan>,
pub style: Option<String>,
pub fill: Option<PropertyValue>,
pub font_family: Option<PropertyValue>,
pub font_size: Option<PropertyValue>,
pub source_span: Option<Span>,
pub unknown_props: BTreeMap<String, UnknownProperty>,
}Expand description
A footnote node — page-level book-interior furniture that auto-numbers and
renders in a reserved zone at the bottom of the page.
A footnote is NOT positioned by the author: it has NO x/y/w/h. At
compile time every footnote that is a DIRECT child of a Page is
collected in source order, auto-numbered 1..N (a footnote that declares an
explicit marker uses that string instead of a
number but still occupies a slot), and rendered stacked above the page’s
bottom margin with a separator rule. A TextSpan that carries a matching
footnote_ref gets the footnote’s marker emitted
inline as a superscript after its text.
KDL: footnote id="fn.1" { span "See also Chapter 4." }. The content is a
list of TextSpans (the same span model as a text node), so it inherits
the text shaping/wrap path verbatim.
Fields§
§id: String§name: Option<String>§role: Option<String>§marker: Option<String>Explicit marker override. When Some(s), the footnote renders s as its
marker (both inline and in the zone) instead of its auto-number; the
footnote still occupies a numbering slot. None → use the auto-number.
spans: Vec<TextSpan>The footnote’s content spans (same model as a text node’s spans).
style: Option<String>§fill: Option<PropertyValue>Fill for the footnote content + the separator rule. None → a sensible
muted default for the rule and opaque black for the text.
font_family: Option<PropertyValue>§font_size: Option<PropertyValue>§source_span: Option<Span>Source declaration span, when available.
unknown_props: BTreeMap<String, UnknownProperty>Unknown properties preserved for forward-compat.
Trait Implementations§
Source§impl Clone for FootnoteNode
impl Clone for FootnoteNode
Source§fn clone(&self) -> FootnoteNode
fn clone(&self) -> FootnoteNode
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for FootnoteNode
impl Debug for FootnoteNode
Source§impl PartialEq for FootnoteNode
impl PartialEq for FootnoteNode
Source§fn eq(&self, other: &FootnoteNode) -> bool
fn eq(&self, other: &FootnoteNode) -> bool
self and other values to be equal, and is used by ==.