はじめに
このマニュアルでは、共通デスクトップ環境アプリケーション・ソフトウェアのオンライン・ヘルプの開発方法について説明します。ヘルプ・トピックの作成方法や、オンライン・ヘルプを OSF/Motif アプリケーションに統合する方法についても説明します。
対象読者
このマニュアルの対象読者は次のとおりです。
-
オンライン・ヘルプ情報を設計、作成、検証する設計者
-
完全なヘルプ機能を備えたソフトウェア・アプリケーションを作成することを目的としている開発者
内容の紹介
このマニュアルは 4 つのパートから構成されています。パート I 「概要」では、アプリケーション・ヘルプの設計段階で必要な設計者と開発者の協力と役割について述べます。パート II 「設計者が行う作業」では、オンライン・ヘルプを構成し記述する設計者に必要な情報を提供します。パート III 「プログラマが行う作業」では、ヘルプ・システムのアプリケーション・プログラマのツールキットを説明します。パート IV 「国際化対応」では、多言語環境でオンライン・ヘルプを使用する場合に設計者とプログラマの両方に必要な情報を提供します。
このマニュアルは次の章から構成されています。
パート I 「概要」
オンライン・ヘルプの作成にあたり、設計者と開発者の協力的な役割について説明します。
パート II 「設計者が行う作業」
ヘルプ・ボリュームの構成に必要な要素を説明します。
ヘルプ・システム・マークアップ言語を概説し、さまざまなタイプの情報をフォーマットするのに使用する要素の例を示します。グラフィックを入れる方法とハイパーリンクの作成についても説明します。
1 つまたは複数のマークアップ・ファイルを処理して、オンライン表示を行うための実行時のファイルを生成する方法を説明します。
ヘルプタグ・マークアップ言語要素を、各要素の例と共にアルファベット順に説明します。
特殊文字をヘルプ・トピックのテキストに入力するのに使用する文字と、それに対応するエンティティ名のリストを示します。
端末エミュレータ・ウィンドウにコマンドを入力して、ヘルプ・ボリュームを処理および表示する方法を要約します。
ヘルプタグ DTD (文書型定義) の概要と、それを使用して完全に SGML (Standard Generalized Markup Language) に準拠するヘルプ・ファイルを作成する方法を説明します。
パート III 「プログラマが行う作業」
ヘルプ・ダイアログ・ウィジェットの概要と使い方を説明します。
さまざまなヘルプにアクセスするためにエントリ・ポイントを提供する方法を説明します。
コールバック構造を使用してハイパーリンク・イベントを処理する方法を示します。
ユーザにヘルプ・システムの使い方を示すヘルプ・モジュールの作成方法を説明します。
アプリケーションでオンライン・ヘルプを提供するために、インストール・パッケージに含まれているものについて説明します。
パート IV 「国際化対応」
ヘルプ・システムで使用する言語依存ファイルを示します。
「用語集」
このマニュアルに出てくる語句とその定義のリストです。
関連マニュアル
このマニュアルの利用にあたっては、次のマニュアルが参考になります。
SGML の技術的な説明については、次の文書を参照してください。
-
『SGML Handbook』Charles F. Goldfarb、Oxford University Press (ISBN 0-19-853737-9)
Sun のマニュアルの注文方法
専門書を扱うインターネットの書店 Fatbrain.com から、米国 Sun MicrosystemsTM, Inc. (以降、SunTM とします) のマニュアルをご注文いただけます。
マニュアルのリストと注文方法については、http://www1.fatbrain.com/documentation/sun の Sun Documentation Center をご覧ください。
Sun のオンラインマニュアル
http://docs.sun.com では、Sun が提供しているオンラインマニュアルを参照することができます。マニュアルのタイトルや特定の主題などをキーワードとして、検索をおこなうこともできます。
表記上の規則
このマニュアルでは、次のような字体や記号を特別な意味を持つものとして使用します。
表 P-1 表記上の規則|
字体または記号 |
意味 |
例 |
|---|---|---|
|
AaBbCc123 |
コマンド名、ファイル名、ディレクトリ名、画面上のコンピュータ出力、コード例を示します。 |
.login ファイルを編集します。 ls -a を使用してすべてのファイルを表示します。 system% |
|
AaBbCc123 |
ユーザーが入力する文字を、画面上のコンピュータ出力と区別して示します。 |
system% su password: |
|
AaBbCc123 |
変数を示します。実際に使用する特定の名前または値で置き換えます。 |
ファイルを削除するには、rm filename と入力します。 |
|
『 』 |
参照する書名を示します。 |
『コードマネージャ・ユーザーズガイド』を参照してください。 |
|
「 」 |
参照する章、節、ボタンやメニュー名、強調する単語を示します。 |
第 5 章「衝突の回避」を参照してください。 この操作ができるのは、「スーパーユーザー」だけです。 |
|
¥ |
枠で囲まれたコード例で、テキストがページ行幅を超える場合に、継続を示します。 |
sun% grep `^#define ¥ XV_VERSION_STRING' |
ただし AnswerBook2TM では、ユーザーが入力する文字と画面上のコンピュータ出力は区別して表示されません。
コード例は次のように表示されます。
[ ] は省略可能な項目を示します。上記の例は、filename は省略してもよいことを示しています。
| は区切り文字 (セパレータ) です。この文字で分割されている引数のうち 1 つだけを指定します。
キーボードのキー名は英文で、頭文字を大文字で示します (例: Shift キーを押します)。ただし、キーボードによっては Enter キーが Return キーの動作をします。
ダッシュ (-) は 2 つのキーを同時に押すことを示します。たとえば、Ctrl-D は Control キーを押したまま D キーを押すことを意味します。
一般規則
-
このマニュアルでは、英語環境での画面イメージを使っています。このため、実際に日本語環境で表示される画面イメージとこのマニュアルで使っている画面イメージが異なる場合があります。本文中で画面イメージを説明する場合には、日本語のメニュー、ボタン名などの項目名と英語の項目名が、適宜併記されています。
-
このマニュアルでは、「IA」という用語は、Intel 32 ビットのプロセッサアーキテクチャを意味します。これには、Pentium、Pentium Pro、Pentium II、Pentium II Xeon、Celeron、Pentium III、Pentium III Xeon の各プロセッサ、および AMD、Cyrix が提供する互換マイクロプロセッサチップが含まれます。
- © 2010, Oracle Corporation and/or its affiliates