链接到帮助主题
本节将介绍如何从公用组件用户界面链接到 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" …>
其他页面
如果您不使用公用组件，但想要在 UI 中生成指向 WHC 的链接，则可以使用 jsp 中的 helpButton 标记来在页面上输出按钮：
<%@taglib uri="http://www.ptc.com/windchill/taglib/wrappers" prefix="w" %>
<w:helpButton helpSelectorKey="HelpTopicName"/>
这会在 UI 中生成帮助按钮 (
)。
如果由于某种原因无法将 helpButton 标记用于特定的 UI，则可以使用 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);
这将在弹窗中启动帮助主题，随后单击帮助链接时，将更新同一帮助窗口，而不是启动新的帮助窗口。