In short
A chapter of a Chinese book set in columns from top to bottom. Each source is cited in a small two-line note inside the column, and the works cited are listed at the end.
What you'll build
The end of a chapter from an invented book on Chinese printing, 版刻叢談 (“Talks on block printing”), set in Traditional characters, top to bottom in columns read from the right, on a 大32開 page of 140 × 203 mm bound on the right. The chapter is about the layout of Song editions, and cites five real works. Each citation is set the way Chinese books have set commentary for centuries: as a 夾注, a note in two rows at half the text size, inside the column where the citation stands. A note that does not fit in what is left of a column goes on at the head of the next, and one goes on across the page turn. The notes follow the note form of GB/T 7714—2015, the mainland standard for references, and the chapter ends with a numbered list of the works it cites, the English ones turned sideways. The same chapter with its notes at the foot of the page would be set like Nº 071.
This recipe answers
- How do I cite to the Chinese standard GB/T 7714, also in vertical text?
- How do I set citations as footnotes, Chicago style, with short forms for later citations?
The short answer
// The GB/T 7714 note style turns each citation into a note. notes: 'warichu' sets the note
// in the column where the citation stands, in two rows at half the text size, the right
// row read first; a note longer than what is left of the column goes on in the next one.
// The list at the chapter's end comes from :::bibliography{scope=chapter}, numbered in
// the order the works are cited. Latin words turn sideways in the notes and in the list.
registerCitationEngine(createCiteprocEngine({ styles: STYLES, locales: LOCALES }));
const citations = {
style: 'china-national-standard-gb-t-7714-2015-note',
notes: 'warichu', // 夾注; 'footnote' sets the same notes at the foot of the page
bibliography: { fontSize: em(0.9), entrySpacing: pt(0) },
};
const cjk = {
grid: { enabled: true, charsPerLine: 36, linesPerPage: 15 },
warichu: { fontSize: em(0.5), color: col('ink') }, // no brackets: the half size sets it off
};
A note style set as 夾注, two half-size rows inside the column
Ingredients
- Features
- Citations in notesCitations in a citation styleWarichu: two-line notes in the lineBibliography from the referencesVertical textBooks bound on the rightCharacter gridChinese numeralsChinese punctuation widthsChinese, Japanese and Korean fontsDesigned openersNumbered headingsRunning heads and foliosHeads by page roleMirrored marginsSemantic colour palettePDF export
- Also uses
- Chinese line breakingColumn balancingHeading attributesPaper colourFonts embedded in the PDFRoman front matter
- Type
- Noto Serif SC, Noto Sans SC, LXGW WenKai TC (SIL OFL 1.1)
- Assets
- None: every picture is drawn in code
Method
#1 · A note style, set inside the line
The code is the short answer above. The GB/T 7714 note style (china-national-standard-gb-t-7714-2015-note) is a note style: each citation becomes a note that names the work in full (Citations). By default a note style sends its notes to the foot of the page. notes: 'warichu' keeps each note in the column instead, set as a warichu: two rows at cjk.warichu.fontSize, half the text size, centred on the column, the right row read first (Marks, ruby and warichu). The Markdown is the same as for any style, [@su1999] after the words it supports, and the note takes the place of the citation, before the 。 that ends the sentence.

The rows are filled part by part. At the foot of the third column there is room for 宿白. 唐宋時期 and no more, so it is split into two rows of three and four cells; the rest of the note fills the head of the next column, again in two rows. On page 2 Twitchett’s note begins at the foot of the last column, and the reader turns the page to finish it.
#2 · The works cited, at the end of the chapter
:::bibliography{title="本章引用書目" scope=chapter} sets the list where it stands and lists only the works this chapter cites (The bibliography). The references come from a BibTeX block. Each entry carries a langid, chinese or english, which the style reads as the work’s language, and names written in characters stay whole. The list is numbered in the order of first citation, and an entry’s turnover columns start below its label.
#3 · Traditional characters to mainland rules
locale: 'zh-Hant-CN' asks for Traditional characters set to the mainland’s rules, as publishers in Beijing and Shanghai set classical scholarship: the comma and the full stop sit in the top right corner of their cell, and a vertical book is bound on the right. The citations follow the tag: Traditional script picks the zh-TW CSL locale, so the words the style adds are in Traditional characters too. Noto Serif SC draws Traditional characters in the mainland’s forms, which suits this edition; LXGW WenKai TC, a Taiwan face, sets only the chapter title, which has no punctuation (Numbers in vertical text explains what happens to the digits).
In the notes and the list, a Latin title and a four-digit year turn sideways and run down the column. A short number next to Chinese text, such as the 1 of a label, stands upright in its cell.
#4 · The opener between rules
// In the flow frame x runs down the column and y across the page, right to left, so a
// 'horizontal' rule is a vertical line on the sheet: three of them rule the two columns.
const [TITLE, PITCH] = [15, 1.6 * LEAD]; // pt: the title's size and its column pitch
const rule = (n) => ({ kind: 'rule', id: `rule-${n}`, direction: 'horizontal',
thickness: pt(n === 1 ? 0.4 : 0.8), color: col('vermilion'),
placement: { anchor: { to: 'container', edge: 'top-left' },
offset: { y: pt(LEAD + n * PITCH) }, size: { width: 'fill' } } });
// A line of PITCH in column n (0, 1), its characters centred between two rules.
const title = (id, content, n, family, size, weight) => ({ kind: 'text', id, content,
fontFamily: family, fontWeight: weight, fontSize: pt(size), lineHeight: PITCH / size,
color: col('ink'), letterSpacing: pt(size * 0.25), align: 'left',
placement: { anchor: { to: 'container', edge: 'top-left' },
offset: { x: pt(2 * BODY), y: pt(LEAD + n * PITCH) } } }); // two characters down
const opener = { enabled: true, minHeight: cols(5), slot: { elements: [
rule(0), rule(1), rule(2),
title('number', '{number}', 0, HEI, 12, 700), // 第三章 in the first column, in 黑
title('title', '{titleText}', 1, KAI, TITLE, 400), // the title in the second, in 楷
] } };
On a vertical page a heading design is laid out in the flow frame: x runs down the column and y across the page from its right edge, so a 'horizontal' rule is a vertical line on the sheet. Three rules frame two columns 30.4 pt apart. 第三章 stands in the first in bold Hei, and the title in the second in Kai (Span and advanced design). The chapter number comes from startAt=3 on the heading and the template 第{1:一}章, and the folios from pageNumbering: trad-chinese-informal from 45. The running heads and folios go down the fore-edge as in Nº 075 (Vertical text elements).
const palette = {
ink: '#22201c', vermilion: '#a8352a', muted: '#6d665d', paper: '#fbf8f1',
};
const col = (id) => ({ hex: palette[id], model: 'hex', paletteId: id });
const colorPalette = Object.entries({ ...palette, 'main-color': palette.vermilion })
.map(([id, hex]) => ({ id, name: id, value: { hex, model: 'hex' } }));
The whole recipe
// ═══ Postext Cookbook · Nº 091 · Vertical Chinese with citations in inline notes ══════ // https://postext.dev/en/cookbook/vertical-book-with-jiazhu-citations // Code: MIT · Text: original (CC BY 4.0) · Pictures: none // Fonts: Noto Serif SC, Noto Sans SC, LXGW WenKai TC (SIL OFL 1.1) · Needs postext ≥ 1.12.0 import { buildDocument, renderPageToCanvas, clearMeasurementCache, registerCitationEngine, loadVerticalAlternates, } from 'https://esm.sh/postext'; import { renderToPdf, decompressWoff2 } from 'https://esm.sh/postext-pdf'; import { createCiteprocEngine, STYLES, LOCALES } from 'https://esm.sh/postext-citeproc'; const LANG = 'en'; // @lang: the language of the frame; the chapter is Chinese in both editions const RECIPE = 'vertical-book-with-jiazhu-citations'; // ─── 1 · Design ───────────────────────────────────────────────────────────── // #region palette: black ink, one vermilion for the opener's rules, the paper of the page const palette = { ink: '#22201c', vermilion: '#a8352a', muted: '#6d665d', paper: '#fbf8f1', }; const col = (id) => ({ hex: palette[id], model: 'hex', paletteId: id }); const colorPalette = Object.entries({ ...palette, 'main-color': palette.vermilion }) .map(([id, hex]) => ({ id, name: id, value: { hex, model: 'hex' } })); // #endregion const [SONG, HEI, KAI] = ['Noto Serif SC', 'Noto Sans SC', 'LXGW WenKai TC']; // 宋, 黑, 楷 const [BODY, LEAD] = [10.5, 19]; // pt: 五號 on a column pitch of 1.8 em const cols = (n) => pt(n * LEAD); // n columns across the page // #region answer: a note style set as 夾注, two half-size rows inside the column // The GB/T 7714 note style turns each citation into a note. notes: 'warichu' sets the note // in the column where the citation stands, in two rows at half the text size, the right // row read first; a note longer than what is left of the column goes on in the next one. // The list at the chapter's end comes from :::bibliography{scope=chapter}, numbered in // the order the works are cited. Latin words turn sideways in the notes and in the list. registerCitationEngine(createCiteprocEngine({ styles: STYLES, locales: LOCALES })); const citations = { style: 'china-national-standard-gb-t-7714-2015-note', notes: 'warichu', // 夾注; 'footnote' sets the same notes at the foot of the page bibliography: { fontSize: em(0.9), entrySpacing: pt(0) }, }; const cjk = { grid: { enabled: true, charsPerLine: 36, linesPerPage: 15 }, warichu: { fontSize: em(0.5), color: col('ink') }, // no brackets: the half size sets it off }; // #endregion // #region opener: 第三章 and the title in two ruled columns, the text after a blank one // In the flow frame x runs down the column and y across the page, right to left, so a // 'horizontal' rule is a vertical line on the sheet: three of them rule the two columns. const [TITLE, PITCH] = [15, 1.6 * LEAD]; // pt: the title's size and its column pitch const rule = (n) => ({ kind: 'rule', id: `rule-${n}`, direction: 'horizontal', thickness: pt(n === 1 ? 0.4 : 0.8), color: col('vermilion'), placement: { anchor: { to: 'container', edge: 'top-left' }, offset: { y: pt(LEAD + n * PITCH) }, size: { width: 'fill' } } }); // A line of PITCH in column n (0, 1), its characters centred between two rules. const title = (id, content, n, family, size, weight) => ({ kind: 'text', id, content, fontFamily: family, fontWeight: weight, fontSize: pt(size), lineHeight: PITCH / size, color: col('ink'), letterSpacing: pt(size * 0.25), align: 'left', placement: { anchor: { to: 'container', edge: 'top-left' }, offset: { x: pt(2 * BODY), y: pt(LEAD + n * PITCH) } } }); // two characters down const opener = { enabled: true, minHeight: cols(5), slot: { elements: [ rule(0), rule(1), rule(2), title('number', '{number}', 0, HEI, 12, 700), // 第三章 in the first column, in 黑 title('title', '{titleText}', 1, KAI, TITLE, 400), // the title in the second, in 楷 ] } }; // #endregion // The fore-edge: the book's title or the chapter's down the outer margin, the folio low. const foreEdge = (id, content, parity, edge, y, pages) => ({ kind: 'text', id, content, parity, pages, writingMode: 'vertical-rl', fontFamily: HEI, fontSize: pt(8), color: col('muted'), overflow: 'clip', placement: { anchor: { to: 'outer', edge }, offset: { y: em(y) } }, }); const header = { elements: [ foreEdge('book', '{title}', 'even', 'top', 4, 'body'), foreEdge('chapter', '{chapterNumber} {chapterTitle}', 'odd', 'top', 4, 'body'), foreEdge('folio', '{pageNumber}', 'all', 'bottom', -5, 'all'), // Across the foot of the opening page, in the edition's language: what is invented. { kind: 'text', id: 'imprint', content: '{subtitle}', pages: 'opener', fontFamily: SONG, fontSize: pt(6.5), color: col('muted'), align: 'center', overflow: 'wrap', placement: { anchor: { to: 'page', edge: 'bottom' }, offset: { y: mm(-9) }, size: { width: mm(100) } } }, ] }; const config = () => ({ // a factory: the engine caches resolved configs per object // Traditional characters to the mainland's rules, as Beijing and Shanghai publishers set // classical scholarship (gotcha: cjk-locale-tag). The citations follow it: zh-TW terms. locale: 'zh-Hant-CN', colorPalette, citations, cjk, page: { sizePreset: 'custom', width: mm(140), height: mm(203), dpi: 150, // 大32開 backgroundColor: col('paper'), margins: { top: mm(34), bottom: mm(26), left: mm(15), right: mm(19), mirror: true }, pageNumbering: { format: 'trad-chinese-informal', startAt: 45 } }, // 四十五 layout: { layoutType: 'single', writingMode: 'vertical-rl' }, // bound on the right bodyText: { fontFamily: SONG, fontSize: pt(BODY), lineHeight: pt(LEAD), color: col('ink'), boldColor: col('ink'), italicColor: col('ink'), referenceColor: col('ink'), textAlign: 'justify', firstLineIndent: em(2), indentAfterHeading: true, }, headings: { fontFamily: SONG, fontWeight: 700, color: col('ink'), balancing: { enabled: false }, // the columns stay on the grid levels: [{ level: 1, numberingTemplate: '第{1:一}章', numberSeparator: ' ', breakBefore: { enabled: true, parity: 'odd' }, // gotcha: headings-drop-h1-break marginBottom: pt(0), advancedDesign: opener }] }, header, footer: { elements: [] }, }); // ─── 2 · Content ──────────────────────────────────────────────────────────── const markdown = String.raw`---Markdown sample · 28 lines · content.en.md
title: "版刻叢談" author: "沈硯秋" subtitle: "A specimen chapter written for the Postext Cookbook. The book and its author are invented; the five works cited are real." --- # 宋刻本的版式 {startAt=3} 雕版印書,始於唐而盛於宋。唐代的印本流傳至今的極少,所見多是佛經、曆書一類的零星之物,敦煌所出的咸通九年《金剛經》卷子,是其中有確切紀年的一件[@su1999]。到了宋代,經史子集都有了刻本,官府、書院、私家和書坊競相開雕,書的樣子也大體定了下來[@zhang1989]。後世講版本的人談到書葉的格局,總是從宋本說起。 一塊書版刻成一葉,四周用欄線圍住,叫作版框。欄線只有一道的稱「四周單邊」,外粗內細兩道的稱「四周雙邊」,只在左右兩邊用雙線的稱「左右雙邊」。框內用直線分行,每半葉幾行、每行幾字,叫作行款。同一地方的書坊往往沿用一種行款,所以著錄一部書,行款總是要記的,鑑定版本時也常用它來推斷刻書的地點和年代。 版框正中留出窄窄的一行,不刻正文,是為版心。印好的紙沿這一行對折,版心便落在書口上,翻檢時一眼可見。版心裏刻書名、卷次和葉碼,有時還刻上刻工的姓名和這一版的字數,那是當年計算工錢用的。版心上下各有一個形如魚尾的標記,叫作魚尾;魚尾到欄線之間若刻一道黑線,叫作黑口,空著不刻的叫作白口。 大體說來,浙江一帶的官刻和家刻,字體方整,多作白口、左右雙邊;福建建陽的坊刻,字體瘦勁,版式緊湊,常在框外左上角加一個小方格,刻上篇名,稱為書耳,便於讀者翻檢[@huang2005]。坊刻的書要賣得出去,處處替讀者打算,這一點從版式上也看得出來。 書末或目錄之後,常有一塊刻記,寫明何人於何年在何處刊行,有時兼作書坊的廣告,叫作牌記。牌記的形制有長方的,也有鐘形、亞字形的。後人鑑定版本,牌記是最直接的依據,可也最容易被書賈挖改作偽,所以不能單憑牌記下斷語,還要和行款、字體、紙墨、避諱字一起看。 西方學者系統地研究中國的雕版書,是二十世紀的事。Carter的專著第一次把中國印刷術的發明及其西傳完整地介紹給英語讀者[@carter1925];Twitchett則從書業和讀者的角度,討論中古時期的印刷與出版[@twitchett1983]。兩書所談雖不限於版式,卻都把宋代看作雕版書定型的時代,和中國學者的看法相合。 :::bibliography{title="本章引用書目" scope=chapter} :::references{format=bibtex} @book{su1999, author = {宿白}, title = {唐宋時期的雕版印刷}, publisher = {文物出版社}, address = {北京}, year = 1999, langid = {chinese}} @book{zhang1989, author = {張秀民}, title = {中國印刷史}, publisher = {上海人民出版社}, address = {上海}, year = 1989, langid = {chinese}} @book{huang2005, author = {黃永年}, title = {古籍版本學}, publisher = {江蘇教育出版社}, address = {南京}, year = 2005, langid = {chinese}} @book{carter1925, author = {Carter, Thomas Francis}, title = {The invention of printing in China and its spread westward}, publisher = {Columbia University Press}, address = {New York}, year = 1925, langid = {english}} @book{twitchett1983, author = {Twitchett, Denis}, title = {Printing and publishing in medieval China}, publisher = {Frederic C. Beil}, address = {New York}, year = 1983, langid = {english}} :::`; // content.<lang>.md: the same Chinese text in both // ─── 3 · Fonts ────────────────────────────────────────────────────────────── const FONTS = { // every face the pages use, loaded before the build (gotcha: fonts-first) 'Noto Serif SC': ['400', '700'], // SONG: the text, notes, list, imprint; the list's title 'Noto Sans SC': ['400', '700'], // HEI: the fore-edge heads and folios; 第三章 'LXGW WenKai TC': ['400'], // KAI: the chapter's title }; // ─── 4 · Build & show ─────────────────────────────────────────────────────── // Each voice loads the files of what it sets; the Song also what the style writes. const heading = markdown.match(/^# (.*?)(?: \{.*\})?$/m)[1]; // the title, no attributes const book = markdown.match(/^title: "(.*)"/m)[1]; // 版刻叢談, the head of the even pages const numerals = '第章一二三四五六七八九十'; await loadFonts(FONTS, markdown); await loadCjkFonts({ [SONG]: ['400'] }, `${markdown}卷等頁`, { vertical: true }); await loadCjkFonts({ [HEI]: ['400'] }, `${heading}${book}${numerals}`, { vertical: true }); await loadCjkFonts({ [SONG]: ['700'] }, markdown.match(/bibliography\{title="([^"]*)"/)[1], { vertical: true }); await loadCjkFonts({ [HEI]: ['700'] }, numerals); await loadCjkFonts({ [KAI]: ['400'] }, heading); const doc = await buildWithFonts(() => buildDocument({ markdown }, config()), markdown); showBook(doc, { title: t({ en: 'Vertical Chinese with citations in inline notes', es: 'Chino vertical con citas en notas dentro del renglón' }) }); offerPdf(() => renderToPdf(doc, { fontProvider: cjkPdfProvider }), `${RECIPE}.pdf`);Kit · core, fonts, viewer, pdf, cjk: the same in every recipe · 422 lines
// ─── Kit ── helpers shared by every Cookbook recipe · postext.dev/cookbook ───── // ─── Kit · core v1 ── the same in every recipe · postext.dev/cookbook ───────── function mm(value) { return { value, unit: 'mm' }; } function pt(value) { return { value, unit: 'pt' }; } function em(value) { return { value, unit: 'em' }; } /** The sample language's string: t({ en: 'Figure', es: 'Figura' }). */ function t(strings) { return strings[LANG] ?? Object.values(strings)[0]; } /** A file in this recipe's assets folder, served from the Postext repo by jsDelivr. */ function asset(file) { return `https://cdn.jsdelivr.net/gh/drnachio/postext@main/cookbook/${RECIPE}/assets/${file}`; } // ─── Kit · fonts v1 ── the same in every recipe · postext.dev/cookbook ──────── // Postext measures text with the faces the browser has loaded, and caches the // widths, so every face must be ready before the first build. Faces come from // Fontsource: the same static files the PDF embeds, so screen and PDF agree. /** faces = { 'Family Name': ['400', '400i', '700'] }. `text` is the sample: * letters beyond Latin-1 (č, ł, ő…) also load the latin-ext files. With * `optional`, a face Fontsource does not ship is skipped instead of failing. * Resolves to the number of faces added. */ async function loadFonts(faces, text = '', { optional = false } = {}) { kitStatus('Loading fonts…'); const ranges = { latin: 'U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,' + 'U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD', 'latin-ext': 'U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,' + 'U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF', }; const subsets = /[Ā-˿Ḁ-ỿ]/.test(text) ? ['latin', 'latin-ext'] : ['latin']; const jobs = []; let added = 0; for (const [family, specs] of Object.entries(faces)) { const id = fontsourceId(family); const meta = optional ? await fontsourceMeta(family) : null; for (const spec of new Set(specs)) { const weight = parseInt(spec, 10); const style = spec.endsWith('i') ? 'italic' : 'normal'; if (hasFace(family, weight, style)) continue; if (optional && !(meta?.weights.includes(weight) && meta.styles.includes(style))) continue; for (const subset of subsets) { const url = `https://cdn.jsdelivr.net/npm/@fontsource/${id}@5/files/${id}-${subset}-${weight}-${style}.woff2`; const face = new FontFace(family, `url(${url}) format('woff2')`, { weight: String(weight), style, unicodeRange: ranges[subset] }); jobs.push(face.load().then((ready) => { document.fonts.add(ready); added++; }, () => { if (subset === 'latin' && !optional) throw new Error(`Fontsource has no ${family} ${weight} ${style}`); })); } } } await Promise.all(jobs).catch((error) => { kitFail(error); throw error; }); return added; } /** Runs `build` (a buildDocument or buildBundle call) and checks the faces * the pages use. A regular face missing from FONTS is loaded with a warning; * bold and italic variants are loaded when the family ships them. Then the * measurement caches are cleared and the build runs again. */ async function buildWithFonts(build, text = '') { const tried = new Set(); for (let round = 0; round < 3; round++) { kitStatus('Laying out…'); await new Promise(requestAnimationFrame); // let the status paint first const result = await Promise.resolve().then(build).catch((error) => { kitFail(error); throw error; }); const wanted = { base: {}, variants: {} }; for (const { font, base } of [result].flat().flatMap(fontStringsOf)) { const { family, weight, style } = parseFont(font); const key = `${family}|${weight}|${style}`; if (tried.has(key) || hasFace(family, weight, style)) continue; tried.add(key); (wanted[base ? 'base' : 'variants'][family] ??= []).push(`${weight}${style === 'italic' ? 'i' : ''}`); } if (Object.keys(wanted.base).length) { console.warn(`[cookbook] FONTS does not list ${JSON.stringify(wanted.base)}: loading them.`); } const added = await loadFonts(wanted.base, text) + await loadFonts(wanted.variants, text, { optional: true }); if (added === 0) return result; clearMeasurementCache(); } throw new Error('The fonts did not settle after three builds.'); } /** Every font string of the layout. `base` marks a block's own face; its * bold, italic and bold-italic variants are listed whether or not used. */ function fontStringsOf(doc) { const found = new Map(); const walk = (node) => { if (!node || typeof node !== 'object') return; if (Array.isArray(node)) { node.forEach(walk); return; } for (const [key, value] of Object.entries(node)) { if (typeof value === 'string' && /fontString$/i.test(key)) { found.set(value, found.get(value) || key === 'fontString'); } else if (value && typeof value === 'object') walk(value); } }; walk(doc.pages); walk(doc.blocks); return [...found].map(([font, base]) => ({ font, base })); } /** '700 37.5px Open Sans' / 'italic 400 13px "Source Serif 4"' → { family, weight, style }. * A string with no weight ('95.8px Young Serif', from a design text) is 400. */ function parseFont(font) { const m = /^(?:(italic|oblique)\s+)?(?:small-caps\s+)?(?:(\d+|bold|normal)\s+)?[\d.]+px\s+(.+)$/.exec(font.trim()); if (!m) throw new Error(`Unexpected font string: ${font}`); const weight = m[2] === 'bold' ? 700 : !m[2] || m[2] === 'normal' ? 400 : Number(m[2]); return { family: m[3].replace(/^["']|["']$/g, ''), weight, style: m[1] ? 'italic' : 'normal' }; } /** True when a loaded FontFace covers exactly this family, weight and style * (document.fonts.check() is also true for families nobody declared). */ function hasFace(family, weight, style) { for (const face of document.fonts) { if (face.status !== 'loaded' || face.style !== style) continue; if (face.family.replace(/^["']|["']$/g, '') !== family) continue; const [low, high = low] = face.weight.split(' ').map(Number); if (weight >= low && weight <= high) return true; } return false; } /** Fontsource's id for a family: 'Source Serif 4' → 'source-serif-4'. */ function fontsourceId(family) { return family.toLowerCase().replace(/\s+/g, '-'); } /** The weights and styles a family ships ({ weights: [400, 700], styles: ['normal', 'italic'] }), or null. */ function fontsourceMeta(family) { fontsourceMeta.cache ??= new Map(); const id = fontsourceId(family); if (!fontsourceMeta.cache.has(id)) { fontsourceMeta.cache.set(id, fetch(`https://api.fontsource.org/v1/fonts/${id}`) .then((res) => (res.ok ? res.json() : null), () => null)); } return fontsourceMeta.cache.get(id); } // ─── Kit · viewer v1 ── the same in every recipe · postext.dev/cookbook ─────── /** Shows the pages as facing spreads on a dark desk: the first page is a * recto on its own, then verso | recto pairs, as in a bound book. Pages * are painted when they scroll near the screen. */ function showPages(docs, { title, width = 460 } = {}) { const root = viewer(title); const pages = [docs].flat().flatMap((doc) => doc.pages.map((page) => ({ doc, page, n: (doc.pageIndexOffset ?? 0) + page.index }))); const spreads = []; let verso = null; for (const p of pages) { if (p.n % 2 === 1) { if (verso) spreads.push([verso, null]); verso = p; } else { spreads.push([verso, p]); verso = null; } } if (verso) spreads.push([verso, null]); const density = Math.min(window.devicePixelRatio || 1, 2); showPages.painter?.disconnect(); const painter = new IntersectionObserver((entries) => { for (const { isIntersecting, target } of entries) { if (!isIntersecting) continue; painter.unobserve(target); const { doc, page } = target.postext; renderPageToCanvas(page, doc, target, { scale: (width * density) / page.width }); } }, { rootMargin: '800px' }); showPages.painter = painter; root.replaceChildren(...spreads.map((pair) => { const spread = document.createElement('div'); spread.className = 'pt-spread'; for (const p of pair) { const figure = document.createElement('figure'); if (p) { const label = p.page.pageLabel || String(p.n + 1); const canvas = document.createElement('canvas'); canvas.postext = p; canvas.style.aspectRatio = `${p.page.width} / ${p.page.height}`; canvas.setAttribute('role', 'img'); canvas.setAttribute('aria-label', `Page ${label}`); const folio = document.createElement('figcaption'); folio.textContent = label; figure.append(canvas, folio); painter.observe(canvas); } else figure.className = 'pt-blank'; spread.append(figure); } return spread; })); kitStatus(`${pages.length} ${pages.length === 1 ? 'page' : 'pages'}`); document.documentElement.dataset.postext = 'ready'; return pages.length; } /** The desk, the bar and the error reporting, created once. */ function viewer(title) { if (!document.getElementById('pt-kit')) { document.head.insertAdjacentHTML('beforeend', `<style id="pt-kit"> :root { color-scheme: dark; } body { margin: 0; background: #0e1014; color: #b9bcc4; font: 13px/1.45 system-ui, sans-serif; } #pt-bar { position: sticky; top: 0; z-index: 1; display: flex; flex-wrap: wrap; align-items: center; gap: 6px 16px; padding: 10px 16px; background: rgb(14 16 20 / .92); backdrop-filter: blur(6px); border-bottom: 1px solid #23262d; } #pt-bar strong { color: #f4f1ea; font-weight: 600; } #pt-actions { display: flex; gap: 12px; margin-left: auto; } #pt-actions a, #pt-actions button { color: #d8a21a; font: inherit; background: none; border: 0; padding: 0; cursor: pointer; } #pages { display: grid; justify-items: center; gap: 48px; padding: 32px 16px 72px; } .pt-spread { display: flex; } .pt-spread figure { margin: 0; width: min(460px, 44vw); } .pt-spread canvas { display: block; width: 100%; background: #fff; box-shadow: 0 1px 2px rgb(0 0 0 / .5), 0 22px 44px -16px rgb(0 0 0 / .8); } .pt-spread figure:first-child canvas { box-shadow: inset -14px 0 14px -14px rgb(0 0 0 / .18), 0 1px 2px rgb(0 0 0 / .5), 0 22px 44px -16px rgb(0 0 0 / .8); } .pt-spread figcaption { margin-top: 10px; text-align: center; font: 600 10px/1 system-ui, sans-serif; letter-spacing: .18em; text-transform: uppercase; color: #6c7079; } .pt-blank { visibility: hidden; } @media (max-width: 760px) { .pt-spread { flex-direction: column; gap: 32px; } .pt-spread figure { width: min(460px, 92vw); } .pt-blank { display: none; } } </style>`); document.body.insertAdjacentHTML('afterbegin', '<header id="pt-bar"><strong id="pt-title"></strong><span id="pt-status" role="status"></span><span id="pt-actions"></span></header>'); document.getElementById('pt-title').textContent = document.title || 'Postext'; addEventListener('error', (event) => kitFail(event.error ?? event.message)); addEventListener('unhandledrejection', (event) => kitFail(event.reason)); } if (title) document.getElementById('pt-title').textContent = title; return document.getElementById('pages') ?? document.body.appendChild(Object.assign(document.createElement('main'), { id: 'pages' })); } function kitStatus(text) { viewer(); document.getElementById('pt-status').textContent = text; } function kitFail(error) { document.documentElement.dataset.postext = 'error'; kitStatus(`Error: ${error?.message ?? error}`); } // ─── Kit · pdf v1 ── the same in every recipe that exports a PDF ────────────── /** postext-pdf embeds TrueType bytes. Fetch the Fontsource file the screen * used, snapping to a weight the family ships and falling back to upright * when it has no italic: the PDF asks for every face a block could use. */ async function fontsourceProvider(family, weight, style) { const id = fontsourceId(family); const meta = await fontsourceMeta(family); const weights = meta?.weights?.length ? meta.weights : [400, 700]; const w = weights.reduce((a, b) => (Math.abs(b - weight) < Math.abs(a - weight) ? b : a)); const s = style === 'italic' && meta && !meta.styles.includes('italic') ? 'normal' : style; const res = await fetch(`https://cdn.jsdelivr.net/npm/@fontsource/${id}@5/files/${id}-latin-${w}-${s}.woff2`); if (!res.ok) throw new Error(`Fontsource has no ${family} ${w} ${s} (${res.status})`); return decompressWoff2(new Uint8Array(await res.arrayBuffer())); } /** A "Build the PDF" button in the bar. Once built: "Open the PDF" (a new * tab, since CodePen's preview frame cannot show PDFs) and a download link. */ function offerPdf(makePdf, filename) { viewer(); const button = Object.assign(document.createElement('button'), { type: 'button', textContent: 'Build the PDF' }); button.dataset.postextPdf = filename; button.addEventListener('click', async () => { button.disabled = true; button.textContent = 'Building the PDF…'; try { const bytes = await makePdf(); const url = URL.createObjectURL(new Blob([bytes], { type: 'application/pdf' })); const size = `${Math.max(1, Math.round(bytes.length / 1024))} KB`; button.replaceWith( Object.assign(document.createElement('a'), { href: url, target: '_blank', rel: 'noopener', textContent: 'Open the PDF ↗' }), Object.assign(document.createElement('a'), { href: url, download: filename, textContent: `Download ${filename} · ${size}` })); } catch (error) { button.disabled = false; button.textContent = 'Build the PDF'; kitFail(error); } }); document.getElementById('pt-actions').append(button); } // ─── Kit · cjk v1 ── Chinese, Japanese and Korean books · postext.dev/cookbook ─ // Fontsource ships a CJK family as about a hundred files per weight, each // declared in its stylesheet with the unicode-range it covers. The screen // loads the files the sample touches; the PDF gets the same files for the // characters its pages set in each face, and embeds each as a subset. // A book bound on the right (vertical text) is shown with its spreads // mirrored: page 1 alone on the left of the spine, then [3 | 2]. /** The files of a Fontsource face, read from its stylesheet: { url, range, * ranges }, the last declared first (the order the browser tries them in). */ function cjkSlices(family, weight, style) { cjkSlices.cache ??= new Map(); const id = fontsourceId(family); const css = `https://cdn.jsdelivr.net/npm/@fontsource/${id}@5/${weight}${style === 'italic' ? '-italic' : ''}.css`; if (!cjkSlices.cache.has(css)) { cjkSlices.cache.set(css, fetch(css) .then((res) => { if (!res.ok) throw new Error(`Fontsource has no ${family} ${weight} ${style} (${res.status})`); return res.text(); }) .then((text) => [...text.matchAll(/@font-face\s*{([^}]*)}/g)].map(([, rule]) => { const range = /unicode-range:\s*([^;]+);/.exec(rule)?.[1].trim() ?? 'U+0-10FFFF'; const ranges = range.split(',').map((part) => { const [lo, hi = lo] = part.trim().slice(2).split('-'); return [parseInt(lo, 16), parseInt(hi, 16)]; }); return { url: new URL(/url\(([^)]+?\.woff2)\)/.exec(rule)[1], css).href, range, ranges }; }).reverse())); } return cjkSlices.cache.get(css); } /** The file of `slices` that holds code point `cp`, if any. */ function cjkSliceFor(slices, cp) { return slices.find((slice) => slice.ranges.some(([lo, hi]) => cp >= lo && cp <= hi)); } /** Whether Fontsource serves `family` as a Chinese, Japanese or Korean * family (its subsets name the script). Fails when the API does not * answer: a CJK face taken for a Latin one would paint in a system face. */ async function isCjkFamily(family) { const meta = await fontsourceMeta(family); if (!meta) throw new Error(`api.fontsource.org did not describe ${family}: reload to try again`); return !!meta.subsets?.some((subset) => /^(chinese|japanese|korean)/.test(subset)); } /** faces = { 'Noto Serif TC': ['400', '700'] }, as for loadFonts: the * whole FONTS object may be passed, its other families are left to * loadFonts. Adds one FontFace per file of each CJK face with its * unicodeRange, then loads the files `text` touches. `text` is what the * faces set: the sample for the text face; a book in several voices calls * it once per voice (loadCjkFonts({ 'LXGW WenKai TC': ['400'] }, quotes)), * so the heading and quotation faces fetch and check only their own * characters. Fails when a character of `text` is in no file of a face. * List every weight the pages use: a weight left to buildWithFonts gets * the latin file only. With { vertical: true } it also loads each * family's vertical forms (brackets, quotes, pause marks) for the canvas, * which needs loadVerticalAlternates imported from postext. Resolves to * the number of files loaded. */ async function loadCjkFonts(faces, text, { vertical = false } = {}) { kitStatus('Loading fonts…'); let loaded = 0; try { if (vertical && typeof loadVerticalAlternates !== 'function') { throw new Error('loadCjkFonts(…, { vertical: true }) needs loadVerticalAlternates imported from postext'); } for (const [family, specs] of Object.entries(faces)) { if (!(await isCjkFamily(family))) continue; const twin = []; for (const spec of new Set(specs)) { const weight = parseInt(spec, 10); const style = spec.endsWith('i') ? 'italic' : 'normal'; const slices = await cjkSlices(family, weight, style); const missing = [...new Set(text)].filter((ch) => /\S/.test(ch) && !cjkSliceFor(slices, ch.codePointAt(0))); if (missing.length) { throw new Error(`${family} ${spec} has no file for ${missing.slice(0, 12).join(' ')}: ` + `give each face the text it sets (loadCjkFonts({ '${family}': ['${spec}'] }, text))`); } for (const slice of slices) { document.fonts.add(new FontFace(family, `url(${slice.url}) format('woff2')`, { weight: String(weight), style, unicodeRange: slice.range })); twin.push({ source: slice.url, weight: String(weight), style, unicodeRange: slice.range }); } const font = `${style === 'italic' ? 'italic ' : ''}${weight} 16px "${family}"`; loaded += (await document.fonts.load(font, text)).length; if (!document.fonts.check(font, text)) throw new Error(`${family} ${spec} did not load for the sample`); } // The same files under a twin name with the `vert` feature on: the // canvas paints the punctuation of vertical lines with it. if (vertical && twin.length) await loadVerticalAlternates(family, twin); } } catch (error) { kitFail(error); throw error; } return loaded; } /** The PDF font provider for recipes with CJK faces: a family whose * Fontsource subsets are Chinese, Japanese or Korean gets the files that * hold the characters its pages set (`request.codePoints`); any other * family goes to fontsourceProvider (the "pdf" block). */ async function cjkPdfProvider(family, weight, style, request) { if (!(await isCjkFamily(family))) return fontsourceProvider(family, weight, style); const meta = await fontsourceMeta(family); const weights = meta.weights?.length ? meta.weights : [400, 700]; const w = weights.reduce((a, b) => (Math.abs(b - weight) < Math.abs(a - weight) ? b : a)); const s = style === 'italic' && !meta.styles.includes('italic') ? 'normal' : style; const slices = await cjkSlices(family, w, s); const picked = new Set(); for (const cp of request?.codePoints ?? []) { const slice = cjkSliceFor(slices, cp); if (slice) picked.add(slice); } if (!picked.size) picked.add(slices[0]); return Promise.all(slices.filter((slice) => picked.has(slice)).map(async (slice) => { const res = await fetch(slice.url); if (!res.ok) throw new Error(`Fontsource file ${slice.url} (${res.status})`); return decompressWoff2(new Uint8Array(await res.arrayBuffer())); })); } /** showPages for a book bound on either edge. A right-bound book (the * document says so: doc.binding is 'right' for page.binding 'right' and * for vertical text) lies on the desk as it opens: page 1 alone on the * left of the spine, then [3 | 2], the spine shade on each page's inner * edge. `binding` ('left' | 'right') overrides the document's. */ function showBook(docs, { binding, ...options } = {}) { const count = showPages(docs, options); const right = (binding ?? [docs].flat()[0]?.binding) === 'right'; if (!document.getElementById('pt-kit-cjk')) { // The pages keep direction ltr: a canvas draws text in the direction its // element inherits, and under rtl each run would end where the engine // starts it, its brackets mirrored. document.head.insertAdjacentHTML('beforeend', `<style id="pt-kit-cjk"> .pt-spread[dir="rtl"] canvas { direction: ltr; } .pt-spread[dir="rtl"] figure:first-child canvas { box-shadow: inset 14px 0 14px -14px rgb(0 0 0 / .18), 0 1px 2px rgb(0 0 0 / .5), 0 22px 44px -16px rgb(0 0 0 / .8); } </style>`); } // Each pair stays [verso, recto] in the page; right to left, the verso // sits on the right. Phones stack the pages in reading order either way. for (const spread of document.querySelectorAll('#pages > .pt-spread')) spread.dir = right ? 'rtl' : 'ltr'; document.getElementById('pages').dataset.binding = right ? 'right' : 'left'; return count; } // ─── /Kit ───────────────────────────────────────────────────────────────────────
The composed script.js runs as it is: paste it into any page’s module script, or open the recipe on CodePen. Recipe folder on GitHub ↗ (opens in a new tab)
Variations
#Brackets round each note
Some editions close a 夾注 in brackets at the text size. cjk.warichu sets them for every note, the citations included.
- warichu: { fontSize: em(0.5), color: col('ink') }, // no brackets: the half size sets it off
+ warichu: { fontSize: em(0.5), color: col('ink'), open: '〔', close: '〕' },#Numbers in the column instead of notes
The numeric GB/T 7714 style with corner brackets prints 〔1〕 upright in the column, and the list stays as it is.
- style: 'china-national-standard-gb-t-7714-2015-note',
- notes: 'warichu', // 夾注; 'footnote' sets the same notes at the foot of the page
+ style: 'china-national-standard-gb-t-7714-2015-numeric',
+ marker: 'corner', // 〔1〕, upright in vertical textPitfalls
Pitfall
Tag the document zh-Hans or zh-Hant, not with LANG
A recipe's editions are en and es, but a Chinese sample is Chinese in both: `locale: LANG` would tag it English or Spanish, hyphenate its Latin words, label its figures Figure or Figura and give the PDF the wrong language. Write the tag yourself: 'zh-Hans' (mainland conventions: GB line breaking, Kaiming punctuation) or 'zh-Hant' (Taiwan: full-width centred punctuation); 'zh-HK' for Hong Kong. A bare 'zh' reads as Simplified, mainland. Chinese line breaking →
Pitfall
Chinese faces load by slices, through the cjk block
Fontsource serves a Chinese, Japanese or Korean family as about a hundred files per weight, each covering a range of characters. loadFonts fetches only the latin file, so on screen the Han characters come from a system face and measure wrong, and fontsourceProvider hands the PDF that latin file, which prints them as empty boxes. List the cjk kit block, call loadCjkFonts(FONTS, markdown) after loadFonts (once per voice, with the text it sets, when the book uses several CJK faces) and give renderToPdf fontProvider: cjkPdfProvider: both take the files that hold the text's characters. Chinese, Japanese and Korean fonts →
Pitfall
Set each region's punctuation in a face of that region
The punctuation widths move the blank beside each mark to the side the document's region puts it, not the side the font draws it: under zh-Hans a Kaiming comma keeps the left half of its box, where a Simplified face draws the glyph, and gives up the right half. A Traditional face centres ,。 in the box, so the half that goes holds part of the glyph and the comma crowds the next character. LXGW WenKai TC, the only Kai text face on Fontsource, does this in Simplified text. Set mainland text, notes and quotations in Noto Serif SC or Noto Sans SC, keep the TC faces for zh-Hant, and use a Simplified brush face (Ma Shan Zheng) only for display lines, where design text applies no punctuation widths. It also draws inherited forms that neither the mainland nor the Taiwan standard prints, 為 with the 爫 top of 爲 and 令 (in 冷, 領) with a 卩 foot: check the characters a page sets in it. Chinese punctuation widths →
Pitfall
A right-bound book shows its spreads with showBook
In a book bound on the right (vertical Chinese, or page.binding 'right') page 1 is still the recto, but it lies on the left of the spine, and the pairs read [3 | 2]. showPages lays every book out left-bound; showBook from the cjk block reads doc.binding and mirrors the pairs. capture.hero still names a spread in reading order, [verso, recto]: [2, 3]. Books bound on the right →
Pitfall
On a character grid, turn column balancing off
Column balancing fills a page that ends short, as a head kept with its text leaves blank lines at the foot, by adding grid lines above heads and by setting a paragraph one line looser. A looser Chinese line spreads its characters (0.13 em on a GB/T 9704 page, far past balancing.maxTracking), so the characters leave the columns of the grid and the heads leave their lines. A page counted in cells ends short instead: set headings.balancing: { enabled: false }. Character grid →
Pitfall
Any headings object switches off the H1 page break
By default an H1 breaks to a recto (always-odd), but passing any headings object resets that default, so chapters run on and span: 'page' does nothing. Restate headings.levels[0].breakBefore: { enabled: true, parity } in every config. Chapters that open on a recto →
Pitfall
Quote every frontmatter value
YAML reads title: 1984 as a number and a date as a Date object, and non-string values print empty in placeholders and leave the PDF without a title. Quote every value: title: "1984". Document metadata →
Pitfall
Load every face before layout
Layout measures text with the faces the browser has loaded and caches the widths, so a face that arrives after the first build leaves wrong line breaks and a PDF that no longer matches the screen. Load every weight and style first, and call clearMeasurementCache() before rebuilding when one arrives late. Fonts before layout →
- A note style writes a work cited a second time in short form, and the GB/T 7714 note style shortens it to 同1, “as in note 1”. A warichu has no number, so the reader cannot find note 1. This chapter cites each work once; a text that cites a work again should write the second citation by hand, or use the numeric style of the second variation.
- The style writes Western punctuation into Chinese entries,
宿白. 唐宋時期的雕版印刷[M]. 北京: 文物出版社, 1999., as the standard prints them. In a vertical column those marks keep their Western form: they turn sideways and take less than a cell, unlike the 。 and , of the text. - A warichu row is half the text size: at 10.5 pt each row is 5.25 pt, the smallest type on the page. Set the text at 五號 or larger, or raise
cjk.warichu.fontSize; the two rows always share one column’s width.
Credits
- Recipe
- Ignacio Ferro
- Text
- Original prose, CC BY 4.0
- Fonts
- Noto Serif SC (SIL OFL 1.1) · Noto Sans SC (SIL OFL 1.1) · LXGW WenKai TC (SIL OFL 1.1)
Edit this write-up ↗ (opens in a new tab)Recipe folder on GitHub ↗ (opens in a new tab)


