Struct AutoNumber 

pub struct AutoNumber {
    pub number_headings: bool,
    pub per_chapter: bool,
    /* private fields */
}

Walks the AST and assigns sequential numbers to figures, tables, listings, theorem-group components, definition-group components, display math equations, and headings.

Numbers are injected as a number string attribute on Component nodes. For MathDisplay nodes (which are not components), the numbers are only stored in the registry.

After calling Transform::transform, retrieve the full registry via AutoNumber::registry.

Example

use rdx_transform::{AutoNumber, Transform, parse};

let mut root = parse("<Figure id=\"fig:arch\">\n</Figure>\n");
let numberer = AutoNumber::new();
numberer.transform(&mut root, "");
let reg = numberer.registry();
assert_eq!(reg.entries["fig:arch"].number, "1");

Fields

number_headings: bool

If true, number headings hierarchically (1, 1.1, 1.1.2).

per_chapter: bool

If true, prefix figure/table numbers with chapter (Figure 2.3 vs Figure 7). When enabled, the chapter counter is the h1 section counter.

Implementations

impl AutoNumber

pub fn new() -> Self

pub fn registry(&self) -> Ref<'_, NumberRegistry>

Return a shared borrow of the registry built during the last call to Transform::transform.

Panics

Panics if the registry is already mutably borrowed elsewhere. This should never happen because transforms run single-threaded.

Trait Implementations

impl Default for AutoNumber

fn default() -> Self

Returns the “default value” for a type.

impl Transform for AutoNumber

fn name(&self) -> &str

A short identifier for this transform (used in error messages / debugging).

fn transform(&self, root: &mut Root, _source: &str)

Apply the transform to the AST. source is the original document text, available for transforms that need to reference raw content.