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

用語集

Standard Generalized Markup Language (SGML)

情報交換の方法を確立することを目的とする国際規格 (ISO 8879: 1986) です。SGML は、情報の構造の指定をマークアップにより行い、内容とは別に表示や書式を規定します。ヘルプタグ・マークアップ言語は、この SGML 規格に準拠しています。

Tagged Image File Format (TIFF)

標準グラフィック・ファイル書式です。ヘルプ・システムのダイアログ・ボックスは TIFF 5.0 イメージをサポートしています。TIFF イメージはファイル名拡張子 .tif で識別できます。

X ウィンドウ・ダンプ

X Window System ディスプレイから取り込んだイメージです。ウィンドウ・イメージの取り込みには xwd ユーティリティを使用します。X Window System のダンプ・イメージ・ファイルはファイル名拡張子 .xwd で識別できます。

X ピックスマップ

マルチカラー・イメージです。ピックスマップ・イメージ・ファイルはファイル名拡張子 .pm で識別できます。

X ビットマップ

フォアグラウンド・カラーとバックグラウンド・カラーから成る 2 色イメージです。ビットマップ・イメージ・ファイルはファイル名拡張子 .bm で識別できます。

アプリケーション・ヘルプ

特定のアプリケーション (ソフトウェア) 用のオンライン・ヘルプです。

アプリケーション定義リンク

あるアプリケーションの動作を呼び出すために特別に設計されたハイパーリンクです。動作を呼び出すには、ヘルプはアプリケーションで作成したダイアログに表示されなければなりません。(アプリケーション定義のハイパーリンクは、ヘルプ・ビューアでは無視されます。)

一般ヘルプ・ダイアログ・ボックス

ヘルプ情報が表示されるウィンドウです。ここにはメニュー・バー、トピック・ツリー (トピックのリストを表示します)、およびヘルプ・トピック表示領域があります。「簡易ヘルプ・ダイアログ・ボックス」を参照してください。

インライン・グラフィック

1 行のテキスト内に表示される小さなグラフィック (イラスト) です。

ウィジェット

グラフィカル・ユーザ・インタフェースの基本的な構成ブロックです。OSF/Motif ウィジェット・セットは、アプリケーション・ユーザ・インタフェースの構築に適したすべての種類のウィジェットを提供します。

エンティティ

名前の付いているテキスト文字列またはファイルです。ほとんどのエンティティは (<!entity> 要素を使用して) 設計者が名付けますが、あらかじめ定義されているものもあります。「エンティティの宣言」「エンティティの参照」を参照してください。

エンティティの参照

前に & (アンド記号)、後ろに ; (セミコロン) が付いているエンティティ名を使用して、エンティティ名を記述した場所にそのエンティティを挿入するよう、ヘルプタグに指示することです。「エンティティ」「エンティティの宣言」を参照してください。

エンティティの宣言

エンティティ名とボリュームを確立するようにマークすることです。「エンティティ」「エンティティの参照」を参照してください。

エントリ・ポイント

ヘルプを要求すると直接表示されるヘルプ・ボリュームにあるポイントです。つまり、ユーザが「入力」するトピックの場所またはオンライン・ヘルプを読み始める場所です。ID を持つあらゆるトピック、またはトピック内の場所がエントリ・ポイントになり得ます。

簡易ヘルプ・ダイアログ・ボックス

ヘルプ・トピック表示領域と 1 つ以上のプッシュ・ボタンがある、簡素化したヘルプ・ダイアログ・ボックスです。その他の機能を提供する「一般ヘルプ・ダイアログ・ボックス」を参照してください。

簡易マークアップ

要素をマークする方法を省略した形式です。簡易マークアップでは、開始タグと終了タグを特別な 2 文字の文字列で置き換えます。たとえば、<computer> という要素の簡易マークアップは、次のように開始の単一引用符を 2 つ付け、終わりに閉じる単一引用符を 2 つ付けます。

``text''
強調表示

テキスト上で注意を促す要素です (通常はイタリック文字です)。日本語では、イタリック書体のフォントが提供されていない場合、それに代わる書体、たとえばボールドで表示されます。

クローズ・コールバック

ヘルプ・ダイアログ・ボックスを閉じたときに呼び出すアプリケーション機能です。

警告

発生する可能性がある損害や回復不可能なデータ損失をユーザに警告する情報です。「注意」「注」を参照してください。

検索ボリューム選択ダイアログ・ボックス

ユーザのシステムで使用可能なヘルプ・ボリュームをリストしたダイアログ・ボックスです。ユーザが索引検索ダイアログ・ボックスで [選択] を選択すると、ユーザが選択できるヘルプ・ボリュームがこのダイアログ・ボックスにリストされます。ボリューム名は 1 つ以上選択でき、対応する索引情報が索引検索ダイアログ・ボックスに報告されます。

コンテキスト・ヘルプ

ユーザがアプリケーションで行う作業に関するオンライン情報です。ヘルプ・トピックの選択はユーザのコンテキストに基づいて行われるため、[F1] キーを押すと「コンテキスト・ヘルプ」が表示される場合もあります。

索引

ヘルプ・ボリューム中に現れる重要な語句のリストです。索引には語句がアルファベット順に並んでいて、知りたい項目についてのヘルプを検索できます。ユーザが (一般ヘルプ・ダイアログ・ボックスの) [索引] ボタンを選択すると、ヘルプ・システムは索引を表示します。「索引検索ダイアログ・ボックス」を参照してください。

索引検索ダイアログ・ボックス

ヘルプ・ボリュームの索引エントリのリストを表示するダイアログ・ボックスです。現在のボリューム、選択したボリューム、すべてのヘルプ・ボリュームの索引を表示できます。ユーザが索引で特定の語句を検索すると、その検索文字列を含む項目がリストされます。

実行時のヘルプ・ファイル

dthelptag コマンドで生成されるファイルです。これらのファイルはヘルプ・システムを使用するユーザに配布されます。

実行別名

実行リンクが実行するコマンド文字列またはスクリプトへ名前を割り当てるリソースです。

実行ポリシー

実行リンクの動作を制御するよう設定できるリソースを提供するヘルプ・システムです。システム管理者またはユーザが、指定されたアプリケーションに対して適切なセキュリティ・レベルを確立できるようにします。

実行リンク

シェル・コマンドまたはシェル・スクリプトを実行するハイパーリンクです。

自動ヘルプ

特定の条件またはエラーが生じると、システムがヘルプを表示します。「システム起動ヘルプ」と呼ばれることもあります。たとえば、エラー・ダイアログは「自動ヘルプ」の形式です。「半自動ヘルプ」「手動ヘルプ」を参照してください。

手動ヘルプ

どんなヘルプが必要で、どうすればそれが得られるかを、ユーザがわかっていなければ使用できないオンライン・ヘルプです。たとえば [ヘルプ] メニューのコマンドの大半は、いつ何を表示するかをユーザが選択するので、「手動」ヘルプです。「自動ヘルプ」「半自動ヘルプ」を参照してください。

新規ウィンドウ表示ハイパーリンク

選択されると新しいダイアログ・ボックスに情報を表示するハイパーリンクです。新規ウィンドウ表示リンクは、他のボリュームへのリンクを目的としています。ユーザは、新規ウィンドウが表示されることによって「新しいコンテキスト」だとわかります。

スタンドアロン・ヘルプ

アプリケーション・ソフトウェアとは無関係に使用されるヘルプ情報です。たとえば、コンピュータ・プログラミングの基本を説明するオンライン・ヘルプは、特定のアプリケーションに関連付けられてはいません。スタンドアロン・ヘルプ・ボリュームは、dthelpview コマンドで表示できます。

ヘルプ情報で表示されるグラフィックまたはイラストです。

正規マークアップ

ヘルプタグ 1.3 文書型定義 (DTD) で指定されたタグ・セットおよびその使用規則です。DTD で決められた規則に従うことにより、設計者は Standard Generalized Markup Language (SGML) 準拠ヘルプ・ソース・ファイルを生成できます。

ダイアログ・キャッシュ

作成されても使用されていないヘルプ・ダイアログのリストです。アプリケーションは、新しいヘルプ・ダイアログを必要とする場合、まずダイアログ・キャッシュに未使用のダイアログがないかどうか検索します。見つかればそれを使用し、見つからない場合は新しいダイアログを作成します。

タグ

要素の始めと終わりをマークするテキスト文字列です。開始タグは、< (左三角括弧)、特殊文字列 (文字のみ)、オプションのパラメータと値、> (右三角括弧) から成ります。

終了タグは、< (左三角括弧)、¥ (バックスラッシュ)、開始タグと同じ特殊文字列、> (右三角括弧) から成ります。正規マークアップでは、終了タグ構文に / (スラッシュ) を使用します。

ユーザに注意してほしい重要な情報であることを示します。情報の内容が特に重大な場合は、代わりに注意や警告が使われます。「注意」「警告」を参照してください。

注意

データが失われる恐れがあることをユーザに知らせる警告です。「注」「警告」を参照してください。

登録

ヘルプ・ボリュームが、ブラウズや他のボリュームへのリンクのためにアクセス可能であると宣言するプロセスです。

トピック

特定のサブジェクトに関する情報です。通常、これは約 1 画面分の情報です。オンライン・ヘルプのトピックは、ハイパーリンクによって互いにリンクされています。

トピック階層

ホーム・トピックが (ハイパーリンクによって) だんだん詳しいトピックに分岐していく、ヘルプ・ボリュームの分岐構造です。「ホーム・トピック」を参照してください。

トピック・ツリー

一般ヘルプ・ダイアログ・ボックスで、ヘルプ情報を表示するために選択できるトピックのリストです。

パーサ

ヘルプタグ・ソフトウェアの一部で、(設計者が作成した) ソース・ファイルを読み取り、ヘルプ・システム・ダイアログが読み取れる実行時のヘルプ・ファイルに変換します。設計者がマークアップを不正確に (または不完全に) 使用した場合、パーサは障害を検出して「パーサ・エラー」の発生を通知します。

ハイパーリンク

テキスト (語句) のセグメント、あるいはそれに対応する動作を示すグラフィック・イメージです。最も典型的なハイパーリンクは、関連するトピックにつながる「ジャンプ」リンクです。ユーザがジャンプ・リンクを選択すると、関連するトピックが表示されます。また、他の動作、つまりシステム・コマンドの実行や特定のアプリケーションの呼び出しなどを起動することもできます。

ハイパーリンク・コールバック

ユーザがハイパーリンクを選択したときに呼び出されるアプリケーション機能です。ヘルプ・ダイアログで自動的に処理されないタイプのハイパーリンクを処理します。

半自動ヘルプ

ユーザがヘルプを要求すると、システムが現在の状況に応じてどのヘルプ情報を表示するかを決定する形式のオンライン・ヘルプです。「コンテキスト・ヘルプ」([F1] キーを押す) は、半自動ヘルプの一例です。「自動ヘルプ」「手動ヘルプ」を参照してください。

ヒストリ・ダイアログ・ボックス

ユーザが使用したトピックを順にリスト表示するダイアログ・ボックスです。ヒストリの順序は、ユーザが最初に使用したトピックに戻りやすくするために、逆の順序で表示することもできます。

ブラウザ・ボリューム

デスクトップは、システムにインストールされたヘルプをリストするスペシャル・ブラウザ・ボリュームを表示することにより、ヘルプ・ビュープログラムを「ヘルプ・ブラウザ」として使用します。dthelpgen と呼ばれるユーティリティは、このボリュームをユーザのホーム・ディレクトリに作成します。

文書型定義 DTD (Document Type Definition)

構造化 (または階層) 情報を作成するのに使用する一連の要素の記述です。DTD は各要素の構文と、ドキュメントでその要素がどのようにどこで使用されるかを指定します。

ヘルプ・キー

通常は [F1] ファンクション・キーですが、現在のコンテキストのヘルプを要求するためのキーです。[F1] キーに代わる [Help] キーが用意されているキーボードもあります。OSF/Motif アプリケーションでは、ウィジェットにヘルプ・コールバックを追加すると ヘルプ・キーが使用可能になります。

ヘルプ・コールバック

ユーザが [F1] キーを押したときに呼び出されるアプリケーション機能です。

ヘルプの使い方

ヘルプ・ダイアログ・ボックスの使用方法を説明したヘルプ情報です。ヘルプ・ウィンドウを使用しているときは [F1] キー、または一般のヘルプ・ダイアログ・ボックスの [ヘルプの使い方] を選択することにより、この情報を取得できます。

ヘルプ・ファミリ

参照するアプリケーションが関連している一連のヘルプ・ボリュームです。

ヘルプ・ボリューム

サブジェクトに関する完全情報です。また、マークアップ・テキストを含む一連のソース・ファイルまたはヘルプタグを使用することにより生成される実行時のヘルプ・ファイルのいずれかを指すこともあります。

ホーム・トピック

ヘルプ・ボリュームの階層の最高位にあるトピックです。ユーザがヘルプ・ボリュームをブラウズしたいことを示すときに表示されるトピックです。ヘルプタグはホーム・トピックの組み込み ID (_hometopic) を提供します。

他のボリュームへのハイパーリンク

他のヘルプ・ボリュームのトピックにジャンプするハイパーリンクです。これは <link> 要素で入力できます。ここで hyperlink パラメータはボリューム名およびボリューム ID (スペースで区切ります) を指定します。例を以下に示します。

<link hyperlink="volume">text<¥link> 
マニュアル・ページへのリンク

起動されると「マニュアル・ページ」を表示するハイパーリンクです。マニュアル・ページとは、システム・コマンドについてのオンラインの短い説明です。マニュアル・ページ上の情報は、ヘルプタグ・システムでは提供されません。

要素

本のタイトル、段落、リスト、またはトピックなど、情報の論理部分です。一部の要素はコンテキストが想定しますが、通常、要素のエクステントはタグによってマークされます。

略式マークアップ

要素をマークする方法を省略した形式です。略式マークアップでは、終了タグと、開始タグの最後の文字を一本の縦線でマークします。たとえば、<book> という要素の略式マークアップは次のとおりです。

<book|text|
例表示

コンピュータのフォントで表示されるテキストの本文で、行分割が意図的に行われています。一般には、コンピュータ・ファイルの一部です。<ex> または <vex> 要素を使用して入力されます。