WebSphere Application Server - Express for i5/OS, Version 6.1   
             オペレーティング・システム: i5/OS

             目次と検索結果のパーソナライズ化

Eclipse ベースのヘルプの起動

Integrated Solutions Console モジュールがヘルプ・ページを必要とするポートレットを含んでいる場合、このトピック内の指示に従って、ポートレットのヘルプを実装します。

サンプル

モード・サンプル (modes.war) は、コンソール・モジュールがユーザー支援またはヘルプを提供する方法を示しています。 このサンプルは、例: コンソール・モジュールのサンプル 内で説明されています。

ポートレット・ヘルプの使用可能化

ポートレット・ヘルプを実装するには、portlet.xml ファイル内の、ポートレットの doHelp() メソッド、EclipseHelp クラス、およびヘルプ設定を使用します。 doHelp() メソッドの内部で、EclipseHelp クラスの portletHelp() メソッドを使用して、Eclipse ヘルプ・プラグイン内のターゲット・ヘルプ・トピックにリンクします。 doHelp() メソッドをポートレット内に組み込み、portlet.xml ファイルにヘルプ設定を追加することによって、ポートレット・ヘルプ・モードを使用可能にします。 ポートレット・ヘルプ・モードが使用可能になると、ポートレット・ヘルプ用のアイコンアイコンがポートレット・タイトル・バー上に表示されます。 ユーザーがアイコンをクリックすると、別のブラウザー・ウィンドウが開いてそのヘルプ・トピックのみを表示します。

doHelp メソッドの追加

doHelp() メソッドをポートレットに追加するには、以下の手順を実行します。

  1. ポートレット Java ファイル内に、以下のインポート・ステートメントを組み込みます。
    import com.ibm.portal.help.EclipseHelp;
    
  2. ポートレット内に doHelp() メソッドを実装します。
       public void doHelp(RenderRequest request, RenderResponse response) 
              throws PortletException, IOException {
    
       }
    
    
  3. メソッド内で、ヘルプ・トピックを含むようにストリングを作成します。 ヘルプ・トピックを指定するための構文は、pluginID/file_path/file_name です。ここで、pluginID はその plugin.xml ファイル内で指定された Eclipse ヘルプ・プラグイン ID、file_path はサブディレクトリー・パス (ある場合)、そして file_name はヘルプ目次ファイルのファイル名と拡張子です。
       public void doHelp(RenderRequest request, RenderResponse response) 
              throws PortletException, IOException {
    
          String topic = "com.ibm.isc.help.modes/help_mode.html";
       }
    
    
  4. 以下のコード・スニペット内で表示されるように、要求、応答、およ びトピックを引き渡すメソッド EclipseHelp.portletHelp() を呼び出します。
       public void doHelp(RenderRequest request, RenderResponse response) 
              throws PortletException, IOException{
    
          String topic = "com.ibm.isc.help.modes/help_mode.html";
         EclipseHelp.portletHelp(request, response, topic);
    
       }
    
    

portlet.xml ファイル内にヘルプ・モードを設定します。

doHelp() メソッドの実装に加えて、portlet.xml ファイル内のそのポートレット用のヘルプ・モードを設定する必要があります。 portlet.xml ファイル内にヘルプ・モードを設定するには、以下のステップを実行します。

  1. テキスト・エディターを使用して、ポートレット・デプロイメント記述子 (portlet.xml ファイル) を開きます。 portlet.xml ファイルの作成について詳しくは、ポートレットの開発の下のトピックを参照してください。
  2. <portlet-app> エレメント内で、doHelp() メソッドを実装するポートレットの <portlet> エレメントを見つけます。
  3. <supports> サブエレメント内で、以下の例に示すような <portlet-mode> エレメントを追加します。
<?xml version="1.0" encoding="UTF-8"?>
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" 
             version="1.0" id="com.ibm.isclite.samples.Modes"
             	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd 
                                 http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd">
   <portlet id="Modes_Portlet" >
      <portlet-name>ModesPortlet</portlet-name>
      <display-name>Modes portlet1 (JSR 168)</display-name>
      <display-name xml:lang="en">Modes portlet1 (JSR 168)</display-name>
      <portlet-class>com.ibm.isclite.samples.Modes</portlet-class>
      <expiration-cache>0</expiration-cache>
      <supports>
         <mime-type>text/html</mime-type>
         <portlet-mode>VIEW</portlet-mode>
         <portlet-mode>EDIT</portlet-mode>
         <portlet-mode>HELP</portlet-mode>
      </supports>
      <supported-locale>en</supported-locale>
      <resource-bundle>nls.HTML</resource-bundle>
   </portlet>

 
</portlet-app>
 

Eclipse のヘルプの作成

Eclipse プラグインとして HTML ヘルプを提供することについて詳細は、http://help.eclipse.orgを参照してください。

参照トピック    

ご利用条件 | フィードバック

最終更新: Jan 21, 2008 7:05:28 PM EST
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.express.iseries.doc/info/iseriesexp/isc/link_help.html