ヘルプ・システム

共通デスクトップ環境のヘルプ・システムは、アプリケーション・ソフトウェアのオンライン・ヘルプを開発および表示するための完全なシステムです。これにより、設計者は豊富なグラフィックとテキスト・フォーマット、ハイパーリンクを備えたオンライン・ヘルプを書くことができ、アプリケーションからヘルプ・システムへアクセスできます。ヘルプ・システムはヘルプ機能をアプリケーションへ統合するためのプログラマのツールキットを提供します。

オンライン・ヘルプの作成とアプリケーションへの統合は、共同作業で行われます。ユーザのヘルプ要求にアプリケーションがどのように応答するかは、開発者が設計し実装します。設計者は、実際に表示されるヘルプ情報を構成し作成します。

ヘルプ・システムには次のものが含まれます。

設計者用

• 共通デスクトップ環境のヘルプタグ・マークアップ言語

  オンライン・ヘルプの構成と内容をマークするためのテキスト・ファイルに使用するタグ・セット

• 共通デスクトップ環境のヘルプタグ・ソフトウェア

  ヘルプタグ・ファイルを実行時のヘルプ・ファイルに変換するためのソフトウェア・ツール・セット

• 共通デスクトップ環境のヘルプビュー・アプリケーション

  オンライン・ヘルプを表示するためのビューア・プログラム

設計者はヘルプ・タグ・セットを使用し、Structured Graphic Markup Language (SGML) タグ規則に従ってヘルプ・トピックを作成します。SGML マークアップは一次データ・フォーマットです。コンパイルされた実行時のフォーマットは SGML に準拠します。

ヘルプ・システムは、UNIX マニュアル・ページ、テキスト・ファイル、テキスト文字列などの SGML でないフォーマットもサポートします。

プログラマ用

• DtHelp プログラミング・ライブラリ

  ヘルプ・ウィンドウを作成してアプリケーションと統合するための アプリケーション・プログラム・インタフェース (API)

• DtHelp ウィジェット

  ヘルプ・ダイアログ・ボックスと簡易ヘルプ・ダイアログ・ボックス (いずれもヘルプ・ライブラリの一部) を作成するための DtHelpDialog および DtHelpQuickDialog ウィジェット

ライブラリおよびヘッダ・ファイル

ヘルプ・ライブラリ libDtHelp は、Motif に基づくヘルプ・ダイアログの作成と管理をサポートします。libDtHelp ヘッダ・ファイルは次のとおりです。

• Dt/Help.h

• Dt/HelpDialog.h

• Dt/HelpQuickD.h

デモ・プログラム

/usr/dt/examples/dthelp にヘルプ・システム・デモがあります。デモの詳細は、 README ファイルを参照してください。

関連マニュアル

ヘルプ・システムの詳細は、関連するマニュアル・ページと『プログラマーズ・ガイド (ヘルプ・システム編)』を参照してください。