Saltar al contingut principal
Recepta número 186

Receptari · Capítol 2 · Text i tipografia

Cites i estadístics fora de les vores de línia

Un article a dues columnes compost dues vegades: les primeres proves avisen de cada cita o signe a la vora d'una línia; les segones encareixen aquests talls.

En aquesta pàgina
  • Mostra en castellà: encara no hi ha edició en català
  • Format 170 × 240 mm
  • 2 columnes, espai entre columnes de 6 mm
  • STIX Two Text 9,5/12,8
  • IBM Plex Sans
  • IBM Plex Sans Condensed
  • 6 pàgines
  • Nivell
  • Postext 1.79.0
  • Compost en 37 ms
  • 180 línies de codi

En poques paraules

En una columna justificada estreta, una crida com [2, 3] pot quedar sola a principi de línia, i p < 0,05 es pot partir després del signe. L'article es compon dues vegades: una ensenya on passa i l'altra ho evita gairebé sempre.

Què compondràs

Tres pàgines d'una revista de pediatria de 170 × 240 mm, a dues columnes justificades de 66 mm en STIX Two Text: un estudi original sobre l'ecografia pulmonar en la pneumònia infantil, amb la bibliografia numerada en estil Vancouver. Una columna tan estreta deixa al tallador de línies poques sortides, i en quatre llocs el text en castellà es talla malament. Dues vegades la crida [4, 5] es parteix entre dues línies, lluny de la paraula a què es refereix, i dues vegades un estadístic se separa del seu signe: kappa sobre = 0,84, CP+ sobre = 19,19. Les primeres proves es componen amb citationBreaks i operatorBreaks en 'warn': no canvien cap tall, marquen cadascun amb una banda ambre pàl·lid i els llisten en una papereta després de la bibliografia. Les segones es componen amb 'avoid', i en queda un dels quatre. L'edició anglesa compon el mateix estudi amb punt decimal.

Aquesta recepta respon a

  • Com evito que un número de cita o un estadístic com p < 0,05 quedin partits al final d’una línia?
  • Com poso els números de cita en superíndex i faig que els DOI siguin enllaços, com a les revistes mèdiques?

La resposta curta

script.js · línies 27–42al codi complet
const bodyText = {
  fontFamily: SERIF, fontSize: pt(9.5), lineHeight: pt(LEAD), color: col('ink'),
  boldColor: col('ink'), italicColor: col('ink'), referenceColor: col('ink'),
  referenceBold: false, textAlign: 'justify', firstLineIndent: mm(3.5),
  indentAfterHeading: false, hyphenation: { enabled: true },
  optimalLineBreaking: true, // the rules price breaks in the Knuth–Plass breaker
  avoidWidows: true, avoidOrphans: true, avoidRunts: true,
  // A line that opens on a citation, "[8, 9]" (citationBreak), or ends or opens on a sign
  // set between spaces, "p <" / "0.05" (operatorBreak). 'warn' reports each one and changes
  // nothing; 'avoid' adds the penalty to the demerits of those breaks and reports the ones
  // it keeps. The first proof sets 'warn' (see proofs).
  citationBreaks: 'avoid', operatorBreaks: 'avoid',
  // 10000 by default, what a line spaced to the limit costs. A 66 mm column offers few other
  // breaks; at 30000 the breaker takes looser lines, never past maxWordSpacing.
  citationBreakPenalty: 30000, operatorBreakPenalty: 30000,
};

Ingredients

Tipografia
STIX Two Text, IBM Plex Sans, IBM Plex Sans Condensed (SIL OFL 1.1)
Recursos
Cap: totes les imatges es dibuixen en codi

Elaboració

#1 · Un preu per a dues classes de tall

El codi és la resposta curta de més amunt. Hi ha tall de cita quan una línia comença amb una crida numerada o amb la segona meitat d'una, com 5] després de [4,. Hi ha tall de signe quan una línia acaba o comença amb un signe entre espais: =, <, ±, ×, el menys. 'warn' avisa de tots dos i deixa les línies com són. 'avoid' suma una penalització als demèrits d'aquests talls, i el tallador de Knuth–Plass busca una altra manera de partir el paràgraf. Necessita optimalLineBreaking: el tallador voraç no té demèrits als quals sumar res.

La penalització per defecte, 10000, és el que costa una línia estirada fins al límit de l'espai entre paraules, de manera que el tallador no obre mai una línia més enllà d'aquest límit per deixar una cita al costat de la seva paraula. En aquesta columna, 10000 deixava dos talls a cada edició. Amb 30000 el tallador accepta línies més obertes, sempre dins de maxWordSpacing, i en queda un a cada edició. Un valor més alt ja no canviava res: l'últim tall no té alternativa dins del límit.

#2 · Marcar els talls al text

script.js · línies 254–279al codi complet
// The word before the citation and the citation, or the sign and the number on its other
// side, wrapped in :mark[…]: a band under ordinary text, so the breaks stay where they were.
const wordEnd = (s, i) => i + s.slice(i).search(/[\s;)]|[,.](?!\d)|$/); // 0.09, not 0
function sides(source, w, a, b) { // a warning names line a, before the break, by its source
  if (w.kind === 'citationBreak') { // "colleagues [@simel1991]"
    const cite = source.lastIndexOf('[@', b.sourceStart + 2);
    return [source.lastIndexOf(' ', cite - 2) + 1, source.indexOf(']', cite) + 1];
  }
  if (w.edge === 'end') { // "LR− = 0.09": the sign ends line a, the number opens line b
    const from = source.lastIndexOf(` ${w.text} `, a.sourceEnd) + 1;
    return [from, wordEnd(source, from + w.text.length + 1)];
  }
  const sign = source.indexOf(` ${w.text} `, b.sourceStart - 1); // the sign opens line b
  return [source.lastIndexOf(' ', sign - 1) + 1, sign + 1 + w.text.length];
}
function markBreaks(source, doc, found) {
  const pairs = doc.blocks.flatMap((b) => b.lines.map((line, i) => [line, b.lines[i + 1]]));
  const spans = new Map();
  for (const w of found) {
    const [a, b] = pairs.find(([line]) => line.sourceStart === w.sourceStart) ?? [];
    const [from, to] = b ? sides(source, w, a, b) : [];
    if (from > a?.sourceStart && to > from && to <= b.sourceEnd) spans.set(from, to);
  }
  return [...spans].sort(([x], [y]) => y - x).reduce((md, [from, to]) => `${md.slice(0, from)}`
    + `:mark[${md.slice(from, to)}]{style="edge"}${md.slice(to)}`, source);
}

Cada avís porta la seva classe, la cita o el signe, el text de les dues línies, la posició al text font de la primera i la pàgina. L'script busca aquestes dues línies al document compost i embolica el tall amb :mark[…]: la paraula anterior a la cita i la cita, o el signe i el número de l'altra banda. Una marca pinta una banda sota el text i deixa els talls on eren. La banda no arriba al número que genera l'estil de cites, així que a la pàgina només es marca la paraula anterior.

Primeres proves, pàgina 212: kappa al final d'una línia i = 0,84 al principi de la següent.

#3 · Dues proves i una papereta de consultes

script.js · línies 283–303al codi complet
const KIND = { citationBreak: t({ en: 'citation', es: 'cita' }),
  operatorBreak: t({ en: 'sign', es: 'signo' }) };
const edge = (s, end) => (end ? s.trim().split(/\s+/).slice(-2) : s.trim().split(/\s+/)
  .slice(0, 2)).join('\u00a0').replace(/[.,;]$/, ''); // no-break spaces: no breaks of its own
const query = (doc, w) => `${t({ en: 'p.', es: 'pág.' })}\u00a0${doc.pages[w.pageIndex]
  .pageLabel}, ${KIND[w.kind]}: …${edge(w.lines[0], true)}\u00a0/ ${edge(w.lines[1])}…`;
const slip = (mode, doc, found) => ['', `:::callout{type="slip" title="${mode === 'warn'
  ? t({ en: 'First proof: queries', es: 'Primeras pruebas: consultas' })
  : t({ en: 'Second proof: queries', es: 'Segundas pruebas: consultas' })}"}`,
`citationBreaks / operatorBreaks: '${mode}' · ${found.length} ${found.length === 1
  ? t({ en: 'break', es: 'corte' }) : t({ en: 'breaks', es: 'cortes' })}.`,
...found.flatMap((w) => ['', query(doc, w)]), ':::', ''].join('\n');
const build = (md, mode) => buildDocumentWithFonts({ markdown: md }, { ...config,
  bodyText: { ...bodyText, citationBreaks: mode, operatorBreaks: mode } }, kitFonts(FONTS));
async function proof(mode) {
  const plain = await build(markdown, mode); // pass 1: where the breaks are
  const found = (plain.contentWarnings ?? []).filter((w) => /^(citation|operator)Break$/
    .test(w.kind));
  return build(markBreaks(markdown, plain, found) + slip(mode, plain, found), mode); // pass 2
}
const docs = { warn: await proof('warn'), avoid: await proof('avoid') };

Cada prova es compon dues vegades. La primera composició troba els talls; la segona compon l'article amb les marques i una papereta després de la bibliografia, de manera que la papereta cau a l'última pàgina. Així torna un caixista les proves amb les seves consultes. Les línies de la papereta uneixen les paraules amb espais de no separació, per no afegir-hi talls propis. capture.doc publica les dues composicions marcades, [1, 3].

Segones proves, pàgina 213: la papereta llista un tall en tot l'article.

El tall que queda en castellà és anteriores [4, sobre 5], a la pàgina 213. A l'edició anglesa les primeres proves en troben tres, entre els quals LR− = sobre 0.09 dues vegades, i les segones en deixen un, first sobre [2, 3].

#4 · Crides numerades entre claudàtors

script.js · línies 46–50al codi complet
registerCitationEngine(createCiteprocEngine({ styles: STYLES, locales: LOCALES }));
const citations = { style: 'elsevier-vancouver', locale: t({ en: 'en-GB', es: 'es-ES' }),
  marker: 'brackets', collapseRanges: true, // [8, 9] and [4–6], set after a word space
  bibliography: { fontSize: em(0.8), lineHeight: pt(9.6), entrySpacing: pt(1),
    labelWidth: mm(6), labelAlign: 'right', doi: 'hide' } };

El processador de cites compon cada [@clave] com un número entre claudàtors després d'un espai i agrupa les sèries com [4–6]. L'espai anterior al claudàtor i el que segueix una coma dins seu són llocs on una línia es pot tallar; per això una columna estreta amb moltes cites necessita la regla.

#5 · La capçalera i el bloc de l'article

script.js · línies 54–78al codi complet
const text = (id, content, family, size, extra) => ({ kind: 'text', id, content, align: 'left',
  fontFamily: family, fontSize: pt(size), color: col('ink'), overflow: 'wrap', ...extra });
const at = (to, edge, x, y, width) => ({ anchor: { to, edge }, offset: { x: mm(x), y: mm(y) },
  ...(width && { size: { width: mm(width), height: 'auto' } }) });
const caps = { fontFamily: COND, fontWeight: 600, letterSpacing: pt(1.2),
  textTransform: 'uppercase' };
const JOURNAL = t({ en: 'Ribera Paediatric Journal', es: 'Revista Pediátrica de la Ribera' });
const white = { ...caps, color: col('paper') };
const titleBlock = { enabled: true, minHeight: mm(58), slot: { elements: [
  { kind: 'box', id: 'band', style: { backgroundColor: col('accent') }, placement: {
    anchor: { to: 'page', edge: 'top-left' }, size: { width: 'fill', height: mm(13) } } },
  text('journal', JOURNAL, COND, 9, { ...white, placement: at('page', 'top-left', INNER, 5) }),
  text('issue', '{attr.issue}', COND, 9, { ...white, align: 'right',
    placement: at('page', 'top-right', -OUTER, 5, 60) }),
  text('kind', '{attr.kind}', COND, 8.5, { ...caps, color: col('accent'),
    placement: at('container', 'top-left', 0, 0, MEASURE) }),
  text('title', '{titleText}', SANS, 16, { fontWeight: 600, lineHeight: 1.18,
    placement: at('#kind', 'below', 0, 2.5, MEASURE - 6) }),
  text('authors', '{attr.authors}', SERIF, 10, { inlineMarks: true, // ^1^ → ¹
    placement: at('#title', 'below', 0, 3.5, MEASURE) }),
  text('affiliations', '{attr.affiliations}', SANS, 7.2, { inlineMarks: true, lineHeight: 1.35,
    color: col('muted'), placement: at('#authors', 'below', 0, 1.6, MEASURE) }),
  text('note', '{attr.note}', SANS, 7.2, { color: col('muted'),
    placement: at('#affiliations', 'below', 0, 2.4, MEASURE) }),
] } };

L'estil del títol dibuixa la banda de la revista, el tipus d'article, el títol, els autors amb els seus números de filiació i una nota, tot a partir d'atributs de l'H1. Les dues edicions comparteixen l'estil, i el text es queda al Markdown.

La recepta completa

Sandbox
// ═══ Postext Cookbook · Nº 186 · Citations and statistics off the line edges ═══════════
// https://postext.dev/en/cookbook/clinical-paper-line-edges
// Code: MIT · Text: original (CC BY 4.0) · Pictures: none
// Fonts: STIX Two Text, IBM Plex Sans and Sans Condensed (SIL OFL 1.1) · Needs postext ≥ 1.79.0
import {
  buildDocumentWithFonts, renderPageToCanvas, registerCitationEngine,
} from 'https://esm.sh/postext';
import { createCiteprocEngine, STYLES, LOCALES } from 'https://esm.sh/postext-citeproc';

const LANG = 'es'; // @lang: the language of the sample document ('en' | 'es')
const RECIPE = 'clinical-paper-line-edges';

// ─── 1 · Design ─────────────────────────────────────────────────────────────
// #region palette: an indigo journal, a pale amber band for the proof marks
const palette = { ink: '#1b1e26', accent: '#2c4a7c', tint: '#e9eef6', mark: '#f7dfa9',
  muted: '#596173', paper: '#ffffff' };
const col = (id) => ({ hex: palette[id], model: 'hex', paletteId: id });
const colorPalette = Object.entries({ ...palette, 'main-color': palette.accent })
  .map(([id, hex]) => ({ id, name: id, value: { hex, model: 'hex' } }));
// #endregion
const [SERIF, SANS, COND] = ['STIX Two Text', 'IBM Plex Sans', 'IBM Plex Sans Condensed'];
const [TRIM_W, TRIM_H, TOP, BOTTOM, INNER, OUTER, GUTTER] = [170, 240, 20, 22, 17, 15, 6];
const MEASURE = TRIM_W - INNER - OUTER; // 138 mm: two columns of 66 mm, about 45 characters
const LEAD = 12.8; // pt, for 9.5 pt type

// #region answer: no line opens on a citation, no line ends or opens on a lone sign
const bodyText = {
  fontFamily: SERIF, fontSize: pt(9.5), lineHeight: pt(LEAD), color: col('ink'),
  boldColor: col('ink'), italicColor: col('ink'), referenceColor: col('ink'),
  referenceBold: false, textAlign: 'justify', firstLineIndent: mm(3.5),
  indentAfterHeading: false, hyphenation: { enabled: true },
  optimalLineBreaking: true, // the rules price breaks in the Knuth–Plass breaker
  avoidWidows: true, avoidOrphans: true, avoidRunts: true,
  // A line that opens on a citation, "[8, 9]" (citationBreak), or ends or opens on a sign
  // set between spaces, "p <" / "0.05" (operatorBreak). 'warn' reports each one and changes
  // nothing; 'avoid' adds the penalty to the demerits of those breaks and reports the ones
  // it keeps. The first proof sets 'warn' (see proofs).
  citationBreaks: 'avoid', operatorBreaks: 'avoid',
  // 10000 by default, what a line spaced to the limit costs. A 66 mm column offers few other
  // breaks; at 30000 the breaker takes looser lines, never past maxWordSpacing.
  citationBreakPenalty: 30000, operatorBreakPenalty: 30000,
};
// #endregion

// #region citations: numbered references in brackets, the list in the Vancouver order
registerCitationEngine(createCiteprocEngine({ styles: STYLES, locales: LOCALES }));
const citations = { style: 'elsevier-vancouver', locale: t({ en: 'en-GB', es: 'es-ES' }),
  marker: 'brackets', collapseRanges: true, // [8, 9] and [4–6], set after a word space

L'script.js compost funciona tal com és: enganxa'l com a script de mòdul en qualsevol pàgina o obre la recepta a CodePen. Carpeta de la recepta a GitHub ↗ (s'obre en una pestanya nova)

Variants

#Avisar dels talls sense canviar res

Una revista que revisa les proves a mà pot deixar la regla en 'warn': el Sandbox llista cada tall entre els seus avisos i les línies es queden com les va compondre el tallador.

-  citationBreaks: 'avoid', operatorBreaks: 'avoid',
+  citationBreaks: 'warn', operatorBreaks: 'warn',

#Mantenir la penalització per defecte

Amb 10000 l'espaiat queda una mica més ajustat i queden dos talls per edició en lloc d'un.

-  citationBreakPenalty: 30000, operatorBreakPenalty: 30000,

Errors freqüents

Avís de maquetació · citationBreak

Cita a l'inici de línia

Per què. Una línia d'un paràgraf comença amb una cita numerada posada després d'una paraula, o amb un tros d'una: «autors» al final d'una línia i «[12]» al començament de la següent, o «[14,» sobre «16]». Un número entre claudàtors o parèntesis després d'un número no és una cita («2016 (3)»), ni una paraula entre claudàtors. El text de dreta a esquerra i el xinès, japonès o coreà es deixen tal com són. Amb bodyText.citationBreaks a 'warn' s'informa de tots aquests talls; a 'avoid', dels que el tall de línies va mantenir perquè cap composició dins l'espaiat entre paraules no els evitava per menys que bodyText.citationBreakPenalty. El motor anota cadascun a doc.contentWarnings amb la cita, les dues línies i la seva pàgina.

Solució. Posa bodyText.citationBreaks a 'avoid': el tall de línies posa preu a un tall abans d'una cita o dins d'ella i compon el paràgraf d'una altra manera on l'espaiat entre paraules ho permet; l'espai continua estirant-se amb els altres. Un tall que es manté costa més d'evitar que bodyText.citationBreakPenalty, sovint perquè la cita és ampla per a la mesura: apuja la penalització per canviar-lo per línies més soltes, o escriu un espai de no separació (U+00A0) entre la paraula i la cita per unir aquest parell sigui quina sigui la regla. En un port d'un llibre existent deixa 'warn': el port reprodueix els talls de l'original. Documentació →

Avís de maquetació · operatorBreak

Signe a la vora de la línia

Per què. Una línia d'un paràgraf acaba o comença amb un signe solt entre espais, un de = < > ≤ ≥ ± × ≈ ≠ ÷ − + · →: «LR+ =» al final d'una línia amb «18,29» a la següent, o «± 0,03» al començament d'una línia. Un guionet entre paraules no és un signe. El text de dreta a esquerra i el xinès, japonès o coreà es deixen tal com són. Amb bodyText.operatorBreaks a 'warn' s'informa de tots aquests talls, un per tall (una línia que comença i acaba amb un signe en dona dos); a 'avoid', dels que el tall de línies va mantenir perquè cap composició dins l'espaiat entre paraules no els evitava per menys que bodyText.operatorBreakPenalty. El motor anota cadascun a doc.contentWarnings amb el signe, l'extrem (final o començament), les dues línies i la seva pàgina.

Solució. Posa bodyText.operatorBreaks a 'avoid': el tall de línies posa preu a un tall en els espais a banda i banda del signe i compon el paràgraf d'una altra manera on l'espaiat entre paraules ho permet. Un tall que es manté costa més d'evitar que bodyText.operatorBreakPenalty, sovint en una columna estreta on el signe i els seus dos termes són amples: apuja la penalització per canviar-lo per línies més soltes, o escriu espais de no separació (U+00A0, o U+202F per a un de fi) al voltant del signe per unir-lo sigui quina sigui la regla. En un port d'un llibre existent deixa 'warn': el port reprodueix els talls de l'original. Documentació →

  • Els talls es busquen a les línies tal com han quedat. Si canvien el format, el cos o el text, canvien de lloc, així que cal llegir els avisos de cada composició i no copiar posicions d'una d'anterior.
  • Per mantenir una cita concreta al costat de la seva paraula en qualsevol columna, escriu un espai de no separació al davant, al Markdown. La regla s'ocupa de la resta de l'article.

Crèdits

Text
Text original, CC BY 4.0
Fonts
STIX Two Text (SIL OFL 1.1) · IBM Plex Sans (SIL OFL 1.1) · IBM Plex Sans Condensed (SIL OFL 1.1)
Sandbox