基本マップを書く <map>

前付けや後付けがないシンプルな構造のマニュアルを作る場合は、基本マップ(map要素)を使ってマニュアルを構成するトピックを指定します。

基本マップは、階層構造および表形式に組織化された、トピック参照(topicref要素)の集まりから成ります。基本マップを使用したDITA文書の場合、DITA Open ToolkitによりPDFを生成すると、目次や索引の挿入位置は常に同じになります。表紙に続いて目次が挿入され、マニュアルの末尾に索引が挿入されます。

ヒント: topicref要素の属性や、topicref要素の配下に挿入するtopicmeta要素を使って、トピックのタイトル、ショート・デスクリプション、およびメタ情報をオーバーライドできます。この機能を活用することにより、トピックの再利用性を向上できます。

マップIDの指定

マップID(map要素のid属性)の指定は必須ではありませんが、すべてのマップにid属性を指定することを推奨します。DITA文書を処理する上で、マップIDが特別な役割を果たすことはありませんが、問題が発生したときのデバッグで役に立ちます。

文書を構成するすべてのマップを通じて、マップIDはユニークでなければいけません。また、マップIDの値は、大文字と小文字の違いが認識されます。

ソフトウェアの変数名の付け方に倣って、下記のルールに従ってマップIDを付与することを推奨します。

ヒント: コンテンツ・マネージメント・システム(CMS)を使用している場合、CMSによってマップIDが自動付与されることがあります。

ロケールの指定

map要素のxml:lang属性に、マップのロケール(言語)を指定します。xml:lang属性の指定を省略したときの、デフォルトのロケールはen-usです。マップのロケールを明示的に示すために、たとえ英文文書のマップの場合でも、必ずxml:lang属性を指定することを推奨します。

DITA Open Toolkitがサポートしているロケールの一覧を下表に示します。

表 1. DITA Open Toolkitがサポートしているロケール(xml:lang属性の値)
言語 xml:lang属性の値
アラビア語 ar-eg
ベラルーシ語 bg-bg
ブルガリア語 be-by
カタロニア語 ca-es
中国語(簡体字) zh-cn
中国語(繁体字) zh-tw
クロアチア語 hr-hr
チェコ語 cs-cz
デンマーク語 da-dk
オランダ語 nl-nl
オランダ語(ベルギー) nl-be
英語(カナダ) en-ca
英語(イギリス) en-gb
英語(アメリカ合衆国) en-us
エストニア語 et-ee
フィンランド語 fi-fi
フランス語 fr-fr
フランス語(ベルギー) fr-be
フランス語(カナダ) fr-ca
フランス語(スイス) fr-ch
ドイツ語 de-de
ドイツ語(スイス) de-ch
ギリシャ語 el-gr
ヘブライ語 he-li
ハンガリー語 hu-hu
アイスランド語 is-is
イタリア語 it-it
イタリア語(スイス) it-ch
日本語 ja-jp
韓国語 ko-lr
ラトビア語 lv-lv
リトアニア語 lt-lt
マケドニア語 mk-mk
ノルウェー語 no-no
ポーランド語 pl-pl
ポルトガル語 pt-pt
ポルトガル語(ブラジル) pt-br
ルーマニア語 ro-ro
ロシア語 ru-ru
セルビア語 sr-sp
スロバキア語 sk-sk
スペイン語 es-es
スウェーデン語 sv-se
タイ語 th-th
トルコ語 tr-tr
ウクライナ語 uk-ua