このマニュアルでは、共通デスクトップ環境アプリケーション・ソフトウェアのオンライン・ヘルプの開発方法について説明します。ヘルプ・トピックの作成方法や、オンライン・ヘルプを OSF/Motif アプリケーションに統合する方法についても説明します。
このマニュアルの対象読者は次のとおりです。
オンライン・ヘルプ情報を設計、作成、検証する設計者
完全なヘルプ機能を備えたソフトウェア・アプリケーションを作成することを目的としている開発者
このマニュアルは 4 つのパートから構成されています。パート I 「概要」では、アプリケーション・ヘルプの設計段階で必要な設計者と開発者の協力と役割について述べます。パート II 「設計者が行う作業」では、オンライン・ヘルプを構成し記述する設計者に必要な情報を提供します。パート III 「プログラマが行う作業」では、ヘルプ・システムのアプリケーション・プログラマのツールキットを説明します。パート IV 「国際化対応」では、多言語環境でオンライン・ヘルプを使用する場合に設計者とプログラマの両方に必要な情報を提供します。
このマニュアルは次の章から構成されています。
パート I 「概要」
オンライン・ヘルプの作成にあたり、設計者と開発者の協力的な役割について説明します。
パート II 「設計者が行う作業」
ヘルプ・ボリュームの構成に必要な要素を説明します。
ヘルプ・システム・マークアップ言語を概説し、さまざまなタイプの情報をフォーマットするのに使用する要素の例を示します。グラフィックを入れる方法とハイパーリンクの作成についても説明します。
1 つまたは複数のマークアップ・ファイルを処理して、オンライン表示を行うための実行時のファイルを生成する方法を説明します。
ヘルプタグ・マークアップ言語要素を、各要素の例と共にアルファベット順に説明します。
特殊文字をヘルプ・トピックのテキストに入力するのに使用する文字と、それに対応するエンティティ名のリストを示します。
端末エミュレータ・ウィンドウにコマンドを入力して、ヘルプ・ボリュームを処理および表示する方法を要約します。
ヘルプタグ DTD (文書型定義) の概要と、それを使用して完全に SGML (Standard Generalized Markup Language) に準拠するヘルプ・ファイルを作成する方法を説明します。
パート III 「プログラマが行う作業」
ヘルプ・ダイアログ・ウィジェットの概要と使い方を説明します。
さまざまなヘルプにアクセスするためにエントリ・ポイントを提供する方法を説明します。
コールバック構造を使用してハイパーリンク・イベントを処理する方法を示します。
ユーザにヘルプ・システムの使い方を示すヘルプ・モジュールの作成方法を説明します。
アプリケーションでオンライン・ヘルプを提供するために、インストール・パッケージに含まれているものについて説明します。
パート IV 「国際化対応」
ヘルプ・システムで使用する言語依存ファイルを示します。
「用語集」
このマニュアルに出てくる語句とその定義のリストです。
このマニュアルの利用にあたっては、次のマニュアルが参考になります。
『Solaris 共通デスクトップ環境 上級ユーザ及びシステム管理者ガイド』
『共通デスクトップ環境 プログラマーズ・ガイド(国際化対応編)』
『共通デスクトップ環境 スタイル・ガイド』
『Solaris 共通デスクトップ環境 ユーザーズ・ガイド』
SGML の技術的な説明については、次の文書を参照してください。
『SGML Handbook』Charles F. Goldfarb、Oxford University Press (ISBN 0-19-853737-9)
SunDocsTM プログラムでは、米国 Sun MicrosystemsTM, Inc. (以降、SunTM とします) の 250 冊以上のマニュアルを扱っています。このプログラムを利用して、マニュアルのセットまたは個々のマニュアルをご注文いただけます。
マニュアルのリストと注文方法については、米国 SunExpressTM, Inc. のインターネットホームページ http://www.sun.com/sunexpress にあるカタログセクションを参照してください。
このマニュアルでは、次のような字体や記号を特別な意味を持つものとして使用します。
表 P-1 表記上の規則
字体または記号 |
意味 |
例 |
---|---|---|
AaBbCc123 |
コマンド名、ファイル名、およびディレクトリ名を示します。または、画面上のコンピュータ出力を示します。 |
.login ファイルを編集します。 ls -a を使用してすべてのファイルを表示します。 system% |
AaBbCc123 |
ユーザが入力する文字を、画面上のコンピュータ出力とは区別して示します。 |
system% su password: |
AaBbCc123 |
変数を示します。実際に使用する特定の名前または値で置き換えます。 |
ファイルを削除するには、rm filename と入力します。 |
『 』 |
参照する書名を示します。 |
『コードマネージャ・ユーザーズガイド』を参照してください。 |
「 」 |
参照する章や節を示します。また、ボタンやメニューなど、強調する単語を囲む場合にも使用します。 |
第 5 章「衝突の回避」を参照してください。 |
コード例は次のように表示されます。
[ ] は省略可能な項目を示します。上記の場合、filename は省略してもよいことを示します。
ただし AnswerBook2TM では、ユーザが入力する文字と画面上のコンピュータ出力は区別して表示されません。