JavaHelp
――効果的なヘルプメッセージの作り方

[cover photo]
  • 2000年11月 発行
  • 192ページ
  • ISBN4-87311-030-0
  • 原書: Creating Effective JavaHelp
  • フォーマット

この商品は品切れ再入荷未定です

Javaアプリケーションに最適なヘルプシステムの唯一の解説書です。インターネットビジネスにおいてeコマース、データベース、高機能サイトなどWebアプリケーションとJavaプログラムのニーズが高まっています。JavaHelpはJavaで開発されたあらゆるアプリケーションに対応できるオンラインヘルプ作成のためのJava拡張のひとつです。本書はJavaHelpを使ってオンラインヘルプを作成するための実践的なプログラミングテクニックだけでなく効果的なヘルプ画面の設計手法や戦略の立て方まで解説しています。本格的なJavaアプリケーションの設計・開発をされる方必携の1冊です。

1章 JavaHelpを理解する
        1.1     JavaHelpとは
        1.2     JavaHelpを使ってオンライン文書を作成する
                1.2.1   なぜJavaHelpをオンラインヘルプに使うのか
                1.2.2   JavaHelpとその他のオンラインヘルプシステムとの比較
                1.2.3   JavaHelpをオンライン文章作成に使う
        1.3     HelpSetファイルを理解する
        1.4     JavaHelpの動作プロセスを理解する
        1.5     JavaHelpのインストール
        1.6     JavaHelpを動かしてみる
                1.6.1   JavaHelpシステムをスタートさせてみる
                1.6.2   JavaHelpインターフェースを使ってみる
                1.6.3   ツールバーのコントロールやメニューを使ってみる
                1.6.4   JavaHelpシステムをナビゲートする
                1.6.5   ヘルプトピックの表示
        1.7     HelpSet提示の仕方を決める
                1.7.1   単独型ヘルプを使う
                1.7.2   文脈依存型ヘルプを使う
                1.7.3   埋め込み型ヘルプを使う
        1.8     HelpSetのインストール法を決める
                1.8.1   ローカルアプリケーション
                1.8.2   ネットワークアプリケーション
                1.8.3   Javaアプレット
                1.8.4   Java製品スイート
        1.9     HelpSetファイルのカプセル化
        1.10    JavaHelpについてさらに調べるには

2章 初めてのHelpSetを作成する
        2.1     HelpSetのディレクトリ構造の作成
        2.2     HelpSetデータとナビゲーションファイルの作成
                2.2.1   HelpSetファイルの作成
                2.2.2   マップファイルの作成
                2.2.3   ナビゲーションファイルの作成
                2.2.4   索引ファイルの作成
        2.3     Helpトピックファイルの作成
        2.4     自作ヘルプのチェック
        2.5     できあがったHelpSetのテスト

3章 JavaHelpプロジェクトの設計
        3.1     一般的なプロジェクト設計作業
                3.1.1   読者対象の定義
                3.1.2   対象ユーザのニーズを定義する
                3.1.3   ハードコピー文書との統合を設計する
                3.1.4   アウトラインの作成
                3.1.5   アウトラインのテスト
                3.1.6   プロジェクト作業の予定管理
        3.2     JavaHelpに特有の設計作業
                3.2.1   HelpSetの示し方を決める
                3.2.2   HelpSetのインストール法を決める
                3.2.3   ファイルとデータ構造をアウトライン化する
                3.2.4   ナビゲーションコンポーネントの設計

4章 ヘルプトピックの作成
        4.1     ヘルプトピックの設計
                4.1.1   ヘルプ作成者への作業の割り振り
                4.1.2   ヘルプトピックに情報を組織化する
                4.1.3   チームメンバーの了解を得る
        4.2     ヘルプトピックの作成と適切なHTMLタグの付与
                4.2.1   HTMLファイルの命名
                4.2.2   テキストに書式を付ける
                4.2.3   リンクの使用
        4.3     効果的で意味の明解なヘルプトピックの執筆
                4.3.1   ユーザのオンラインヘルプの読み方を理解する
                4.3.2   情報のチャンク分け
                4.3.3   トピックコンテンツの執筆
                4.3.4   トピックの長さを決める
                4.3.5   トピックタイトルを考える
        4.4     既存のHTMLトピックファイルの利用

5章 HelpSetデータとナビゲーションファイルの作成
        5.1     XMLを理解する
        5.2     HelpSetファイルの作成
                5.2.1   HelpSetデータ要素について理解する
                5.2.2   ナビゲーションコンポーネント要素を理解する
        5.3     マップIDをヘルプトピックに割り当てる
                5.3.1   マップファイル
                5.3.2   マップファイル名の付け方
                5.3.3   マップファイルの構造化
        5.4     ナビゲーションコンポーネントの指定
                5.4.1   目次(TOC)の作成      
                5.4.2   索引の作成
                5.4.3   キーワード検索索引の作成

6章      HelpSetの機能強化
        6.1     ポップアップウィンドウと二次ウィンドウの作成
                6.1.1   ポップアップウィンドウと二次ウィンドウの相違点 
                6.1.2   ポップアップ・二次ウィンドウのプログラミング
        6.2     ナビゲーション機能のカスタマイズ
                6.2.1   ナビゲーションコンポーネントのツールチップの変更
                6.2.2   ナビゲーションコンポーネントの削除
                6.2.3   ナビゲーションコンポーネントタブの再配置
                6.2.4   TOCのカスタマイズ
                6.2.5   高度なキーワード検索索引機能の利用
        6.3     HelpSetのマージ
                6.3.1    要素の使用
                6.3.2   マージの欠点
                6.3.3   マージされるHelpSetをもつプロジェクトの管理

7章 JavaHelp APIを利用した高度な提示法
        7.1     TypeFacerアプリケーション
        7.2     ボタンやメニュー、キーを用いたヘルプ呼び出し  
        7.3     スクリーンレベル文脈依存型ヘルプの利用
                7.3.1   スクリーンレベル文脈依存型ヘルプのプログラミング
                7.3.2   概要ヘルプトピックの維持
        7.4     フィールドレベル文脈依存型ヘルプの利用
                7.4.1   フィールドレベル文脈依存型ヘルプのプログラミング
        7.5     ヘルプをアプリケーションに埋め込む
                7.5.1   埋め込み型ヘルプを理解する
                7.5.2   埋め込み型ヘルプのプログラミング
                7.5.3   プログラムによるビューアトピックの制御

8章      ユーザーへのヘルプシステムの配布
        8.1     HelpSetのカプセル化
                8.1.1   JARファイルの作成
        8.2     必要なファイルすべての配布
        8.3     基本的なJavaサポートの確保

9章      サードパーティ製ヘルプ作成ツールを使う
        9.1     JavaHelpとサードパーティ製ツールの関係
        9.2     サードパーティ製ツールの機能
                9.2.1   ForeHelp
                9.2.2   Doc-to-HelpとRoboHELP

付録A HelpSetタグ
付録B 軽量コンポーネントのタグ
付録C JavaHelp API
付録D TypeFacer.javaソースリスト

用語集 

索引

Feedback

皆さんのご意見をお聞かせください。ご購入いただいた書籍やオライリー・ジャパンへのご感想やご意見、ご提案などをお聞かせください。より良い書籍づくりやサービス改良のための参考にさせていただきます。
[feedbackページへ]