プライマリ・コンテンツに移動

Oracle® Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド リリース5.1 E83810-03 |
| 目次 | 索引

前 | 次 |

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

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

トピック:

- ページ・デザイナでのヘルプの作成
- レガシー・コンポーネント・ビューでのヘルプの作成
- 複数のアイテム・ヘルプ・トピックの同時編集
- ヘルプ・ナビゲーション・バー・エントリの作成

## 10.4.1 ページ・デザイナでのヘルプの作成

この項では、ページ・デザイナでヘルプを作成する方法について説明します。

トピック:

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

### 10.4.1.1 ヘルプの作成について

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

- ステップ1: 専用のヘルプ・ページおよびヘルプ・リージョンを作成します。ページ・デザイナでのヘルプ・ページおよびヘルプ・リージョンの作成を参照してください。

- ステップ2: ページ・ヘルプ・テキストを定義します。ページ・デザイナでのページ・ヘルプの定義を参照してください。

- ステップ3: アイテム・ヘルプ・テキストを定義します。ページ・デザイナでのアイテム・ヘルプの定義を参照してください。

- ステップ4: ヘルプ・ページにリンクするためのナビゲーション・バー・アイコンを作成します。ヘルプ・ナビゲーション・バー・エントリの作成を参照してください。

### 10.4.1.2 ページ・デザイナでのヘルプ・ページおよびヘルプ・リージョンの作成

ページ・デザイナでヘルプ・ページおよびヘルプ・リージョンを作成するには、次のステップを実行します。

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

   ヒント:

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

4. プロパティ・エディタですべての属性を表示するには、「すべて表示」をクリックします。
5. 次の属性を編集します。

   ヒント:

   グループまたは属性を検索するには、「フィルタ・プロパティ」フィールドにキーワードを入力します。

   1. 指定、タイトル - リージョンのタイトルを入力します。

   2. レイアウト、順序 - このアイテムの表示順序を入力します。順序および他のレイアウト設定によって、リージョン内の他のアイテムに対して相対的に、このアイテムの表示位置が決定されます。

   3. レイアウト、親リージョン - このリージョンが属する親リージョンを選択します。親リージョンが選択されている場合、このリージョンは完全に親リージョン内にレンダリングされます。

   4. レイアウト、位置 - 順序、親リージョンおよび位置を指定します。

   5. 外観、テンプレート - リージョン・テンプレートを選択して、このリージョンの外観とレイアウトを定義します。リージョン・テンプレートはアプリケーション・テーマで定義されます。リージョンが作成されると、テンプレートが、現在のテーマで定義されたデフォルトのリージョン・テンプレートに自動的に設定されます。

   6. 外観、アイテム表示位置 - メイン・リージョン・コンテンツに対して相対的に、ページ・アイテムの表示位置を選択します。

   ヒント:

   属性の詳細は、プロパティ・エディタで属性を選択し、中央ペインで「ヘルプ」タブをクリックして、参照してください。

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

   ヒント:

   サポートされるチャート・オプションの詳細は、Oracle JavaScript拡張機能ツールキット(JET)のJSDocページのojChartを参照してください。

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

関連項目:

「アプリケーションのホームページからのページの作成」

### 10.4.1.3 ページ・デザイナでのページ・ヘルプの定義

ページ・デザイナでページ・ヘルプ・テキストを定義するには、次のステップを実行します。

1. ページ・デザイナで新規ページを表示します。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
   2. アプリケーションを選択します。
   3. ページを選択します。
   ページ・デザイナが表示されます。
2. 「レンダリング」タブで、ページ名をクリックします。
3. 「プロパティ・エディタ - ページ」で、「ヘルプ」まで下にスクロールして「ヘルプ・テキスト」属性にテキストを入力します。
4. 「保存」をクリックします。

### 10.4.1.4 ページ・デザイナでのアイテム・ヘルプの定義

ページ・デザイナでページ・ヘルプ・テキストを定義するには、次のステップを実行します。

1. ページ・デザイナで新規ページを表示します。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
   2. アプリケーションを選択します。
   3. ページを選択します。
   ページ・デザイナが表示されます。
2. 「レンダリング」タブで、ヘルプを定義するアイテムをクリックします。
3. プロパティ・エディタで「ヘルプ」を見つけて展開し、「ヘルプ・テキスト」属性にテキストを入力します。
4. 「保存」をクリックします。

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

## 10.4.2 レガシー・コンポーネント・ビューでのヘルプの作成

この項では、コンポーネント・ビューでヘルプを作成する方法について説明します。

注意:

レガシー・コンポーネント・ビューでのページの管理

トピック:

- ヘルプの作成について
- コンポーネント・ビューでのヘルプ・ページおよびヘルプ・リージョンの作成
- コンポーネント・ビューでのページ・ヘルプの定義
- コンポーネント・ビューでのアイテム・ヘルプの定義

### 10.4.2.1 ヘルプの作成について

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

- ステップ1: 専用のヘルプ・ページおよびヘルプ・リージョンを作成します。コンポーネント・ビューでのヘルプ・ページおよびヘルプ・リージョンの作成を参照してください。

- ステップ2: ページ・ヘルプ・テキストを定義します。コンポーネント・ビューでのページ・ヘルプの定義を参照してください。

- ステップ3: アイテム・ヘルプ・テキストを定義します。コンポーネント・ビューでのアイテム・ヘルプの定義を参照してください。

- ステップ4: ヘルプ・ページにリンクするためのナビゲーション・バー・アイコンを作成します。ヘルプ・ナビゲーション・バー・エントリの作成を参照してください。

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

### 10.4.2.2 コンポーネント・ビューでのヘルプ・ページおよびヘルプ・リージョンの作成

アプリケーションのヘルプを作成するための最初のステップは、専用のページおよび「ヘルプ・テキスト」リージョンを作成することです。次の構文を使用してコールすると、作成するリージョンに、カレント・ページのページ・ヘルプおよびアイテム・ヘルプが表示されます。

    f?p=&APP_ID.:Page:Session:&APP_PAGE_ID.

コンポーネント・ビューでヘルプ・ページおよびヘルプ・リージョンを作成するには、次のステップを実行します。

1. ヘルプ用の空白ページを作成します。アプリケーションのホームページからのページの作成を参照してください。

2. コンポーネント・ビューでページを表示します。レガシー・コンポーネント・ビューでのページの表示を参照してください。

3. 新しいリージョンを作成します。「リージョン」で、「作成」アイコンをクリックします。

   「リージョンの作成」ウィザードが表示されます。

4. 「リージョン」で、「作成」アイコンをクリックします。

5. リージョン・タイプを選択するプロンプトが表示されたら、「ヘルプ・テキスト」を選択して「次へ」をクリックします。

6. 「表示属性」は、次のようにします。

   1. タイトル - リージョンのタイトルを入力します。選択するリージョン・テンプレートにリージョン・タイトルが表示される際に、このタイトルが表示されます。

   2. リージョン・テンプレート: リージョンの外観を制御するテンプレートを選択します。

   3. 親リージョン: 新しいリージョンが属する親リージョンを定義します。

   4. 表示ポイント: このリージョンの表示ポイントを指定します。詳細は、フィールドレベル・ヘルプを参照してください。

   5. 順序: このコンポーネントの順序を指定します。これによって評価の順序が決まります。

   6. 「次へ」をクリックします。

7. 「ソース」で、「次へ」をクリックします。

8. 「条件付き表示」は、次のようにします。

   1. 条件タイプ: このコンポーネントがレンダリングされるために満たす必要があるリストから、条件タイプを選択します。条件付きのレンダリングおよびプロセスの理解を参照してください。

   2. 認可スキーム: オプションで認可スキームを選択します。このコンポーネントをレンダリングまたは処理するためには、この認可スキームがTRUEと評価される必要があります。認可を介したセキュリティの提供を参照してください。

   3. 「次へ」をクリックします。

9. 「リージョンの作成」をクリックします。

### 10.4.2.3 コンポーネント・ビューでのページ・ヘルプの定義

コンポーネント・ビューでページ・ヘルプ・テキストを定義するには、次のステップを実行します。

1. ページ・ヘルプを追加するページにナビゲートします。レガシー・コンポーネント・ビューでのページの表示を参照してください。
2. 「ページ」で、「編集」アイコンをクリックします。
3. 「ヘルプ」までスクロールします。
4. 表示されたフィールドにヘルプ・テキストを入力します。

   ヒント:

   デフォルトでは、「ヘルプ」にはテキスト`No help is available for this page`が入力されています。

5. 「変更の適用」をクリックします。

ページ・ヘルプ・テキストが必要な各ページに対して、これらのステップを実行します。

### 10.4.2.4 コンポーネント・ビューでのアイテム・ヘルプの定義

コンポーネント・ビューでアイテム・ヘルプを定義するには、次のステップを実行します。

1. ヘルプを追加するページにナビゲートします。レガシー・コンポーネント・ビューでのページの表示を参照してください。
2. 「アイテム」で、編集するアイテムを探します。
3. アイテムの属性ページにアクセスします。「アイテム」で、アイテム名を選択します。

   「ページ・アイテムの編集」ページが表示されます。

4. 「ヘルプ・テキスト」までスクロールします。
5. 表示されたフィールドにヘルプ・テキストを入力します。
6. 「変更の適用」をクリックします。

ヘルプ・テキストが必要な各アイテムに対して、これらのステップを実行します。

## 10.4.3 複数のアイテム・ヘルプ・トピックの同時編集

この項では、複数のヘルプ・トピックを一度に編集する様々な方法について説明します。

トピック:

- 「アイテム・ヘルプをバルク編集」レポートの使用
- アイテム・ヘルプ・トピックのシード

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

アプリケーションにヘルプを含める場合は、「アイテム・ヘルプをバルク編集」レポートを使用して、アプリケーション内のすべてのヘルプ・トピックを一度に編集できます。さらに、「アイテム・ヘルプをバルク編集」レポートを使用して、アイテムのラベルや名前を表示し、アイテムまたはアイテムを含むページへのリンクにアクセスできます

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

「アイテム・ヘルプをバルク編集」レポートを表示するには、次のステップを実行します。

1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
2. アプリケーションを選択します。
3. 「ユーティリティ」アイコンをクリックします。
4. 「ページ固有のユーティリティ」から、「アイテム・ユーティリティ」を選択します。
5. 「すべてのアイテム・ヘルプ・テキストのグリッド編集」をクリックします。
6. アイテム・ヘルプのバルクレポートでは、次の操作が可能です。

   - 既存のヘルプ・トピックを更新できます。表示されるヘルプ・テキストを編集し、「変更の適用」をクリックします。

   - ページ番号をクリックして、アイテムが含まれているページにリンクできます。

   - アイテム名をクリックして、ページ・アイテムにリンクできます。

関連項目:

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

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

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

ヘルプ・トピックをシードするには、次のステップを実行します。

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

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

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

ナビゲーション・バー・エントリを作成するには、次のステップを実行します。

1. ナビゲーション・バー・エントリ・ページにナビゲートします。

   1. 「ワークスペース」ホームページにナビゲートします。

   2. 「アプリケーション・ビルダー」アイコンをクリックします。

   3. アプリケーションを選択します。

   4. アプリケーションのホームページで、「共有コンポーネント」をクリックします。

   5. 「ナビゲーション」で、「ナビゲーション・バー・エントリ」をクリックします。

2. 「作成」をクリックします。

   ナビゲーション・バー・エントリの作成ウィザードが表示されます。

3. 「方法」で、「最初から」を選択し、「次へ」をクリックします。

4. 「タイプ」で、「URLへのナビゲーション」を選択して「次へ」をクリックします。

5. 「属性」で、次のように指定します。

   1. 順序: このコンポーネントの評価の順序を指定します。

   2. エントリ・ラベル: このナビゲーション・バー・エントリの表示テキストを入力します。

   3. アイコン・イメージ名: イメージ名を入力します。ネーミング規則の詳細は、フィールドレベル・ヘルプを参照してください。フィールドレベル・ヘルプの表示を参照してください。

   4. イメージALT: イメージのナビゲーション・アイコンのALTテキストを入力します。イメージ名を指定しないと、このテキストが表示されます。

   5. イメージの高さ: イメージの高さをピクセルで定義します。

   6. 「次へ」をクリックします。

6. 「ターゲット」は、次のようにします。

   1. ターゲットは: 「このアプリケーションのページ」を選択します。

   2. ページ: ページ・デザイナでのヘルプの作成で作成したヘルプ・ページのページ番号を指定します。

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

          &APP_PAGE_ID.

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

   4. 「次へ」をクリックします。

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

8. 「作成」をクリックします。

関連項目:

ナビゲーション・バー・エントリの作成