postext 1.11.3 → 1.12.1

package/dist/pipeline/build.js

@@ -13,7 +13,11 @@ import { getMeasureRegion, getMeasureUprightDigits, getMeasureWritingMode, setMe
 import { stampCentralBaselines } from './verticalMetrics';
 import { resolveAllConfig, computeBaselineGrid, resolvedLocale } from './config';
 import { createHeadingLevelResolver, deriveSectionGeometryConfig, sectionWritingMode, deriveSectionMeasureContext, headingIsHidden, headingIsNumbered, headingMarksFor, headingStyleOf, planHeadingSections, } from './headingStyles';
-import { computeOutline, hasIndexDirective, hasTocDirective, headingNumberingOptions, headingTemplatesOf, outlineFromDoc, sameOutline } from './outline';
+import { locateAnchors } from './anchors';
+import { applyCitations, citationLocale, processCitations, withBibliographyStyle } from './citations';
+import { bookCitationContexts, needsCitationContext } from '../citations/context';
+import { anchorTargetsOf, hasAnchorRefs, printsAnchorPages } from './crossRefs';
+import { anchorOutline, computeOutline, hasIndexDirective, hasTocDirective, headingNumberingOptions, headingTemplatesOf, outlineFromDoc, sameOutline } from './outline';
 import { expandTocDirectives } from './toc';
 import { expandIndexDirectives, locateIndexMarks } from './indexDirective';
 import { resolveBodyStyle, resolveBlockquoteStyle, resolveParagraphStyle } from './styles';
@@ -271,7 +275,16 @@ function placeDocumentPass(content, config, cache, options, hints) {
     // Footnote definitions (`[^id]: …`) leave the flow; the markers are
     // numbered in citation order. With `placement: 'chapterEnd'` the notes
     // come back as paragraphs after each chapter's last block.
-    const footnoteSplit = splitFootnoteDefinitions(headingMarksFor(parseMarkdownMemo(markdownBody), resolved));
+    // Citations (#268): formatted against the book's references (or set as
+    // notes under a note style) before the notes leave the flow; the
+    // bibliography takes `:::bibliography`'s place or follows the text.
+    const parsedBody = headingMarksFor(parseMarkdownMemo(markdownBody), resolved);
+    const citationContext = content.citations
+        ?? (needsCitationContext(parsedBody, frontmatterMeta) ? bookCitationContexts([{ metadata: frontmatterMeta, blocks: parsedBody }])[0] : undefined);
+    const citationsApplied = citationContext
+        ? applyCitations(parsedBody, citationContext, processCitations(citationContext, resolved, citationLocale(resolved, resolvedLocale(resolved))), resolved, resolvedLocale(resolved))
+        : undefined;
+    const footnoteSplit = splitFootnoteDefinitions(citationsApplied?.blocks ?? parsedBody);
     const footnoteDefs = footnoteSplit.defs;
     // Numbered by page or column (`numbering: 'page'`), a note takes the
     // number the previous build gave it where it landed; the first build
@@ -293,8 +306,15 @@ function placeDocumentPass(content, config, cache, options, hints) {
     // first pass; `buildDocument` lays the document out again with them).
     // `:::index` expands into the entries of the book's index marks, from
     // the same outline.
+    // A reference naming an anchor (#262) reads its number, title and page
+    // from the same outline.
+    const resourceIds = new Set((content.resources ?? []).map((r) => r.id));
+    const anchorRefs = hasAnchorRefs(parsedBlocks, resourceIds);
     const outline = content.outline
-        ?? (hasTocDirective(parsedBlocks) || hasIndexDirective(parsedBlocks) ? computeOutline(parsedBlocks, resolved, headingStart) : undefined);
+        ?? (hasTocDirective(parsedBlocks) || hasIndexDirective(parsedBlocks) || anchorRefs ? computeOutline(parsedBlocks, resolved, headingStart) : undefined);
+    const anchorRefContext = anchorRefs
+        ? { targets: anchorTargetsOf(outline), strings: resolved.crossRefs }
+        : undefined;
     const indexExpanded = expandIndexDirectives(expandTocDirectives(parsedBlocks, outline, resolved), outline, resolved);
     const contentBlocks = indexExpanded.blocks;
     if (indexExpanded.warnings.length > 0)
@@ -332,7 +352,10 @@ function placeDocumentPass(content, config, cache, options, hints) {
     const orderedMetrics = computeOrderedListRunMetrics(contentBlocks, resolved, bodyStyle.fontSizePx);
     const orderedLevelIndentsPx = computeOrderedLevelIndentsPx(resolved, bodyStyle.fontSizePx, orderedMetrics.maxWidthByDepth);
     // `:::paragraphs{style="…"}` containers, resolved per content-block index.
-    const paragraphContainers = planParagraphContainers(contentBlocks, chapterEndNotes ? withFootnoteStyle(resolved) : resolved);
+    let containerStyles = chapterEndNotes ? withFootnoteStyle(resolved) : resolved;
+    if (citationsApplied?.bibliography)
+        containerStyles = withBibliographyStyle(containerStyles, citationsApplied.labelChars);
+    const paragraphContainers = planParagraphContainers(contentBlocks, containerStyles);
     // `:::callout` ranges keyed by their start marker index (same rationale).
     const calloutPlan = planCallouts(contentBlocks);
     // `:::part` ranges: start/end marker indices and the enclosed blocks.
@@ -1573,6 +1596,7 @@ function placeDocumentPass(content, config, cache, options, hints) {
         floatedIds,
         leftFlow: calloutsOutOfFlow,
         ...(footnoteNumbering.numbers.size > 0 ? { footnoteNumbers: footnoteNumbering.numbers } : {}),
+        ...(anchorRefContext ? { anchorRefs: anchorRefContext } : {}),
     };
     // --- Footnotes at the column foot (`footnotes.placement: 'column'`) ------
     // A text block placed in a column reserves, at the column's foot, the
@@ -1916,6 +1940,8 @@ function placeDocumentPass(content, config, cache, options, hints) {
         }
         if (raw.footnoteNote !== undefined)
             blk.footnoteNote = raw.footnoteNote;
+        if (raw.bibEntry !== undefined)
+            blk.bibEntry = raw.bibEntry;
         if (raw.toc?.kind === 'entry') {
             blk.tocEntry = raw.toc.pageIndex !== undefined ? { pageIndex: raw.toc.pageIndex } : {};
         }
@@ -5295,7 +5321,9 @@ export function* buildDocumentGen(content, config, cache, options) {
     // References and markup the source names wrongly: read from the source
     // once, located on the pages of the finished layout. Kept apart from
     // `doc.warnings`, whose entries keep their postext 1.4 shape.
-    const found = [...collectContentWarnings(content.markdown, config, content.resources ?? []), ...(indexWarnings.get(doc) ?? [])];
+    const bookAnchors = content.outline ? new Set(anchorOutline(content.outline).map((e) => e.anchorId)) : undefined;
+    const bookCitationKeys = content.citations ? new Set(content.citations.items.map((i) => i.id)) : undefined;
+    const found = [...collectContentWarnings(content.markdown, config, content.resources ?? [], bookAnchors, bookCitationKeys), ...(indexWarnings.get(doc) ?? [])];
     const located = found.length > 0 ? locateContentWarnings(doc, found) : [];
     // Justified CJK lines the composer could not fill within its tracking cap.
     const loose = cjkLooseLineWarnings(doc);
@@ -5317,12 +5345,17 @@ export function* buildDocumentGen(content, config, cache, options) {
 const indexWarnings = new WeakMap();
 /** `doc` with the page of each of its index marks (`doc.indexMarks`). */
 function withIndexMarks(doc, content) {
-    if (!content.markdown.includes(':index'))
-        return doc;
     const { content: body, contentOffset } = extractFrontmatter(content.markdown);
-    const marks = locateIndexMarks(doc, parseMarkdownMemo(body), contentOffset);
-    if (marks)
-        doc.indexMarks = marks;
+    const blocks = parseMarkdownMemo(body);
+    if (content.markdown.includes(':index')) {
+        const marks = locateIndexMarks(doc, blocks, contentOffset);
+        if (marks)
+            doc.indexMarks = marks;
+    }
+    // Where every anchor landed (#261), for links and page references.
+    const anchors = locateAnchors(doc, blocks, contentOffset);
+    if (anchors)
+        doc.anchors = anchors;
     return doc;
 }
 /** {@link buildDocumentGen} before the document-wide warnings: the
@@ -5335,7 +5368,14 @@ function* buildDocumentRounds(content, config, cache, options) {
     // it in one extra round.
     if (content.outline === undefined) {
         const parsed = parseMarkdownMemo(extractFrontmatter(content.markdown).content);
-        if (hasTocDirective(parsed) || hasIndexDirective(parsed)) {
+        // A reference printing an anchor's page (#263) settles the same way.
+        const pageRefs = () => {
+            if (!hasAnchorRefs(parsed, new Set((content.resources ?? []).map((r) => r.id))))
+                return false;
+            const resolved = resolveAllConfig(config);
+            return printsAnchorPages(parsed, anchorTargetsOf(computeOutline(parsed, resolved, content.continuation?.headings)), resolved.crossRefs.defaultStyle);
+        };
+        if (hasTocDirective(parsed) || hasIndexDirective(parsed) || pageRefs()) {
             let outline = computeOutline(parsed, resolveAllConfig(config), content.continuation?.headings);
             let doc = withIndexMarks(yield* buildDocumentNumbered({ ...content, outline }, config, cache, options, 0), content);
             for (let round = 0; round < MAX_TOC_ROUNDS; round++) {