Referenz
Auf einen Blick
Abschnitt betitelt „Auf einen Blick“Referenzmaterial beantwortet präzise Fragen: welches Symbol, welcher Wert, welche Unterstützungsstufe oder welche Klausel jeweils gilt. Der Tab „Referenz“ bündelt die verifizierte Oberfläche von NextPDF: Modulreferenz, Unterstützungsmatrizen, API-Oberfläche, Fehlerreferenz, Standardkonformität und die vom Projekt veröffentlichten Richtlinien. Er erklärt nicht, wie Sie ein Ziel erreichen; nutzen Sie dafür die Anleitungen oder das Cookbook.
Referenzkarte
Abschnitt betitelt „Referenzkarte“Core-Engine
Abschnitt betitelt „Core-Engine“Die nextpdf/core-Engine ist nach Modulen dokumentiert.
| Seite | Wofür Sie sie verwenden |
|---|---|
| Core-Engine-Referenz | Namespace-Überblick über alle Modulseiten und die vier Unterfamilien. |
| Contracts: 41 öffentliche Interfaces (SPI) | Öffentliche Interfaces und Enums mit nachverfolgter Stabilität. |
| Core: Document-Fassade + Concern-Traits | Document-Fassade und die Has*-Trait-Familie. |
| HTML: Subsystem für HTML+CSS-zu-PDF-Rendering | Der HTML-Renderer mit Single-Pass-Streaming. |
| Sicherheit: Verschlüsselung, Crypto-Policy und Signaturoberfläche | Verschlüsselung, Berechtigungen und Integrationspunkte für das Signieren. |
Rendering-Unterstützung
Abschnitt betitelt „Rendering-Unterstützung“Was der Renderer verifiziert und als unterstützt, teilweise unterstützt oder nicht unterstützt deklariert.
| Seite | Wofür Sie sie verwenden |
|---|---|
| CSS-Support-Matrix | Support-Level pro Funktion für Cascading Style Sheets (CSS) in der HTML-Pipeline. |
| Nicht unterstützte CSS-Funktionen und Behelfslösungen | Welche Funktionen außerhalb des Umfangs liegen und welche Alternativen verfügbar sind. |
| Unterstützungsmatrix für Schriftarten und Schriftsysteme | Schrifttechnologien und die Unterstützung von Schriftsystemen. |
| Unterstützung für vertikale CJK-Schreibrichtung | Unterstützung für den vertikalen Writing-Mode bei chinesischem, japanischem und koreanischem Text. |
| Unterstützung für Komplexschrift-Shaping | Shaping-Unterstützung für Schriften, die sie benötigen. |
API-Oberfläche
Abschnitt betitelt „API-Oberfläche“Präzise Symbole, zulässige Werte und Serviceverträge.
| Seite | Wofür Sie sie verwenden |
|---|---|
| Enum-Referenz | Alle öffentlichen Enums und ihre zulässigen Werte. |
| TSA-Konfiguration | Die standardmäßige Time-Stamping Authority (TSA) und wie Sie sie ändern. |
| Referenz zur Connect-REST-API | Die REST-Endpunkte von NextPDF Connect aus dem OpenAPI-3.1-Dokument. |
| Connect-API-Explorer | Der interaktive Explorer für denselben Vertrag. |
API-Referenzen (Application Programming Interface, API) finden Sie auf Paketebene in den jeweiligen Paketen: Connect API-Referenz, Index der Integrations-APIs und Python-SDK-API-Referenz im Tab „Anleitungen“.
Fehlerreferenz
Abschnitt betitelt „Fehlerreferenz“Alle Exceptions, die die Engine auslöst: nach Domäne geordnet, mit strukturiertem Kontext und Wiederherstellungshinweisen.
| Seite | Wofür Sie sie verwenden |
|---|---|
| Fehlerreferenz | Das Exception-Modell: die Basisklasse NextPdfException und der Kontextvertrag. |
| Core- und allgemeine Fehler | Fehler im Dokumentlebenszyklus und allgemeine Engine-Fehler. |
| Rendering- und I/O-Fehler | HTML-, Schrift-, Writer- und Reader-Fehler. |
| Security- und Signaturfehler | Fehler bei Verschlüsselung, Signieren und PKI. |
| Laufzeit- und Support-Fehler | Fehler bei HTTP, Resilienz und Observability. |
| Accelerator-Fehler | Fehler des optionalen Accelerator-Sidecars. |
| Compliance-Fehler | Fehler bei Validierung und Konformitäts-Tooling. |
Standardkonformität
Abschnitt betitelt „Standardkonformität“Die Standardprofile, auf die NextPDF Core abzielt, jeweils mit klarer Abgrenzung: Die Engine erzeugt Ausgaben, die als konform vorgesehen sind; über die Konformität entscheidet ein externer Validator.
| Seite | Wofür Sie sie verwenden |
|---|---|
| Standardkonformität | Die Konformitätshaltung und der Profilindex. |
| PDF 2.0-Konformität | Die ISO 32000-2-Baseline, auf die die Engine abzielt. |
| PDF/A-4-Konformität | Archivierungskonformität, einschließlich PDF/A-4-Klauselzuordnung. |
| PDF/UA-2-Konformität | Barrierefreiheitskonformität, einschließlich PDF/UA-2-Klauselzuordnung. |
| PDF/X-Konformität | Konformität für die Druckproduktion. |
| PAdES-Klauselzuordnung | Das Baseline-Profil-Mapping nach ETSI EN 319 142 für PDF-Signaturen. |
| ZUGFeRD-/Factur-X-Konformität | Konformität für hybride elektronische Rechnungen. |
Trust Center
Abschnitt betitelt „Trust Center“Die Engineering-Grundsätze der Core-Engine mit klar abgegrenzten Aussagen.
| Seite | Wofür Sie sie verwenden |
|---|---|
| Trust Center | Der Index dieser Aussagen. |
| Produktlizenzierung | Die Lizenzbedingungen des Open Core und der kommerziellen Editionen. |
| Marken- und Brand-Nutzung | Wie Name und Marken von NextPDF verwendet werden dürfen. |
| Datenverarbeitung, PII und Telemetrie | Was die Engine liest, speichert und übermittelt. |
| Sicherheitsmodell für Signaturen und Verschlüsselung | Das kryptografische Design mit seinen Grenzen. |
| Bedrohungsmodell für die Engine | Wovor sich die Engine schützt und wovor nicht. |
| Richtlinie zur Offenlegung von Schwachstellen | Wie Sie eine Schwachstelle melden. |
Projekt und Releases
Abschnitt betitelt „Projekt und Releases“| Seite | Wofür Sie sie verwenden |
|---|---|
| Changelog | Was sich in den einzelnen Releases geändert hat. |
| Changelog-Konventionen | Wie Changelog-Einträge geschrieben und klassifiziert werden. |
| Versionierung, Stabilität, Deprecation und Support-Policy | Die releaseübergreifenden Kompatibilitätszusagen. |
| Aufbau der NextPDF-Dokumentation | Struktur und Governance dieser Dokumentation. |
Glossar
Abschnitt betitelt „Glossar“Glossar – die in dieser Dokumentation verwendeten Begriffe, zentral definiert, damit ihre Verwendung in der gesamten Dokumentation einheitlich bleibt.
Vertrag für Referenzeinträge
Abschnitt betitelt „Vertrag für Referenzeinträge“Jeder API-Eintrag muss dieselben Fragen beantworten:
| Frage | Erforderliche Antwort |
|---|---|
| Was rufen Sie auf? | Vollständig qualifiziertes Symbol, Endpunkt, CLI-Befehl (Command-Line Interface, CLI) oder Konfigurationsschlüssel. |
| Welche Eingaben werden akzeptiert? | Parametertabelle mit Typ, Pflichtangabe, Standardwert und akzeptierten Werten. |
| Was passiert standardmäßig? | Das Verhalten, wenn optionale Eingaben weggelassen werden. |
| Was wird zurückgegeben? | Rückgabetyp, Response-Body, Dateiausgabe, Stream oder Nebeneffekt. |
| Was kann fehlschlagen? | Exception, Validierungsfehler, HTTP-Status oder operativer Fehlermodus. |
| Wie nutzen Sie es sicher? | Hinweise zu Sicherheit, Worker-Safety, Größenlimits, Pfaden, Timeouts und dem Umgang mit Secrets. |
Abdeckungsrichtlinie
Abschnitt betitelt „Abdeckungsrichtlinie“Referenzseiten zu API und Verhalten sind quellengestützt. Öffentliche APIs werden anhand von Paketquellcode, Konfigurationsdateien, Tests und Beispielen dokumentiert. Interne Hilfsklassen werden nur dann dokumentiert, wenn Anwendungsentwicklerinnen und -entwickler ihr Verhalten verstehen müssen, um das Paket zu konfigurieren oder zu betreiben.
Übersetzungsbereitschaft
Abschnitt betitelt „Übersetzungsbereitschaft“Referenzseiten verwenden bevorzugt Tabellen statt dichter Fließtextabsätze. Jede Zeile sollte für sich allein verständlich sein, da die spätere Segmentierung im Extensible Localization Interchange File Format (XLIFF) den Inhalt blockweise aufteilt.