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

インライン要素の入力

インライン要素は、テキストの段落の中で語句をマークするのに使用します。これらの要素は、特定の項目を書式化するのに使用するフォントに影響します。

語句を強調表示するには

    <emph> (強調表示) 要素を次のように使用します。

       
    <emph> text <¥emph>  

    簡易形式では次のようになります。

       
    !! text !! 

イタリックで強調表示されたテキストが表示されます。日本語では、イタリック書体のフォントが提供されていない場合、それに代わる書体、たとえばボールドで表示されます。

重要な語を強調表示するには、次のようにします。

A thousand times <emph>no<¥emph> 

簡易形式では、

A thousand times !!no!!

どちらの場合も、「no」がイタリックで表示されます。

本のタイトルを入力するには

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

       
    <book>  title <¥book>  

    簡易形式では、

       
    book| title |

本のタイトルがイタリックで表示されます。日本語では、イタリック書体のフォントが提供されていない場合、それに代わる書体、たとえばボールドで表示されます。

このマニュアルのタイトルを入力するには、次のようにします。

<book|The Help System Author's and Programmer's Guide|

Bold フォントで強調表示するには

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

       
    <term nogloss> bold text <¥term>

    簡易形式では、

       
    <term nogloss |bold text |

    <term> 要素は用語集のエントリを作成するのに使用されます。しかし、nogloss パラメータを追加すれば、テキストは Bold フォントで表示されますが用語集には追加されません。

コンピュータ・リテラルを表示するには

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

       
    <computer>  text  <¥computer>  

    簡易形式では、

       
    
    `` text ''
    

コンピュータ・テキストはファイル名を識別するのに便利です。次の例では、helptag.opt というファイル名が簡易マークアップでタグ付けされています。ファイル名がコンピュータ・テキストで表示されます。

Add the search path to your "helptag.opt" file.

上記のマークアップの出力は、次のとおりです。

Add the search path to your helptag.opt file.

変数を表示するには

    <var> (変数) 要素を次のように使用します。

       
    <var> text <¥var>  

    略式では、

       
    <var |text | 

    簡易形式では、

       
    
    %% text %%
    

変数がイタリックで表示されます。

次のコマンド行形式には、ユーザがファイル名を指定することを示す変数があります。

dtpad %%filename%%

出力は次のとおりです。

dtpad filename

変数は、コンピュータ・テキストまたはコンピュータの例表示に現れます。次の例は volume をファイル名の変数部分として指定します。

The HelpTag software takes your "%%volume%%.htg" file as input.

出力は次のとおりです。

The HelpTag software takes your volume.htg file as input.

上記のどちらの例も、%% の対の部分は正規マークアップ (<var>...<¥var>) でも略式マークアップ (<var| ...|) でも入力できます。