ヘルプトピックへのリンク
このセクションでは、共通のコンポーネントユーザーインタフェースから Windchill ヘルプセンター (WHC) のトピックにリンクする方法について説明します。WHC はすべてのヘルプトピックのリポジトリです。
WHC の Web アプリケーションは Windchill の Web アプリケーションとは異なります。
URL の詳細
• wt.properties ファイル内の wt.whc.url プロパティによって、WHC への URL が定義されます。
• wt.help.HelpLinkHelper.createHelpHREF(String) API は適切な完全修飾 WHC URL を返します。
このセクションでは、Windchill UI から WHC のヘルプトピックにリンクする方法について説明します。
情報ページ
情報ビルダーでヘルプコンテキストを設定している場合、情報ページの右上隅にヘルプボタン (
) が表示されます。
// sets the help topic to use from the Windchill Help Center
infoConfig.setHelpContext("HelpTopicName");
テーブル/ツリー
情報ビルダーでヘルプコンテキストを設定している場合、テーブル/ツリーの右上隅にヘルプボタン (
) が表示されます。
// sets the help topic to use from the Windchill Help Center
tableConfig.setHelpContext("HelpTopicName");
テーブルやツリーが、ビルダーで定義されるのではなく、まだ jsp 内で定義されている場合、ヘルプトピックへの追加は次のようになります。
<renderTable model="${tableModel}" helpContext=" HelpTopicName"/>
ウィザード
ウィザードタグでヘルプセレクタキーを指定している場合、ウィザードの右上隅にヘルプボタン (
) が表示されます。
<jca:wizard helpSelectorKey="HelpTopicName" …>
その他のページ
共通のコンポーネントを使用していない場合に、WHC へのリンクを UI に表示するには、jsp で helpButton タグを使用してページにボタンを出力できます。
<%@taglib uri="http://www.ptc.com/windchill/taglib/wrappers" prefix="w" %>
<w:helpButton helpSelectorKey="HelpTopicName"/>
これによって UI にヘルプボタン (
) が表示されます。
なんらかの理由によって特定の UI に helpButton タグを使用できない場合、HelpLinkHelper.createHREF(String) API を使用してヘルプトピックへの URL を取得できます。
たとえば、wt.help.HelpLinkHelper.createHelpHREF("HelpTopicName") は WHC の特定のヘルプトピックへの URL を <wt.properties 内のプロパティ wt.whc.url の値>/HelpTopicName.html の形式で返します。
例: http://<ローカルホスト>/Windchill-WHC/HelpTopicName.html
その URL を開くには JavaScript API を使用します。PTC.help.openHelpWindow(helpUrl);
これによってポップアップウィンドウでヘルプトピックが開き、ヘルプリンクをクリックすると、新しいヘルプウィンドウが開く代わりに、同じウィンドウが更新されます。