トピック参照を書く <topicref>

DITAマップの中では、トピック参照を表すtopicref要素が重要な役割を果たします。topicref要素により、文書に含める各トピックを指定すると同時に、トピックの階層構造を定義します。

topicref要素は、トピックを参照するだけでなく、他のDITAマップを参照したり、HTMLやPDFなどの外部の情報リソースを参照したりすることもできます。topicref要素から他のDITAマップを参照することにより、DITAマップをネストすることができます。

リソース・フォーマットの指定(format属性)

format属性には、参照先の情報リソースのフォーマットを指定します。

dita
参照先がDITAトピック
ditamap
参照先がDITAマップ
html
参照先がHTML
pdf
参照先がPDF
指定なし
ditaを指定したのと等価

参照先が上記以外の場合は、ファイル名の拡張子を指定します。例えば、参照先がテキスト・ファイルの場合、txtを指定します。

参照先のトピックやマップの指定(href属性)

参照先のトピックやマップのファイル・パスを、編集中のマップからの相対パスで指定します。フォルダ名やファイル名を区切るデリミタはスラッシュ(/)です。

ヒント: 参照先に、DITAトピック以外の外部リソース(HTML、PDFなど)を指定することもできます。DITAトピック以外の外部リソースを指定する場合は、format属性にリソース・フォーマットを指定してください。

ナビゲーション・タイトルの指定(navtitle属性)

参照先のトピックまたはマップのタイトルを指定します。ナビゲーション・タイトルの指定は必須ではありませんが、マップを見ただけで参照先のトピックが分かるようにするため、常にナビゲーション・タイトルを指定することを推奨します。

ヒント: 参照先が外部リソースの場合は、その外部リソースの情報の主題を、ナビゲーション・タイトルとして指定してください。

トピック・タイプの指定(type属性)

参照先のトピックの、トピック・タイプ(topic, concept, task, またはreference)を指定します。トピック・タイプの指定は必須ではありませんが、マップを見ただけで参照先のトピックのタイプが分かるようにするため、常にトピック・タイプを指定することを推奨します。