为应用程序和组件添加教员帮助

Tekla Structures
2022
Tekla Structures

为应用程序和组件添加教员帮助

您可以为应用程序和组件目录中的工具轻松创建侧窗体帮助。

应用程序和组件目录中,教员窗体会在您选择某一项时显示内容。这些信息特别有用,可向用户提供有关如何选择正确组件的建议或在运行工具之前的说明。要充分利用此功能,用户应排列其侧窗体,使两个窗格都可见。

  1. 应用程序和组件目录中,选择需要添加帮助的工具。
  2. 教员窗体中,单击菜单,然后选择添加帮助文件

    此时将打开一个对话框,用于根据您的选择创建必要的文件。

  3. 单击下一步,然后选择一种或多种语言。

    选择在您的组织中用作 Tekla Structures 用户界面语言的语言。即使不翻译内容,每种语言也必须有一个内容文件。

  4. 单击下一步,然后选择要用于存储所生成文件的文件夹。

    文件可存储在模型、工程、公司或系统文件夹中。它们将遵循标准的文件夹搜索顺序

    如果您要将文件分发给用户,我们建议您将文件存储在工程或公司文件夹中。

  5. 单击创建

    Tekla Structures 将创建一个 XML 文件,该文件可在应用程序和组件目录中的工具与帮助内容的 HTML 文件之间定义一个链接。

    用于存储 HTML 文件的文件夹结构将文件归入多个语言特定的文件夹。内容的 XML 文件和根文件夹是根据需要帮助的工具的标识符来命名的。您可以在允许的存储位置之间复制文件,但不能重命名文件或文件夹或者更改文件夹结构。

  6. 在首选工具(例如 Visual Basic)中编辑 HTML 内容文件,或将文件替换为您自己的 HTML 文件(采用相同的文件名)。

您可以选择将教员帮助文件添加到 .tsep 包实现扩展,以便用户在安装 .tsep 包时自动添加教员帮助文件。您可以在工程定义 .xml 文件中使用通配符 (*),添加指定文件夹中的所有文件。例如:

<TargetPathVariables>
	<PathVariable Id="HelpDirectory" Value="%ENVDIR%\common\extensions\MyExtension\"/>
</TargetPathVariables>

<Component Id="ExampleExtension" Guid="4902568A-2195-4B38-BBA4-BEB56A2ABECF">
	<File Id="HelpFilesToCopy" Source="%TSEPDEFINITIONFILEFOLDER%\plugin\*" Target="%HelpDirectory%"/>
</Component>
这些内容是否有用?
上一步
下一步