Referencia
De un vistazo
Sección titulada «De un vistazo»El material de referencia responde a preguntas concretas: qué símbolo corresponde, qué valor se admite, qué nivel de compatibilidad aplica o qué cláusula interviene. Esta pestaña reúne la superficie verificada de NextPDF: referencia de módulos, matrices de compatibilidad, superficie de API, referencia de errores, conformidad con estándares y políticas publicadas por el proyecto. Aquí no se explica cómo alcanzar un objetivo; para ello, consultar las Guías o el Cookbook.
Mapa de referencia
Sección titulada «Mapa de referencia»Motor Core
Sección titulada «Motor Core»El motor nextpdf/core, documentado módulo a módulo.
| Página | Para qué sirve |
|---|---|
| Referencia del motor Core | Mapa de espacios de nombres con todas las páginas de módulos y las cuatro subfamilias. |
| Contracts: 41 interfaces públicas (SPI) | Interfaces públicas y enumeraciones con seguimiento de estabilidad. |
| Core: fachada Document y traits de incumbencia | La fachada Document y la familia de traits Has*. |
| HTML: subsistema de renderizado de HTML+CSS a PDF | Renderizador HTML en streaming de una sola pasada. |
| Seguridad: cifrado, política criptográfica y superficie de firma | Cifrado, permisos y puntos de integración de firma. |
Compatibilidad del renderizado
Sección titulada «Compatibilidad del renderizado»Lo que el renderizador verifica, declara, admite parcialmente o no admite.
| Página | Para qué sirve |
|---|---|
| Matriz de compatibilidad de CSS | Niveles de compatibilidad de CSS por característica en la canalización HTML. |
| Funcionalidades CSS no compatibles y soluciones alternativas | Qué queda fuera del alcance y qué conviene hacer en su lugar. |
| Matriz de compatibilidad de fuentes y sistemas de escritura | Tecnologías de fuentes y compatibilidad con sistemas de escritura. |
| Compatibilidad con la escritura vertical CJK | Compatibilidad con el modo de escritura vertical en textos en chino, japonés y coreano. |
| Compatibilidad con el modelado de sistemas de escritura complejos | Compatibilidad del modelado para los sistemas de escritura que lo requieren. |
Superficie de la API
Sección titulada «Superficie de la API»Símbolos exactos, valores permitidos y contratos de servicio.
| Página | Para qué sirve |
|---|---|
| Referencia de enumeraciones | Todas las enumeraciones públicas y sus valores permitidos. |
| Configuración de la TSA | La autoridad de sellado de tiempo (TSA) predeterminada y cómo cambiarla. |
| Referencia de la API REST de Connect | Los endpoints REST de NextPDF Connect, basados en el documento OpenAPI 3.1. |
| Explorador de la API de Connect | El explorador interactivo del mismo contrato. |
La referencia de API de cada paquete se encuentra junto al paquete correspondiente: Referencia de la API de Connect, Índice de API de integraciones y Referencia de la API del SDK de Python, en la pestaña Guías.
Referencia de errores
Sección titulada «Referencia de errores»Todas las excepciones que lanza el motor, organizadas por dominio, junto con su contexto estructurado y orientación de recuperación.
| Página | Para qué sirve |
|---|---|
| Referencia de errores | El modelo de excepciones: la clase base NextPdfException y el contrato de contexto. |
| Errores del núcleo y generales | Fallos del ciclo de vida del documento y del motor en general. |
| Errores de representación y de E/S | Fallos en HTML, fuentes, escritor y lector. |
| Errores de seguridad y de firma | Fallos de cifrado, firma y PKI. |
| Errores de tiempo de ejecución y de soporte | Fallos de HTTP, resiliencia y observabilidad. |
| Errores del acelerador | Fallos del sidecar de aceleración opcional. |
| Errores de conformidad | Fallos de las herramientas de validación y de conformidad. |
Conformidad con estándares
Sección titulada «Conformidad con estándares»Los perfiles estándar a los que se orienta NextPDF Core, con el alcance declarado para cada uno: el motor produce una salida destinada a ser conforme; la conformidad la determina un validador externo.
| Página | Para qué sirve |
|---|---|
| Conformidad con los estándares | La postura de conformidad y el índice de perfiles. |
| Conformidad con PDF 2.0 | La base de ISO 32000-2 a la que se orienta el motor. |
| Conformidad con PDF/A-4 | Conformidad para archivado, junto con su Mapa de cláusulas de PDF/A-4. |
| Conformidad con PDF/UA-2 | Conformidad para accesibilidad, junto con su Mapa de cláusulas de PDF/UA-2. |
| Conformidad con PDF/X | Conformidad de producción para impresión. |
| Mapa de cláusulas de PAdES | El mapeo del perfil de línea base ETSI EN 319 142 para firmas PDF. |
| Conformidad con ZUGFeRD / Factur-X | Conformidad de factura electrónica híbrida. |
Centro de confianza
Sección titulada «Centro de confianza»La postura de ingeniería del motor Core, con el alcance de cada afirmación.
| Página | Para qué sirve |
|---|---|
| Centro de confianza | Índice de las posturas publicadas. |
| Licenciamiento del producto | Los términos de licencia del núcleo abierto y de las ediciones comerciales. |
| Uso de la marca registrada y de la marca | Cómo usar el nombre y las marcas de NextPDF. |
| Tratamiento de datos, PII y telemetría | Qué lee, almacena y transmite el motor. |
| Modelo de seguridad para firma y cifrado | El diseño criptográfico y sus límites. |
| Modelo de amenazas del motor | Frente a qué se defiende el motor y frente a qué no. |
| Política de divulgación de vulnerabilidades | Cómo reportar una vulnerabilidad. |
Proyecto y versiones
Sección titulada «Proyecto y versiones»| Página | Para qué sirve |
|---|---|
| Registro de cambios | Qué cambió en cada versión. |
| Convenciones del registro de cambios | Cómo se redactan y clasifican las entradas del registro de cambios. |
| Política de versionado, estabilidad, obsolescencia y soporte | Los compromisos de compatibilidad entre versiones. |
| Estructura de la documentación de NextPDF | La estructura y la gobernanza de este conjunto documental. |
Glosario
Sección titulada «Glosario»Glosario — los términos utilizados en esta documentación, definidos una sola vez y enlazados en todas partes.
Contrato de las entradas de referencia
Sección titulada «Contrato de las entradas de referencia»Cada entrada de API debe responder a las mismas preguntas:
| Pregunta | Respuesta obligatoria |
|---|---|
| ¿Qué se invoca? | Símbolo totalmente cualificado, endpoint, comando de línea de comandos (CLI) o clave de configuración. |
| ¿Qué entrada se acepta? | Tabla de parámetros con tipo, obligatoriedad, valor predeterminado y valores aceptados. |
| ¿Qué ocurre de forma predeterminada? | Comportamiento cuando se omite una entrada opcional. |
| ¿Qué se devuelve? | Tipo de retorno, cuerpo de respuesta, salida a archivo, flujo o efecto secundario. |
| ¿Qué puede fallar? | Excepción, error de validación, estado HTTP o modo de fallo operativo. |
| ¿Cómo se usa de forma segura? | Notas sobre seguridad, uso seguro en workers, límites de tamaño, rutas, tiempos de espera y gestión de secretos. |
Política de cobertura
Sección titulada «Política de cobertura»Las páginas de referencia de API y comportamiento están respaldadas por el código fuente. Las API públicas se documentan a partir del código fuente del paquete, los archivos de configuración, las pruebas y los ejemplos. Las clases auxiliares internas solo se documentan cuando un desarrollador de aplicaciones necesita comprender su comportamiento para configurar u operar el paquete.
Preparación para la traducción
Sección titulada «Preparación para la traducción»En las páginas de referencia se prefieren las tablas a los párrafos densos. Cada fila debe poder entenderse de forma independiente, porque la segmentación posterior en el formato de archivo de intercambio de localización extensible (XLIFF) dividirá el contenido por bloques.