10.5 アプリケーションのヘルプの作成

アプリケーション・ビルダーで作成したヘルプは、専用のヘルプ・ページに表示されます。ヘルプを表示するには、専用の「ヘルプ」ページへのリンクをクリックします。このヘルプ・ページには、表示しているページに固有のページ・ヘルプおよびフィールドレベル・ヘルプのトピックが表示されます。

• ヘルプの作成
  開発者は、アプリケーションの専用のヘルプ・ページおよびアイテム・ヘルプ・テキストの両方を作成できます。
• 「アイテム・ヘルプをバルク編集」レポートの使用
  「アイテム・ヘルプをバルク編集」レポートを使用して、アプリケーション内のすべてのヘルプ・トピックを一度に編集できます
• アイテム・ヘルプ・トピックのシード
  ヘルプがまだ含まれていないアプリケーションの場合は、デフォルトのヘルプ・テキストの一括更新(またはシード)を実行できます。
• ヘルプ・ナビゲーション・バー・エントリの作成
  ヘルプを作成したら、次のステップとして、ユーザーがリンクに使用するためのナビゲーション・バー・エントリを作成します。

10.5.1 ヘルプの作成

開発者は、アプリケーションの専用のヘルプ・ページおよびアイテム・ヘルプ・テキストの両方を作成できます。

• ヘルプの作成について
  
• ヘルプ・ページおよびヘルプ・リージョンの作成
  
• ページ・ヘルプの定義
  
• アイテム・ヘルプの定義
  

10.5.1.1 ヘルプの作成について

アプリケーション・ビルダーには、アプリケーションのヘルプを作成するための組込み属性が含まれています。アプリケーションのヘルプを作成するには、次のステップを実行します。

• ステップ1: 専用のヘルプ・ページおよびヘルプ・リージョンを作成します。「ヘルプ・ページおよびヘルプ・リージョンの作成」を参照してください。
• ステップ2: ページ・ヘルプ・テキストを定義します。「ページ・ヘルプの定義」を参照してください。
• ステップ3: アイテム・ヘルプ・テキストを定義します。「アイテム・ヘルプの定義」を参照してください。
• ステップ4: ヘルプ・ページにリンクするためのナビゲーション・バー・アイコンを作成します。「ヘルプ・ナビゲーション・バー・エントリの作成」を参照してください。

10.5.1.2 ヘルプ・ページおよびヘルプ・リージョンの作成

ページ・デザイナでヘルプ・ページおよびヘルプ・リージョンを作成するには:

1. ヘルプ用の空白ページを作成します。
2. ページ・デザイナで新規ページを表示します。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
   2. アプリケーションを選択します。
   3. ページを選択します。
   ページ・デザイナが表示されます。
3. ギャラリで、「ヘルプ・テキスト」リージョンを右クリックして「追加先」を選択し、適切な位置を選択します。

   ヒント:

   ギャラリからドラッグ・アンド・ドロップすることもできます。ギャラリから、「ヘルプ・テキスト」リージョンを選択して、「レイアウト」タブの適切な位置にドラッグします。

4. プロパティ・エディタで、次の属性を編集します。
   1. 指定、タイトル - リージョンのタイトルを入力します。
   2. レイアウト、順序 - このアイテムの表示順序を入力します。順序および他のレイアウト設定によって、リージョン内の他のアイテムに対して相対的に、このアイテムの表示位置が決定されます。
   3. レイアウト、親リージョン - このリージョンが属する親リージョンを選択します。親リージョンが選択されている場合、このリージョンは完全に親リージョン内にレンダリングされます。
   4. レイアウト、位置 - 順序、親リージョンおよび位置を指定します。
   5. 外観、テンプレート - リージョン・テンプレートを選択して、このリージョンの外観とレイアウトを定義します。リージョン・テンプレートはアプリケーション・テーマで定義されます。リージョンが作成されると、テンプレートが、現在のテーマで定義されたデフォルトのリージョン・テンプレートに自動的に設定されます。
   6. 外観、コンポーネントのレンダリング - リージョン・コンポーネントがメイン・リージョン・コンテンツの上または下に表示する場合に選択します。

   ヒント:

   属性についてさらに学習するには、プロパティ・エディタで属性を選択し、中央ペインで「ヘルプ」タブをクリックして、参照してください。

5. 「保存」をクリックします。

   ヒント:

   サポートされるチャート・オプションの詳細は、Oracle JavaScript Extension Toolkit (JET)のJSDocページのojChartを参照してください。

関連項目:

アプリケーションへの新規ページの追加

10.5.1.3 ページ・ヘルプの定義

ページ・ヘルプ・テキストを定義するには:

1. ページ・デザイナで新規ページを表示します。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
   2. アプリケーションを選択します。
   3. ページを選択します。
   ページ・デザイナが表示されます。
2. 「レンダリング」タブで、ページ名をクリックします。
3. グループまたは属性を検索するには:

   • グループまたは属性の検索: 「フィルタ・プロパティ」フィールドにキーワードを入力します。プロパティ・エディタにグループまたは属性が表示されます。デフォルトの表示に戻すには、キーワードを削除します。

   • 「グループに移動」の使用: 「グループに移動」をクリックして、グループを選択します。デフォルトの表示に戻すには、「グループに移動」を再度クリックして、「すべて開く」を選択します。

4. 「プロパティ・エディタ - ページ」で、「ヘルプ」を見つけて、「ヘルプ・テキスト」属性にテキストを入力します。
5. 「保存」をクリックします。

10.5.1.4 アイテム・ヘルプの定義

アイテム・ヘルプを定義するには:

1. ページ・デザイナで新規ページを表示します。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
   2. アプリケーションを選択します。
   3. ページを選択します。
   ページ・デザイナが表示されます。
2. 「レンダリング」タブで、ヘルプを定義するアイテムをクリックします。
3. グループまたは属性を検索するには:

   • グループまたは属性の検索: 「フィルタ・プロパティ」フィールドにキーワードを入力します。プロパティ・エディタにグループまたは属性が表示されます。デフォルトの表示に戻すには、キーワードを削除します。

   • 「グループに移動」の使用: 「グループに移動」をクリックして、グループを選択します。デフォルトの表示に戻すには、「グループに移動」を再度クリックして、「すべて開く」を選択します。

4. プロパティ・エディタで、「ヘルプ」を検索し、「ヘルプ」属性にテキストを入力します。
5. 「保存」をクリックします。

6. ヘルプ・テキストが必要な各アイテムに対して、前述のステップを繰り返します。

10.5.2 「アイテム・ヘルプをバルク編集」レポートの使用

「アイテム・ヘルプをバルク編集」レポートを使用して、アプリケーション内のすべてのヘルプ・トピックを一度に編集できます

開発者は、「アイテム・ヘルプをバルク編集」レポートを使用して、アイテムのラベルや名前を表示したり、アイテムにアクセスしたり、関連ページへのアイテムが含まれるページにリンクできます

アプリケーションにヘルプを含める場合は、「アイテム・ヘルプをバルク編集」レポートを使用して、複数のヘルプ・トピックを一度に編集できます。

「アイテム・ヘルプをバルク編集」レポートを表示するには:

1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
2. アプリケーションを選択します。
3. 「ユーティリティ」アイコンをクリックします。
4. 「ページ固有のユーティリティ」から、「アイテム・ユーティリティ」を選択します。
5. 「すべてのアイテム・ヘルプ・テキストのグリッド編集」をクリックします。
6. アイテム・ヘルプのバルクレポートでは、次の操作が可能です。
   • 既存のヘルプ・トピックを更新できます。表示されるヘルプ・テキストを編集し、「変更の適用」をクリックします。
   • ページ番号をクリックして、アイテムが含まれているページにリンクできます。
   • アイテム名をクリックして、ページ・アイテムにリンクできます。

関連項目:

アイテム・ヘルプ・トピックのシード

10.5.3 アイテム・ヘルプ・トピックのシード

ヘルプがまだ含まれていないアプリケーションの場合は、デフォルトのヘルプ・テキストの一括更新(またはシード)を実行できます。

ヘルプ・トピックをシードするには:

1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
2. アプリケーションを選択します。
3. 「ユーティリティ」アイコンをクリックします。
4. 「ページ固有のユーティリティ」から、「アイテム・ユーティリティ」を選択します。
5. 「すべてのアイテム・ヘルプ・テキストのグリッド編集」をクリックします。
6. 「アイテム・ヘルプ・テキストのシード」をクリックします。
7. 既存のアイテム・ヘルプを編集するには:
   1. 「アイテム・ヘルプ・テキスト」に、すべてのヘルプ・トピックに表示されるデフォルト・テキストを入力します。
   2. 「変更の適用」をクリックします。
8. 現在ヘルプ・テキストのないすべてのアイテムにヘルプ・テキストを作成するには、「アイテム・ヘルプ・テキストのシード」 をクリックして画面上の指示に従います。
9. 「変更の適用」をクリックします。

10.5.4 ヘルプ・ナビゲーション・バー・エントリの作成

ヘルプを作成したら、次のステップは、ユーザーがリンクに使用するためのナビゲーション・バー・エントリを作成します。

ナビゲーション・バー・エントリを作成するには:

1. ナビゲーション・バー・エントリ・ページにナビゲートします。
   1. 「ワークスペース」ホームページにナビゲートします。
   2. 「アプリケーション・ビルダー」アイコンをクリックします。
   3. アプリケーションを選択します。
   4. アプリケーションのホームページで、「共有コンポーネント」をクリックします。
   5. 「ナビゲーション」で、「クラシック・ナビゲーション・バー・エントリ」をクリックします。
2. 「作成」をクリックします。
   ナビゲーション・バー・エントリの作成ウィザードが表示されます。
3. 「方法」で、「最初から」を選択し、「次へ」をクリックします。
4. 「タイプ」で、「URLへのナビゲーション」を選択して「次へ」をクリックします。
5. 「属性」で、次のように指定します。
   1. 順序: このコンポーネントの評価の順序を指定します。
   2. エントリ・ラベル: このナビゲーション・バー・エントリの表示テキストを入力します。
   3. アイコン・イメージ名: イメージ名を入力します。ネーミング規則の詳細は、フィールドレベル・ヘルプを参照してください。
   4. イメージALT: イメージのナビゲーション・アイコンのALTテキストを入力します。イメージ名を指定しないと、このテキストが表示されます。
   5. イメージの高さ - イメージの高さを定義します。
   6. 幅: イメージの幅を定義します。
   7. 「次」をクリックします。
6. 「ターゲット」で、次のステップを実行します。
   1. ターゲットは: 「このアプリケーションのページ」を選択します。
   2. ページ: 「ヘルプの作成」で作成したヘルプ・ページのページ番号を指定します。

   3. リクエスト: 次を入力します。

      &APP_PAGE_ID.
      

      「リクエスト」に置換文字列&APP_PAGE_IDを指定することによって、Oracle APEXエンジンに対して、ユーザーがこのアイコンをクリックしたときにカレント・ページのヘルプ・テキストを表示するように指示します。

   4. 「次」をクリックします。
7. ナビゲーション・バー・エントリを表示するための条件を設定するには、条件タイプを選択します。
8. 「作成」をクリックします。