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

用語集の作成

本の用語集のように、重要な用語を定義する用語集をヘルプ・ボリュームに入れることができます。用語集は <glossary> 要素でマークされ、ヘルプ・ボリュームの最後のトピックになります。

ヘルプ・ボリューム全体を通じて、<term> 要素と共に入力したキーワードとなる語句は、自動的に用語集にあるその用語の定義への定義ハイパーリンクになります。

用語集の用語をマークするには

    <term> 要素を次のように使用します。

       <term>word or phrase<¥term>  

    略式では、

       <term|word or phrase|

    簡易形式では、

       
    ++word or phrase++
    

ヘルプ・テキスト内の用語のスペルが用語集の定義のスペルと完全に同じではない場合は、その用語の「glossary form」(用語集形式) を次のように指定できます。

<term "glossary form">word or phrase<¥term> 

glossary form は、その用語が用語集に表示されるとおりの形式です。その用語が (コンテキストにより) ヘルプ・トピックでは複数形でなければならず、用語集では単数形でなければならない場合に便利です。

用語はボールド・フォントで表示され、自動的に定義ハイパーリンクになります。用語が選択されると、用語集の定義が簡易ヘルプ・ダイアログに表示されます。


注 -

故意に用語集に定義しない用語をマークする場合は、<term> 要素に nogloss 属性を追加してください。これにより、その用語は用語用のボールド・フォントで表示されますが、用語集へのリンクは作成されません。


用語集に「widget」の定義がある場合は、次のように入力できます。

A ++widget++ is the fundamental building block of OSF/Motif user interfaces.

用語集のエントリは「widget」だが、文中では複数形を使用する必要がある場合、次のように用語を入力できます。

<term  "widget">Widgets<¥term> are the fundamental building blocks 
of OSF/Motif user interfaces.

同じ用語を入力したいが、用語集に入れたくないか、またはハイパーリンクにしたくない場合は、次のように nogloss パラメータを使用します。

<term nogloss> Widgets<¥term>are the fundamental building blocks 
of OSF/Motif user interfaces.

略式では次のとおりです。

<term nogloss|Widgets| are the fundamental building blocks 
of OSF/Motif user interfaces.

用語集に用語を定義するには

    <dterm> 要素を用語集に次のように入力します。

       <glossary>      
     .
     .
     .
     <dterm>word or phrase
     Definition of the term
     .
     .
     .

<dterm> の語句は用語集の中で必ずソートしてください。

次の例は、用語集の SGML という用語の定義の部分です。

<glossary>
 .
 .
 .
 <dterm>SGML
 Standard Generalized Markup Language. An
 international standard [ISO 8859: 1986] that
 establishes a method for information interchange.
 SGML describes constructs for marking the
 structure of information separate from its
 intended presentation or format.

関連事項