章 3 · 部 II · 技法
Postextの設定
Postextの設定のしくみと、20ページに分かれたリファレンスのどこで各設定を説明しているかの案内
かんたんな説明
このページは、ページの見た目を決めるすべての設定を載せたリファレンスの入口です。ページの大きさ、段の数、フォント、文字の大きさ、見出し、囲み、色など、すべての選択は1つの設定のまとまりに入っています。どの設定にも最初から無理のない値が入っているので、書くのは変えたいものだけです。リファレンスは20のページに分かれています。このページの一覧にはすべての節へのリンクがあるので、必要なところへ直接移動してください。
Postextのレイアウトに関する判断は、すべて1つの設定オブジェクトで決まります。
PostextConfigは、ページの寸法、段組み、本文の文字組み、見出しのスタイル、文書の言語(locale)などを制御します。プロパティはすべて省略できます。Postextには伝統的な書籍組版にならった無理のない既定値が用意されているので、指定するのは変えたい項目だけで済みます。
import { buildDocument } from 'postext';
const document = buildDocument(content, {
page: { sizePreset: '21x28', dpi: 300 },
layout: { layoutType: 'double', gutterWidth: { value: 0.5, unit: 'cm' } },
bodyText: { fontFamily: 'EB Garamond', fontSize: { value: 9, unit: 'pt' } }, // 9 pt overrides the 8 pt default
headings: { fontFamily: 'Open Sans' },
});エンジンがこの設定をどう処理するかの概要は、アーキテクチャーのページを参照してください。
#内容一覧
このリファレンスは20のページに分かれています。以下の各グループが1つのページで、その下にそのページの節を挙げます。
- ページ:サイズ、余白、ベースライングリッド、トンボ、ノンブル、綴じ。
- レイアウト:段数、段間、段間罫、縦組み。
- 抜き加工:
dieCuts。1丁または複数の丁を貫く穴、角丸、型抜きの本で、文字は各穴を避けて組まれます。ガイドは特殊インキと抜き加工で、特色インキの加工(finish)と抜き型の線(print.dieLine)も扱います。
- 柱とノンブル:ページごとに置くテキスト、罫線、ボックス、画像の要素。プレースホルダー、奇偶、ページの役割、配置を指定できます。
- ハイフネーション:ハイフネーションのパターン、分割しない語、行末不ぞろいのテキスト。
- 文書の言語:最上位の
locale。ハイフネーションのフォールバック、組み込みのリソースタイプ、表と分割された囲みの続きを示す文字列、アクセシブルなPDFにタグ付けされる言語を決めます。そこから導かれる数字(numerals)とテキストの方向(direction)、Postextが組める言語と文字体系もここで説明します。右から左に組む本のガイドはアラビア語の組版です。 - 言語と文字体系:Postextが組める文字体系と、それぞれを説明するページ。
- アラビア文字のテキスト:アラビア文字の字形、カシーダ、母音記号、数字。
- 見出し:共通の既定値と、H1〜H6ごとの上書き。
- オーファン、ウィドウ、ラント、分割禁止の規則:改段をまたいでも行やブロックを離さないための
bodyTextのキー。 - 段末そろえ:すべての段の終わりをそろえる調整手段。編集上の優先順に並べています。
- 脚注:
footnotes。[^id]で引いた注を置く場所、番号の付け方、見た目。 - 行番号:
lineNumbers。詩の行や本文の5行ごとの番号を余白に印字します。数える行、数え直す位置、番号を置く側。 - 相互参照:
crossRefs。:refの番号やページの前後に印字する語と、その既定のスタイル。 - 引用:
citations。引用スタイルと、引用および参考文献の見た目。 - 印刷物でのリンク:
links。印刷したページでリンクのアドレスをどう示すか。何もしない、括弧でアドレスを示す、アドレスとQRコードの注を付ける。 - 目次:
:::tocが出力する内容。項目の文字組み、リーダー、ページ番号、著者の行、部の行。 - 索引:
:::indexが出力する内容。項目の文字組み、字下げ、ページ番号の区切りと範囲、頭文字ごとのグループ、並べ替えの言語。
- 東アジアの組版:
cjk。中国語・日本語・韓国語のテキストの地域ごとの慣習と行分割、両端そろえの行の伸ばし方、約物の幅とぶら下げ、漢字とラテン文字の間のスペース、文字グリッド、縦組みでの数字の正立、そして圏点、ルビ、割注、漢文の訓点。全体のガイドは中国語の組版と日本語の組版です。
- リソースの種類:図、表、独自の種類に付ける種類別の番号。
- 表スタイル(名前付きの表スタイルを含む)とキャプションスタイル:表リソースとそのキャプションの文字組みと装飾。
- ダイアグラムスタイル:特色印刷のために、埋め込んだSVGのダイアグラムを単色に塗り替えます。
- 楽譜スタイル:
scoreStyleとscoreStyles。すべての楽譜の五線の大きさ、音楽フォント、間隔、小節番号。 - 動画スタイル:
videoStyle。動画のポスターに重ねる再生マークとQRコード、HTMLビューアーとEPUBでプレーヤーが備える機能。
- 段落スタイル:
:::paragraphsコンテナー用の名前付きスタイル。参考文献、用語集、注記などに使います。 - チップスタイル:
chipStyles。行内の:chip[…]用の名前付きスタイル。語群の枠、キーボードのキー、タグなどに使います。 - 文字スタイル:
characterStyles。:span[…]{style="id"}と書いた語句用の名前付きスタイル。書体、サイズ、色、字間、大文字と、それに添えるハイライトのスタイルを決めます。 - ハイライトのスタイル:
markStyles。行内の:mark[…]用の名前付きスタイル。行をまたぐハイライトの語句の後ろに敷く帯と、語句の下や語句を貫く線です。 - コードリスト:
codeStyle。```のコードリストの書体、枠、タブ幅、長い行、行番号、字句の色、構文の色分けとそのハイライターのフック、そしてコードの書体で組むインラインコード。 - 部:
:::partコンテナー用の部扉ページ。奇偶、版面、扉のデザイン、本文の文字組み。 - 見出しスタイル:
{style="…"}を付けた見出し用の名前付きスタイル。番号のない章、独自の柱を立てる前付け、ジオメトリーとパレット。 - 章スタイル:
chapterStyles。章がフロントマター(chapterStyle:)で名前を指定して適用するデザイン一式(ページ、組版、色、柱)。部の:::part{style="…"}で、その部のすべての章に適用することもできます。
- 囲みスタイル:
:::calloutコンテナー用の、枠で囲んだ注記、ヒント、学習目標。
- 練習問題スタイル:
exerciseStyles。:::exerciseブロックの番号のバッジ、指示文の書式、選択肢の記号、空欄、書き込み欄、マス目、わり算の筆算、答えの色。本全体の設定:exercises。教師用の版、解答を印刷する場所、並べ替えの乱数の種、画面の版。ガイドは練習問題です。
- ページテンプレート:
pageTemplates。テンプレートページの枠、グループ、装飾、テンプレート間の継承、奇数ページと偶数ページのバリアント。ラベルスタイル:labelStyles。画像のアンカーに置くラベルの見た目。枠の見た目:frameLooks。テンプレートページの内容がlook="…"で使う、名前の付いた色の組み合わせ。テンプレートで起こりうる問題はすべてページテンプレートの警告にあります。
- 単位と色、カラーパレット:
Dimension、ColorValue、名前付きの色。 - カスタムフォント:ユーザーがアップロードしたフォントファミリーを、Google Fontsと並べて宣言します。
- 数字のスタイル:
figureStyleで、テキストスタイルごとにオールドスタイル数字、ライニング数字、等幅数字、プロポーショナル数字をフォントのOpenType機能から選びます。 - HTMLビューアー:HTMLバックエンドの目標段幅と行分割。
- Canvasビューアー:
canvasViewer。SandboxのCanvasで、見開きの左右のページの間隔と、ページの行と次の行の間隔。 - PDF生成(設定):PDFバックエンドのしおり、アクセシブルな(タグ付きの)出力、色空間の強制。
- 印刷出力(設定):
printの設定。PDF/X-1aとPDF/X-4、ICC出力プロファイル、黒の扱い(K版のみのグレー、オーバープリント、リッチブラック)、CMYKで指定した色、プリフライト、印刷プレビュー。 - コントラストの検査(設定):
contrastの設定。地の色に対する文字色をWCAGのAAまたはAAAで、画面と出力プロファイルの用紙について検査し、印刷には細すぎる白抜き文字も報告します。 - 本文の検査(設定):
checks.contentInConfig。プレースホルダーの代わりに本の本文そのものが入ったデザイン内のテキストを報告します。書名と出版社名は許可リストで除外できます。 - Folioビューアー(設定):3Dの本のビューアーの用紙、綴じ、表面、光。
- デバッグ:エディター用の視覚的なオーバーレイと、執筆中の警告。
- プログラムからの利用:
buildDocumentとそれが報告する警告、リゾルバー、キャッシュ。 - Web Workerでレイアウトを実行する:キャンセルできる、メインスレッド外でのビルド。
- PDFの生成:
postext-pdf。フォントプロバイダー、CJKフォント、ワーカー、印刷入稿用のファイル。
- HTMLビューアーの統合とPDFの生成:最初から最後まで通した実例。
- 3Dの本(
postext-folio):組み上がった文書を、机の上に開いて置いた印刷本として表示します。読者はページをめくれます。 - EPUBの本:同じレイアウトから作る固定レイアウトとリフロー型のEPUB 3ファイルと、EPUBCheckによる検査。
- SCORMパッケージ:章と節を学習管理システム向けのSCOにまとめ、練習問題が得点を報告します。
- バンドル(
.postextファイル):本をまるごと1つのファイルに収めます。コードから.postextアーカイブを作成し、開き、ビルドします。