トピックへのアクセス

ヘルプタグ言語の多くの要素は ID 属性をサポートしています。ID は、トピックとトピック内の要素を識別するために内部的に使用される独自の名前です。ID は一度しか定義されませんが、複数のハイパーリンクと相互参照は同じ ID を参照できます。ID はユーザには見えません。

アプリケーションのヘルプを記述している場合、ユーザがヘルプを要求したときに表示される特定のトピックを識別するために、アプリケーションが ID を使用することもあります。たとえば、アプリケーションのメニューを説明するいくつかのトピックを記述する場合などです。トピックに割り当てる ID は、アプリケーションの開発者によって使用されます。アプリケーション・コード内に同一の ID を定義することにより、開発者は特定のトピックを統合できます。これによりアプリケーションは、特定のメニューに関してヘルプが要求されたときに正しいトピックへアクセスし、表示できます。

ID 名に関する規則

• ID 文字列は、英字 (A から Z と a から z)、数字 (0 から 9)、マイナス (-) 記号から成り、必ず英字で始まります。

• 設計者定義 ID は _ (下線文字) を使用できません。ヘルプタグ要素のいくつかに組み込まれている ID のために予約されています。

• 大文字でも小文字でも意味は変わりませんが、読みやすいように使い分けてください。

• ID 文字列の長さは、64 文字以内です。

• 単一のヘルプ・ボリューム内の各 ID は、固有のものでなければなりません。

ID をトピックに追加するには

次のように要素の id パラメータを使用します。

<element id=id>  ...

新しいトピックを開始し、設計者定義 ID をサポートしている要素は次のとおりです。

• <chapter id=id>

• <otherfront id=id>

• <rsect id=id>

• <s1 id=id>

• <s2 id=id> . . .<s9 id=id>

組み込み ID

組み込み ID を持っている要素は数個ありますが、設計者定義 ID をサポートしていません。次の要素のそれぞれも新しいトピックを開始しますが、これらの要素は定義済み ID (括弧内のもの) を持っています。

<abstract>

(_abstract)

<copyright>

(_copyright)

<glossary>

(_glossary)

<hometopic>

(_hometopic)

<title>

(_title)

ID をトピック内の要素に追加するには

要素が設計者定義 ID をサポートしている場合、次のように要素の id パラメータを使用します。

   <element id=id>  ...

ID 属性をサポートしている (トピック内の) 要素は、次のとおりです。

• <figure id=id>

• <graphic id=id>

• <image id=id>

• <location id=id>

• <p id=id>

または、次のように <location> 要素を使用して、トピック内の任意の場所に ID を設定します。

<location id=id> text <¥location> 

text は ID を追加したい語句です。<¥location> 終了タグは必須です。位置 ID に対するリンクを起動すると、ヘルプ・ビューアは ID が入っているトピックを表示し、ウィンドウを ID の位置までスクロールします。

例

ID を図に追加する場合、タイトルがなければなりません。図の ID に対して相互参照が行われる場合、タイトルが必要です。その場合、タイトルは図へのハイパーリンクになります。

次は、ID my−big−picture の図をマークアップする例です。

<figure id=my-big-picture entity=big-picture-TIFF>
 Here's My Figure
 <¥figure> 

次の例は、「easier than ever」という句に ID easy-spot が割り当てられているパラグラフです。

Getting help is <location id=easy-spot> easier than ever<¥location>.