Module: Uniword::Caption

Defined in:
lib/uniword/caption.rb,
lib/uniword/caption/counter.rb,
lib/uniword/caption/caption_builder.rb,
lib/uniword/caption/cross_reference.rb

Overview

Auto-numbered figure/table/equation captions with cross-references and Tables of Figures.

Three pieces, all model-driven:

  • Caption::Counter — label-keyed counters (Figure, Table, Equation) persisted on the document. Reset to 1 at the start of each document load.
  • Caption::CaptionBuilder — builds a Caption-styled paragraph with a SEQ field, returns the assigned bookmark name.
  • Caption::CrossReference — builds a REF fldSimple targeting a named bookmark.

The TOC of figures is just the existing TOC engine with \c instead of \o; see Toc::FigureEntryBuilder.

Defined Under Namespace

Classes: CaptionBuilder, Counter, CrossReference