Referentie
In één oogopslag
Sectie met titel “In één oogopslag”Referentiemateriaal beantwoordt concrete vragen: welk symbool, welke waarde, welk ondersteuningsniveau en welke clausule van toepassing is. Dit tabblad beschrijft het geverifieerde NextPDF-oppervlak: de modulereferentie, ondersteuningsmatrices, het API-oppervlak, de foutreferentie, standaardconformiteit en het beleid dat het project publiceert. Je leest hier niet hoe je een doel bereikt; gebruik daarvoor de Handleidingen of het Cookbook.
Referentiekaart
Sectie met titel “Referentiekaart”Core-engine
Sectie met titel “Core-engine”De nextpdf/core-engine, gedocumenteerd per module.
| Pagina | Waarvoor je het gebruikt |
|---|---|
| Core-engine-referentie | Het namespace-overzicht met alle modulepagina’s en de vier subfamilies. |
| Contracts: 41 publieke interfaces (SPI) | De publieke interfaces en enums met bijgehouden stabiliteit. |
| Core: Document-facade en concern-traits | De Document-facade en de Has*-traitfamilie. |
| HTML: renderingsubsysteem voor HTML+CSS naar PDF | De streaming-HTML-renderer met één doorgang. |
| Beveiliging: versleuteling, crypto-beleid en ondertekeningsoppervlak | Versleuteling, permissies en integratiepunten voor ondertekening. |
Renderingondersteuning
Sectie met titel “Renderingondersteuning”Wat de renderer verifieert, claimt, gedeeltelijk ondersteunt of niet ondersteunt.
| Pagina | Waarvoor je het gebruikt |
|---|---|
| CSS-ondersteuningsmatrix | Ondersteuningsniveaus per functie voor Cascading Style Sheets (CSS) in de HTML-pijplijn. |
| Niet-ondersteunde CSS-functies en workarounds | Wat buiten scope valt en wat je in plaats daarvan kunt gebruiken. |
| Matrix voor lettertype- en schriftondersteuning | Lettertypetechnologieën en ondersteuning voor schriftsystemen. |
| Ondersteuning voor verticaal CJK-schrift | Ondersteuning voor verticale writing-mode voor Chinese, Japanse en Koreaanse tekst. |
| Ondersteuning voor complex-script-shaping | Ondersteuning voor shaping in schriften die dat nodig hebben. |
API-oppervlak
Sectie met titel “API-oppervlak”Exacte symbolen, toegestane waarden en servicecontracten.
| Pagina | Waarvoor je het gebruikt |
|---|---|
| Enum-referentie | Elke publieke enum en de bijbehorende toegestane waarden. |
| TSA-configuratie | De standaard-tijdstempelautoriteit (Time-Stamping Authority, TSA) en hoe je deze wijzigt. |
| Connect REST API-referentie | De REST-endpoints van NextPDF Connect, gebaseerd op het OpenAPI 3.1-document. |
| Connect API-verkenner | De interactieve verkenner voor hetzelfde contract. |
De Application Programming Interface (API)-referenties per package vind je bij de bijbehorende packages: NextPDF Connect API-referentie, Index van integratie-API’s en API-referentie voor de Python-SDK op het tabblad Handleidingen.
Foutreferentie
Sectie met titel “Foutreferentie”Elke uitzondering die de engine opwerpt, ingedeeld per domein, met gestructureerde context en herstelrichtlijnen.
| Pagina | Waarvoor je het gebruikt |
|---|---|
| Foutreferentie | Het uitzonderingsmodel: NextPdfException als basis en het contextcontract. |
| Core- en algemene fouten | Documentlevenscyclus- en algemene engine-fouten. |
| Rendering- en I/O-fouten | HTML-, lettertype-, writer- en reader-fouten. |
| Beveiligings- en ondertekeningsfouten | Versleutelings-, ondertekenings- en PKI-fouten. |
| Runtime- en ondersteuningsfouten | HTTP-, veerkracht- en observeerbaarheidsfouten. |
| Accelerator-fouten | Fouten van de optionele acceleratie-sidecar. |
| Compliance-fouten | Fouten in tooling voor validatie en conformiteit. |
Conformiteit met standaarden
Sectie met titel “Conformiteit met standaarden”De standaardprofielen waarop NextPDF Core zich richt, telkens met de afbakening van de claim: de engine produceert uitvoer die bedoeld is om conform te zijn; een externe validator stelt de conformiteit vast.
| Pagina | Waarvoor je het gebruikt |
|---|---|
| Conformiteit met standaarden | De conformiteitspositie en de index van profielen. |
| PDF 2.0-conformiteit | De ISO 32000-2-baseline waarop de engine zich richt. |
| PDF/A-4-conformiteit | Conformiteit voor archivering, met de bijbehorende PDF/A-4-clausuletoewijzing. |
| PDF/UA-2-conformiteit | Conformiteit voor toegankelijkheid, met de bijbehorende PDF/UA-2-clausuletoewijzing. |
| PDF/X-conformiteit | Conformiteit voor printproductie. |
| PAdES-clausuletoewijzing | De ETSI EN 319 142-mapping van het baselineprofiel voor PDF-handtekeningen. |
| ZUGFeRD / Factur-X-conformiteit | Conformiteit voor hybride elektronische facturen. |
Vertrouwenscentrum
Sectie met titel “Vertrouwenscentrum”De engineeringpositie van de core-engine, met de afbakening van elke claim.
| Pagina | Waarvoor je het gebruikt |
|---|---|
| Vertrouwenscentrum | De index van deze positie. |
| Productlicentiëring | De licentievoorwaarden voor de open core en de commerciële edities. |
| Merk en merkgebruik | Hoe je de naam en merken van NextPDF mag gebruiken. |
| Gegevensverwerking, PII en telemetrie | Wat de engine leest, opslaat en verzendt. |
| Beveiligingsmodel voor ondertekening en versleuteling | Het cryptografische ontwerp en de grenzen daarvan. |
| Dreigingsmodel voor de engine | Waartegen de engine zich verdedigt en waartegen niet. |
| Beleid voor het melden van kwetsbaarheden | Hoe je een kwetsbaarheid meldt. |
Project en releases
Sectie met titel “Project en releases”| Pagina | Waarvoor je het gebruikt |
|---|---|
| Wijzigingslogboek | Wat per release is gewijzigd. |
| Changelog-conventies | Hoe changelog-vermeldingen worden opgesteld en geclassificeerd. |
| Versionering, stabiliteit, deprecation en supportbeleid | De compatibiliteitsbeloften tussen releases. |
| Zo is de documentatie van NextPDF opgebouwd | De structuur en het beheer van deze documentatieset. |
Woordenlijst
Sectie met titel “Woordenlijst”Woordenlijst — de termen die in deze documentatie worden gebruikt, één keer gedefinieerd voor hergebruik in de hele documentatie.
Contract voor referentievermeldingen
Sectie met titel “Contract voor referentievermeldingen”Elke API-vermelding moet dezelfde vragen beantwoorden:
| Vraag | Vereist antwoord |
|---|---|
| Wat roep ik aan? | Een volledig gekwalificeerd symbool, endpoint, command-line interface (CLI)-opdracht of configuratiesleutel. |
| Welke invoer wordt geaccepteerd? | Een parametertabel met het type, of de parameter verplicht is, de standaardwaarde en de geaccepteerde waarden. |
| Wat gebeurt er standaard? | Het gedrag wanneer optionele invoer wordt weggelaten. |
| Wat komt er terug? | Het retourtype, de responsbody, bestandsuitvoer, een stream of een neveneffect. |
| Wat kan er misgaan? | Een uitzondering, validatiefout, HTTP-status of operationele foutmodus. |
| Hoe gebruik ik het veilig? | Opmerkingen over beveiliging, worker-veiligheid, groottelimieten, paden, time-outs en omgaan met secrets. |
Dekkingsbeleid
Sectie met titel “Dekkingsbeleid”Referentiepagina’s over API’s en gedrag zijn gebaseerd op bronnen. Publieke API’s worden gedocumenteerd op basis van de packagebroncode, configuratiebestanden, tests en voorbeelden. Interne hulpklassen worden alleen gedocumenteerd wanneer applicatieontwikkelaars hun gedrag moeten begrijpen om het package te configureren of te gebruiken.
Vertaalgereedheid
Sectie met titel “Vertaalgereedheid”Referentiepagina’s gebruiken bij voorkeur tabellen in plaats van tekstzware alinea’s. Elke rij moet op zichzelf kunnen staan, omdat latere Extensible Localization Interchange File Format (XLIFF)-segmentatie de inhoud per blok opsplitst.