ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発
12c(12.1.2)
E48092-01
  目次へ移動
目次
前
前 		 次
次		  

18 Webアプリケーションでの状況依存ヘルプの実装

この章では、Webアプリケーションで状況依存ヘルプを有効にする方法、およびヘルプ・トピックにトピックIDをマップする方法について説明します。

この章には次の項が含まれます:

18.1 Webアプリケーションでの状況依存ヘルプの実装について

Oracle Help for the Web (OHW)には、Webアプリケーションのユーザー・インタフェースの一部の状況に関連付けられたヘルプ・トピックを表示する、状況依存ヘルプのメカニズムが備えられています。通常、ヘルプ・トピックは、Webアプリケーションの特定のページ、表または入力フィールドの機能について説明するために記述されています。「ヘルプ」ボタンをクリックするなどして、ユーザー・インタフェース・コントロールのヘルプを要求すると、その状況(またはコントロール)に関連する適切なトピックが表示されます。

状況依存ヘルプをWebアプリケーションで使用するには、ヘルプ・システムに1つ以上のマップ・ファイルが存在し、アプリケーション・コードに適切なヘルプ・コードが追加されている必要があります。

18.2 ヘルプ・トピックへのトピックIDのマップ

OHWの状況依存ヘルプ・システムには、ヘルプ・トピックHTMLファイルにトピックIDをマップする1つ以上のマップ・ファイルが必要となります。ヘルプセットでは、マップ・ファイルはmap.xmlとして、XMLファイル形式で保存されています。

通常、マップ・ファイルはヘルプ作成者が作成します。Webアプリケーション開発者は、Webアプリケーションのコントロールを状況依存トピックに関連付けるときに、ヘルプ作成者のマップ・ファイルに指定されたトピックIDを使用する必要があります。このため、作業内容についてヘルプ作成者と調整を行う必要性が生じます。

次に、XML形式のマップ・ファイルのサンプルを示します。

 <?xml version='1.0' ?>
 <map version="1.0">
   <mapID target="topic_1" url="file_1.html" />
   <mapID target="topic_2" url="file_2.html#a1" />
   <mapID target="topic_3" url="file_3.html" wintype="intro" />
 </map>

target属性には、ヘルプセット内の関連付けられたHTMLファイルを示す一意のIDを指定します。url属性には、このIDに関連付けるファイルの場所を指定します。wintype属性はオプションであり、トピックを表示するウィンドウ・タイプの名前を指定します。マップ・ファイルで使用される要素の詳細は、第5.3項「マップ・ファイル」を参照してください。

18.3 ヘルプ・システムへの状況依存リンクの作成

状況依存ヘルプの実装にOHWを使用するアプリケーションは、OHWサーブレットへの特別な形式のURLを使用して状況依存トピックを要求します。宛先URL(リンク、イメージなど)を持つすべてのユーザー・インタフェース・コントロールを、状況依存トピックに関連付けることができます。

状況依存ヘルプ用のOHWへのリンクを作成するには、フロント・メイン・ページ(「目次」、「索引」および「検索」ナビゲータがページ左側の3つのペインにレイアウトされたUI)の宛先URLを使用するか、またはトピックIDを使用して、3ペイン・レイアウトUIでトピックを表示する宛先URLを作成できます。また、宛先URLにロケールおよびグループを指定することもできます。

18.3.1 フロント・メイン・ページへのリンク

フロント・メイン・ページのURLは、次のように、単にOHWサーブレットのURLとなります。

http://<server>:<port>/<servlet mapping>

<server>はサーブレット・コンテナを実行するサーバーの名前、<port>はサーブレット・コンテナが使用するポート、および<servlet mapping>はOHWサーブレット(oracle.help.web.rich.OHWServlet)用のweb.xmlファイルに設定されているサーブレット・マッピングです。

たとえば、web.xmlには、次のようなサーブレット定義およびサーブレット・マッピングが設定されています。

<!-- configuration for product1 help front servlet -->
<servlet>
   <servlet-name>product1</servlet-name>
   <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
   <init-param>
      <param-name>ohwConfigFileURL</param-name>
      <param-value>/helpsets/product1/ohwconfig.xml</param-value>
   </init-param>
<load-on-startup>1</load-on-startup>
</servlet>
 
<servlet-mapping>
   <servlet-name>product1</servlet-name>
   <url-pattern>/product1/*</url-pattern>
</servlet-mapping>

この例の場合、フロント・メイン・ページのURLは次のとおりです。

http://www.myhelpserver.com:8888/docs/product1/

ユーザーがフロント・メイン・ページにリンクされたユーザー・インタフェース・コントロールのヘルプを要求すると、ユーザーのブラウザにOHWのメイン・ページが表示され、「目次」、「索引」および「検索」ナビゲータが、左側に3ペイン・レイアウトで表示されます。

18.3.2 トピックへのリンク

トピックへリンクするURLを作成するには、OHWサーブレットのURLに、トピック・パラメータを追加します。topicパラメータの値は、次のようにヘルプ・トピックのトピックIDを指定します。

http://<server>:<port>/<servlet mapping>/?topic=<topic-id>

たとえば、次のURLは、トピックID topic_1と関連付けられているトピックを要求します。

http://www.myhelpserver.com:8888/docs/product1/?topic=topic_1

OHWへの状況依存リンクを実装するときに、アプリケーションのメイン・ページを置き換えるのではなく、JavaScriptを使用して2次ウィンドウにリンク先が表示されるようにする場合があります。

ユーザーがトピックIDにリンクされたユーザー・インタフェース・コントロールのヘルプを要求すると、3ペイン・レイアウトUIで、「トピック」ナビゲータ(右側)にトピック・ファイルが表示され、「目次」ナビゲータ(左側)の目次ツリーでのそのトピックが選択されます。

18.3.3 ロケールおよびグループの指定

トピック・ページまたはフロント・ページなどのOHWページへのリンクを作成する場合は、localeおよびgroup問合せパラメータを使用して、OHWサーブレットのURLにロケールおよびグループを含めることができます。

トピックの構文は、次のとおりです。

http://<server>:<port>/<servlet-mapping>/?topic=<topic-id>&locale=<ISO-code>
http://<server>:<port>/<servlet-mapping>/?topic=<topic-id>&locale=<ISO-code>&group=<aGroup>

フロント・ページの構文は、次のとおりです。

http://<server>:<port>/<servlet-mapping>/?locale=<ISO-code>
http://<server>:<port>/<servlet-mapping>/?locale=<ISO-code>&group=<aGroup>

ロケールを指定した場合、OHWによって、ローカライズ済ヘルプセット(使用可能な場合)に切り替えられ、指定したロケールが上書きまたは削除されるまで引き続きそのロケールが使用されます。指定したローカライズ済ヘルプセットがない場合、このパラメータは無視されます。

次に例を示します。

http://www.myhelpserver.com:7101/docs/product1/?topic=topic_1&locale=sp

ロケールおよびグループの詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。

  前
前 		 次
次
  目次へ移動
目次