Skip to content

ドキュメント改善: 印刷/PDF出力まわりの説明を拡充する(ページサイズ指定・CLI推奨理由の明確化) #2107

Description

@ogwata

背景

#2056 での議論を踏まえ、「印刷/PDFとして出力」まわりのドキュメント(docs/ja/vivliostyle-viewer.md / docs/vivliostyle-viewer.md)を改善したいです。

今回の報告は最終的にはChromiumのリグレッション(@pageのnegative marginがあると印刷ダイアログで用紙サイズ選択UIが誤って表示される)が原因で、Chromium側で修正済みでした。ただし議論の中で、以下のようなドキュメントの不足が背景にあったことが分かりました。

  • ページサイズの指定方法(@pageルール/設定パネル)が、印刷・PDF出力の説明から分かりにくい
  • 印刷ダイアログの「用紙サイズ」欄の選択と、実際に出力されるPDFのページサイズが無関係であることが説明されていない
  • OS・ブラウザ・出力先(「PDFに保存」/実プリンタ/仮想プリンタ等)の組み合わせにより、印刷ダイアログの挙動が変わりうることに触れていない
  • 入稿用データなど正確性が求められる場合にVivliostyle CLIを推奨する理由(ブラウザ版固定、起動オプション制御など)が説明されていない

提案する加筆・修正

対象: 「印刷/PDFとして出力」節(ja / en)、日英両方に反映。

  1. ページサイズ指定方法への相互参照を追加

    • 節の冒頭で、出力されるページサイズは文書の@pageルール(またはViewer設定パネルの Page Size)で決まる旨を明記し、「設定パネル」節へリンクする。
  2. 「印刷ダイアログの用紙サイズ選択とPDF出力サイズは無関係」という注記を追加

    • ブラウザの印刷ダイアログに用紙サイズの選択肢が表示される場合があるが、実際に出力されるPDFのサイズはこの選択に関わらず文書側の指定(@page)通りになる、という点を明記する。
    • このドロップダウンの見え方はブラウザのバージョンや出力先の種類(「PDFに保存」/OSの仮想プリンタ/実プリンタのドライバ等)によって変わりうるため、表示されていても慌てず@page指定を確認するよう案内する。
  3. 「環境依存性」に関する注意書きを追加

    • OS・ブラウザ・出力先の組み合わせによって印刷ダイアログの挙動や見た目が異なる場合があること、Vivliostyle ViewerはあくまでWebブラウザの印刷機能を利用しているため、こうした差異はブラウザ側の実装に起因することを明記する。
  4. 「Vivliostyle CLI」節を拡充

    • 現状「コマンドラインからPDFに出力できる。PDF/X-1a形式への変換も可能」の一文のみ。これに加えて、Vivliostyle CLIが使用ブラウザのバージョンを固定し起動オプションを制御することで、環境差異による出力の揺れを避け安定した組版・出力を行える旨を追記する。
    • 印刷所への入稿など高い正確性が求められる場合は、Viewer + ブラウザ印刷ではなくCLIの利用を推奨する、という文言を明記する(#2056でのMurakamiShinyu氏コメントを反映)。

参考: 現状のテキスト(ja, docs/ja/vivliostyle-viewer.md)

## 印刷/PDFとして出力

ブラウザの印刷・PDF保存機能を利用して、レンダリングされたドキュメントをPDFに変換できます。

例えば、Google Chrome で PDF に出力するには、メニューから「印刷」を開き、出力先として「PDFに保存」、背景のグラフィック ON と指定して「保存」します。

注: 文書の全ページを印刷する場合、設定パネルで **Render All Pages** が On になっていることを確認してください。これが Off の場合、すでに表示されたページしか印刷できず、またページ番号が正しく出力されません。

### Vivliostyle CLI

[Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli) を使うとコマンドラインからPDFに出力できます。印刷に適したPDF/X-1a形式への変換も可能です。

スコープ外(今回は対応しない)

  • Chromiumのnegative margin issue自体への言及(すでに修正済みの一時的な不具合のため、恒久的なドキュメントに残す必要性は薄いと判断)
  • vivliostyle.org / docs2.vivliostyle.org 側の反映は別途(本リポジトリの docs/ を修正すれば、サブモジュール経由で反映される想定)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions