Saltar al contenido principal
Receta número 186

Recetario · Capítulo 2 · Texto y tipografía

Citas y estadísticos fuera de los bordes de línea

Un artículo a dos columnas compuesto dos veces: las primeras pruebas avisan de cada cita o signo en un borde de línea; las segundas encarecen esos cortes.

p. 211 · 1 de 6

  • Formato 170 × 240 mm
  • 2 columnas, medianil de 6 mm
  • STIX Two Text 9,5/12,8
  • IBM Plex Sans
  • IBM Plex Sans Condensed
  • 6 páginas
  • Nivel
  • Postext 1.79.0
  • Compuesto en 37 ms
  • 180 líneas de código

En pocas palabras

En una columna justificada estrecha, una llamada como [2, 3] puede quedarse sola al principio de una línea, y p < 0,05 puede partirse tras el signo. El artículo se compone dos veces: una enseña dónde pasa y otra lo evita casi siempre.

Lo que vas a componer

Tres páginas de una revista de pediatría de 170 × 240 mm, a dos columnas justificadas de 66 mm en STIX Two Text: un estudio original sobre la ecografía pulmonar en la neumonía infantil, con la bibliografía numerada en estilo Vancouver. Una columna tan estrecha deja al cortador de líneas pocas salidas, y en cuatro sitios el texto español se corta mal. Dos veces la llamada [4, 5] se parte entre dos líneas, lejos de la palabra a la que apoya, y dos veces un estadístico se separa de su signo: kappa sobre = 0,84, CP+ sobre = 19,19. Las primeras pruebas se componen con citationBreaks y operatorBreaks en 'warn': no cambian ningún corte, marcan cada uno con una banda ámbar pálido y los listan en una papeleta tras la bibliografía. Las segundas se componen con 'avoid', y queda uno de los cuatro. La edición inglesa compone el mismo estudio con punto decimal.

Esta receta responde a

  • ¿Cómo evito que un número de cita o un estadístico como p < 0,05 queden partidos al final de una línea?
  • ¿Cómo pongo los números de cita en superíndice y hago que los DOI sean enlaces, como en las revistas médicas?

La respuesta corta

script.js · líneas 27–42en el código completo
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,
};

Ingredientes

Tipografía
STIX Two Text, IBM Plex Sans, IBM Plex Sans Condensed (SIL OFL 1.1)
Recursos
Ninguno: todas las imágenes se dibujan en código

Elaboración

#1 · Un precio para dos clases de corte

El código está en la respuesta corta. Hay corte de cita cuando una línea empieza con una llamada numerada o con la segunda mitad de una, como 5] tras [4,. Hay corte de signo cuando una línea acaba o empieza con un signo entre espacios: =, <, ±, ×, el menos. 'warn' avisa de los dos y deja las líneas como están. 'avoid' suma una penalización a los deméritos de esos cortes, y el cortador de Knuth–Plass busca otra forma de partir el párrafo. Necesita optimalLineBreaking: el cortador voraz no tiene deméritos a los que sumar nada.

La penalización por omisión, 10000, es lo que cuesta una línea estirada hasta el límite del espacio entre palabras, de modo que el cortador nunca abre una línea más allá de ese límite para dejar una cita junto a su palabra. En esta columna, 10000 dejaba dos cortes en cada edición. Con 30000 el cortador acepta líneas más abiertas, siempre dentro de maxWordSpacing, y queda uno en cada edición. Un valor más alto ya no cambiaba nada: el último corte no tiene alternativa dentro del límite.

#2 · Marcar los cortes en el texto

script.js · líneas 254–279en el código completo
// 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 aviso trae su clase, la cita o el signo, el texto de las dos líneas, la posición en el texto fuente de la primera y la página. El script busca esas dos líneas en el documento compuesto y envuelve el corte en :mark[…]: la palabra anterior a la cita y la cita, o el signo y el número del otro lado. Una marca pinta una banda bajo el texto y deja los cortes donde estaban. La banda no llega al número que genera el estilo de citas, así que en la página solo se marca la palabra anterior.

Primeras pruebas, página 212: kappa al final de una línea y = 0,84 al principio de la siguiente.

#3 · Dos pruebas y una papeleta de consultas

script.js · líneas 283–303en el código completo
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 prueba se compone dos veces. La primera composición encuentra los cortes; la segunda compone el artículo con las marcas y una papeleta tras la bibliografía, de modo que la papeleta cae en la última página. Así devuelve un cajista las pruebas con sus consultas. Las líneas de la papeleta unen sus palabras con espacios de no separación, para no añadir cortes propios. capture.doc publica las dos composiciones marcadas, [1, 3].

Segundas pruebas, página 213: la papeleta lista un corte en todo el artículo.

El corte que queda en español es anteriores [4, sobre 5], en la página 213. En la edición inglesa las primeras pruebas encuentran tres, entre ellos LR− = sobre 0.09 dos veces, y las segundas dejan uno, first sobre [2, 3].

#4 · Llamadas numeradas entre corchetes

script.js · líneas 46–50en el código completo
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 procesador de citas compone cada [@clave] como un número entre corchetes tras un espacio y agrupa las series como [4–6]. El espacio anterior al corchete y el que sigue a una coma dentro de él son sitios donde una línea puede cortarse; por eso una columna estrecha con muchas citas necesita la regla.

#5 · La cabecera y el bloque del artículo

script.js · líneas 54–78en el código completo
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) }),
] } };

El estilo del título dibuja la banda de la revista, el tipo de artículo, el título, los autores con sus números de filiación y una nota, todo a partir de atributos del H1. Las dos ediciones comparten el estilo, y el texto se queda en el Markdown.

La receta 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

El script.js compuesto funciona tal cual: pégalo como script de módulo en cualquier página o abre la receta en CodePen. Carpeta de la receta en GitHub ↗ (se abre en una nueva pestaña)

Variantes

#Avisar de los cortes sin cambiar nada

Una revista que revisa las pruebas a mano puede dejar la regla en 'warn': el Sandbox lista cada corte entre sus avisos y las líneas se quedan como las compuso el cortador.

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

#Mantener la penalización por omisión

Con 10000 el espaciado queda algo más apretado y se quedan dos cortes por edición en lugar de uno.

-  citationBreakPenalty: 30000, operatorBreakPenalty: 30000,

Errores frecuentes

Aviso de maquetación · citationBreak

Cita al principio de línea

Por qué. Una línea de un párrafo empieza con una cita numerada puesta tras una palabra, o con un trozo de ella: «autores» al final de una línea y «[12]» al principio de la siguiente, o «[14,» sobre «16]». Un número entre corchetes o paréntesis tras un número no es una cita («2016 (3)»), ni una palabra entre corchetes. El texto de derecha a izquierda y el chino, japonés o coreano se dejan como están. Con bodyText.citationBreaks en 'warn' se informa de todos esos cortes; en 'avoid', de los que el corte de líneas mantuvo porque ninguna composición dentro del espaciado entre palabras los evitaba por menos que bodyText.citationBreakPenalty. El motor anota cada uno en doc.contentWarnings con la cita, las dos líneas y su página.

Solución. Pon bodyText.citationBreaks en 'avoid': el corte de líneas pone precio a un corte antes de una cita o dentro de ella y compone el párrafo de otro modo donde el espaciado entre palabras lo permite; el espacio sigue estirándose con los demás. Un corte que sigue cuesta más de evitar que bodyText.citationBreakPenalty, a menudo porque la cita es ancha para la medida: sube la penalización para cambiarlo por líneas más sueltas, o escribe un espacio de no separación (U+00A0) entre la palabra y la cita para unir ese par sea cual sea la regla. En un port de un libro existente deja 'warn': el port reproduce los cortes del original. Documentación →

Aviso de maquetación · operatorBreak

Signo en el borde de línea

Por qué. Una línea de un párrafo termina o empieza con un signo suelto entre espacios, uno de = < > ≤ ≥ ± × ≈ ≠ ÷ − + · →: «LR+ =» al final de una línea con «18,29» en la siguiente, o «± 0,03» al principio de una línea. Un guion entre palabras no es un signo. El texto de derecha a izquierda y el chino, japonés o coreano se dejan como están. Con bodyText.operatorBreaks en 'warn' se informa de todos esos cortes, uno por corte (una línea que empieza y termina con un signo da dos); en 'avoid', de los que el corte de líneas mantuvo porque ninguna composición dentro del espaciado entre palabras los evitaba por menos que bodyText.operatorBreakPenalty. El motor anota cada uno en doc.contentWarnings con el signo, el extremo (final o comienzo), las dos líneas y su página.

Solución. Pon bodyText.operatorBreaks en 'avoid': el corte de líneas pone precio a un corte en los espacios a ambos lados del signo y compone el párrafo de otro modo donde el espaciado entre palabras lo permite. Un corte que sigue cuesta más de evitar que bodyText.operatorBreakPenalty, a menudo en una columna estrecha donde el signo y sus dos términos son anchos: sube la penalización para cambiarlo por líneas más sueltas, o escribe espacios de no separación (U+00A0, o U+202F para uno fino) alrededor del signo para unirlo sea cual sea la regla. En un port de un libro existente deja 'warn': el port reproduce los cortes del original. Documentación →

  • Los cortes se buscan en las líneas tal como quedaron. Si cambian el formato, el cuerpo o el texto, cambian de sitio, así que hay que leer los avisos de cada composición y no copiar posiciones de una anterior.
  • Para mantener una cita concreta junto a su palabra en cualquier columna, escribe un espacio de no separación delante en el Markdown. La regla se ocupa del resto del artículo.

Créditos

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