<xref>

相互参照

ヘルプ・ボリューム内で別の位置を指定し、その位置へのハイパーリンクを作成するテキストを挿入します。

形式

<xref id> 

id は相互参照されているトピックまたは位置の識別子です。

相互参照は、章またはセクションのタイトル、ヘッダ、図のタイトル、リスト項目、または行番号に変換されます。相互参照テキストは、ハイパーリンクになり、ユーザが選択すると相互参照された位置へジャンプします。

相互参照を作成するには、参照予定の要素に id を定義しなければなりません。宛先要素の id を <xref> タグにある id パラメータとして使用します。これにより、<xref> 要素から宛先要素へのハイパーリンクが作成されます。id はそのまま正確にスペルアウトされなければなりません。しかし、大文字と小文字の区別はありません。

id パラメータは、次の要素につけることができます。

<chapter>
<s1>, <s2>,...<s9>
 <otherfront>
 <p>
 <image>
 <item>
 <figure>
 <location>
 <rsect>

下線が入っている id (「_abstract」や「_hometopic」など) への相互参照はできません。<link> 要素を使用してください。

例

ユーザが詳細な章を参照できるようにするには、章の id を使用して参照を作成してください。たとえば、id が windowmgr である「Window Management」というタイトルの章を参照するには、「Refer to <xref windowmgr> for details.」と記述します。

オンライン・ヘルプ・ボリュームでは、結果は「Refer to Window Management for details.」 となります。id は章のタイトル「Window Management」に置き換えられ、ハイパーリンクになります。

次のマークアップは「analyzer」という名前の id をセクションの要素に代入します。

<s1 id=analyzer>Logic Analyzers

次の例は、このトピックへの相互参照が記述されているマークアップです。

The DX16500A logic analysis system, described in
 <xref analyzer>, can be configured to a user's needs.

処理後、 <xref> 要素は次のように「Logic Analyzers」に置き換えられます。

テキスト「Logic Analyzers」はハイパーリンクで、ユーザが選択すると相互参照ヘルプ・トピックへジャンプします。

関連項目

• 「<chapter> 」

• 「<!entity> 」

• 「<figure> 」

• 「<graphic> 」

• 「<image> 」

• 「<link> 」

• 「<location> 」

• 「<otherfront> 」

• 「<p> 」

• 「<rsect> 」

• 「<s1>...<s9> 」