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

ヘルプタグによるヘルプ・トピックの記述

オンライン・ヘルプは通常のテキスト・ファイルで記述されます。情報の「要素」をマークアップするには特殊コード、すなわち「タグ」を使用します。タグは、ヘルプタグと呼ばれるマークアップ言語を形成します。

ヘルプタグ・マークアップ言語は、章、セクション、サブセクションなどハイレベルの要素と、段落、リスト、強調語などローレベルの要素とを判別する、要素の階層を定義します。

「一般的なマークアップのガイドライン」では、マークアップの使い方について簡単に示しています。各要素の詳細は、第 5 章「ヘルプタグ・マークアップのリファレンス」を参照してください。

簡易マークアップ

タグセットは、実行時のヘルプ・ファイルを作成するため、簡易マークアップ、および正規マークアップの 2 種類の方法で使用できます。前者は、標準テキスト・エディタを使用して情報を「hand−tag」(タグ付け) する設計者にとって最適です。すなわち、実際のヘルプ・トピック・テキストに加えて、設計者がタグを入力する場合です。手動によるタグ入力の影響を小さくするため、簡易マークアップではいくつかの省略方法を取り込んでいます。最初に、必要な開始タグと終了タグの数を減らします。また、マークアップやスタイルを変更するときに適宜使用する簡単な文字の組み合わせも提供されています。

正規マークアップ

正規マークアップとは、設計者が使用できる SGML (Standard Generalized Markup Language) によって、完全に SGML に準拠したヘルプ・トピックを作成することです。この場合はすべての要素の最初と最後にタグを付けなければなりません。また、各要素の構造にも明示的にタグを付けなければなりません。したがって、正規マークアップを使用するとタグの数が非常に多くなります。標準エディタで正規マークアップを入力することもできますが、構造化エディタを使用することをお勧めします。

構造化エディタ

構造化エディタと呼ばれる新しいツールが、SGML マークアップを効率よく作成するために使用できるようになりつつあります。典型的には、構造化エディタではコンテキスト・メニューを提供します。つまり、メニューに表示される要素が、ドキュメントのカーソルの位置に基づいて動的に変更されます。

たとえばリストを入力する場合は、メニューにはリスト要素のコンテキストで有効な要素だけが含まれます。この組み込み「知能」によって、設計者は簡単にマークできます。

設計者が、セクション、ヘッダ、リストなどの要素を選択すると、エディタはそれに対応する開始、終了、および任意の中間構造タグを生成します。たとえば設計者が章という要素を選択すると、この要素が必要とする中間タグをエディタが自動的に挿入します。編集者は単に章のタイトルを入力すればよいのです。生成されたタグの表示は任意で、設計者はタグを表示しないようにできます。


注 -

簡易マークアップ、正規マークアップのいずれの場合も、コンパイルおよび表示の時には同じオンライン情報を生成します。どちらの方法を使用するかは、ヘルプ情報および有効な設計ツールが使えるかどうかに依存します。


正規マークアップの使い方

正規マークアップを使う場合は、最初にパート II 「設計者が行う作業」を読んでヘルプタグ要素の設定を理解してください。簡易マークアップと正規マークアップは同じタグセットを共有しますが、重要な相違点がいくつかあります。

第 8 章「ヘルプタグ文書型定義の読み方」では、文書型定義 (DTD) の主要なコンポーネントを説明し、正規マークアップの方法を示します。完全なヘルプタグ文書型定義は、付録 A「ヘルプタグ 1.3 DTD」にあります。


注 -

開発者キットには、ヘルプタグ文書型定義が入っています。ファイルは /usr/dt/dthelp/dthelptag/dtd ディレクトリにあり、helptag.dtd という名前です。


関連項目