Guidedog マニュアル 0.2.0
言語
このページの内容
Guidedog / ドキュメント 0.2.0

読みやすい組版

熟読前に構造が見えるページにする。明確な見出し、静かなナビゲーション、適度な本文幅が中心だ。色は関係や操作を示す補助とし、それだけに意味を託さない。

ウェブページ

独自レイアウトはプロジェクト案内、本文、ページ目次の三領域で、小画面はドロワーを使う。Libertinus Serif と Sans を同梱する。見出しは太いセリフ体、案内・ラベル・操作は対応するサンセリフ体。WOFF2 をサイトから配信し、フォントサービスに接続しない。

既定はライト。 ダークとシステムも選べ、同一オリジンで選択を記憶する。システムは OS に従う。印刷 HTML は明るい色を使う。JavaScript なしでも本文と案内は使える。テーマ操作と高度な検索は段階的な機能追加だ。

英語の本文はブラウザーでも段落全体の Knuth–Plass 改行を使える。小さなスクリプトが読み込んだフォントを測り、箱・空白・ハイフネーションのペナルティーを作って段落の改行を選ぶ。Frank Liang のパターン法で候補を求め、元の TeX パターンとライセンスを同梱する。

強調と原文を保ち、本文幅の変更時に再計算する。最適化した一段落内のコピーは見かけの改行やハイフンを含まない原文になる。印刷時は通常段落に戻し、印刷レイアウトで改ページする。

リンク、数式、コード、操作要素、狭い幅、他言語には標準レイアウトを使う。良い間隔の解がない段落も同様だ。JavaScript なしでも読める。代替は言語対応の hyphens: auto と text-wrap: pretty だが、CSS だけで Knuth–Plass 最適化を保証するものではない。

PDF のページ

書籍も Web と同じ Libertinus を使い、両端揃え、最適化した改行、言語別ハイフネーションを設定する。間隔、柱、キャプション、コード、罫線も制御する。フォント・分割コスト・段落幅は共同で働く。不自然な空きに強制改行を足すのは大抵適切でない。

Typst は PDF の段落を、Web の補助は対象の本文を最適化する。ソース・フォント・階層は共有するが改行は異なり得る。Typst テキスト契約 と ブラウザーのハイフネーション契約 を参照。

デザインの変更

見た目の変数は _static/editorial.css、構造は _templates/layout.html、印刷は _templates/book.typ で編集する。読む順、フォーカス表示、ラベル、十分なコントラストを保つ。

変更後は両形式を作り、コード・表・図・数式を含むページを確認する。美しい表紙は本文の保証ではない。契約は テンプレート、全 API は API Reference と同じ PDF 本にある。