Skip to main content

Module pages

Module pages 

Source
Expand description

Page output: the display structure.

The engine’s only product. Painters (SVG preview, PDF export) consume this and never re-derive layout. Coordinates are page units (points), origin top-left.

Structs§

Corners
The four corners of a box, each rounded by its own radius.
Folios
Where one node’s content is set: the folios it runs between, and the pages of the book those folios are.
Glyph
One glyph: an id in its font and an absolute x. Kerning and justification mean no two glyphs are uniformly spaced — the glyph is the atom of layout, so positions are per-glyph.
Link
One link on one page: the area its text covers on each line, and where it goes.
Navigation
What a reader of the book on a screen follows beyond the links on its pages: the outline of its headings.
OutlineEntry
One heading in the outline.
Page
One typeset page: a number, a side, a trim size, and what to paint on it.
PageBox
One box on one page, in points, origin top-left.
Radius
How far one corner of a box is rounded: the two radii of the quarter ellipse the corner follows, in points.

Enums§

DrawItem
A single paint operation. Deliberately tiny: text, rules, images, and the rounded boxes a border radius draws.
LinkTo
Where a link goes.
Side
Which side of the spread a page falls on.