共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)

<location>

位置

<location> 要素の位置を参照する際に ID を定義します。<location> 要素により、トピックの一部を <link> または <xref> の要素を使用してハイパーリンクの宛先として使用できます。

形式

<location id=id>text<¥location> 

または

<location id=id|text|
id

現在の位置の識別子で、ハイパーリンクの宛先として使用できます。

text

ID を割り当てたいテキストのブロックです。

<location> 要素は、組み込み ID か設計者定義 id パラメータを持っている要素(<hometopic><figure> など) がすでにある位置では必須ではありません。

<xref> 要素で作成された相互参照は、<xref> 要素を <location> の開始タグと終了タグの間のテキストに置き換えます。

次のマークアップ名は位置に名前を付け、その他の場所ではその位置へのハイパーリンクを作成します。

<s1 id=ConfigTopic> Configuration
 	...
 <location id=ConfigTopicBody>some text<¥location>
     ...
 <s1 id=UseTopic> Usage
     ...
 See <link ConfigTopicBody>Configuration<¥link>
 for additional information.

<location> 要素の ID へリンクすると、<location> タグが入力されているポイントへ、ヘルプ・ウィンドウが自動的にスクロールするという利点があります。対照的に、トピックの ID (この場合は「ConfigTopic」) へリンクすると、必ずトピックの先頭に行きます。

<location> 要素は、プレースホルダとして定義済みエンティティ (&empty;) を使用してファイル内の位置を参照することもできます。

ファイル内のキーの位置にこのマークアップを追加すると、その特定位置へのリンクを作成できます。

paragraph text
 .
 .
 .
 <location id=pointA>&empty;<¥location>
 .
 .
 .

関連項目