/** * Index marks, anchors and headings written in the part of a story that * went on in a page of another chapter (#988, DESIGN §5.17, §5.18). * * The chapter that sent the story cannot place them: the words are laid by * the chapter that has the page, so the sender's own location finds no line * for them and falls back on the page where the story starts. The receiving * chapter knows the page and reports it ({@link locateCarriedOutline}, * `VDTDocument.carriedOutline`); a host with every chapter's outline puts * the pages into the sender's entries ({@link mergeCarriedOutline}), keyed * by the sending chapter and the offset in its body. */ import type { ImportedJumps } from '../composed/carry.js'; import type { OutlineEntry } from '../types.js'; import type { VDTCarriedOutlineEntry, VDTDocument } from '../vdt.js'; /** * What the stories carried into `doc` hold: each index mark, inline anchor * and heading of a story that this chapter laid (the part the sender did * not), with the page it landed on here. `baseLength` is where the carried * blocks start among the chapter's content blocks, `bodyOffset` this * chapter's own. */ export declare function locateCarriedOutline(doc: VDTDocument, carried: ImportedJumps, bodyOffset: number): VDTCarriedOutlineEntry[]; /** An entry of `VDTDocument.carriedOutline` with its page as the book * prints it (label and index in the whole book), what a host keeps of a * chapter once its document is gone. */ export interface CarriedPlace { chapter: number; kind: VDTCarriedOutlineEntry['kind']; sourceStart: number; pageLabel: string; pageIndex: number; pageFormat: VDTDocument['pages'][number]['pageNumberFormat']; } /** `doc.carriedOutline` with the pages of the book. */ export declare function carriedPlaces(doc: VDTDocument): CarriedPlace[]; /** * `outlines` (one array of entries per chapter, as `outlineFromDoc` gives * them) with the pages the receiving chapters found for the index marks, * anchors and headings of the stories they carry (`carriedPlaces`, one * list per chapter) put into the sending chapter's entries. A chapter * nothing was carried from keeps its array. */ export declare function mergeCarriedOutline(outlines: readonly (readonly OutlineEntry[])[], places: readonly (readonly CarriedPlace[] | undefined)[]): (readonly OutlineEntry[])[]; //# sourceMappingURL=carriedOutline.d.ts.map