| Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発 12c (12.2.1.1) E77341-01 |
|
 前 |
 次 |
この章では、オンライン・ヘルプとADF Facesアプリケーションの統合方法およびOHWのヘルプ・プロバイダとしての登録方法について説明します。
この章には、次のセクションがあります。
ご使用のADF Facesアプリケーションにオンライン・ヘルプを組み込む場合、ADF Faces (ADFリッチ・クライアントとも呼ばれる)には、そのための簡単な方法が用意されています。オンライン・ヘルプ・システムを作成して、アプリケーションのコンポーネントにヘルプ・トピックを統合できます。
この章では、ヘルプ・プロバイダとしてのOHWの構成方法、ADFリッチ・クライアントのその他のヘルプ・プロバイダ、およびHelpTopicId属性を使用してヘルプ・トピックをアプリケーションに関連付ける方法について説明します。
ヘルプ・トピックをADF Facesコンポーネントと統合すると、そのコンポーネントにヘルプ・アイコン(疑問符を青色の円で囲んだもの)が表示されます。ヘルプ・アイコンをクリックすると、図19-1に示すように、関連するヘルプ・トピックが新しいウィンドウに表示されます。
次の手順で説明するように、オンライン・ヘルプとアプリケーションとの統合は簡単なプロセスです。
ヘルプ・プロバイダのアプリケーションでの登録
各ヘルプ・トピックのトピックIDおよびヘルプ・テキストを含むプロパティ・ファイルの作成
HelpTopicId属性を使用した、UIコンポーネントのヘルプ・トピックへの関連付け
オンライン・ヘルプとアプリケーションとの統合の詳細は、『Oracle ADF FacesによるWebユーザー・インタフェースの開発』のコンポーネントのヘルプの表示に関する項を参照してください。
ADF Facesリッチ・クライアントには、多様なヘルプ・プロバイダが用意されています。これらの異なるヘルプ・プロバイダを組み合せるか、独自のヘルプ・プロバイダ・クラスを作成できます。また、ヘルプ・プロバイダとしてOHWを使用することもできます。
ADFリッチ・クライアント・アプリケーションのヘルプ・プロバイダとしてOHWを設定するには、次のタスクを実行する必要があります。
WebアプリケーションとしてOHWをデプロイします。
Webアプリケーション・サーバーにADFアプリケーションをデプロイします。
このデプロイのコンテキスト・ルートを書き留めます。
このデプロイのweb.xmlファイルを開きます。
OHWサーブレット・インスタンスを見つけます。
jspx Webページを開発します。
ADF FacesベースのWebアプリケーションを作成します。
特定のコンポーネント(input*、select*など)用にjspx Webページを作成し、helpTopicIdという名前の属性を見つけて、OHWインスタンスで表示するIDを指定します。
ヘルプセットをコピーし、<application_root>/public_htmlフォルダの下にあるディレクトリに配置します。たとえば、このディレクトリをhelpsetsという名前にします。
adf-settings.xmlファイルを設定します。
アプリケーションのディレクトリに移動し、.adf/META-INF/ディレクトリを検索します。このディレクトリの下に、adf-settings.xmlファイルがあります。.adf/META-INF/ディレクトリがない場合は、META-INFディレクトリを、ViewController/srcディレクトリの下に作成します。
adf-settings.xmlにコードを入力します。次に例を示します。
<?xml version="1.0" encoding="UTF-8" ?>
<adf-settings xmlns="http://xmlns.oracle.com/adf/settings">
<adf-faces-config xmlns="http://xmlns.oracle.com/adf/faces/settings">
<help-provider>
<help-provider-class>
oracle.help.web.rich.helpProvider.OHWHelpProvider
</help-provider-class>
<property>
<property-name>ohwConfigFileURL</property-name>
<value>/helpsets/ohwconfig.xml</value>
</property>
<!--property>
<property-name>group</property-name>
<value>null</value>
</property-->
<property>
<property-name>baseURI</property-name>
<value>
http://localhost:8989/help-ohw-rcf-context-root/ohguide/
</value>
</property>
</help-provider>
</adf-faces-config>
</adf-settings>
このadf-settings.xmlファイルを、次のように設定してください。
OHWをヘルプ・プロバイダとして使用する場合は、このadf-settings.xmlファイルで、クラスをOHWHelpProviderにする必要があります。
ohwConfigFileURLプロパティを、/helpsets/ohwconfig.xmlを指すように設定します。helpsetsディレクトリは、手順3で作成したものです。
|
注意: propシステム・プロパティを使用して、ohwConfigURLを指定することもできます。たとえば、web.xmlでは、ohwConfigURLは次のように構成されます。
<param-name>ohwConfigFileURL</param-name>
<param-value>file:///{%prop}/help/ohwconfig.xml</param-value>
<property>
<property-name>ohwConfigFileURL</property-name>
<value>file:///{%prop}/help/ohwconfig.xml</value>
</property>
|
groupプロパティに、ohwconfig.xmlファイルのグループ名(ヘルプ・プロバイダで使用するもの)を指定します。
baseURIプロパティに、手順1でデプロイしたRCFアプリケーションの、サーバー・ホスト、コンテキスト・ルートおよびOHWサーブレット・インスタンスを指定します。
ヘルプ・トピックをADFコンポーネントに関連付けるには、ヘルプ・トピックの一意のIDをHelpTopicId属性の値として割り当てる必要があります。HelpTopicId属性は、「プロパティ」ウィンドウの「外観」セクションで使用できます。
ヘルプ・トピックをコンポーネントに関連付ける前に、アプリケーションにヘルプ・プロバイダが登録されていることを確認してください。ヘルプ・プロバイダとしてOHWを登録するには、第19.3項「ADFリッチ・クライアントのヘルプ・プロバイダとしてのOHWの登録」を参照してください。
HelpTopicId属性の詳細は、『Oracle ADF FacesによるWebユーザー・インタフェースの開発』のコンポーネントのヘルプの表示に関する項を参照してください。
ADFリッチ・クライアントの一般的な2つのヘルプ・プロバイダは、ResourceBundleHelpProviderとELHelpProviderです。ResourceBundleHelpProviderでは、リソース・バンドルに定義されているヘルプをADF Facesアプリケーションに表示できます。リソース・バンドルは、ヘルプ・ファイル、制御ファイル、グラフィックおよびその他の関連ファイルのコンテナです。ELHelpProviderでは、XLIFFファイルに定義されているヘルプ・テキストをADF Facesアプリケーションに表示できます。XLIFFファイルはマップに変換されるか、ヘルプ・テキスト文字列のマップを含むマネージドBeanを作成します。ELHelpProviderではヘルプ・ファイルは作成されませんが、このファイルをADF Facesアプリケーションに関連付けるのに役立ちます。
これらと他のヘルプ・プロバイダの詳細は、『Oracle ADF FacesによるWebユーザー・インタフェースの開発』のコンポーネントのヘルプの表示に関する項を参照してください。
