リファレンス
リファレンス資料は、厳密な問いに答えるためのものです。対象のシンボルは何か、どの値を使うのか、サポートレベルは何か、該当する箇条はどれか。このタブでは、NextPDF の検証済みサーフェスを整理しています。対象には、モジュールリファレンス、サポートマトリクス、API サーフェス、エラーリファレンス、標準への適合性、プロジェクトが公開するポリシーが含まれます。ここでは、目標に到達する 方法 は扱いません。その場合は ガイド または クックブック を参照してください。
リファレンスマップ
「リファレンスマップ」という見出しのセクションコアエンジン
「コアエンジン」という見出しのセクションnextpdf/core エンジンをモジュールごとにドキュメント化しています。
| ページ | 用途 |
|---|---|
| Core エンジンリファレンス | 名前空間のマップ。すべてのモジュールページと 4 つのサブファミリーを示します。 |
| コントラクト：41 個の公開インターフェイス（SPI） | 安定性の追跡対象である公開インターフェイスと列挙型。 |
| Core: Document ファサードと concern トレイト | Document ファサードと Has* トレイトファミリー。 |
| HTML: HTML+CSS から PDF へのレンダリングサブシステム | シングルパスのストリーミング HTML レンダラー。 |
| セキュリティ: 暗号化、暗号ポリシー、署名サーフェス | 暗号化、権限、署名の統合箇所。 |
レンダリングサポート
「レンダリングサポート」という見出しのセクションレンダラーが検証する対象、表明する対象、部分的にサポートする対象、サポートしない対象を示します。
| ページ | 用途 |
|---|---|
| CSS サポートマトリクス | HTML パイプラインにおける機能別の Cascading Style Sheets（CSS）サポートレベル。 |
| サポートされていない CSS 機能と回避策 | 対象外の範囲と、代替として取るべき方法。 |
| フォントと文字体系のサポートマトリックス | フォント技術と文字体系のサポート。 |
| CJK 縦書きのサポート | 中国語、日本語、韓国語テキストに対する縦書きモードのサポート。 |
| 複雑なスクリプトのシェイピング対応 | シェイピングが必要な文字体系向けのサポート。 |
API サーフェス
「API サーフェス」という見出しのセクション正確なシンボル、許可値、サービスコントラクトを示します。
| ページ | 用途 |
|---|---|
| Enum リファレンス | すべての公開列挙型とその許可値。 |
| TSA の設定 | デフォルトのタイムスタンプ局（TSA）と、その変更方法。 |
| Connect REST API リファレンス | OpenAPI 3.1 ドキュメントに基づく、NextPDF Connect の REST エンドポイント。 |
| Connect API エクスプローラー | 同じコントラクトを扱うインタラクティブなエクスプローラー。 |
パッケージレベルの Application Programming Interface（API）リファレンスは、各パッケージ内に配置されています。ガイドタブには、Connect API リファレンス、統合 API インデックス、Python SDK API リファレンス があります。
エラーリファレンス
「エラーリファレンス」という見出しのセクションエンジンが送出するすべての例外をドメイン別に整理し、構造化されたコンテキストと復旧のためのガイダンスを添えて掲載しています。
| ページ | 用途 |
|---|---|
| エラーリファレンス | 例外モデル。NextPdfException 基底クラスとコンテキストコントラクト。 |
| コアおよび一般のエラー | ドキュメントライフサイクルと一般的なエンジンの障害。 |
| レンダリングおよび I/O のエラー | HTML、フォント、ライター、リーダーの障害。 |
| セキュリティおよび署名のエラー | 暗号化、署名、PKI の障害。 |
| ランタイムおよびサポートのエラー | HTTP、レジリエンス、可観測性の障害。 |
| Accelerator のエラー | オプションのアクセラレーションサイドカーの障害。 |
| 準拠のエラー | 検証および適合性ツールの障害。 |
標準への適合性
「標準への適合性」という見出しのセクション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 適合性 | ハイブリッド電子請求書の適合性。 |
トラストセンター
「トラストセンター」という見出しのセクションコアエンジンのエンジニアリング上の方針と、各主張の境界を示します。
| ページ | 用途 |
|---|---|
| トラストセンター | 方針の索引。 |
| 製品ライセンス | オープンコアおよび商用エディションのライセンス条項。 |
| 商標とブランドの使用 | NextPDF の名称とマークの使用方法。 |
| データの取り扱い、PII、テレメトリ | エンジンが読み取り、保存し、送信する対象。 |
| 署名と暗号化のセキュリティモデル | 暗号設計とその限界。 |
| エンジンの脅威モデル | エンジンが防御する対象と防御しない対象。 |
| 脆弱性開示ポリシー | 脆弱性の報告方法。 |
プロジェクトとリリース
「プロジェクトとリリース」という見出しのセクション| ページ | 用途 |
|---|---|
| 変更履歴 | 各リリースの変更点。 |
| 変更履歴の規約 | 変更履歴エントリの書き方と分類方法。 |
| バージョニング、安定性、非推奨、サポートポリシー | リリース間の互換性に関する約束。 |
| NextPDF ドキュメントの構成 | このドキュメントセットの構成とガバナンス。 |
用語集 — このドキュメントで使用する用語を一元的に定義し、各所からリンクしています。
リファレンスエントリの規約
「リファレンスエントリの規約」という見出しのセクションすべての API エントリは、同じ問いに答えられるようにします。
| 問い | 必須の回答 |
|---|---|
| 何を呼び出すか。 | 完全修飾シンボル、エンドポイント、コマンドラインインターフェイス（CLI）コマンド、または構成キー。 |
| どの入力を受け付けるか。 | 型、必須かどうか、デフォルト、許可される値を含むパラメータテーブル。 |
| デフォルトでは何が起こるか。 | 省略可能な入力を省略した場合の動作。 |
| 何が返されるか。 | 戻り値の型、レスポンスボディ、ファイル出力、ストリーム、または副作用。 |
| どのような失敗が起こり得るか。 | 例外、検証エラー、HTTP ステータス、または運用上の障害モード。 |
| 安全に使用するにはどうするか。 | セキュリティ、ワーカーの安全性、サイズ上限、パス、タイムアウト、シークレットの取り扱いに関する注意事項。 |
網羅範囲ポリシー
「網羅範囲ポリシー」という見出しのセクションAPI および動作のリファレンスページは、ソースで裏付けられています。公開 API は、パッケージのソース、構成ファイル、テスト、サンプルに基づいてドキュメント化されます。内部ヘルパークラスは、アプリケーション開発者がパッケージを構成または運用するうえで、その動作を理解する必要がある場合にのみドキュメント化されます。
翻訳への対応状況
「翻訳への対応状況」という見出しのセクションリファレンスページでは、情報量の多い段落よりもテーブルを優先します。後続工程の Extensible Localization Interchange File Format（XLIFF）セグメンテーションでは内容がブロック単位で分割されるため、各行だけで意味が通じるようにする必要があります。