ナビゲーションをスキップ

Administration Console の拡張

  前 次 前/次ボタンと目次ボタンとの区切り線 目次  

コンソール拡張でのローカライゼーションの使い方

以下の節では、Administration Console 拡張で使用されるテキストをローカライズする方法について説明します。

 


コンソール拡張のローカライゼーションの概要

Administration Console 拡張をローカライズすると、コンソール拡張をさまざまな言語で提供できます。ローカライズしたテキストは、提供する言語ごとに作成した特別なローカライゼーション カタログ ファイルに格納します。さらに、すべてのカタログ ファイルのリストを index.xml というファイルに記述します。記述した index.xml ファイルとカタログ ファイルは、コンソール拡張を定義する Web アプリケーションにパッケージ化します (「Administration Console 拡張のパッケージ化」を参照)。

コンソール拡張の以下の部分をローカライズすることができます。

 


コンソールで使用するローカライゼーション カタログの決定

コンソール アプリケーションは、Administration Console で設定された言語プリファレンス、ユーザの Web ブラウザで指定された言語と国、および index.xml ファイルの設定値を使用して、コンソールを表示するためのローカライゼーション カタログを決定します。index.xml ファイル (「index.xml ファイルの記述」を参照) では、使用可能なすべてのローカライゼーション カタログのリストが定義され、それらのファイルと言語プリファレンス、および 1 つまたは複数のロケール設定が関連付けられます。ロケール設定には、国属性と言語属性があります。

コンソール アプリケーションは、Administration Console の [コンソール|プリファレンス] 画面で設定された言語プリファレンスをチェックします。言語が指定されている場合、コンソールは index.xml ファイルの <catalog> 要素の name 属性を参照して、その言語に関連付けられているローカライゼーション カタログを見つけます。

注意 :[コンソール|プリファレンス] 画面で言語が明示的に指定されなかった場合、[言語] フィールドのデフォルトは英語です。プリファレンスが設定されていない場合、コンソールは index.xml ファイルの <locale> 要素を参照して、ユーザの Web ブラウザの設定値と一致する国と言語を見つけます。

 


コンソール拡張のローカライゼーションの主要手順

コンソール拡張のテキストをローカライズするには、次の手順に従います。

  1. 提供する言語ごとに XML カタログ ファイルを作成します。これらの XML ファイルには、ローカライズされたテキストを参照するための ID 文字列を記述します。この ID 文字列は、各言語カタログで同じです。ID 文字列は、カタログから検索され、コンソールに表示されるテキストのブロックを指し示します。
  2. 手順の詳細については、「ローカライゼーション カタログの記述」を参照してください。

  3. ローカライゼーション カタログのリストを記述した index.xml ファイルを作成します。
  4. 手順の詳細については、「index.xml ファイルの記述」を参照してください。

  5. コンソール拡張タグ ライブラリの JSP タグを使用して、ローカライズしたテキストを表示します。各 JSP タグには、カタログ ID を指定するために使用する属性があります。詳細については、「JSP でのローカライズ テキストの使い方」を参照してください。
  6. JSP、カタログ、および Java クラスを Web アプリケーションとしてパッケージ化します。「Administration Console 拡張のパッケージ化」を参照してください。
  7. コンソール拡張が収められた Web アプリケーションを対象 WebLogic Server ドメインの管理サーバにデプロイします。「Administration Console 拡張のデプロイメント」を参照してください。

 


ローカライゼーション カタログの記述

ローカライゼーション カタログは、XML 表記法を使用して記述します。XML エディタまたは通常のテキスト エディタを使用できます。サンプル カタログについては、「サンプル ローカライゼーション カタログ」を参照してください。

ローカライゼーション カタログを記述するには、次の手順に従います。

  1. ローカライゼーション カタログをプレーン テキスト ファイルとして作成し、コンソール拡張が格納されている Web アプリケーションの WEB-INF/catalogs ディレクトリに保存します。ローカライゼーション カタログのファイル名は、そのカタログを定義する index.xml (「index.xml ファイルの記述」を参照) の <catalog> 要素の file 属性と一致している必要があります。
  2. カタログ ファイルには、以下の基本 XML 要素を記述する必要があります。

    <?xml version="1.0" ?>
    <catalog>

    (カタログ データをここに挿入する)

    </catalog>
  3. ローカライゼーション テキスト エントリを作成します。
  4. WEB-INF/catalogs ディレクトリ内の index.xml ファイルにこのカタログのエントリを作成します。手順については、「index.xml ファイルの記述」を参照してください。

単一の単語または語句のローカライズ

単一の単語または語句のローカライズ テキストを作成するには、次の手順に従います。

  1. <textlist> 要素を使用します。<textlist> 要素の中には、ローカライズ テキストの複数のエントリを名前と値のペアとして次の形式で作成できます。
  2. textid = localized text string
  3. 次の XML を使用して、ローカライズされたテキストのすべてのエントリを、<textlist> 要素で囲みます。
  4. <![CDATA[
    ...
    ]]>

次に例を示します。

<textlist>
<![CDATA[

example.mytext      = This is localized text from the catalog.
example.title       = Console Extensibility Example
example.tab.extra   = Extra
example.tab.1       = Extension Catalog Text
example.tab.2       = Console Catalog Text
example.tab.3       = Programmatic
]]>
</textlist>

長いテキスト ブロックのローカライズ

長い文字列のローカライズ テキストを作成するには、次の手順に従います。

  1. <text> 要素の id 属性を使用して、ローカライゼーション カタログ ID を指定します。次に例を示します。
  2. <text id='example.error-message'>
  3. <text> タグと </text> タグの間にローカライズ テキストを挿入します。このテキストの中では HTML タグを使用できます。
  4. ローカライズ テキストを次の XML で囲みます。
  5. <![CDATA[
    ...
    ]]>

次に例を示します。

<text id='example.error-message'>
<![CDATA[
An <b>error</b> has occured.
<p> Please consult the documentation for more information.
]]>
</text>

 


index.xml ファイルの記述

index.xml ファイルは、言語をカタログ ファイルにマップし、ローカライズ テキストの表示に関する詳細を提供します。

index.xml ファイルを作成するには、次の手順に従います。

  1. index.xml ファイルをプレーン テキスト ファイルとして作成し、コンソール拡張が格納されている Web アプリケーションの WEB-INF/classes ディレクトリに保存します。
  2. カタログ ファイルには、以下の基本 XML 要素を記述する必要があります。

    <?xml version="1.0" ?>
    <index>

    (カタログ定義をここに挿入する)

    </index>
  3. 定義するカタログごとに <catalog> 要素を作成します。この要素の中には、以下の属性を定義します。

    属性

    説明

    name

    言語の名前。詳細については、「コンソールで使用するローカライゼーション カタログの決定」を参照。

    file

    この言語用に使用するカタログ ファイルのパスとファイル名。index.xml ファイルを起点とする相対パスを指定する。index.xml ファイルは、コンソール拡張が格納されている Web アプリケーションの WEB-INF/catalogs ディレクトリに存在する必要がある。

    charset

    ローカライズ テキストを表示するための文字セットの名前。World Wide Web Consortium (W3C) によって定義された標準文字セット名を使用する。

    encoding

    ローカライズ テキストを表示するためのエンコーディングの名前。World Wide Web Consortium (W3C) によって定義されたエンコーディングを使用する。

  4. <catalog> 要素の中に 1 つまたは複数の <locale> サブ要素を作成します。Administration Console アプリケーションは、ユーザの Web ブラウザの設定値とこれらの属性を比較して、どのカタログを使用するかを決定します。詳細については、「コンソールで使用するローカライゼーション カタログの決定」を参照してください。

    属性

    説明

    country

    http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
    で指定される国。

    language

    http://userpage.chemie.fu-berlin.de/diverse/doc/ISO_3166.html
    で指定される言語。

  5. コンソール拡張の言語カタログごとに <catalog> 要素と <locale> 要素を作成します。

 


サンプル ローカライゼーション カタログ

コード リスト 3-1english.xml

<?xml version="1.0"?>

<catalog>

<text id='example.error-message'>
<![CDATA[
An <b>error</b> {0} has occured.
<p> Please consult the documentation for more information.
]]>
</text>


<textlist>
<![CDATA[

example.mytext = This is localized text from the catalog.
example.title = Console Extensibility Example
example.copyright = Copyright 2001 BEA Systems.
example.dialog = This is an example dialog for the server named {0}.
example.tab.extra = Extra
example.tab.1 = Extension Catalog Text
example.tab.2 = Console Catalog Text
example.tab.3 = Programmatic
example.tab.4 = Switch on the Fly
]]>
</textlist>
</catalog>

 


JSP でのローカライズ テキストの使い方

以下の節では、コンソール拡張のさまざまな要素をローカライズするための JSP コードについて説明します。

ナビゲーション ツリー ノードのローカライズ

ナビゲーション ツリーのノードをローカライズするには、<wl:node> タグの labelId 属性を使用します。詳細については、「<wl:node> タグ」を参照してください。

たとえば、次のコードを記述すると、ローカライゼーション カタログから node1 という ID で検索されるラベルを持つノードが作成されます。

<wl:node 
   labelId='node1'
   icon='/images/bullet.gif'
   url='/dialog_domain_example.jsp'>
</wl:node>

右クリック メニューのローカライズ

右クリック メニューをローカライズするには、<wl:menu> タグの labelId 属性を使用します。詳細については、「<wl:menu> および <wl:menu-separator> タグ」を参照してください。

たとえば、次のコードを記述すると、右クリック メニュー付きのノードが作成されます。このメニュー アイテムのラベルは、ローカライゼーション カタログから beaDocsbeaHome という ID で検索されます。

<wl:node 
   label='My 2st nested node'
   icon='/images/bullet.gif'>
   <wl:menu
      labelId='beaDocs'
      url='http://e-docs.bea.com/index.html'
      target='_blank'/>
   <wl:menu-separator/>

    <wl:menu
        labelId='beaHome'
        url='http://www.bea.com'
         target='_blank'/>

</wl:node>

タブ ラベルのローカライズ

タブ付きダイアログのラベルをローカライズするには、<wl:tab> タグの labelId 属性を使用します。詳細については、「<wl:tab> タグ」を参照してください。

たとえば、次のコードではタブのローカライズ ラベルが使用されます。このラベルは、ローカライゼーション カタログから tab.1 という ID で検索されます。

<wl:tab name='LocalizedTextTab' labelId='tab.1'>
The tab label for this tab comes from the catalog.
</wl:tab>

labelId 属性を指定しない場合、コンソールはローカライゼーション カタログから次の形式のエントリを検索します。

tab + name

コンソール ダイアログのテキストのローカライズ

コンソール画面のテキストをローカライズするには、以下の 2 つの節で説明するように、<wl:text> タグの textId および textParamId 属性を使用します。このタグの詳細については、「<wl:text> タグ」を参照してください。

テキストのローカライズ

テキストをローカライズするには、<wl:text> タグの textId 属性を使用してローカライゼーション カタログからテキストを検索します。たとえば、次のコードでは、ローカライゼーション カタログから ID LocalizedText.1 が検索されます。

<wl:tab name='LocalizedTextTab' labelId='tab.2'>
<wl:text textId='LocalizedText.1'/>
</wl:tab>

パラメータのローカライズ

パラメータをローカライズすることもできます。パラメータは、文字列 {0} の代わりに使用されます (文字列がローカライゼーション カタログに格納されている場合)。

たとえば、次のコードでは、LocalizedText.3 という ID で格納されている文字列 {0} の代わりに、LocalizedParam.1 という ID でカタログに格納されているローカライズ テキストが表示されます。

<wl:text 
  textId='LocalizedText.3'
  textParamId='LocalizedParam.1' />

応答用の文字セットの指定

ブラウザが応答のコーディングに使用する文字セットを指定するには、すべてのコンソール拡張 JSP について、すべての JSP ディレクティブの後に次のコードを挿入します (JSP ディレクティブは <%@ で始まります)。

<%@ page import='weblogic.management.console.catalog.Catalog' %>
<%@ page import='weblogic.management.console.helpers.Helpers' %>
<%
Catalog catalog = Helpers.catalog(pageContext);
String charset = catalog.getCharset();
if (charset != null)
response.setContentType("text/html; charset="+charset);
%>

 

ページの先頭 前 次