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

ヘルプ・トピックの作成

ヘルプ・トピックは、固有の ID で識別できる情報の単位です。ヘルプ・トピックは、オンライン・ヘルプを記述しているプロダクトを最適に言い表す論理的な枠組みにグループ化されます。

記述する各トピックには、トピックの開始をマークする要素 (または、タグ) が付いていなければなりません。

<element id=id>  Help Topic's Title
 The body of the topic

elementchapter, s1, s2, ..., s9 のいずれかです。トピックの本文は、タイトルの後ならどの行からも始められます。

あるトピックのトピック階層内での位置は、そのトピックの開始に使われる element と、直前のトピックの開始に使われる element によって決まります。たとえば、あるトピックが <s2> で始まっていて、<s1> で始まるトピックの直後にある場合は、<s2> トピックは <s1> トピックのサブトピックになります。

アプリケーション (アプリケーション・ヘルプを記述している場合) かハイパーリンクのどちらかからアクセスするトピックには id が必要です。

ヘルプ・トピックのタイトルにはどんな文字列でも使用できます。タイトル文字列がソース・ファイルで 1 行を超える場合は、最後の行以外の行は & (アンド記号) で終わります。タイトル内の特定の位置で強制的に改行するには、¥ (バックスラッシュ) 文字を使用してください。

次の行は、<s1> タグを使用してトピックの開始をマークします。

<s1 id=welcome>Welcome to My Application

タイトルを強制的に 2 行に表示するには、次のように ¥ (バックスラッシュ) を使用してください。

<s1 id=welcome> Welcome to ¥ My Application

関連項目