Configuración de Postext

En Postext, todas las decisiones de maquetación dependen de un único objeto de configuración.

PostextConfig controla las dimensiones de la página, la disposición de las columnas, la tipografía del texto base, los estilos de los encabezados, el idioma del documento (locale) y mucho más. Todas las propiedades son opcionales: Postext trae valores por defecto razonables, inspirados en la tipografía tradicional del libro. Solo tienes que indicar lo que quieras cambiar.

import { buildDocument } from 'postext';
 
const document = buildDocument(content, {
  page: { sizePreset: '21x28', dpi: 300 },
  layout: { layoutType: 'double', gutterWidth: { value: 0.5, unit: 'cm' } },
  bodyText: { fontFamily: 'EB Garamond', fontSize: { value: 9, unit: 'pt' } }, // 9 pt sobrescribe el valor por defecto de 8 pt
  headings: { fontFamily: 'Open Sans' },
});

Para ver en conjunto cómo procesa el motor esta configuración, consulta la página Arquitectura.

#Índice

La referencia está repartida en veinte páginas. Cada grupo de esta lista es una página, seguida de las secciones que contiene.

Página y disposición

• Página: tamaño, márgenes, rejilla base, marcas de corte, numeración y encuadernación.
• Disposición: número de columnas, medianiles, filetes y escritura vertical.

Cabeceras y pies de página

• Cabeceras y pies: los elementos de texto, filetes, cajas e imágenes de cada página, con marcadores de posición, paridad, tipos de página y colocación.

Texto base

• Texto base: tipografía, justificación y corte de líneas, citas, verso, tabulaciones y letras capitulares.

Separación silábica e idioma

• Separación silábica: patrones de separación, palabras que no se parten y texto en bandera.
• Idioma del documento: el locale de primer nivel, que fija el idioma de respaldo de la separación silábica, los tipos de recurso integrados, los textos de continuación de las tablas y de los recuadros partidos y el idioma que se declara en un PDF accesible; las cifras (numerals) y la dirección del texto (direction) que se deducen de él, y los idiomas y escrituras que Postext compone. La guía de los libros de derecha a izquierda es Composición árabe.
• Idiomas y escrituras: los sistemas de escritura que compone Postext y las páginas que explican cada uno.
• Texto árabe: formas contextuales de las letras, kashida, signos vocálicos y cifras del texto árabe.

Encabezados

• Encabezados: valores comunes a todos los niveles y valores propios de cada uno, de H1 a H6.

Viudas, huérfanas y equilibrado

• Huérfanas, viudas, líneas cortas y reglas de cohesión: las claves de bodyText que mantienen juntas líneas y bloques cuando hay un salto de columna.
• Equilibrado de columnas: los recursos que hacen que todas las columnas terminen a la misma altura, aplicados por orden de prioridad editorial.

Listas y matemáticas

• Listas no ordenadas y Listas ordenadas: viñetas, numeración y anidamiento.
• Matemáticas: cómo se dibujan las fórmulas LaTeX (escala, color y márgenes).

Notas y referencias

• Notas al pie (footnotes): adónde van las notas citadas con [^id], cómo se numeran y qué aspecto tienen.
• Numeración de líneas (lineNumbers): un número en el margen cada cinco líneas de verso, o de texto; qué se cuenta, dónde vuelve a empezar la cuenta y en qué lado van los números.
• Referencias cruzadas (crossRefs): las palabras que se imprimen alrededor del número o de la página de un :ref, y su estilo por defecto.
• Citas (citations): el estilo de cita y el aspecto de las citas y de la bibliografía.
• Enlaces en papel (links): qué muestra la página impresa de la dirección de un enlace: nada, la dirección entre paréntesis o una nota con la dirección y un código QR; y el color y el subrayado de los enlaces en las salidas que elijas.
• Índice general: qué imprime :::toc (tipografía de las entradas, líneas de puntos, números de página, líneas de autor y filas de parte).
• Índice analítico: qué imprime :::index (tipografía de las entradas, sangrías, separadores e intervalos de páginas, grupos por letra inicial e idioma de ordenación).

Tipografía de Asia oriental

• Tipografía de Asia oriental (cjk): las convenciones regionales y el corte de líneas del texto chino, japonés y coreano; cómo se reparte el espacio en sus líneas justificadas; el ancho de la puntuación y la puntuación colgada; el espacio entre caracteres chinos y latinos; la retícula de caracteres; los números que van de pie en el texto vertical, y las marcas de énfasis, el ruby, las notas warichu y las marcas de kanbun. Las guías completas son Composición china y Composición japonesa.

Recursos y tablas

• Tipos de recurso: numeración propia de cada tipo, para figuras, tablas y tipos personalizados.
• Estilo de tablas (con estilos de tabla con nombre) y Estilo de pies de recurso: tipografía y decoración de las tablas y de sus pies.
• Estilo de diagramas: cómo se recolorean a una sola tinta los diagramas SVG insertados, para imprimir con tinta directa.
• Estilo de partitura (scoreStyle y scoreStyles): tamaño del pentagrama, fuente musical, espaciado y números de compás de todas las partituras.
• Estilo de vídeo (videoStyle): la marca de reproducción y el código QR que se imprimen sobre el póster de un vídeo, y lo que ofrecen sus reproductores en el visor HTML y en EPUB.

Estilos y partes

• Estilos de párrafo: estilos con nombre para los contenedores :::paragraphs (bibliografías, glosarios, notas).
• Estilos de chip (chipStyles): estilos con nombre para el :chip[…] en línea, como la caja de un banco de palabras, una tecla o una etiqueta.
• Estilos de resaltado (markStyles): estilos con nombre para el :mark[…] en línea, es decir, la franja que hay detrás de una frase resaltada y que la acompaña cuando pasa a la línea siguiente.
• Listados de código (codeStyle): la letra, la caja, el ancho del tabulador, las líneas largas, los números de línea y los colores de los elementos sintácticos de los listados ```; el coloreado de sintaxis y su enganche para resaltadores externos, y el código en línea con letra de código.
• Partes: las páginas que separan las partes en los contenedores :::part (paridad, caja de texto, diseño de la apertura y tipografía del texto).
• Estilos de encabezado: estilos con nombre para los encabezados con {style="…"}, como los capítulos sin numerar o los preliminares con sus propios titulillos; su geometría y su paleta.

Recuadros

• Estilos de recuadro: notas, consejos y objetivos en recuadro para los contenedores :::callout.

Ajustes de ejercicios

• Estilos de ejercicio (exerciseStyles): el número, la letra del enunciado, las letras de las opciones, los huecos, los espacios para escribir, las cuadrículas, la división y el color de las respuestas de los bloques :::exercise. Ajustes del libro (exercises): la edición del profesor, dónde se imprimen las soluciones, la semilla del desorden y las ediciones en pantalla. La guía es Ejercicios.

Ajustes de cómics

• Cómics (comics): el marco y las calles de las páginas de cómic, los estilos de viñeta, la rotulación, los estilos de bocadillo y el reparto. La guía es Cómics.

Ajustes de páginas compuestas

• Plantillas de página (pageTemplates): los marcos, grupos y decoración de una página compuesta, la herencia entre plantillas y las variantes para páginas impares y pares. Estilos de rótulo (labelStyles): el aspecto de los rótulos que se colocan sobre las anclas de una imagen. Aspectos de marco (frameLooks): juegos de colores con nombre que un trozo de una página compuesta lleva con look="…". Todos los problemas que puede tener una plantilla se enumeran en Avisos de las plantillas de página.

Fuentes, colores y salida

• Unidades y colores y Paleta de colores: Dimension, ColorValue y los colores con nombre.
• Fuentes personalizadas: cómo declarar las familias tipográficas que sube el usuario, junto a las de Google Fonts.
• Estilos de cifras: figureStyle, cifras elzevirianas, alineadas, tabulares o proporcionales en cada estilo de texto, con las funciones OpenType de la fuente.
• Visor HTML: el ancho de columna deseado y el corte de líneas de la salida HTML.
• Visor Canvas (canvasViewer): el espacio entre las dos páginas de un par y entre una fila y la siguiente en el Canvas del Sandbox.
• Generación de PDF (configuración): marcadores del documento (outlines), salida accesible (etiquetada) y espacio de color forzado en la salida PDF.
• Producción para imprenta (configuración) (print): PDF/X-1a y PDF/X-4, los perfiles ICC de salida, el negro (grises solo en K, sobreimpresión, negro enriquecido), los colores definidos en CMYK, la verificación previa (preflight) y la simulación de impresión.
• Comprobación del contraste (configuración) (contrast): el contraste del texto con su fondo según los niveles AA o AAA de WCAG, en pantalla y sobre el papel del perfil de salida, y el texto calado demasiado fino para la imprenta.
• Comprobación del contenido (configuración) (checks.contentInConfig): avisa de los textos del diseño que contienen el propio texto del libro en lugar de marcadores de posición, con una lista de frases permitidas para el título y la editorial.
• Visor Folio (configuración): papel, encuadernación, superficie y luz del visor del libro en 3D.
• Depuración: superposiciones visuales y avisos de autoría para el editor.

Uso programático

• Uso programático: buildDocument, los avisos que devuelve, los resolvers y las cachés.
• Ejecutar la composición en un Web Worker: la composición fuera del hilo principal, con posibilidad de cancelarla.

Archivos PDF

• Generación de PDF (postext-pdf): proveedores de fuentes, fuentes CJK, workers y archivos listos para imprenta.

HTML, Folio, EPUB y SCORM

• Integrar el visor HTML y Generación de PDF: recetas completas, de principio a fin.
• Un libro en 3D (postext-folio): el documento maquetado como un libro impreso abierto sobre una mesa, con hojas que el lector puede pasar.
• Libros EPUB: archivos EPUB 3 de maquetación fija y de maquetación fluida generados a partir de la misma composición, y cómo validarlos con EPUBCheck.
• Paquetes SCORM: capítulos y secciones como SCO para un sistema de gestión del aprendizaje, con ejercicios que envían sus puntuaciones.

Paquetes .postext

• Paquetes (archivos .postext): un libro entero en un solo archivo; cómo crear, abrir y compilar archivos .postext desde el código.