| Oracle® Fusion Middleware Oracle WebLogic Administration Console の拡張 11g リリース 1 (10.3.1) B55554-01 |
|
 戻る |
 次へ |
| Oracle® Fusion Middleware Oracle WebLogic Administration Console の拡張 11g リリース 1 (10.3.1) B55554-01 |
|
戻る |
次へ |
Administration Console のヘルプ ビューアは、Sun Microsystems のオープン ソース ヘルプ システムである JavaHelp 2.0 の実装を使用する Oracle WebLogic Portal Web アプリケーションです。
この章では、コンソール拡張ヘルプの作成方法とそのヘルプを Administration Console のヘルプ システムにマージする方法について説明します。
コンソール拡張ヘルプ トピックの作成に必要な主な手順は次のとおりです。
HTML トピックのファイルと Javahelp コントロールのファイルを含む Javahelp ヘルプセットを作成します。
コンソール拡張ヘルプ トピックから状況依存リンクを確立します。
コンソール拡張を使用してヘルプ システムをデプロイします。
Sun Microsystems から入手できる Javahelp ソフトウェアを使用して Javahelp システムを作成できます。または、Javahelp を作成するヘルプ作成ツールを使用できます。詳細な手順については、Javahelp のドキュメントまたは作成ツールのドキュメントを参照してください。
JavaHelp の詳細および Javahelp ソフトウェアのダウンロードの詳細については、(http://java.sun.com/javase/technologies/desktop/javahelp/) で、「JavaHelp システム」を参照してください。
Administration Console のヘルプ システムに必要なファイルは以下のとおりです。これらのファイルをまとめて「ヘルプセット」と呼びます。
トピックのファイル (.html)
これらのファイルにはヘルプ コンテンツがあります。これらのファイルを作成するには、HTML ファイルを作成する任意のエディタを使用できます。
ヘルプセット ファイル (.hs)
この XML ファイルは、マップ ファイルの名前と場所、ヘルプセットのタイトルなどの情報を含めた拡張ヘルプセットを定義します。
コンソール拡張ヘルプセットでは、HelpSet ファイルの名前は拡張の名前で始める必要があります。たとえば、Jolt コンソール拡張 HelpSet ファイルの名前は jolt.hs。(Jolt コンソール拡張は Administration Console の標準拡張です)。ローカライズされたヘルプセットでは、拡張の名前の最後にロケール情報を追加します。たとえば、jolt_en_US.hs。
マッピング ファイル (.jhm)
この XML ファイルはコンテキスト ヘルプ ID をヘルプ トピックにマップします。
目次ファイル (.xml)
この XML ファイルはヘルプの目次を定義します。
省略可能なファイルは以下のとおりです。
索引ファイル (.xml)
この XML ファイルはヘルプの索引を定義します。
全文検索データベース
これらのデータベース ファイルが Javahelp ソフトウェアまたは Javahelp を作成するヘルプ作成ツールの使用によって生成されます。
ヘルプセットをマージし、ローカライズされたヘルプセットを提供するためにはさらに考慮事項があります。詳細については、「拡張ヘルプをマージするためのディレクトリ構造」および「ヘルプセットのローカライズ」を参照してください。
拡張ヘルプセットが構成され、適切に名前が指定されていれば、コンソール拡張ヘルプセットの目次と検索データベースが主要な Administration Console ヘルプに自動的にマージされます。拡張ヘルプセットは、ヘルプが Administration Console と同じサーバ インスタンスにデプロイされるときにのみマージされます。
Administration Console のヘルプセット ファイルはマージ タイプを Javahelp AppendMerge タイプに設定します。そのタイプは、コンソール拡張ヘルプセットを主要なコンソール ヘルプにマージする方法を定義します。
Javahelp のマージの詳細については、(http://docs.sun.com/source/819-0913/author/merge.html) で「ヘルプセットのマージ」を参照してください。WebLogic Server にヘルプセットをマージする方法の詳細については、「ヘルプセットをマージする方法」も参照してください。
拡張のヘルプを主要なコンソール ヘルプにマージするには、ヘルプ ファイルは次のように構成されていることが必要です。ヘルプセット ファイルを含めたディレクトリの名前は bea-helpsets でなければならない。
...\console_extension\bea_helpsets\extension_name_locale.hs ...\console_extension\bea_helpsets\locale\extension_name-map.jhm ...\console_extension\bea_helpsets\locale\extension_name-toc.xml ...\console_extension\bea_helpsets\locale\extension_name-search\search database files ...\console_extension\bea_helpsets\locale\topics_dir\HTML topic files... ...\console_extension\bea-helpsets\locale\topics_dir\images\Graphic files... ...\console_extension\PortalConfig\... ...\console_extension\WEB-INF\... ...\console_extension\Other extension source directories...
|
注意 : HTML トピックのファイルと画像ファイルは、複数のディレクトリおよびサブディレクトリに配置されている場合がありますが、すべては、...\console_extension\bea_helpsets\locale\ の下にある必要があります。 |
次に例を示します。
...\my_ext\webapp\bea_helpsets\my_ext_en_US.hs ...\my_ext\webapp\bea_helpsets\en_US\my_ext_map.jhm ...\my_ext\webapp\bea_helpsets\en_US\my_ext_toc.xml ...\my_ext\webapp\bea_helpsets\en_US\my_ext-search\search database files... ...\my_ext\webapp\bea_helpsets\en_US\pagehelp\HTML topic files... ...\my_ext\webapp\bea_helpsets\en_US\taskhelp\HTML topic files... ...\my_ext\webapp\bea-helpsets\en_US\taskhelp\images\Graphic files... ...\my_ext\webapp\jsp\... ...\my_ext\webapp\PortalConfig\... ...\my_ext\webapp\WEB-INF\...
複数のローカライズされたヘルプセットを同時にヘルプに含めることができます。特定ロケールのヘルプ ファイルを検索するには、ヘルプ ビューアがjava.util.ResourceBundle で使用される方法と同じ方法を使用します。ヘルプ ビューアは拡張のために bea-helpsets ディレクトリの下に以下のディレクトリ構造を想定しています。
...\extension_name_locale_1.hs...\extension_name_locale_2.hs...\extension_name_locale_3.hs...\locale_1\map.jhm...\locale_1\toc.xml...\locale_1\search\Search db files......\locale_1\topics\HTML topic files......\locale_1\topics\images\Graphic files...(optional) ...\locale_2\map.jhm...\locale_2\toc.xml...\locale_2\my_search\Search db files......\locale_2\topics\HTML topic files......\locale_1\topics\images\Graphic files...(optional) ...\locale_3\map.jhm...\locale_3\toc.xml...\locale_3\search\Search db files......\locale_3\topics\HTML topic files...\locale_3\topics\images\Graphic files...(optional)
たとえば、図 8-1 を参照してください。
ブラウザで指定したロケールのヘルプ コンテンツが見つからない場合は、ヘルプ ビューアによりデフォルトのフォルダのコンテンツが表示されます。
ユーザがヘルプ ビューアから初めてヘルプを要求する場合、Administration Console ヘルプセットが解析され、ヘルプセット オブジェクトが作成されて、捕捉されます。ヘルプ ビューアが拡張ヘルプセットのサーバ拡張フォルダとドメイン拡張フォルダを検索し、それらを Administration Console ヘルプセットにマージします。コンソールは以下の場所で拡張を探します。
WL_HOME/server/lib/console-ext
WL_HOME/server/lib/console-ext/autodeploy
DOMAIN_HOME/console-ext
ヘルプセットが以下のルールに従ってマージされます。
ユーザが要求したロケールに対するコンソール ヘルプと拡張ヘルプが存在する場合、拡張ヘルプがコンソール ヘルプにマージされます。
ユーザが要求したロケールに対するコンソール ヘルプと拡張ヘルプが存在しない場合、コンソール ヘルプが英語で表示されます。ヘルプ ビューアが英語のロケールのための拡張ヘルプを検索し、それが見つかった場合は、拡張ヘルプがコンソール ヘルプにマージされます。
ユーザが要求したロケールのコンソール ヘルプが存在して、そのロケールの拡張ヘルプが存在しない場合、ヘルプ ビューアが英語のロケールのための拡張ヘルプを検索し、それが見つかった場合は、拡張ヘルプがコンソール ヘルプにマージされます。
特定のロケールのための拡張ヘルプを検索する場合、ヘルプ ビューアが言語、国、およびバリアントのヘルプセットを探します。3 つとも見つからない場合は、ヘルプ ビューアが言語と国を探します。言語と国でも見つからない場合は、次のリストに示すように、ヘルプ ビューアが言語を探します。
言語 + "_" + 国 + "_" + バリアント
言語 + "_" + 国
言語
ユーザが Administration Console の上部にある[コンテンツ ヘッダ] メニューのヘルプ リンクをクリックして Administration Console からヘルプを要求します。そのリンクが現在のページのヘルプ トピックを表示します。
コンソール拡張ページのための状況依存のヘルプを提供するには、
ブック、ページまたはページでの対象のためにヘルプ IDの提供必要があります。
Javahelp マップ (.jhm) ファイルにヘルプ ID のヘルプ ファイルへのマップが必要です。
ここで、コンソール拡張の開発者は Administration Console の左側の [操作ガイド] パネルまたはコンフィグレーション ページやモニタ ページの右側の [詳細] のリンクを提供することはできません。
各 Portal ページやブックには、ヘルプ ID があり、ページの対象には、ヘルプ ID があります。helpid または helpurlpatterns を指定する必要があります。
helpid という名前の meta タグを使用してヘルプ ID とバンドル名を指定することで、ポータル ページやブックのヘルプ コンテキストを指定します。ヘルプ ID とバンドル名はセミコロン (;) で区切ります。または、ポータルとブックは祖先ページやブックからコンテキストを継承できます。
ヘルプ ID には英数字、ハイフン (-)、およびアンダースコア (_) のみが含まれます。その他の文字は拒否され、一般的なエラー メッセージが表示されます。
ヘルプ Web アプリケーションが helpid メタ データからヘルプ ID とバンドル名を読み込みます。ページまたはブックが helpid を設定しない場合、ヘルプ アプリケーションが helpid を取得するために親ページまたはブックを再帰的に検索します。最も近い親からの helpid が使用されます。
Administration Console の全体的な Home ブックには、コンテキストの helpid が見つからない場合、コンソールのデフォルトのヘルプ ページが表示されることを確認する helpid があります。helpid 値を bea.wls.console.pageHelpKey という JavaScript 変数に割り当てます。
[コンテンツ ヘッダ] のヘルプ リンクをクリックすると、helpid がヘルプ Web アプリケーションにクエリ パラメータとして渡されます。ヘルプ Web アプリケーションが helpid を使用して マッピング (.jhm) ファイルをクエリし、ヘルプ リソースを返します。
次の例では、Jolt コンソール拡張の [JoltConnectionPool の設定] ページの [コンフィグレーション｜一般] タブのために helpid を割り当て方法を示します。この断片は JoltFullFeatures.book ファイルから取得されます。
<netuix:page markupName="page" markupType="Page" definitionLabel="JoltConnectionPoolConfigGeneralTabPage" title="tab.general.label" presentationClass="page-content"> <netuix:meta name="helpid" content="Jolt.jolt.joltconnectionpoolconfiggeneral.title;jolt"/>
Administration Console は、ヘルプを呼び出すための別の方法を提供します。一般的なヘルプ URL パターンは、ポータルページやブックの helpurlpattern メタ データ タグを使用して定義できます。パターンの値には、netuix メタ タグを使用して任意のページやブックに代入できる変数があります。たとえば、helpurlpattern メタ タグの値を次のように設定します。
<netuix:meta name="helpurlpattern" content=
"/consolehelp/console-help.portal?_nfpb=true&_pageLabel=page&helpId=${helpid}"/>
次に、<netuix:meta> タグを使用して helpid 値を指定します。
<netuix:meta name="helpid" content="applications.CreateDeploymentPlan"/>
URL パターンの helpid 変数は helpid メタ タグに提供されている値と代入されます。
helpurlpattern は任意のページやブックに指定できます。それを指定しない場合、helpurlpattern を探すために親ページとブックは再帰的に検索されます。最も近い親からの helpurlpattern が使用されます。パターンが見つかった場合、有効な URL に到着するために、現在のページやブックに定義した任意の変数置換値が URL パターンに適用されます。
helpurlpattern は、拡張ヘルプの別の URL を提供するときの便利な方法です。my_extension という拡張を考慮してください。ヘルプの要求を Web ページに転送する必要があります。my_extension という拡張がルート ページやブックに helpurlpattern を次のように定義します。
<netuix:meta name="helpurlpattern"
content="http://my_web_site.com/my_product/docs/${product_name}/index.html"/>
product_name メタ タグは置換値を提供できます。
<netuix:meta name="product_name" content="my_extension"/>
生成されたヘルプ リンクは http://my_web_site.com/my_product/docs/my_extension/index.html を指します。
ポータル ページとブックで定義した ヘルプ ID を Javahelp マップ (.jhm) ファイルの HTML ヘルプ トピックのファイルにマップします。たとえば、マップ ファイルの次の要素がヘルプ ID domainconfig を ページ ディレクトリにある domainConfig.html トピック ファイルに関連付けます。
<mapID target="domainconfig" url="Pages/domainConfig.html"/>
指定したトピック ファイルへのパスは、マップ ファイルの場所を基準にしたパスです。マップ ファイルは locale ディレクトリにあります。詳細については、「拡張ヘルプをマージするためのディレクトリ構造」を参照してください。
ルック アンド フィール (LAF) を提供し、それをヘルプ Web アプリケーションのポータル (console-help.portal) の対象とすることで、ヘルプ Web アプリケーションの外観を変更できます。Administration Console Web アプリケーションと同じサーバ インスタンスにデプロイされるときにのみ、拡張 LAF がヘルプ Web アプリケーションの外観を変更できます。ルック アンド フィールの変更の詳細については、「Administration Console の外観の変更」を参照してください。
