Documentation Home
> 共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)
共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)
Book Information
はじめに
パート I 概要
第 1 章 ヘルプ・システムの概要
ヘルプ・システムの概要
開発者のツールキット
設計者用ツールキット
アプリケーション開発者用ツール
オンライン・ヘルプの概要
ヘルプ情報モデル
アプリケーションとの統合
ヘルプの種類
ユーザがヘルプを獲得する方法
[ヘルプ] キー
[ヘルプ] メニュー
[ヘルプ] ボタン
ヘルプ・ユーザ・インタフェース
ヘルプ・ウィンドウ
ハイパーリンク
ヘルプ・ナビゲーション
ヘルプ・ナビゲーション・ボタン
ヘルプ・メニュー
ヘルプ索引
ヘルプからの印刷
ヘルプ・トピックの構成
ヘルプ・トピック
ヘルプ・ボリューム
ヘルプ・ファミリ
ヘルプ・ブラウザ・ボリューム
設計者が行う作業
オンライン・ヘルプの目的
対象となるユーザ
ヘルプへのアクセス方法
アプリケーションのヘルプ
スタンドアロン・ヘルプ・ボリューム
ヘルプの表示方法の評価
アプリケーション・プログラマとの協力
設計者のワークフロー
ヘルプタグによるヘルプ・トピックの記述
簡易マークアップ
正規マークアップ
構造化エディタ
正規マークアップの使い方
関連項目
形式ではなく構造を考える
実行時のヘルプ・ファイルの作成
ユーザを想定したヘルプのレビュー
プログラマが行う作業
ヘルプへのアクセス方法
ヘルプの設計者との協力
ヘルプのエントリ・ポイントの識別
ヘルプ・ダイアログの作成と管理
パッケージとヘルプの割り当て
パート II 設計者が行う作業
第 2 章 ヘルプ・ボリュームの構成および記述
ヘルプ・ボリュームのコンポーネント
ホーム・トピック
トピックとサブトピック
エンティティ
メタ情報
用語集
一般的なマークアップのガイドライン
ソース・ファイル内のマークアップ
簡易マークアップ
正規マークアップ
ヘルプタグ記号の表示
ヘルプ・ボリュームの例
ヘルプ・ソース・ファイル
volume.htg ファイルの作成
複数のソース・ファイル
例
ファイル・マネージャのヘルプ・ファイル
関連項目
新規にヘルプ・ボリュームを記述する例
ソース・ディレクトリの作成
ビルド・ディレクトリの作成
マスタ・ヘルプタグ・ファイルの作成
helptag.opt ファイルの作成
実行時のヘルプ・ファイルの作成
ヘルプ・ボリュームの表示
関連項目
トピック階層の作成
例
関連項目
ホーム・トピックを作成するには
例
トピックを階層に追加するには
例
メタ情報トピックの作成
メタ情報セクションを作成するには
例
関連項目
非階層トピックの追加
非階層トピックを追加するには
例
関連項目
トピックへのアクセス
ID 名に関する規則
ID をトピックに追加するには
組み込み ID
ID をトピック内の要素に追加するには
例
エンティティの使い方
エンティティの宣言に関する規則
テキスト・エンティティを作成するには
例
ファイル・エンティティを作成するには
例: テキスト・ファイル・エンティティ
例: グラフィック・ファイル・エンティティ
関連項目
第 3 章 ヘルプ・トピックの記述
ヘルプ・トピックの作成
例
関連項目
トピック内に構造を作成する
パラグラフを開始するには
例
リストを作成するには
例
ラベル付きリストを作成するには
例
ラベル付きリストにヘッダを付けるには
例
関連項目
トピックにサブヘッダを付けるには
例
コンピュータ・リストを表示するには
例
関連項目
注、注意、警告を追加するには
例
関連項目
インライン要素の入力
語句を強調表示するには
例
本のタイトルを入力するには
例
Bold フォントで強調表示するには
コンピュータ・リテラルを表示するには
例
変数を表示するには
例
ハイパーリンクの作成
<xref> 要素の使い方
<xref> を使ってリンクを作成するには
リンク要素の使い方
<link> を使ってリンクを作成するには
例
定義済み ID へのリンクを作成するには
例
他のボリュームにあるトピックへのリンクを作成するには
例
関連項目
定義リンクを作成するには
例
関連項目
マニュアル・ページへのリンクを作成するには
例
関連項目
アプリケーション定義リンクを作成するには
例
メタ情報トピックへリンクするには
関連項目
実行リンクの制御
実行ポリシーのデフォルト動作
実行別名
実行別名を作成するには
例
ハイパーリンクでの実行別名の使用
実行別名を使用して実行リンクを作成するには
例
DtNexecutionPolicy リソース
関連項目
グラフィックの表示
図を作成するには
例
関連項目
インライン・グラフィックを表示するには
例
グラフィックのまわりをテキストで囲むには
例
関連項目
特殊文字の表示
特殊文字を表示するには
例
関連項目
コメントと作成者のメモの取り込み
コメントを挿入するには
例
作成者のメモを挿入するには
例
索引の作成
索引エントリをマークするには
例
用語集の作成
用語集の用語をマークするには
例
用語集に用語を定義するには
例
関連事項
第 4 章 ヘルプ・ボリュームの処理と表示
概要
ヘルプタグ・ソフトウェア
ボリュームの表示
実行時のヘルプ・ファイルの作成
実行時のヘルプ・ボリュームを作成するには
ヘルプタグの出力
手動で dthelptag コマンドを実行するには
例: コマンド
例: helptag.opt ファイル
関連項目
パーサ・エラーをレビューおよび修正するには
一般的なエラー
ヘルプ・ボリュームの表示
ヘルプ・ボリュームを表示するには
手動で dthelpview コマンドを実行するには
例
関連項目
例: 個人用ヘルプ・ディレクトリ
ブラウザ・ボリュームへのヘルプの追加
ブラウザ・ボリューム
ヘルプ・ファミリ・ファイル
ヘルプ・ファミリを作成するには
例
関連項目
ブラウザ・ボリュームを表示するには
手動でブラウザ・ボリュームを表示するには
関連項目
ヘルプ・トピックの印刷
ヘルプのテスト
ハイパーリンクの妥当性テスト
エントリ・ポイントの確認
索引エントリのチェック
グラフィックのテスト
パーサ・エラーのチェック
関連項目
第 5 章 ヘルプタグ・マークアップのリファレンス
マークアップ要素の解説
<!-- ... -->
形式
例
関連項目
<abbrev>
省略タイトル
形式
例
関連項目
<abstract>
概要
形式
例
注
関連項目
<<annotation text>>
注釈
形式
例
<book>
本のタイトル
形式
例
<caution>
注意の通知
形式
例
関連項目
<chapter>
章
形式
例
関連項目
<computer>
コンピュータ・リテラル
形式
例
関連項目
<copyright>
著作権の告知
形式
例
関連項目
<dterm>
用語の定義
形式
例
関連項目
<emph>
テキストの強調表示
形式
例
関連項目
<!entity>
エンティティの宣言
形式
エンティティの目的
例
関連項目
<esc>
エスケープ
形式
関連項目
<ex>
コンピュータの例
形式
例
関連項目
<figure>
図
形式
例
関連項目
<glossary>
用語集
形式
例
関連項目
<graphic>
インライン・グラフィック
形式
例
関連項目
<head>
ヘッダの挿入
形式
例
関連項目
<helpvolume>
アプリケーション・ヘルプ・ボリューム
形式
関連項目
<hometopic>
「ホーム」ヘルプ・トピックまたは最上位のヘルプ・トピック
形式
例
関連項目
<idx>
索引エントリ
形式
例
<image>
イメージ表示
形式
関連項目
<item>
リスト項目
形式
関連項目
<keycap>
キーボード・キー
形式
例
関連項目
<lablist>
ラベル付きリスト
形式
例
関連項目
<lineno>
行番号
形式
例
関連項目
<link>
ハイパーリンク
形式
注
例
関連項目
<list>
リスト
形式
例
関連項目
<location>
位置
形式
例
関連項目
<memo>
メモ
形式
例
関連項目
<metainfo>
メタ情報
形式
例
関連項目
<newline>
復帰改行
形式
例
関連項目
<note>
注
形式
例
関連項目
<otherfront>
他のメタ情報 (前付)
形式
関連項目
<otherhead>
他のヘッダ
形式
例
関連項目
<p>
新しい段落
形式
例
関連項目
<procedure>
プロシージャ
形式
例
関連項目
<quote>
引用符
形式
例
関連項目
<rsect>
参照セクション
形式
例
関連項目
<s1>...<s9>
サブセクション (<s1>, <s2>, ... , <s9>)
形式
例
関連項目
<sub>
サブスクリプト
形式
例
関連項目
<super>
スーパースクリプト
形式
例
関連項目
<term>
用語集の用語
形式
例
関連項目
<title>
ヘルプ・ボリューム・タイトル
形式
例
関連項目
<user>
ユーザの応答
形式
例
関連項目
<var>
変数
形式
例
関連項目
<vex>
逐語例
形式
例
関連項目
<warning>
警告
形式
例
関連項目
<xref>
相互参照
形式
例
関連項目
第 6 章 特殊文字エンティティの概要
特殊文字
第 7 章 コマンドの要約
ヘルプ・システム・コマンド
ヘルプタグ・ファイルの処理 (dthelptag)
コマンド形式
コマンド・オプション
パーサ・オプション
関連項目
ヘルプ・トピックの表示 (dthelpview)
コマンド形式
関連項目
ブラウザ・ヘルプ・ボリュームの作成 (dthelpgen)
コマンド形式
オプション
関連項目
第 8 章 ヘルプタグ文書型定義の読み方
文書型定義
ヘルプタグ 1.3 DTD
関連項目
DTD コンポーネント
要素宣言
例
要素宣言のキーワード
属性リスト宣言
正規マークアップ
正規マークアップの注意点
明示的な開始タグおよび終了タグ
要素の明確な階層
例
ファイル・エンティティ宣言
例
正規マークアップの処理
パート III プログラマが行う作業
第 9 章 ヘルプ・ダイアログ・ボックスの作成と管理
ヘルプ・ダイアログ・ボックス
標準 Xt 活用例
一般ヘルプ・ダイアログ
一般ヘルプ・ダイアログを作成するには
例
関連項目
簡易ヘルプ・ダイアログ
簡易ヘルプ・ダイアログを作成するには
例
関連項目
アプリケーション・プログラム・インタフェースの概要
第 10 章 ヘルプ要求への応答
ヘルプの要求
コンテキストの検知
エントリ・ポイント
ヘルプ・トピックの表示
関連項目
ヘルプ・トピックを表示するには
例
テキスト文字列を表示するには
例
テキスト・ファイルを表示するには
例
マニュアル・ページを表示するには
例
ヘルプ・キー ([F1] キー) を使用可能にする
ヘルプ・コールバックを追加するには
クライアント・データの重要性
例
[ヘルプ] メニューの提供
関連項目
アイテムヘルプ・モードのサポート
アイテムヘルプのサポートを追加するには
例
第 11 章 ヘルプ・ダイアログのイベント処理
ヘルプ・ダイアログ・イベントのサポート
ハイパーリンク・イベント
ダイアログを終了する場合
簡易ヘルプ・ボタン
関連項目
ハイパーリンク・イベントへの応答
ハイパーリンク・コールバックを指定するには
例
ヘルプ・ダイアログの終了の検出
アプリケーション構成ボタンの使い方
アプリケーション構成ボタンを使用可能にするには
例
関連項目
第 12 章 「ヘルプの使い方」の作成
「ヘルプの使い方」の作成
アプリケーション・ヘルプの場合
スタンドアロン・ヘルプの場合
「ヘルプの使い方」の検索方法
アプリケーションの「ヘルプの使い方」へのアクセス
helpOnHelpVolume リソースを設定するには
例
[ヘルプの使い方] コマンドを指定するには
例
「ヘルプの使い方」を表示するには
例
関連項目
独自の「ヘルプの使い方」ボリュームを記述する
必須のエントリ・ポイント
Help4Help ソース・ファイルをコピーするには
例
第 13 章 インストール・パッケージの準備
概要
オンライン・ヘルプの配布
インストール・パッケージの作成
実行時のヘルプ・ファイル
グラフィック・ファイル
ヘルプ・ファミリ・ファイル
アプリケーションとそのヘルプの登録
スタンドアロン・ヘルプ
アプリケーションの登録時に発生すること
ヘルプ・ボリュームの検索方法
製品準備チェックリスト
設計者の場合
製品のインテグレータの場合
プログラマの場合
パート IV 国際化対応
第 14 章 母国語のサポート
国際化されたオンライン・ヘルプ
国際化の要因
文字セットおよびマルチバイト文字
言語および地域名
ロケールおよび文字セット
例
ヘルプタグ・ソフトウェア
DtHelp メッセージ・カタログ
LANG 環境変数
関連項目
helplang.ent ファイル
フォーマット・テーブル
フォント・スキーマ
関連項目
フォント・スキーマの理解
フォント・リソース
フォント・スキーマの例
フォント・スキーマを選択するには
例
フォーマット・テーブルの作成
フォーマット・テーブルの例
メッセージ・カタログを作成するには
関連項目
ローカライズされたヘルプ・ボリュームの表示
オンライン・ヘルプの国際化対応の確認事項
関連項目
付録 A ヘルプタグ 1.3 DTD
用語集
索引
0
数字・記号
A
B
C
D
E
F
G
H
I
L
M
N
O
P
S
T
V
X
あ
い
う
え
お
か
き
く
け
こ
さ
し
す
せ
そ
た
ち
て
と
な
は
ひ
ふ
へ
ほ
ま
め
も
や
ゆ
よ
ら
り
れ
ろ
© 2010, Oracle Corporation and/or its affiliates