PDFLang ドキュメント — 日本語
.pdfl 言語と pdfl CLI の完全ガイド — バージョン 0.6.0。
本ドキュメントのすべての例は、実行可能でコメント付きのコードです。この言語が 初めての方は、第1章のマニュアルから読み進め、残りはリファレンスとしてご利用 ください。
ツールの表示言語について。
pdflのメッセージ(診断、エラー、CLI ヘルプ、 レポートのラベル)は英語です。コマンドラインツールの標準に従っています。 本ドキュメントは日本語ですが、チェックが失敗するとpage 7: 324% ink (limit 300%)のように表示されます。スクリプトにご自身が 書いたメッセージは、書いた言語のまま出力されます。
目次
| 章 | 内容 |
|---|---|
| 1. 言語 | 完全マニュアル:check、アサーション、型、単位、ブロック、関数、import、rule |
| 2. ドキュメント型 | doc、page、font、image、region — 全プロパティとメソッド |
3. text:: |
テキスト:抽出、正規化、検索、ブラジル固有の検証、個人情報 |
4. struct:: |
構造とメタデータ:オブジェクト、XMP、セキュリティ、ハッシュ |
5. visual:: |
画像:解像度、視覚比較、pHash、SSIM、品質 |
6. prepress:: |
印刷前検査:インク総量、分版、特色、フォント、ボックス |
7. codes:: |
バーコードと QR コード:検出、デコード、検証 |
8. fix:: |
正規化:ボックス、ページ、透かし、結合/分割、最適化 |
9. data:: |
外部データ:用語集、データセット、参照テーブル |
| 10. 標準ライブラリ | リストと文字列のメソッド、グローバル関数 |
| 11. CLI コマンド | run、compare、watch、fix、inspect、lint、fmt、doc、pack、add |
| 12. レシピ | 実例:印刷会社、法務出版社、製薬会社、CI/CD |
30秒で始める
my_profile.pdfl を作成します:
// すべてのスクリプトは check のリストです。各 check は関連する検証を
// まとめ、レポートの1セクションになります。
check "Basic structure" {
// require: 式そのものからメッセージが自動生成されます
require doc.page_count > 0
// assert: 自分で書いたメッセージで失敗します
assert doc.title != "", "PDF has no title in its metadata"
}
実行します:
pdfl run my_profile.pdfl document.pdf
レポートは JSON として標準出力に出ます。終了コードで結果がわかります:
0 すべて合格、1 警告のみ、2 検証エラー、3 構文エラー。
本書の表記について
- 各関数はシグネチャ、動作、戻り値、コメント付きの例とともに 記載されています。
- 角かっこ内の引数は省略可能です:
calculate_tac([page])。 - 「1 起点」とは、最初のページが
0ではなく1であることを意味します — この言語はプログラマではなく、人がページを数えるやり方に合わせています。 - 寸法は常にポイント単位です(1 pt = 1/72 インチ)。単位リテラル
(
3mm、1in)を使えば自動で変換されます。
他の言語: English · Português (Brasil) · スペイン語 · 中文 · Français · العربية · Deutsch