関連リンクを書く <related-links>, <link>, <linktext>, <desc>

トピックの末尾に、関連するDITAトピックあるいは外部リソースへのリンクを挿入するには、related-links要素を使います。

関連リンクは、下図に示したようにrelated-links要素、link要素、linktext要素、およびdesc要素を使って書きます。



関連リンクの文書構造

link要素では、format属性、href属性、およびscope属性により、それぞれリンク形式、リンク先のURL、リンクのスコープを指定します。出力物がHTML HelpやXHTMLの場合は、下図の出力例に示したとおり、linktext要素に指定した文字列がリンク・テキストとして、desc要素に指定した文字列がツール・チップ(吹き出し)として表示されます。



関連リンクの出力例(HTML Helpの場合)

重要: related-links要素を使ってトピック間のリンクを指定するのは、極力、避けるべきです。related-links要素を使ってトピック間のリンクを指定すると、トピック間に依存関係ができ、トピックの再利用性を低下させるためです。代わりに、マップに関連テーブル(reltable要素)を書くことにより、トピック間のリンクを指定することを推奨します。

リンク・ターゲットの情報を書く

関連リンクのリンク先(リンク・ターゲット)に指定できるのは、DITAトピックあるいは外部リソースです。外部リソースはURLで指定します。リンク・ターゲットの情報は、link要素のformat属性、href属性、およびscope属性を使って指定します。

format属性
format属性には、リンク・ターゲットの種類を指定します。
dita
リンク・ターゲットがDITAトピック
html
リンク・ターゲットがHTML
pdf
リンク・ターゲットがPDF
指定なし
ditaを指定したのと等価
リンク・ターゲットが上記以外の場合は、ファイル名の拡張子を指定します。例えば、リンク・ターゲットがテキスト・ファイルの場合、txtを指定します。
href属性
リンク・ターゲットがDITAトピックなのか、外部リソースなのかによって、href属性の書き方が変わります。リンク・ターゲットがDITAトピックの場合は、href属性にDITA固有の表記法でDITAトピックの位置を指定します。リンク・ターゲットが外部リソースの場合は、href属性に外部リソースのURLを指定します。
リンク・ターゲット href属性の値
DITAトピック 書式:
href="filename.dita#topicID"
外部リソース 記述例:
href="http://www.w3.org/International/articles/language-tags/"
scope属性
scope属性には、編集中のDITA文書とリンク・ターゲットの位置関係を指定します。
local
リンク・ターゲットが編集中のDITA文書の一部
peer
リンク・ターゲットが編集中のDITA文書の一部だが、パブリッシング処理の最中には参照できない
external
リンク・ターゲットが外部リソース
scope属性にexternalを指定することにより、リンク・テキストをクリックしたときに、外部リソースのコンテンツが、Webブラウザの新しいウィンドウに表示されるようになります。外部リソースのコンテンツを参照した後に、コンテクストを見失うことなく元のトピックに戻れるため、オンライン・マニュアルのユーザビリティが向上します。

リンク・テキストを指定する

リンク・テキストを指定するにはlinktext要素を使います。scope属性がexternalまたはpeerの場合、linktext要素の指定を省略すると、link要素のhref属性に指定した文字列がリンク・テキストとして表示されます。

scope属性がlocalの場合は、linktext要素を指定しなくても構いません。scope属性がlocalの場合は、リンク・ターゲットのトピック・タイトルがリンク・テキストとして表示されます。

リンク・ターゲットの補足説明を書く

リンク・ターゲットの補足説明を書くにはdesc要素を使います。

scope属性がexternalまたはpeerの場合にdesc要素の指定を省略すると、リンク・ターゲットの補足説明は表示されません。

scope属性がlocalの場合にdesc要素の指定を省略すると、リンク先のDITAトピックのショート・デスクリプションが、リンク・ターゲットの補足説明として表示されます。

関連リンクに見出しを付ける

1つあるいは複数の関連リンクに対して見出しを付けることができます。関連リンクに見出しを付けるには、下図に示したようにlink要素をlinklist要素でラップし、title要素を挿入します。



関連リンクの見出しの指定