參考資料
參考資料用來回答精確問題:要使用哪個符號、哪個值、哪種支援層級、哪一項條款。本頁彙整 NextPDF 已驗證的介面範圍:模組參考、支援對照表、API 介面、錯誤參考、標準一致性,以及本專案發布的各項政策。這裡不說明如何達成目標;如需操作步驟,請改用 指南或 Cookbook(範例指南)。
參考地圖
標題為「參考地圖」的區段核心引擎
標題為「核心引擎」的區段逐一介紹 nextpdf/core 引擎的各項模組。
| 頁面 | 用途 |
|---|---|
| 核心引擎參考 | 命名空間導覽:各模組頁面與四個子系列。 |
| 契約:41 個公開介面(SPI) | 納入穩定性追蹤的公開介面與列舉。 |
| Core:Document 門面與職責 trait | Document 門面與 Has* trait 家族。 |
| HTML:HTML+CSS 轉 PDF 繪製子系統 | 單趟串流式 HTML 繪製器。 |
| 安全性:加密、加密政策與簽章介面 | 加密、權限與簽章的整合點。 |
繪製支援
標題為「繪製支援」的區段列出繪製器對各項功能的支援狀態:已驗證、已宣稱、部分支援,或不支援。
| 頁面 | 用途 |
|---|---|
| CSS 支援對照表 | HTML 管線中各項 Cascading Style Sheets(CSS)功能的支援層級。 |
| 不支援的 CSS 功能與替代做法 | 哪些功能不屬於支援範圍,以及可改用的替代做法。 |
| 字型與文字系統支援對照表 | 字型技術與書寫系統的支援情形。 |
| CJK 直書支援 | 中文、日文與韓文文字的直書 writing-mode 支援。 |
| 複雜書寫系統字形塑形支援 | 針對需要字形塑形的書寫系統提供字形塑形支援。 |
API 介面
標題為「API 介面」的區段精確列出符號、允許的值與服務合約。
| 頁面 | 用途 |
|---|---|
| 列舉參考 | 每個公開列舉及其允許的值。 |
| TSA 設定 | 預設的 Time-Stamping Authority(TSA)及其變更方式。 |
| Connect REST API 參考 | NextPDF Connect 的 REST endpoint,取自 OpenAPI 3.1 文件。 |
| Connect API 探索器 | 同一份合約的互動式探索器。 |
套件層級的 Application Programming Interface(API)參考資料放在各套件所在的位置,也就是「指南」分頁中的 Connect API 參考、整合 API 索引 與 Python SDK API 參考資料。
錯誤參考
標題為「錯誤參考」的區段引擎拋出的每一種例外都會依領域分類,並附上結構化情境與復原指引。
| 頁面 | 用途 |
|---|---|
| 錯誤參考 | 例外模型:NextPdfException 基底類別與情境合約。 |
| 核心與一般錯誤 | 文件生命週期與一般引擎失敗。 |
| 繪製與 I/O 錯誤 | HTML、字型、寫入器與讀取器的失敗。 |
| 安全性與簽署錯誤 | 加密、簽署與 PKI 的失敗。 |
| 執行階段與支援錯誤 | HTTP、韌性與可觀測性的失敗。 |
| Accelerator 錯誤 | 選用加速 sidecar 的失敗。 |
| 合規錯誤 | 驗證與一致性工具的失敗。 |
標準一致性
標題為「標準一致性」的區段NextPDF Core 鎖定的各項標準設定檔;每一項都明確界定其邊界:引擎產出的是意圖符合規範的輸出,一致性則由外部驗證器判定。
| 頁面 | 用途 |
|---|---|
| 標準符合性 | 一致性立場與設定檔索引。 |
| PDF 2.0 符合性 | 引擎鎖定的 ISO 32000-2 基準。 |
| PDF/A-4 符合性 | 封存一致性,並附上 PDF/A-4 條款對映。 |
| PDF/UA-2 符合性 | 無障礙一致性,並附上 PDF/UA-2 條款對映。 |
| PDF/X 符合性 | 印刷生產一致性。 |
| PAdES 條款對映 | PDF 簽章的 ETSI EN 319 142 基準設定檔對映。 |
| ZUGFeRD / Factur-X 符合性 | 混合式電子發票一致性。 |
信任中心
標題為「信任中心」的區段說明核心引擎的工程立場,並界定各項聲明的邊界。
| 頁面 | 用途 |
|---|---|
| 信任中心 | 各項立場的索引。 |
| 產品授權 | open core 與各商業版本的授權條款。 |
| 商標與品牌使用 | NextPDF 名稱與標誌的使用方式。 |
| 資料處理、PII 與遙測 | 引擎會讀取、儲存與傳輸哪些資料。 |
| 簽章與加密安全模型 | 加密設計及其限制。 |
| 引擎威脅模型 | 引擎防禦哪些威脅,又不防禦哪些。 |
| 漏洞揭露政策 | 如何回報漏洞。 |
專案與版本發布
標題為「專案與版本發布」的區段| 頁面 | 用途 |
|---|---|
| 變更紀錄 | 每個版本有哪些變更。 |
| 變更日誌慣例 | 變更日誌項目的撰寫與分類方式。 |
| 版本控管、穩定性、棄用與支援政策 | 跨版本的相容性承諾。 |
| NextPDF 文件組織結構 | 本文件集的結構與治理方式。 |
詞彙表
標題為「詞彙表」的區段詞彙表:本文件所使用的術語會在此各自定義一次,並於各處加上連結。
參考項目合約
標題為「參考項目合約」的區段每個 API 項目都必須回答同一組固定問題:
| 問題 | 必填答案 |
|---|---|
| 我要呼叫什麼? | 具完整限定名稱的符號、endpoint、command-line interface(CLI)指令或組態鍵。 |
| 接受哪些輸入? | 包含型別、是否必填、預設值與可接受值的參數表格。 |
| 預設會發生什麼? | 省略選填輸入時會採取的行為。 |
| 會回傳什麼? | 回傳型別、回應內容、檔案輸出、stream 或副作用。 |
| 可能在哪裡失敗? | 例外、驗證錯誤、HTTP 狀態碼或維運層級的失敗模式。 |
| 我要怎麼安全地使用它? | 安全性、worker 安全性、大小限制、路徑、逾時與密鑰處理等注意事項。 |
涵蓋範圍政策
標題為「涵蓋範圍政策」的區段API 與行為參考頁面皆以原始碼為依據。公開 API 文件根據套件原始碼、組態檔、測試與範例撰寫而成。只有當應用程式開發者必須理解內部輔助類別的行為,才能設定或操作該套件時,才會為這些類別撰寫文件。
翻譯就緒度
標題為「翻譯就緒度」的區段參考頁面優先使用表格,而非密集段落。每一列都應能獨立理解,因為後續的 Extensible Localization Interchange File Format(XLIFF)段落切分會依區塊拆分內容。