DITA-OTのXHTML出力にヘッダーやフッターを追加するには
DITA-OTが出力する各トピックのXHTMLファイルに、ヘッダーやフッターを追加することができます。この機能は、Copyright ©の注記をすべてのページに表示させるときなどに便利です。
DITA-OTを使ってXHTMLを生成するとき、下図の例に示したように、全ページのヘッダーやフッターに既定の文字列を表示させることができます。
ヘッダーおよびフッターを使用する
ヘッダおよびフッタを使用するために、DITA-OTには下記のAntパラメータが用意されています。
Antパラメーター | dost.jarオプション | 解説 |
---|---|---|
args.ftr | /ftr | 各ページのフッタ領域に表示するコンテンツを記述した、XHTMLファイルのURIを指定する。 |
args.hdf | /hdr | 各ページのヘッダ領域に表示するコンテンツを記述した、XHTMLファイルのURIを指定する。 |
ヘッダーおよびフッターのXHTMLファイルの書き方
ヘッダーおよびフッターとして使用するXHTMLは、整形式でなければいけません。すなわち、ドキュメント・フラグメント(最上位ノードが1つだけ)で、かつ、空タグを除くすべての開始タグと終了タグが対応していなければいけません。また、エンコーディングはUTF-8でなければいけません。正しいフッター・ファイルの記述例を示します。
フッター・ファイルの正しい記述例
<div> <hr color="#000099"/> <font size="-1" color="#808080"> <div>© DITA Consortium Japan 2009</div> </font> </div>
以下の悪い記述例に示したようなXHTMLは、ドキュメント・フラグメントでない(最上位ノードが2つ以上ある)ので、DITA-OTの実行中にエラーが発生します。
フッター・ファイルの悪い記述例
<hr color="#000099"/> <font size="-1" color="#808080"> <div>© DITA Consortium Japan 2009</div> </font>
ヘッダーやフッターに指定したXHTMLファイルは、各ページのXHTMLファイルに展開されます。
: : <li class="ulchildlink"><strong><a href="../about_index/redirect_term.html">代替語句を参照させる</a></strong><br/> ある語句の代替語句の参照を促すには、indexterm要素の子要素としてindex-see要素を挿入します。</li> </ul> </div> <div> <hr color="#000099"/> <font size="-1" color="#808080"> <div>© DITA Consortium Japan 2009</div> </font> </div> </body> </html>
関連情報
Including a header and footer in XHTML output
DITA Open Toolkit User Guideの中の、Customizing your published outputにセクションにある、ヘッダーとフッターを追加する手順の説明です。