表示モード
BuildVuには3つの表示モード
があります:idrviewer(デフォルト)、content、そしてsinglefile(2025.10以降)。このモードによって、変換されたドキュメントにビューアーを付属させるか、表示方法を自分で実装するかが決まります。
idrviewer(デフォルト) | content | singlefile | |
|---|---|---|---|
| BuildVuの出力内容 | IDRViewer
が組み込まれたindex.htmlと、ページごとのファイル | ページごとのファイル(ビューアーなし) | すべてのページを含む単一の自己完結型HTMLファイル(BuildVu-HTMLのみ) |
| ページの表示担当 | IDRViewer(必要に応じてページを読み込む) | 独自のページまたはアプリケーション | ブラウザ(すべてのページを一度に読み込む) |
| ナビゲーション・ズーム・検索 | IDRViewerと選択したビューアーUI が提供 | 独自に実装が必要 | 提供なし |
| SEO | SEOを目的とした設計ではない | 各ページに独自のURLを設定でき、個別にインデックス登録が可能 | ドキュメント全体が1ページとしてインデックス登録される |
| アナリティクス | 標準タグでは開いたドキュメントごとに1回のページ読み込みとして記録されるため、ページや検索のトラッキングにはIDRViewerのイベントを使用 | 他のページと同様に、サイトが読み込んだURLごとにページビューとして記録 | 開いたドキュメントごとに1回のページ読み込みとして記録 |
ビューアーを自前で構築せずに動作するビューアーを利用したい場合はidrviewerを選択してください。IDRViewerがページの読み込み、レイアウト、ズーム、テキスト選択を処理し、提供されるUIがナビゲーション、サムネイル、(Complete UIでは)ドキュメント全体の検索
機能を追加します。ゼロから構築する代わりに、デフォルトUIの変更
やビューアーのカスタマイズ
も可能です。
トレードオフとして、ドキュメントはビューアーの内部に存在することになります。ページは閲覧者が近づいたときにのみ読み込まれるため、大きなドキュメントでも高速に動作しますが、クローラーは最初のページしか認識できません 。また、アドレスバーはページをリロードせずに変化するため、アナリティクスにはIDRViewer専用の設定 が必要です。
変換されたページを独自のサイトやアプリケーションに組み込み、ナビゲーション、スタイリング、同意管理、アナリティクスを自前で用意する場合はcontentを選択してください。主な使用理由は以下のとおりです:
- ドキュメントの各ページに独自のURLを付与することで、検索エンジンが各ページを個別にインデックス登録 でき、追加コードなしでアナリティクスツールが各ページのページビューを記録できる。
- 独自レイアウトやiframeにページを埋め込む(Complete Document を参照)。
ナビゲーション、ズーム、検索、注釈やハイパーリンクの表示
など、IDRViewerが行っていたすべての処理を自分で実装する必要があります。これが通常、判断における主なコストとなるため、contentモードは手間を省くためではなく、ページをサイトにどう組み込むかという観点で選択してください。
ビューアー出力との相違点がいくつかあります:
- ドキュメントのメタデータは
config.jsではなくproperties.jsonに書き込まれます(メタデータJSON API )。 - コンテンツを表示するページに文字セット を設定する必要があります。
- Complete Document 、CSS Suffix 、Override Page Number はこのモードでのみ使用できます。
ドキュメント全体を単一のHTMLファイル
にまとめる必要がある場合、たとえば1ページとしてインデックス登録したい場合や、出力がブラウザで読み込まれないワークフローの場合はsinglefileを選択してください。すべてのページとアセットが埋め込まれるため、大きなまたは複雑なドキュメントは読み込みが遅くなったり、特にモバイル環境でブラウザがクラッシュする可能性があります。小さなドキュメントにのみ使用してください。
- idrviewer: アナリティクスタグを
index.htmlに追加し、IDRViewerのイベントをトラッキングします。IDRViewerアナリティクスガイド を参照してください。 - content: サイトの他のページと同様に、変換されたコンテンツを表示するページにタグを追加します。各ドキュメントページに独自のURLがある場合、それぞれがページビューとして記録されます。複数のページを1つのURLで表示する場合、またはURLを変更せずにページを切り替える場合は、ページが変わるたびに独自のイベントを送信してください。
- singlefile: ファイルに追加されたタグは、開いたドキュメントごとに1回のページ読み込みのみを記録し、それ以外は記録しません。読者がどこまで読み進めたかを計測するには、独自のスクロールトラッキングが必要です。ファイルは変換のたびに上書きされるため、再変換後にタグを再度追加する必要があります。
