@baiyibai-antora/extensions 1.18.5 → 1.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.adoc +19 -0
- package/dist/extensions/cite-it/assembly-numbering.d.ts +42 -25
- package/dist/extensions/cite-it/assembly-numbering.d.ts.map +1 -1
- package/dist/extensions/cite-it/assembly-numbering.js +44 -32
- package/dist/extensions/cite-it/assembly-numbering.js.map +1 -1
- package/dist/extensions/cite-it/csl.d.ts +36 -8
- package/dist/extensions/cite-it/csl.d.ts.map +1 -1
- package/dist/extensions/cite-it/csl.js +85 -18
- package/dist/extensions/cite-it/csl.js.map +1 -1
- package/dist/extensions/cite-it/index.d.ts +28 -8
- package/dist/extensions/cite-it/index.d.ts.map +1 -1
- package/dist/extensions/cite-it/index.js +206 -69
- package/dist/extensions/cite-it/index.js.map +1 -1
- package/dist/extensions/cite-it/macro.d.ts +11 -0
- package/dist/extensions/cite-it/macro.d.ts.map +1 -1
- package/dist/extensions/cite-it/macro.js +1 -0
- package/dist/extensions/cite-it/macro.js.map +1 -1
- package/package.json +1 -1
- package/resources/cite-it/author-date.csl +2273 -0
package/CHANGELOG.adoc
CHANGED
|
@@ -3,6 +3,25 @@
|
|
|
3
3
|
|
|
4
4
|
All notable changes to this project will be documented in this file.
|
|
5
5
|
|
|
6
|
+
== [1.19.0] - 2026-08-31
|
|
7
|
+
|
|
8
|
+
=== Added
|
|
9
|
+
|
|
10
|
+
* cite-it: a new `author-date` `style`, a real, complete, unmodified APA 7th edition CSL style (`resources/cite-it/author-date.csl`, fetched from the official `citation-style-language/styles` repository, same CC-BY-SA licensing convention `ieee-bracket.csl` already carries), alongside the existing `ieee-bracket` (numeric). `csl.ts` exposes `citationFormatFor(style)`, reading each bundled style's own real CSL `<category citation-format="...">` metadata rather than a hand-maintained parallel table.
|
|
11
|
+
* cite-it: the citation-format `style` selects now drives the inline `cite:[key]` marker's own shape in BOTH ordinary HTML and PDF/assembled output, not just the bibliography list. `ieee-bracket` (numeric, the default) means true first-appearance `[N]` markers, linked, on HTML too now, reusing the exact same real, navigation-order numbering PDF output has always used, not a fresh per-page count: a key cited from page to page carries one consistent number everywhere. `author-date` is new for PDF/assembled output: Ruby's `asciidoctor-pdf` subprocess never loads this package's live macro, so its markers, and the bibliography partial's own row label, get the same pre-rewrite-before-parse treatment numeric markers always needed.
|
|
12
|
+
* cite-it: the generated bibliography partial's row order now matches what each citation-format's reader actually needs to look an entry up: ascending citation-number order for `numeric` (unchanged), first-author-name alphabetical order for `author-date` (previously always sorted by internal citation key, an identifier a reader never sees).
|
|
13
|
+
|
|
14
|
+
=== Changed
|
|
15
|
+
|
|
16
|
+
* cite-it: `style` is now a playbook-wide setting only, applied identically to every participating component version's HTML, PDF, and Confluence/ADF output. It is no longer overridable per component version: a component version's own `ext.cite_it.style`, if still present, is ignored, with a build warning naming the ignored value. The inline citation marker and the bibliography entry it points at must share one citation-format convention for a reader to look an entry up at all (a numeric marker needs a numerically ordered list; an author-date marker needs an author-ordered one), a constraint that holds site-wide, not per component version.
|
|
17
|
+
* cite-it: with the playbook-wide default (`ieee-bracket`, unchanged), ordinary HTML output now renders `[N]` citation markers by default, matching PDF output, instead of the previous `(Author, Year)` fallback. This changes default rendered HTML output for every existing site using cite-it with no `style` configured; set `style: 'author-date'` to keep the previous look.
|
|
18
|
+
* cite-it: the generated bibliography partial's row-label rewrite for a `numeric`-style citation is no longer restored before the next ordinary (HTML, or Confluence/ADF export) `loadAsciiDoc` call reads it. `style` being playbook-wide means every consumer wants the identical rewritten partial now; the restore mechanism 1.18.4 added specifically because PDF and ordinary output used to want different content for the same partial no longer has a scenario to guard against.
|
|
19
|
+
* cite-it: `formatBibliographyEntries`'s underlying citeproc `Engine` is now constructed once per style and reused for every later call, instead of being rebuilt (recompiling the whole CSL style document) on every call. Confirmed to be the entire real cost of a `formatBibliographyEntries` call, independent of item count: ~76ms to construct for `ieee-bracket.csl`, ~1.3s for the real, complete `author-date.csl` (99 macros, 252 conditional branches against `ieee-bracket.csl`'s 15 and 36), profiled directly to `CSL.XmlJSON.getNodesByName`, citeproc-js's own unindexed full-tree-rescan on every macro-name lookup, not the actual formatting work (`updateItems`/`makeBibliography` alone are consistently single-digit milliseconds regardless of style). Reuse safety (no disambiguation-state leakage between two component-versions sharing one cached engine) verified directly, not assumed, and locked in with a test.
|
|
20
|
+
|
|
21
|
+
=== Fixed
|
|
22
|
+
|
|
23
|
+
* cite-it: `loadAsciiDocWrapper`'s own assembled-output detection checked only whether `asciidocConfig.attributes` carried the key `'loader-assembler'`, not its value, unlike `registerCiteMacro`'s equivalent, correct `doc.hasAttribute('loader-assembler')` check, which treats an attribute explicitly set to `false` as unset. A toolchain that declares `loader-assembler` as a default `asciidoc.attributes` entry, even set to `false`, satisfied the old check on every single page load, assembled or not, independent of whether Antora Assembler ever actually ran, reported directly with a reproduction.
|
|
24
|
+
|
|
6
25
|
== [1.18.5] - 2026-08-31
|
|
7
26
|
|
|
8
27
|
=== Fixed
|
|
@@ -182,8 +182,7 @@ export declare function reorderBibliographyRows(text: string, numbers: Map<strin
|
|
|
182
182
|
/**
|
|
183
183
|
* Rewrites the generated bibliography partial's OWN `cite:[key]` row
|
|
184
184
|
* labels to their final `[N]` numbers, mutating the file directly in the
|
|
185
|
-
* content catalog
|
|
186
|
-
* changed.
|
|
185
|
+
* content catalog.
|
|
187
186
|
*
|
|
188
187
|
* Needed for a reason distinct from rewriteCiteMarkers' normal call site:
|
|
189
188
|
* Antora's own include processor resolves an `include::partial$...[]`
|
|
@@ -194,31 +193,49 @@ export declare function reorderBibliographyRows(text: string, numbers: Map<strin
|
|
|
194
193
|
* rewrite text that arrives via an include inside that parse; a citing
|
|
195
194
|
* page's own `cite:[key]` usage rewrites correctly, but the generated
|
|
196
195
|
* partial's own row labels, pulled in during the same parse, would
|
|
197
|
-
* otherwise reach Ruby unrewritten
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
*
|
|
196
|
+
* otherwise reach Ruby unrewritten (for PDF) or reach registerCiteMacro's
|
|
197
|
+
* own live rendering, which has no reliable way to know the true,
|
|
198
|
+
* cross-page-computed number a per-document counter alone would not
|
|
199
|
+
* necessarily match. Called once per component-version, before any
|
|
200
|
+
* loadAsciiDoc call that needs `numbers` can run (synchronous, from
|
|
201
|
+
* ensureAssemblyDataComputed), so the partial is already correct by the
|
|
202
|
+
* time anything tries to include it.
|
|
201
203
|
*
|
|
202
|
-
* The mutation
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
204
|
+
* The mutation is never restored, deliberately, as of the `style`-is-
|
|
205
|
+
* playbook-wide-only redesign: `style` (and therefore, via
|
|
206
|
+
* citationFormatFor, whether numeric numbering applies at all) is now the
|
|
207
|
+
* SAME single value for every consumer of this partial, ordinary HTML,
|
|
208
|
+
* PDF/assembled, and Confluence/ADF export alike, so there is no longer a
|
|
209
|
+
* competing "the next reader wants something different" case to guard
|
|
210
|
+
* against. An EARLIER version of this function returned a restore
|
|
211
|
+
* function per changed partial, undone at the start of the next ordinary
|
|
212
|
+
* loadAsciiDoc call specifically because PDF assembly used to always want
|
|
213
|
+
* `[N]` while ordinary/Confluence output always wanted `(Author, Year)`
|
|
214
|
+
* for the exact same partial; confirmed live, without that restore, the
|
|
215
|
+
* demo site's own published Confluence page once showed the assembled
|
|
216
|
+
* `[1]` label instead. That divergence cannot happen anymore: whichever
|
|
217
|
+
* citation-format `style` resolves to, every consumer wants the identical
|
|
218
|
+
* rewritten (or, for a non-numeric style, entirely untouched, since this
|
|
219
|
+
* function is only ever called when numeric numbering applies) partial
|
|
220
|
+
* content.
|
|
215
221
|
*
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
*
|
|
222
|
+
* For the `numeric` citation-format only, also reorders the partial's rows
|
|
223
|
+
* into ascending citation-number order (reorderBibliographyRows) before
|
|
224
|
+
* rewriting labels: the order the partial was generated in has no
|
|
225
|
+
* relationship to citation number (Node does not know numbers yet at
|
|
226
|
+
* generation time), and a numbered bibliography listed out of number order
|
|
227
|
+
* reads as broken to anyone looking at it. A non-numeric citation-format
|
|
228
|
+
* needs no second reorder pass here: index.ts's own row-generation already
|
|
229
|
+
* sorts by author for that case, a real ordering known at generation time,
|
|
230
|
+
* unlike citation number.
|
|
231
|
+
*
|
|
232
|
+
* `labelFor` decouples this function from numeric numbering specifically:
|
|
233
|
+
* the caller supplies whichever label shape the active `style`'s citation-
|
|
234
|
+
* format implies (numberLabels for `numeric`, formatHtmlLabels-shaped
|
|
235
|
+
* author/year text for `author-date`), the same function it uses to
|
|
236
|
+
* rewrite the CITING page's own markers, so the row label and the marker
|
|
237
|
+
* pointing at it always agree.
|
|
221
238
|
*/
|
|
222
|
-
export declare function rewritePartialForAssembly(ctx: ScanContext, numbers: Map<string, number
|
|
239
|
+
export declare function rewritePartialForAssembly(ctx: ScanContext, numbers: Map<string, number>, reorderByNumber: boolean, labelFor: (key: string) => string | undefined): void;
|
|
223
240
|
export {};
|
|
224
241
|
//# sourceMappingURL=assembly-numbering.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assembly-numbering.d.ts","sourceRoot":"","sources":["../../../src/extensions/cite-it/assembly-numbering.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAcH,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,UAAU,cAAc;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAKlB,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;CACzC;AAED,UAAU,WAAW;IACnB,GAAG,EAAE,cAAc,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACxB;AAED,UAAU,cAAc;IACtB,QAAQ,EAAE,MAAM,WAAW,EAAE,CAAC;IAC9B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,EAAE,KAAK,WAAW,GAAG,SAAS,CAAC;IACrJ,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,WAAW,GAAG,SAAS,CAAC;CAC3G;AA4DD,MAAM,WAAW,WAAW;IAC1B,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;;;OASG;IACH,gBAAgB,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,GAAG,SAAS,EACzC,GAAG,EAAE,WAAW,GACf,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAsErB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,GAAG,SAAS,EACzC,GAAG,EAAE,WAAW,GACf,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAmBrB;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,EAC7C,MAAM,UAAO,EACb,MAAM,GAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAW,GACxC,MAAM,CAsCR;AAED;;;;;mDAKmD;AACnD,wBAAgB,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAK9F;AA0BD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CA2B1F;AAED
|
|
1
|
+
{"version":3,"file":"assembly-numbering.d.ts","sourceRoot":"","sources":["../../../src/extensions/cite-it/assembly-numbering.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAcH,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,UAAU,cAAc;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAKlB,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;CACzC;AAED,UAAU,WAAW;IACnB,GAAG,EAAE,cAAc,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACxB;AAED,UAAU,cAAc;IACtB,QAAQ,EAAE,MAAM,WAAW,EAAE,CAAC;IAC9B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,EAAE,KAAK,WAAW,GAAG,SAAS,CAAC;IACrJ,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,WAAW,GAAG,SAAS,CAAC;CAC3G;AA4DD,MAAM,WAAW,WAAW;IAC1B,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;;;OASG;IACH,gBAAgB,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,GAAG,SAAS,EACzC,GAAG,EAAE,WAAW,GACf,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAsErB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,GAAG,SAAS,EACzC,GAAG,EAAE,WAAW,GACf,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAmBrB;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,EAC7C,MAAM,UAAO,EACb,MAAM,GAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAW,GACxC,MAAM,CAsCR;AAED;;;;;mDAKmD;AACnD,wBAAgB,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAK9F;AA0BD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CA2B1F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,WAAW,EAChB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5B,eAAe,EAAE,OAAO,EACxB,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GAC5C,IAAI,CAiBN"}
|
|
@@ -365,8 +365,7 @@ function reorderBibliographyRows(text, numbers) {
|
|
|
365
365
|
/**
|
|
366
366
|
* Rewrites the generated bibliography partial's OWN `cite:[key]` row
|
|
367
367
|
* labels to their final `[N]` numbers, mutating the file directly in the
|
|
368
|
-
* content catalog
|
|
369
|
-
* changed.
|
|
368
|
+
* content catalog.
|
|
370
369
|
*
|
|
371
370
|
* Needed for a reason distinct from rewriteCiteMarkers' normal call site:
|
|
372
371
|
* Antora's own include processor resolves an `include::partial$...[]`
|
|
@@ -377,35 +376,50 @@ function reorderBibliographyRows(text, numbers) {
|
|
|
377
376
|
* rewrite text that arrives via an include inside that parse; a citing
|
|
378
377
|
* page's own `cite:[key]` usage rewrites correctly, but the generated
|
|
379
378
|
* partial's own row labels, pulled in during the same parse, would
|
|
380
|
-
* otherwise reach Ruby unrewritten
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
379
|
+
* otherwise reach Ruby unrewritten (for PDF) or reach registerCiteMacro's
|
|
380
|
+
* own live rendering, which has no reliable way to know the true,
|
|
381
|
+
* cross-page-computed number a per-document counter alone would not
|
|
382
|
+
* necessarily match. Called once per component-version, before any
|
|
383
|
+
* loadAsciiDoc call that needs `numbers` can run (synchronous, from
|
|
384
|
+
* ensureAssemblyDataComputed), so the partial is already correct by the
|
|
385
|
+
* time anything tries to include it.
|
|
384
386
|
*
|
|
385
|
-
* The mutation
|
|
386
|
-
*
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
387
|
+
* The mutation is never restored, deliberately, as of the `style`-is-
|
|
388
|
+
* playbook-wide-only redesign: `style` (and therefore, via
|
|
389
|
+
* citationFormatFor, whether numeric numbering applies at all) is now the
|
|
390
|
+
* SAME single value for every consumer of this partial, ordinary HTML,
|
|
391
|
+
* PDF/assembled, and Confluence/ADF export alike, so there is no longer a
|
|
392
|
+
* competing "the next reader wants something different" case to guard
|
|
393
|
+
* against. An EARLIER version of this function returned a restore
|
|
394
|
+
* function per changed partial, undone at the start of the next ordinary
|
|
395
|
+
* loadAsciiDoc call specifically because PDF assembly used to always want
|
|
396
|
+
* `[N]` while ordinary/Confluence output always wanted `(Author, Year)`
|
|
397
|
+
* for the exact same partial; confirmed live, without that restore, the
|
|
398
|
+
* demo site's own published Confluence page once showed the assembled
|
|
399
|
+
* `[1]` label instead. That divergence cannot happen anymore: whichever
|
|
400
|
+
* citation-format `style` resolves to, every consumer wants the identical
|
|
401
|
+
* rewritten (or, for a non-numeric style, entirely untouched, since this
|
|
402
|
+
* function is only ever called when numeric numbering applies) partial
|
|
403
|
+
* content.
|
|
398
404
|
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
405
|
+
* For the `numeric` citation-format only, also reorders the partial's rows
|
|
406
|
+
* into ascending citation-number order (reorderBibliographyRows) before
|
|
407
|
+
* rewriting labels: the order the partial was generated in has no
|
|
408
|
+
* relationship to citation number (Node does not know numbers yet at
|
|
409
|
+
* generation time), and a numbered bibliography listed out of number order
|
|
410
|
+
* reads as broken to anyone looking at it. A non-numeric citation-format
|
|
411
|
+
* needs no second reorder pass here: index.ts's own row-generation already
|
|
412
|
+
* sorts by author for that case, a real ordering known at generation time,
|
|
413
|
+
* unlike citation number.
|
|
414
|
+
*
|
|
415
|
+
* `labelFor` decouples this function from numeric numbering specifically:
|
|
416
|
+
* the caller supplies whichever label shape the active `style`'s citation-
|
|
417
|
+
* format implies (numberLabels for `numeric`, formatHtmlLabels-shaped
|
|
418
|
+
* author/year text for `author-date`), the same function it uses to
|
|
419
|
+
* rewrite the CITING page's own markers, so the row label and the marker
|
|
420
|
+
* pointing at it always agree.
|
|
404
421
|
*/
|
|
405
|
-
function rewritePartialForAssembly(ctx, numbers) {
|
|
406
|
-
const restores = [];
|
|
407
|
-
if (numbers.size === 0)
|
|
408
|
-
return restores;
|
|
422
|
+
function rewritePartialForAssembly(ctx, numbers, reorderByNumber, labelFor) {
|
|
409
423
|
for (const cp of ctx.categoryPartials) {
|
|
410
424
|
const partial = ctx.contentCatalog.getFiles().find((f) => f.src.component === ctx.component &&
|
|
411
425
|
f.src.version === ctx.version &&
|
|
@@ -415,13 +429,11 @@ function rewritePartialForAssembly(ctx, numbers) {
|
|
|
415
429
|
if (!partial)
|
|
416
430
|
continue;
|
|
417
431
|
const before = partial.contents.toString('utf8');
|
|
418
|
-
const reordered = reorderBibliographyRows(before, numbers);
|
|
419
|
-
const after = rewriteCiteMarkers(reordered,
|
|
432
|
+
const reordered = reorderByNumber ? reorderBibliographyRows(before, numbers) : before;
|
|
433
|
+
const after = rewriteCiteMarkers(reordered, labelFor, false);
|
|
420
434
|
if (after === before)
|
|
421
435
|
continue;
|
|
422
436
|
partial.contents = Buffer.from(after, 'utf8');
|
|
423
|
-
restores.push(() => { partial.contents = Buffer.from(before, 'utf8'); });
|
|
424
437
|
}
|
|
425
|
-
return restores;
|
|
426
438
|
}
|
|
427
439
|
//# sourceMappingURL=assembly-numbering.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assembly-numbering.js","sourceRoot":"","sources":["../../../src/extensions/cite-it/assembly-numbering.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;;AAsIH,wDAyEC;AAiBD,wDAsBC;AA0ED,gDA2CC;AAQD,oCAKC;AA0BD,0DA2BC;
|
|
1
|
+
{"version":3,"file":"assembly-numbering.js","sourceRoot":"","sources":["../../../src/extensions/cite-it/assembly-numbering.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;;AAsIH,wDAyEC;AAiBD,wDAsBC;AA0ED,gDA2CC;AAQD,oCAKC;AA0BD,0DA2BC;AA2DD,8DAsBC;AA5fD,mCAA8C;AAC9C,iDAA4E;AAC5E,6CAAoD;AACpD,2EAAuE;AACvE,uEAAgE;AA+ChE,8EAA8E;AAC9E,yEAAyE;AACzE,wEAAwE;AACxE,sEAAsE;AACtE,2EAA2E;AAC3E,yEAAyE;AACzE,2EAA2E;AAC3E,2EAA2E;AAC3E,oBAAoB;AACpB,8EAA8E;AAE9E,SAAS,0BAA0B,CAAC,OAAsC,EAAE,IAAiB,EAAE,GAAa;IAC1G,KAAK,MAAM,KAAK,IAAI,OAAO,IAAI,EAAE,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,OAAO,KAAK,UAAU,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;YACnE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;YACvG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACxB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,0BAA0B,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,sBAAsB,CAC7B,UAAyC,EACzC,KAAoB;IAEpB,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,0BAA0B,CAAC,UAAU,EAAE,IAAI,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC;IAE7D,MAAM,UAAU,GAAG,IAAI,GAAG,EAAuB,CAAC;IAClD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG;YAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,IAAI;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAyBD;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,UAAyC,EACzC,GAAgB;IAEhB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,MAAM,KAAK,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,MAAM,CAChD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,CAC1E,CAAC;IACF,MAAM,KAAK,GAAG,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACxD,uEAAuE;IACvE,wEAAwE;IACxE,mEAAmE;IACnE,oEAAoE;IACpE,sEAAsE;IACtE,sEAAsE;IACtE,sEAAsE;IACtE,uEAAuE;IACvE,qEAAqE;IACrE,uEAAuE;IACvE,iEAAiE;IACjE,kEAAkE;IAClE,wEAAwE;IACxE,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,cAAc,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC7H,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,kEAAkE;QAClE,oEAAoE;QACpE,yEAAyE;QACzE,iEAAiE;QACjE,sEAAsE;QACtE,uEAAuE;QACvE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QACrD,MAAM,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,IAAA,4CAAoB,EAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,CAAC,IAAY,EAAW,EAAE;YAC1C,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,OAAO,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;YACjE,MAAM,CAAC,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;QACtD,CAAC,CAAC;QAEF,IAAI,IAAI,GAAG,IAAA,uBAAe,EAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAA,0BAAkB,EAC9B,IAAI,EACJ,GAAG,CAAC,cAAqE,EACzE,GAAG,CAAC,SAAS,EACb,GAAG,CAAC,OAAO,EACX,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,MAAM,EACzB,cAAc,EACd,EAAE,EACF,SAAS,EACT,EAAE,EACF,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CACpB,CAAC;QACF,IAAI,KAAK;YAAE,IAAI,GAAG,GAAG,IAAI,KAAK,IAAA,uBAAe,EAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC;QAEtE,oEAAoE;QACpE,+DAA+D;QAC/D,sEAAsE;QACtE,oEAAoE;QACpE,sEAAsE;QACtE,sEAAsE;QACtE,oEAAoE;QACpE,uEAAuE;QACvE,MAAM,WAAW,GAAG,IAAA,2BAAmB,EAAC,IAAA,qCAAe,EAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,sBAAsB,CACpC,UAAyC,EACzC,GAAgB;IAEhB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,MAAM,KAAK,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,MAAM,CAChD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,CAC1E,CAAC;IACF,MAAM,KAAK,GAAG,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAExF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC;YAAE,MAAM;QAChC,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClE,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC;YAClD,IAAI,IAAA,uBAAe,EAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;gBACzE,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,8EAA8E;AAC9E,sEAAsE;AACtE,0EAA0E;AAC1E,2EAA2E;AAC3E,sEAAsE;AACtE,mEAAmE;AACnE,iEAAiE;AACjE,wEAAwE;AACxE,0EAA0E;AAC1E,0EAA0E;AAC1E,0EAA0E;AAC1E,+CAA+C;AAC/C,8EAA8E;AAC9E,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,SAAgB,kBAAkB,CAChC,IAAY,EACZ,QAA6C,EAC7C,MAAM,GAAG,IAAI,EACb,SAAqC,IAAI;IAEzC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,cAAc,GAAG,KAAK,CAAC;IAE3B,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACjC,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/B,cAAc,GAAG,CAAC,cAAc,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,cAAc,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QAE5D,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YACzD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC3E,+DAA+D;YAC/D,8DAA8D;YAC9D,kEAAkE;YAClE,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;YACzF,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YAC1B,MAAM,KAAK,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/B,4DAA4D;YAC5D,gEAAgE;YAChE,0DAA0D;YAC1D,iEAAiE;YACjE,8DAA8D;YAC9D,gEAAgE;YAChE,0DAA0D;YAC1D,gEAAgE;YAChE,+DAA+D;YAC/D,iCAAiC;YACjC,OAAO,KAAK,CAAC,CAAC,CAAC,QAAQ,KAAK,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;QACzF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED;;;;;mDAKmD;AACnD,SAAgB,YAAY,CAAC,OAA4B;IACvD,OAAO,CAAC,GAAG,EAAE,EAAE;QACb,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7B,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC;IACpD,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,SAAS,GAAG,2BAA2B,CAAC;AAE9C,SAAgB,uBAAuB,CAAC,IAAY,EAAE,OAA4B;IAChF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,IAAI,KAAK,GAAgD,IAAI,CAAC;IAE9D,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,KAAK;aACF,KAAK,EAAE;aACP,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC;aACnF,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACxC,KAAK,GAAG,IAAI,CAAC;IACf,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChC,IAAI,CAAC,EAAE,CAAC;YACN,KAAK,KAAL,KAAK,GAAK,EAAE,EAAC;YACb,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YAChC,SAAS;QACX,CAAC;QACD,KAAK,EAAE,CAAC;QACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,KAAK,EAAE,CAAC;IAER,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,SAAgB,yBAAyB,CACvC,GAAgB,EAChB,OAA4B,EAC5B,eAAwB,EACxB,QAA6C;IAE7C,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,CAChD,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS;YACjC,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO;YAC7B,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS;YAC1B,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM;YAC3B,CAAC,CAAC,GAAG,CAAC,QAAQ,KAAK,EAAE,CAAC,QAAQ,CACjC,CAAC;QACF,IAAI,CAAC,OAAO;YAAE,SAAS;QACvB,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,eAAe,CAAC,CAAC,CAAC,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACtF,MAAM,KAAK,GAAG,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,MAAM;YAAE,SAAS;QAC/B,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;AACH,CAAC"}
|
|
@@ -13,16 +13,44 @@
|
|
|
13
13
|
* partial's row label (macro.ts), so the two numbering sources agree by
|
|
14
14
|
* construction rather than by cross-checking two independent counters.
|
|
15
15
|
*
|
|
16
|
-
* `STYLES`
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
16
|
+
* `STYLES` bundles two real, unmodified, standard CSL styles fetched from
|
|
17
|
+
* the official citation-style-language/styles repository, the same CC-BY-SA
|
|
18
|
+
* licensing convention both files carry in their own `<info><rights>`:
|
|
19
|
+
* `ieee-bracket` (numeric) and `author-date` (a real, complete APA 7th
|
|
20
|
+
* edition style, not a hand-authored approximation of "an author-date
|
|
21
|
+
* style" - CSL's own `author-date` category covers several genuinely
|
|
22
|
+
* different concrete conventions, APA chosen as the most broadly
|
|
23
|
+
* recognized one). Adding a style is a matter of shipping its `.csl` file
|
|
24
|
+
* under `resources/cite-it/` and one new `STYLES` entry (`citationFormat`
|
|
25
|
+
* included, see `CitationFormat`/`citationFormatFor` below), not a design
|
|
26
|
+
* change. A `style` value not present in `STYLES` is rejected with a clear
|
|
27
|
+
* error rather than silently falling back, since a silently wrong citation
|
|
28
|
+
* style is a worse failure than a build error naming the actual gap.
|
|
24
29
|
*/
|
|
25
30
|
import type { CslJsonItem } from './registry';
|
|
31
|
+
/**
|
|
32
|
+
* `citationFormat` mirrors each style's own real CSL `<category
|
|
33
|
+
* citation-format="...">` metadata (confirmed directly in both bundled
|
|
34
|
+
* files: `ieee-bracket.csl` declares `numeric`, `author-date.csl` declares
|
|
35
|
+
* `author-date`), declared here rather than parsed from the XML at load
|
|
36
|
+
* time: the value drives real branching elsewhere in cite-it (which inline
|
|
37
|
+
* marker shape a style produces, how the generated bibliography partial's
|
|
38
|
+
* own rows are ordered), so it needs to be known synchronously, cheaply,
|
|
39
|
+
* and without adding an XML-attribute-extraction dependency for one field.
|
|
40
|
+
* A style bundled here always keeps its own XML `<category>` tag in sync,
|
|
41
|
+
* the normal CSL-authoring convention, but that tag itself is descriptive
|
|
42
|
+
* metadata only; this declaration is what code actually reads.
|
|
43
|
+
*/
|
|
44
|
+
export type CitationFormat = 'numeric' | 'author-date';
|
|
45
|
+
/**
|
|
46
|
+
* The citation-format a `style` config value resolves to, for callers that
|
|
47
|
+
* need to know which inline-marker/bibliography-ordering rules to apply
|
|
48
|
+
* without loading the full citeproc Engine. Throws the same clear,
|
|
49
|
+
* unsupported-style error `loadEngine` does, rather than defaulting
|
|
50
|
+
* silently: an unrecognized style name is a real misconfiguration either
|
|
51
|
+
* way, whichever entry point first notices it.
|
|
52
|
+
*/
|
|
53
|
+
export declare function citationFormatFor(styleName: string): CitationFormat;
|
|
26
54
|
/**
|
|
27
55
|
* Convert one citeproc bibliography entry's raw HTML fragment into AsciiDoc
|
|
28
56
|
* inline text. citeproc's output shape is two sibling <div>s per entry:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"csl.d.ts","sourceRoot":"","sources":["../../../src/extensions/cite-it/csl.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"csl.d.ts","sourceRoot":"","sources":["../../../src/extensions/cite-it/csl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAMH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAK9C;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,aAAa,CAAC;AAOvD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc,CAQnE;AAqFD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAY7D;AA4GD,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAC/B,IAAI,EAAE,MAAM,EAAE,EACd,eAAe,UAAQ,EACvB,kBAAkB,UAAQ,EAC1B,UAAU,SAAK,GACd,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CA2CrB"}
|
|
@@ -14,14 +14,19 @@
|
|
|
14
14
|
* partial's row label (macro.ts), so the two numbering sources agree by
|
|
15
15
|
* construction rather than by cross-checking two independent counters.
|
|
16
16
|
*
|
|
17
|
-
* `STYLES`
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
17
|
+
* `STYLES` bundles two real, unmodified, standard CSL styles fetched from
|
|
18
|
+
* the official citation-style-language/styles repository, the same CC-BY-SA
|
|
19
|
+
* licensing convention both files carry in their own `<info><rights>`:
|
|
20
|
+
* `ieee-bracket` (numeric) and `author-date` (a real, complete APA 7th
|
|
21
|
+
* edition style, not a hand-authored approximation of "an author-date
|
|
22
|
+
* style" - CSL's own `author-date` category covers several genuinely
|
|
23
|
+
* different concrete conventions, APA chosen as the most broadly
|
|
24
|
+
* recognized one). Adding a style is a matter of shipping its `.csl` file
|
|
25
|
+
* under `resources/cite-it/` and one new `STYLES` entry (`citationFormat`
|
|
26
|
+
* included, see `CitationFormat`/`citationFormatFor` below), not a design
|
|
27
|
+
* change. A `style` value not present in `STYLES` is rejected with a clear
|
|
28
|
+
* error rather than silently falling back, since a silently wrong citation
|
|
29
|
+
* style is a worse failure than a build error naming the actual gap.
|
|
25
30
|
*/
|
|
26
31
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
27
32
|
if (k2 === undefined) k2 = k;
|
|
@@ -57,6 +62,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
57
62
|
};
|
|
58
63
|
})();
|
|
59
64
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
65
|
+
exports.citationFormatFor = citationFormatFor;
|
|
60
66
|
exports.htmlEntryToAsciiDoc = htmlEntryToAsciiDoc;
|
|
61
67
|
exports.formatBibliographyEntries = formatBibliographyEntries;
|
|
62
68
|
const fs = __importStar(require("node:fs"));
|
|
@@ -66,27 +72,87 @@ const date_fns_1 = require("date-fns");
|
|
|
66
72
|
const asciidoc_replacements_1 = require("../../lib/asciidoc-replacements");
|
|
67
73
|
const RESOURCES_DIR = path.join(__dirname, '..', '..', '..', 'resources', 'cite-it');
|
|
68
74
|
const STYLES = {
|
|
69
|
-
'ieee-bracket': { style: 'ieee-bracket.csl', locale: 'locale-en-US.xml' },
|
|
75
|
+
'ieee-bracket': { style: 'ieee-bracket.csl', locale: 'locale-en-US.xml', citationFormat: 'numeric' },
|
|
76
|
+
'author-date': { style: 'author-date.csl', locale: 'locale-en-US.xml', citationFormat: 'author-date' },
|
|
70
77
|
};
|
|
78
|
+
/**
|
|
79
|
+
* The citation-format a `style` config value resolves to, for callers that
|
|
80
|
+
* need to know which inline-marker/bibliography-ordering rules to apply
|
|
81
|
+
* without loading the full citeproc Engine. Throws the same clear,
|
|
82
|
+
* unsupported-style error `loadEngine` does, rather than defaulting
|
|
83
|
+
* silently: an unrecognized style name is a real misconfiguration either
|
|
84
|
+
* way, whichever entry point first notices it.
|
|
85
|
+
*/
|
|
86
|
+
function citationFormatFor(styleName) {
|
|
87
|
+
const spec = STYLES[styleName];
|
|
88
|
+
if (!spec) {
|
|
89
|
+
throw new Error(`cite-it: unknown style "${styleName}"; supported styles: ${Object.keys(STYLES).join(', ')}`);
|
|
90
|
+
}
|
|
91
|
+
return spec.citationFormat;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* One real `Engine` per style, constructed once and reused for every
|
|
95
|
+
* subsequent `formatBibliographyEntries` call in the same process,
|
|
96
|
+
* regardless of which component-version or item set is being formatted.
|
|
97
|
+
* `new Engine(sys, styleXml)` is where citeproc-js actually compiles the
|
|
98
|
+
* CSL style document into its own internal execution form, confirmed
|
|
99
|
+
* directly to be the entire real cost (timed independently of
|
|
100
|
+
* `updateItems`/`makeBibliography`, both consistently single-digit
|
|
101
|
+
* milliseconds regardless of style): ~76ms for `ieee-bracket.csl` (18KB),
|
|
102
|
+
* ~1.3s for the real, complete `author-date.csl` (86KB, over 100 macros).
|
|
103
|
+
* Reconstructing that from scratch per call, once per participating
|
|
104
|
+
* component-version, was real, avoidable per-build cost.
|
|
105
|
+
*
|
|
106
|
+
* Reuse is safe, not just fast, confirmed directly against citeproc-js's
|
|
107
|
+
* own real behavior, not assumed from its documentation: `engine.
|
|
108
|
+
* updateItems(keys)` fully replaces the engine's active item set on every
|
|
109
|
+
* call, including its disambiguation/registry state, byte-for-byte
|
|
110
|
+
* identical output to a fresh `Engine` given the same keys, verified by
|
|
111
|
+
* alternating between two different, independently colliding item sets on
|
|
112
|
+
* one shared engine and diffing against two separate fresh engines (no
|
|
113
|
+
* leakage of one component-version's disambiguation suffixes into
|
|
114
|
+
* another's, in either order). `itemsRef` exists only so each cached
|
|
115
|
+
* engine's own `retrieveItem` closure can be redirected to the CURRENT
|
|
116
|
+
* caller's items map on every call, since the closure itself is fixed at
|
|
117
|
+
* construction time but the underlying data is not.
|
|
118
|
+
*/
|
|
119
|
+
const engineCache = new Map();
|
|
71
120
|
function loadEngine(styleName, items) {
|
|
72
121
|
const spec = STYLES[styleName];
|
|
73
122
|
if (!spec) {
|
|
74
123
|
throw new Error(`cite-it: unknown style "${styleName}"; supported styles: ${Object.keys(STYLES).join(', ')}`);
|
|
75
124
|
}
|
|
125
|
+
const cached = engineCache.get(styleName);
|
|
126
|
+
if (cached) {
|
|
127
|
+
cached.itemsRef.current = items;
|
|
128
|
+
return cached.engine;
|
|
129
|
+
}
|
|
76
130
|
const styleXml = fs.readFileSync(path.join(RESOURCES_DIR, spec.style), 'utf8');
|
|
77
131
|
const localeXml = fs.readFileSync(path.join(RESOURCES_DIR, spec.locale), 'utf8');
|
|
132
|
+
const itemsRef = { current: items };
|
|
78
133
|
const sys = {
|
|
79
134
|
retrieveLocale: () => localeXml,
|
|
80
|
-
retrieveItem: (id) =>
|
|
135
|
+
retrieveItem: (id) => itemsRef.current.get(id),
|
|
81
136
|
};
|
|
82
|
-
|
|
137
|
+
const engine = new citeproc_1.Engine(sys, styleXml);
|
|
138
|
+
engineCache.set(styleName, { engine, itemsRef });
|
|
139
|
+
return engine;
|
|
83
140
|
}
|
|
84
141
|
/**
|
|
85
|
-
* Decode the
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
142
|
+
* Decode the HTML entities citeproc's own output uses. citeproc escapes
|
|
143
|
+
* text it renders (author names, titles) as HTML, since its native output
|
|
144
|
+
* target is a browser DOM; the generated partial is AsciiDoc, not HTML, so
|
|
145
|
+
* entities are decoded back to literal characters rather than left for
|
|
146
|
+
* AsciiDoc to interpret as markup.
|
|
147
|
+
*
|
|
148
|
+
* The small named-entity list was sufficient for `ieee-bracket.csl` alone
|
|
149
|
+
* (`and="text"` between co-authors, never a literal "&"), but a style using
|
|
150
|
+
* `and="symbol"` renders "&" as the NUMERIC entity `&`, not `&`
|
|
151
|
+
* (confirmed directly loading a real APA-style bibliography entry through
|
|
152
|
+
* citeproc: "Smith, J. A., & Nakamura, K."). Decimal and hex numeric
|
|
153
|
+
* character references are decoded generically, not just the one citeproc
|
|
154
|
+
* happens to emit today, so a future style choosing a different one still
|
|
155
|
+
* works without another silent gap.
|
|
90
156
|
*/
|
|
91
157
|
function decodeEntities(s) {
|
|
92
158
|
return s
|
|
@@ -94,8 +160,9 @@ function decodeEntities(s) {
|
|
|
94
160
|
.replace(/</g, '<')
|
|
95
161
|
.replace(/>/g, '>')
|
|
96
162
|
.replace(/"/g, '"')
|
|
97
|
-
.replace(
|
|
98
|
-
.replace(
|
|
163
|
+
.replace(/ /g, ' ')
|
|
164
|
+
.replace(/&#(\d+);/g, (_, dec) => String.fromCodePoint(Number(dec)))
|
|
165
|
+
.replace(/&#x([0-9a-fA-F]+);/g, (_, hex) => String.fromCodePoint(Number.parseInt(hex, 16)));
|
|
99
166
|
}
|
|
100
167
|
/**
|
|
101
168
|
* Convert one citeproc bibliography entry's raw HTML fragment into AsciiDoc
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"csl.js","sourceRoot":"","sources":["../../../src/extensions/cite-it/csl.ts"],"names":[],"mappings":";AAAA
|
|
1
|
+
{"version":3,"file":"csl.js","sourceRoot":"","sources":["../../../src/extensions/cite-it/csl.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCH,8CAQC;AAmHD,kDAYC;AA4GD,8DAkDC;AA1UD,4CAA8B;AAC9B,gDAAkC;AAClC,uCAAkC;AAClC,uCAAgD;AAEhD,2EAA6E;AAE7E,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;AAiBrF,MAAM,MAAM,GAAsF;IAChG,cAAc,EAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,SAAS,EAAE;IACpG,aAAa,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,aAAa,EAAE;CACvG,CAAC;AAEF;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,SAAiB;IACjD,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,2BAA2B,SAAS,wBAAwB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7F,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,cAAc,CAAC;AAC7B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,GAAG,IAAI,GAAG,EAA+E,CAAC;AAE3G,SAAS,UAAU,CAAC,SAAiB,EAAE,KAA+B;IACpE,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,2BAA2B,SAAS,wBAAwB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC1C,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC;QAChC,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAC/E,MAAM,SAAS,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IAEjF,MAAM,QAAQ,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IACpC,MAAM,GAAG,GAAG;QACV,cAAc,EAAE,GAAG,EAAE,CAAC,SAAS;QAC/B,YAAY,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAA4B;KAClF,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,iBAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACzC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAS,cAAc,CAAC,CAAS;IAC/B,OAAO,CAAC;SACL,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;SACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SAC3E,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,mBAAmB,CAAC,SAAiB;IACnD,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACxF,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAErD,MAAM,kBAAkB,GAAG,KAAK;SAC7B,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC;SACtC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC;SACtC,OAAO,CAAC,yBAAyB,EAAE,MAAM,CAAC;SAC1C,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAE3B,MAAM,KAAK,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7E,OAAO,IAAA,kDAA0B,EAAC,KAAK,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAAC,IAAY;IAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH;;;oBAGoB;AACpB,SAAS,eAAe,CAAC,CAAS;IAChC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,gBAAgB,CAAC,IAAiB,EAAE,UAAkB;IAC7D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACvD,MAAM,SAAS,GAAI,MAAkC,CAAC,YAAY,CAAC,CAAC;IACpE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC3E,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,CAA8B,CAAC;IACrE,IAAI,IAAI,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAE9B,sEAAsE;IACtE,iEAAiE;IACjE,kEAAkE;IAClE,uEAAuE;IACvE,2EAA2E;IAC3E,uEAAuE;IACvE,qEAAqE;IACrE,kEAAkE;IAClE,sDAAsD;IACtD,MAAM,OAAO,GAAG,UAAU,KAAK,SAAS;QACtC,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;QACnE,CAAC,CAAC,UAAU,CAAC;IACf,OAAO,IAAA,iBAAU,EAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,eAAe,CAAC,KAA+B,EAAE,IAAc,EAAE,UAAkB;IAC1F,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IAClC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI;YAAE,SAAS;QACjC,oEAAoE;QACpE,+DAA+D;QAC/D,mEAAmE;QACnE,oEAAoE;QACpE,yBAAyB;QACzB,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAgB,yBAAyB,CACvC,SAAiB,EACjB,KAA+B,EAC/B,IAAc,EACd,eAAe,GAAG,KAAK,EACvB,kBAAkB,GAAG,KAAK,EAC1B,UAAU,GAAG,EAAE;IAEf,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IAErC,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACpG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACzB,MAAM,CAAC,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAEpD,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;QACtB,MAAM,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO;QAC/B,IAAI,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,kBAAkB;YAAE,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC;QAEjE,uEAAuE;QACvE,qEAAqE;QACrE,mEAAmE;QACnE,iEAAiE;QACjE,oEAAoE;QACpE,oEAAoE;QACpE,qEAAqE;QACrE,oEAAoE;QACpE,kEAAkE;QAClE,oEAAoE;QACpE,iBAAiB;QACjB,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;YAC1C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,EAAE,CAAC;gBACzC,mEAAmE;gBACnE,kEAAkE;gBAClE,mEAAmE;gBACnE,aAAa;gBACb,MAAM,OAAO,GAAG,IAAA,kDAA0B,EAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;gBACpE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;oBACvD,IAAI,GAAG,GAAG,IAAI,IAAI,OAAO,GAAG,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -2,11 +2,23 @@
|
|
|
2
2
|
* @baiyibai-antora/extensions - cite-it
|
|
3
3
|
*
|
|
4
4
|
* Resolves `cite:[key]` citations against BibTeX/BibLaTeX `.bib` files and
|
|
5
|
-
* generates a categorized bibliography partial.
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
5
|
+
* generates a categorized bibliography partial. The playbook-wide `style`
|
|
6
|
+
* (below) picks one of two citation-formats, applied identically across
|
|
7
|
+
* ordinary HTML, PDF/Antora Assembler-flattened output, and Confluence/ADF
|
|
8
|
+
* export: `ieee-bracket` (numeric, the default) renders a true
|
|
9
|
+
* first-appearance `[N]` marker, linked to the bibliography row it
|
|
10
|
+
* numbers, everywhere citation numbering historically was a PDF-only
|
|
11
|
+
* concept, since Ruby's own `asciidoctor-pdf` subprocess never loads this
|
|
12
|
+
* package's live macro (see assembly-numbering.ts's own module docblock),
|
|
13
|
+
* so every marker, in every mode, needs the same pre-rewrite-before-parse
|
|
14
|
+
* treatment; `author-date` renders a templated author/year fragment
|
|
15
|
+
* instead (`renderHtmlFallback`, macro.ts), matching how ordinary HTML
|
|
16
|
+
* rendered by default before this design existed. The inline marker and
|
|
17
|
+
* the bibliography entry it points at always share the SAME
|
|
18
|
+
* citation-format: a reader has no way to look an entry up otherwise (a
|
|
19
|
+
* numeric marker needs a numerically ordered list; an author-date marker
|
|
20
|
+
* needs an author-ordered one), which is also why `style` is playbook-wide
|
|
21
|
+
* only, not overridable per component-version.
|
|
10
22
|
*
|
|
11
23
|
* A category is defined entirely by which `.bib` file(s) an entry lives in,
|
|
12
24
|
* never by a data field inside the entry. Each category is an ordered list
|
|
@@ -29,10 +41,16 @@
|
|
|
29
41
|
* component-version at least one category, it is scanned and gets its
|
|
30
42
|
* generated partial(s), whether or not its own antora.yml mentions
|
|
31
43
|
* cite-it at all. `ext.cite_it` in a component-version's antora.yml is
|
|
32
|
-
* purely an OPTIONAL override, the same standing as `enabled`,
|
|
44
|
+
* purely an OPTIONAL override, the same standing as `enabled`,
|
|
33
45
|
* `output_partial`, and `write_to_disk`: present only when a component
|
|
34
46
|
* needs to diverge from the playbook default, never required just to
|
|
35
|
-
* take part.
|
|
47
|
+
* take part. `style` is the one exception: playbook-wide only, never a
|
|
48
|
+
* per-component-version override (a component-version still setting
|
|
49
|
+
* `ext.cite_it.style` warns once, naming the ignored value, rather than
|
|
50
|
+
* silently doing nothing). See the module docblock above for why: the
|
|
51
|
+
* inline marker and the bibliography entry it points at must share one
|
|
52
|
+
* citation-format convention for a reader to look an entry up at all, a
|
|
53
|
+
* constraint that does not hold per-component-version, only site-wide.
|
|
36
54
|
*
|
|
37
55
|
* EARLIER DESIGN, REPLACED: this extension originally required an
|
|
38
56
|
* explicit `ext.cite_it` block, even an empty one, mirroring
|
|
@@ -73,7 +91,9 @@
|
|
|
73
91
|
* - require: '@baiyibai-antora/extensions/cite-it'
|
|
74
92
|
* cite_it:
|
|
75
93
|
* enabled: true
|
|
76
|
-
* #
|
|
94
|
+
* # Playbook-wide only, applied identically to every participating
|
|
95
|
+
* # component-version's HTML, PDF, and Confluence/ADF output alike:
|
|
96
|
+
* # 'ieee-bracket' (numeric, the default) or 'author-date'.
|
|
77
97
|
* style: 'ieee-bracket'
|
|
78
98
|
* # Base filename for each category's own generated partial
|
|
79
99
|
* # (e.g. category "standards" -> generated-bibliography-
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/cite-it/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/cite-it/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqMG;AAwCH,UAAU,iBAAiB;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAaD,UAAU,YAAY;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,OAAO,CAAC;IAQvB,gBAAgB,EAAE,OAAO,CAAC;IAS1B,mBAAmB,EAAE,OAAO,CAAC;IAY7B,WAAW,EAAE,MAAM,CAAC;IAQpB,UAAU,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED,UAAU,YAAY;IACpB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9B,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/B;AASD,UAAU,cAAc;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CAChC;AAED,UAAU,QAAQ;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;KAC/B,CAAC;CACH;AAED,UAAU,iBAAiB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,UAAU,cAAc;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,WAAW;IACnB,GAAG,EAAE,cAAc,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;IAC9B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,UAAU,qBAAqB;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IACpD,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;CACxB;AAED,UAAU,cAAc;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,qBAAqB,EAAE,CAAC;CACnC;AAED,UAAU,iBAAiB;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,cAAc;IACtB,QAAQ,EAAE,MAAM,WAAW,EAAE,CAAC;IAC9B,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IACrC,aAAa,CAAC,EAAE,MAAM,cAAc,EAAE,CAAC;IACvC,eAAe,CAAC,EAAE,CAChB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,iBAAiB,EAC3B,aAAa,CAAC,EAAE,MAAM,EACtB,iBAAiB,CAAC,EAAE,MAAM,EAAE,KACzB,WAAW,GAAG,SAAS,CAAC;IAC7B,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,WAAW,GAAG,SAAS,CAAC;CAC3G;AAED,UAAU,oBAAoB;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC/C;AAED,UAAU,oBAAoB;IAC5B,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED,UAAU,QAAQ;IAChB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,YAAY,CAAC;IAC3C,IAAI,CAAC,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAAE,gBAAgB,EAAE,oBAAoB,EAAE,CAAA;KAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAClH,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACjG,IAAI,CAAC,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,cAAc,CAAC,EAAE,cAAc,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACtI,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE;QAAE,cAAc,CAAC,EAAE,cAAc,CAAA;KAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IACvG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IAKhE,YAAY,CAAC,EAAE,MAAM;QACnB,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,EAAE,oBAAoB,CAAC,CAAC,CAAC;QAC/E,iBAAiB,CAAC,EAAE;YAAE,aAAa,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,EAAE,GAAG,SAAS,CAAA;SAAE,CAAC;KACtG,CAAC;IACF,YAAY,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,CAAC;IACrE,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,KAAK,IAAI,CAAC;IACtF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;CACxC;AAoQD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,IAAI,CAs0CjE"}
|