Dokumentacja referencyjna
W skrócie
Dział zatytułowany „W skrócie”Materiały referencyjne odpowiadają na konkretne pytania: który symbol, która wartość, który poziom obsługi, która klauzula. Ta sekcja obejmuje zweryfikowany zakres NextPDF: dokumentację modułów, macierze obsługi, obszar API, dokumentację błędów, zgodność ze standardami oraz zasady publikowane przez projekt. Nie wyjaśnia, jak osiągnąć cel; do tego służą Przewodniki lub Receptariusz.
Mapa dokumentacji referencyjnej
Dział zatytułowany „Mapa dokumentacji referencyjnej”Silnik Core
Dział zatytułowany „Silnik Core”Silnik nextpdf/core opisany według modułów.
| Strona | Do czego służy |
|---|---|
| Dokumentacja silnika Core | Mapa przestrzeni nazw: wszystkie strony modułów i cztery podrodziny. |
| Kontrakty: 41 publicznych interfejsów (SPI) | Publiczne interfejsy i typy wyliczeniowe, których stabilność jest śledzona. |
| Core: fasada Document + cechy odpowiedzialności | Fasada Document oraz rodzina cech Has*. |
| HTML: podsystem renderowania HTML+CSS do PDF | Jednoprzebiegowy, strumieniowy mechanizm renderowania HTML. |
| Bezpieczeństwo: szyfrowanie, polityka kryptograficzna i obszar podpisywania | Szyfrowanie, uprawnienia i punkty integracji z podpisywaniem. |
Obsługa renderowania
Dział zatytułowany „Obsługa renderowania”Co mechanizm renderujący weryfikuje, deklaruje, obsługuje częściowo lub czego nie obsługuje.
| Strona | Do czego służy |
|---|---|
| Macierz obsługi CSS | Poziomy obsługi poszczególnych funkcji Cascading Style Sheets (CSS) w potoku HTML. |
| Nieobsługiwane funkcje CSS i ich obejścia | Co pozostaje poza zakresem i czego użyć w zamian. |
| Macierz obsługi czcionek i pism | Technologie czcionek i obsługiwane systemy pisma. |
| Obsługa pionowego pisma CJK | Obsługa pionowego trybu pisania dla tekstu chińskiego, japońskiego i koreańskiego. |
| Obsługa kształtowania pism złożonych | Obsługa kształtowania systemów pisma, które tego wymagają. |
Obszar API
Dział zatytułowany „Obszar API”Dokładne symbole, dozwolone wartości i kontrakty usług.
| Strona | Do czego służy |
|---|---|
| Referencja enumów | Każdy publiczny typ wyliczeniowy i jego dozwolone wartości. |
| Konfiguracja TSA | Domyślny urząd znakowania czasem (TSA) oraz sposób jego zmiany. |
| Dokumentacja REST API Connect | Punkty końcowe REST w NextPDF Connect, na podstawie dokumentu OpenAPI 3.1. |
| Eksplorator API Connect | Interaktywny eksplorator tego samego kontraktu. |
Dokumentacja interfejsów programistycznych (API) na poziomie pakietów jest dostępna przy odpowiednich pakietach: Dokumentacja API Connect, Indeks API integracji oraz Dokumentacja API pakietu Python SDK w sekcji Przewodniki.
Dokumentacja błędów
Dział zatytułowany „Dokumentacja błędów”Każdy wyjątek zgłaszany przez silnik, pogrupowany według domeny, wraz z ustrukturyzowanym kontekstem i wskazówkami dotyczącymi odzyskiwania.
| Strona | Do czego służy |
|---|---|
| Dokumentacja błędów | Model wyjątków: bazowy wyjątek NextPdfException i kontrakt kontekstu. |
| Błędy core i ogólne | Cykl życia dokumentu i ogólne awarie silnika. |
| Błędy renderowania i wejścia/wyjścia | Awarie HTML, czcionek, zapisywania i odczytu. |
| Błędy bezpieczeństwa i podpisywania | Awarie szyfrowania, podpisywania i PKI. |
| Błędy środowiska wykonawczego i wsparcia | Awarie związane z HTTP, odpornością i obserwowalnością. |
| Błędy akceleratora | Awarie opcjonalnego sidecara akceleracji. |
| Błędy zgodności | Awarie walidacji i narzędzi zgodności. |
Zgodność ze standardami
Dział zatytułowany „Zgodność ze standardami”Profile standardów, na które ukierunkowany jest NextPDF Core, z jasno określoną granicą dla każdego z nich: silnik generuje dane wyjściowe z myślą o zgodności; rozstrzyga ją zewnętrzny walidator.
| Strona | Do czego służy |
|---|---|
| Zgodność ze standardami | Stanowisko dotyczące zgodności i indeks profili. |
| Zgodność z PDF 2.0 | Bazowy zakres ISO 32000-2, na który ukierunkowany jest silnik. |
| Zgodność z PDF/A-4 | Zgodność na potrzeby archiwizacji; zobacz Mapa klauzul PDF/A-4. |
| Zgodność z PDF/UA-2 | Zgodność w zakresie dostępności; zobacz Mapa klauzul PDF/UA-2. |
| Zgodność z PDF/X | Zgodność w zakresie produkcji poligraficznej. |
| Mapa klauzul PAdES | Mapowanie profilu bazowego ETSI EN 319 142 dla podpisów PDF. |
| Zgodność z ZUGFeRD / Factur-X | Zgodność na potrzeby hybrydowych faktur elektronicznych. |
Centrum zaufania
Dział zatytułowany „Centrum zaufania”Stanowisko inżynierskie dotyczące silnika Core oraz zakres każdego twierdzenia.
| Strona | Do czego służy |
|---|---|
| Centrum zaufania | Indeks stanowisk. |
| Licencjonowanie produktu | Warunki licencji otwartego rdzenia i edycji komercyjnych. |
| Znak towarowy i korzystanie z marki | Jak używać nazwy i znaków NextPDF. |
| Obsługa danych, PII i telemetrii | Co silnik odczytuje, przechowuje i przesyła. |
| Model bezpieczeństwa podpisywania i szyfrowania | Projekt kryptograficzny i jego ograniczenia. |
| Model zagrożeń silnika | Przed czym silnik się broni, a przed czym nie. |
| Zasady ujawniania podatności | Sposób zgłaszania podatności. |
Projekt i wydania
Dział zatytułowany „Projekt i wydania”| Strona | Do czego służy |
|---|---|
| Dziennik zmian | Co zmieniło się w każdym wydaniu. |
| Konwencje dziennika zmian | Jak są zapisywane i klasyfikowane wpisy dziennika zmian. |
| Polityka wersjonowania, stabilności, deprecjacji i wsparcia | Gwarancje kompatybilności między wydaniami. |
| Jak jest zorganizowana dokumentacja NextPDF | Struktura tego zestawu dokumentacji i zarządzanie nim. |
Słownik
Dział zatytułowany „Słownik”Słownik — terminy używane w tej dokumentacji, zdefiniowane w jednym miejscu i linkowane w całym zestawie dokumentacji.
Kontrakt wpisu w dokumentacji referencyjnej
Dział zatytułowany „Kontrakt wpisu w dokumentacji referencyjnej”Każdy wpis API musi odpowiadać na ten sam zestaw pytań:
| Pytanie | Wymagana odpowiedź |
|---|---|
| Co należy wywołać? | W pełni kwalifikowany symbol, punkt końcowy, polecenie interfejsu wiersza poleceń (CLI) albo klucz konfiguracyjny. |
| Jakie dane wejściowe są akceptowane? | Tabela parametrów z typem, informacją o tym, czy parametr jest wymagany, wartością domyślną oraz akceptowanymi wartościami. |
| Co dzieje się domyślnie? | Zachowanie po pominięciu opcjonalnych danych wejściowych. |
| Co jest zwracane? | Typ zwracany, treść odpowiedzi, plik wyjściowy, strumień lub efekt uboczny. |
| Co może zakończyć się niepowodzeniem? | Wyjątek, błąd walidacji, status HTTP lub tryb awarii operacyjnej. |
| Jak bezpiecznie tego używać? | Uwagi dotyczące bezpieczeństwa, bezpieczeństwa procesów roboczych, limitów rozmiaru, ścieżek, limitu czasu oraz obsługi danych poufnych. |
Zasady określania zakresu dokumentacji
Dział zatytułowany „Zasady określania zakresu dokumentacji”Strony referencyjne dotyczące API i zachowania są oparte na źródłach. Publiczne interfejsy API są dokumentowane na podstawie kodu źródłowego pakietu, plików konfiguracyjnych, testów oraz przykładów. Wewnętrzne klasy pomocnicze są dokumentowane tylko wtedy, gdy programiści aplikacji muszą rozumieć ich działanie, aby skonfigurować pakiet lub nim zarządzać.
Gotowość do tłumaczenia
Dział zatytułowany „Gotowość do tłumaczenia”Na stronach dokumentacji referencyjnej preferuje się tabele zamiast zwartych akapitów. Każdy wiersz powinien być zrozumiały sam w sobie, ponieważ późniejsza segmentacja w formacie Extensible Localization Interchange File Format (XLIFF) podzieli treść na bloki.