ブックマップの構造

ブックマップのルート要素はbookmapです。bookmap要素の配下には、タイトル(title要素)、ブックのメタ情報(bookmeta要素)、前付け(frontmatter要素)、章(chapter要素)、付録(appendix要素)、後付け(backmatter要素)を順次配置します。

ブックマップの構造を下図に示します。



ブックマップの構造

ブックマップに記述できる主要な要素を以下に示します。

title要素
マップ・タイトルを記述します。DITA Open Toolkitを使ってDITA文書をパブリッシングすると、マップ・タイトルがマニュアル・タイトルになります。
bookmeta要素
執筆者、製品情報、版権などのメタ情報を記述します。執筆者と版権の情報はマニュアルの表紙に出力されます。製品情報は本文のヘッダ部に表示されます。
frontmatter要素
本文の前に位置する、目次、商標・権利等の注記、謝辞、表記ルール、マニュアルの要約、草稿についてのコメント、および前書きを記述できます。必須の項目はありませんが、目次の指定(booklists/toc)がないと、DITA Open Toolkitを使ってPDFを生成したときに、目次が出力されません。
chapter要素
マニュアルの章を構成するトピックまたはマップのパスを指定します。トピックを指定した場合は、そのトピックが章の先頭ページになります。マップを指定した場合は、マップ内の先頭のトピックが、章の先頭ページになります。
appendix要素
マニュアルの付録を構成するトピックまたはマップのパスを指定します。
backmatter要素
本文の後ろに位置する、索引、商標・権利等の注記、謝辞、表記ルール、および正誤表を記述できます。必須の項目はありませんが、索引の指定(booklists→indexlist)がないと、DITA Open Toolkitを使ってPDFを生成したときに、索引が出力されません。
reltable要素
任意のトピック間のリンクを、表形式で指定します。

目次、索引および各種リストの作成

前付け(frontmatter要素)および後付け(backmatter要素)の中には、目次や索引を始めとする、各種リストを作成するためのbooklists要素を挿入できます。booklists要素の中に挿入できる、各種リストを表す要素を以下に示します。DITA Open Toolkitを使ってPDFを生成するときに自動生成されるのは、このリストの中のtoc(目次)とindexlist(索引1)だけです。tocとindexlist以外のリストを自動生成するには、DITA Open Toolkitをカスタマイズしなければいけません。tocとindexlist以外のリストを手作業で作成する場合は、下記要素のhref属性に、リストを含むトピックのパスを指定します。

toc
目次(自動生成)
figurelist
図一覧
tablelist
表一覧
abbrevlist
略語一覧
trademarklist
商標および登録商標の一覧
bibliolist
関連マニュアルの一覧
glossarylist
用語一覧
indexlist
索引(自動生成)

ブックマップの記述例

ブックマップの簡単な記述例を下記に示します。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN"
"http://docs.oasis-open.org/dita/v1.1/OS/dtd/bookmap.dtd">
<bookmap id="dita-userguide" xml:lang="un-us">
  <title>DITA User Guide</title>
  <frontmatter>
    <booklists>
      <toc/>
    </booklists>
  </frontmatter>
  <chapter href="condproc/condproc.dita" navtitle="Conditional Processing"
           type="concept"/>
  <chapter href="proccond/proccond.dita"
           navtitle="Filtering and Flagging Content" type="task">
    <topicref href="proccond/addmeta.dita"
              navtitle="Adding metadata to elements" type="task"/>
    <topicref href="proccond/filtcontent.dita" navtitle="Filtering content"
              type="task"/>
    <topicref href="proccond/flagcontent.dita" navtitle="Flagging content"
              type="task"/>
    <topicref href="proccond/showrev.dita" navtitle="Showing revisions"
              type="task"/>
  </chapter>
  <backmatter>
    <booklists>
      <indexlist/>
    </booklists>
  </backmatter>
</bookmap>

上記のブックマップからPDFを生成すると、下図のような目次になります。

1 索引を生成するには、XSL FOフォーマッターとしてAntenna House FormatterあるいはRenderX XEPが必要です。