トピックIDの指定 @id

すべてのトピックには、トピックを識別するためのトピックID(id属性)を指定しなければいけません。

トピックIDは、他のトピックやマップからトピックを参照するときに、トピックを識別する目的で使われます。このため、文書を構成するすべてのトピックを通じて、トピックIDはユニークでなければいけません。なお、トピックIDの値は、大文字と小文字の違いが区別されます。

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

トピックIDの付与ルール

各組織において、トピックIDの付け方にルールを設けるべきです。適切なルールを設けることにより、トピックの執筆者に以下のようなメリットがもたらされます。

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

ヒント: DITAからXHTMLを生成すると、ハイパーリンクのリンク先を示すためにトピックIDの値がそのままアンカー名として使われる場合があります。リンクを解決するときに、リンク先のアンカー名の大文字・小文字を区別するかどうかは、Webブラウザによって異なります。したがって、XHTMLのハイパー・リンクのリンク切れを防止するためにも、トピックIDの中の英字は、すべて小文字に統一すべきです。