Referensi
Gambaran umum
Bagian berjudul “Gambaran umum”Materi referensi menjawab pertanyaan spesifik: simbol mana, nilai apa, tingkat dukungan apa, dan klausa mana. Tab ini memuat permukaan NextPDF yang telah diverifikasi: referensi modul, matriks dukungan, permukaan API, referensi kesalahan, kesesuaian standar, dan kebijakan proyek yang diterbitkan. Referensi bukan jalur berorientasi tugas; saat Anda ingin mencapai suatu tujuan, bukan sekadar mencari satu fakta, gunakan Panduan atau Buku resep.
Peta referensi
Bagian berjudul “Peta referensi”Mesin inti
Bagian berjudul “Mesin inti”Mesin nextpdf/core didokumentasikan per modul.
| Halaman | Gunakan untuk |
|---|---|
| Referensi mesin core | Peta namespace untuk setiap halaman modul dan empat subkeluarganya. |
| Contracts: 41 antarmuka publik (SPI) | Antarmuka publik dan enum yang stabilitasnya dilacak. |
| Core: facade Document + concern-trait | Facade Document dan kelompok trait Has*. |
| HTML: subsistem rendering HTML+CSS ke PDF | Renderer HTML streaming dalam satu lintasan. |
| Keamanan: enkripsi, kebijakan kripto, dan permukaan penandatanganan | Enkripsi, izin, dan titik integrasi penandatanganan. |
Dukungan rendering
Bagian berjudul “Dukungan rendering”Apa saja yang telah diverifikasi, diklaim, didukung sebagian, atau tidak didukung oleh renderer.
| Halaman | Gunakan untuk |
|---|---|
| Matriks dukungan CSS | Tingkat dukungan Cascading Style Sheets (CSS) per fitur dalam alur HTML. |
| Fitur CSS yang tidak didukung dan solusinya | Apa yang berada di luar cakupan dan apa yang harus dilakukan sebagai alternatifnya. |
| Matriks dukungan font dan aksara | Teknologi font dan dukungan sistem penulisan. |
| Dukungan penulisan vertikal CJK | Dukungan mode penulisan vertikal untuk teks Tionghoa, Jepang, dan Korea. |
| Dukungan shaping skrip-kompleks | Dukungan shaping untuk aksara yang membutuhkannya. |
Permukaan API
Bagian berjudul “Permukaan API”Simbol yang tepat, nilai yang diizinkan, dan kontrak layanan.
| Halaman | Gunakan untuk |
|---|---|
| Referensi enum | Setiap enum publik dan nilai yang diizinkannya. |
| Konfigurasi TSA | Otoritas stempel waktu (TSA) bawaan dan cara mengubahnya. |
| Referensi Connect REST API | Endpoint REST NextPDF Connect berdasarkan dokumen OpenAPI 3.1. |
| Penjelajah Connect API | Penjelajah interaktif untuk kontrak yang sama. |
Referensi antarmuka pemrograman aplikasi (API) tingkat paket ditempatkan bersama paket masing-masing: Referensi API Connect, Indeks API integrasi, dan Referensi API SDK Python di tab Panduan.
Referensi kesalahan
Bagian berjudul “Referensi kesalahan”Setiap pengecualian yang dilemparkan oleh mesin dikelompokkan menurut domain, lengkap dengan konteks terstruktur dan panduan pemulihan.
| Halaman | Gunakan untuk |
|---|---|
| Referensi kesalahan | Model pengecualian: kelas dasar NextPdfException dan kontrak konteks. |
| Kesalahan inti dan umum | Kegagalan siklus hidup dokumen dan kegagalan umum mesin. |
| Kesalahan rendering dan I/O | Kegagalan pada HTML, font, writer, dan reader. |
| Kesalahan keamanan dan penandatanganan | Kegagalan enkripsi, penandatanganan, dan PKI. |
| Kesalahan runtime dan pendukung | Kegagalan HTTP, ketahanan, dan observabilitas. |
| Kesalahan Accelerator | Kegagalan sidecar akselerasi opsional. |
| Kesalahan kepatuhan | Kegagalan validasi dan alat kesesuaian. |
Kesesuaian standar
Bagian berjudul “Kesesuaian standar”Profil standar yang ditargetkan oleh NextPDF Core, masing-masing dengan batasan yang dijelaskan: mesin menghasilkan keluaran yang dimaksudkan untuk sesuai; validator eksternal yang menentukan kesesuaiannya.
| Halaman | Gunakan untuk |
|---|---|
| Kesesuaian standar | Postur kesesuaian dan indeks profil. |
| Kesesuaian PDF 2.0 | Baseline ISO 32000-2 yang ditargetkan oleh mesin. |
| Kesesuaian PDF/A-4 | Kesesuaian arsip, dengan Pemetaan klausa PDF/A-4. |
| Kesesuaian PDF/UA-2 | Konformansi aksesibilitas, dengan Pemetaan klausa PDF/UA-2. |
| Kesesuaian PDF/X | Kesesuaian produksi cetak. |
| Pemetaan klausa PAdES | Pemetaan profil baseline ETSI EN 319 142 untuk tanda tangan PDF. |
| Kesesuaian ZUGFeRD / Factur-X | Kesesuaian faktur elektronik hibrida. |
Pusat Kepercayaan
Bagian berjudul “Pusat Kepercayaan”Postur rekayasa mesin inti, beserta batasan setiap klaim.
| Halaman | Gunakan untuk |
|---|---|
| Pusat Kepercayaan | Indeks postur kepercayaan. |
| Lisensi produk | Ketentuan lisensi untuk open core dan edisi komersial. |
| Merek dagang dan penggunaan brand | Bagaimana nama dan merek NextPDF boleh digunakan. |
| Penanganan data, PII, dan telemetri | Apa yang dibaca, disimpan, dan dikirimkan oleh mesin. |
| Model keamanan untuk tanda tangan dan enkripsi | Desain kriptografis dan batasannya. |
| Model ancaman mesin | Apa yang dilindungi oleh mesin dan apa yang tidak. |
| Kebijakan pengungkapan kerentanan | Cara melaporkan kerentanan. |
Proyek dan rilis
Bagian berjudul “Proyek dan rilis”| Halaman | Gunakan untuk |
|---|---|
| Catatan Perubahan | Perubahan pada setiap rilis. |
| Konvensi changelog | Bagaimana entri changelog ditulis dan diklasifikasikan. |
| Kebijakan versioning, stabilitas, deprecation, dan dukungan | Komitmen kompatibilitas lintas rilis. |
| Cara dokumentasi NextPDF disusun | Struktur dan tata kelola rangkaian dokumentasi ini. |
Glosarium
Bagian berjudul “Glosarium”Glosarium — istilah-istilah yang digunakan dalam dokumentasi ini, didefinisikan sekali agar dapat digunakan kembali di seluruh dokumentasi.
Kontrak entri referensi
Bagian berjudul “Kontrak entri referensi”Setiap entri API harus menjawab pertanyaan yang sama:
| Pertanyaan | Jawaban yang diperlukan |
|---|---|
| Apa yang saya panggil? | Simbol dengan nama lengkap, endpoint, perintah antarmuka baris perintah (CLI), atau kunci konfigurasi. |
| Input apa yang diterima? | Tabel parameter yang memuat tipe, status wajib, nilai default, dan nilai yang diterima. |
| Apa perilaku standarnya? | Perilaku saat input opsional tidak diberikan. |
| Apa yang dikembalikan? | Tipe nilai kembali, isi respons, keluaran berkas, aliran, atau efek samping. |
| Apa saja yang dapat gagal? | Pengecualian, kesalahan validasi, status HTTP, atau mode kegagalan operasional. |
| Bagaimana cara menggunakannya dengan aman? | Catatan tentang keamanan, keamanan worker, batas ukuran, path, timeout, dan penanganan rahasia. |
Kebijakan cakupan
Bagian berjudul “Kebijakan cakupan”Halaman referensi API dan perilaku didukung oleh sumber rujukan. API publik didokumentasikan berdasarkan kode sumber paket, berkas konfigurasi, pengujian, dan contoh. Kelas pembantu internal hanya didokumentasikan ketika pengembang aplikasi perlu memahami perilakunya untuk mengonfigurasi atau mengoperasikan paket.
Kesiapan terjemahan
Bagian berjudul “Kesiapan terjemahan”Halaman referensi mengutamakan tabel alih-alih paragraf padat. Setiap baris harus dapat berdiri sendiri karena segmentasi Extensible Localization Interchange File Format (XLIFF) nantinya akan memecah konten per blok.