Integrated Solutions Console モジュールがヘルプ・ページを必要とするポートレットを含んでいる場合、このトピック内の指示に従って、ポートレットのヘルプを実装します。
モード・サンプル (modes.war) は、コンソール・モジュールがユーザー支援またはヘルプを提供する方法を示しています。 このサンプルは、例: コンソール・モジュールのサンプル 内で説明されています。
ポートレット・ヘルプを実装するには、portlet.xml ファイル内の、ポートレットの doHelp() メソッド、EclipseHelp クラス、およびヘルプ設定を使用します。
doHelp() メソッドの内部で、EclipseHelp クラスの portletHelp() メソッドを使用して、Eclipse ヘルプ・プラグイン内のターゲット・ヘルプ・トピックにリンクします。
doHelp() メソッドをポートレット内に組み込み、portlet.xml ファイルにヘルプ設定を追加することによって、ポートレット・ヘルプ・モードを使用可能にします。
ポートレット・ヘルプ・モードが使用可能になると、アイコンがポートレット・タイトル・バー上に表示されます。
ユーザーがアイコンをクリックすると、別のブラウザー・ウィンドウが開いてそのヘルプ・トピックのみを表示します。
doHelp() メソッドをポートレットに追加するには、以下の手順を実行します。
import com.ibm.portal.help.EclipseHelp;
public void doHelp(RenderRequest request, RenderResponse response) throws PortletException, IOException { }
public void doHelp(RenderRequest request, RenderResponse response) throws PortletException, IOException { String topic = "com.ibm.isc.help.modes/help_mode.html"; }
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); }
doHelp() メソッドの実装に加えて、portlet.xml ファイル内のそのポートレット用のヘルプ・モードを設定する必要があります。 portlet.xml ファイル内にヘルプ・モードを設定するには、以下のステップを実行します。
<?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 プラグインとして HTML ヘルプを提供することについて詳細は、http://help.eclipse.orgを参照してください。