使用帮助系统元素

HelpPackage

帮助系统中的每个主题都由一个HelpPackage表示，其中包含一个同名的HelpTopic子元素。

帮助包按父包和子包的层次结构排列，以开发帮助系统中帮助页面的结构。然后通过页面顶部的面包屑控件和页面左侧的子主题链接列表之类的菜单，将此包层次结构反映在生成的网页中。

注记帮助层次结构中的顶级包（实际上是“章节”节点；例如，在Enterprise Architect自己的帮助中，“建模语言”）应该设置代码工程“命名空间的根”标志.当生成网络帮助时， Enterprise Architect在指定的输出文件夹中创建子文件夹，使用名称命名空间的根包的名称作为文件夹名称。每个生成的主题文件都放置在从其最近的父包创建的子文件夹中，该子文件夹被标记为命名空间的根。至少，一个顶级包必须被标记为一个命名空间的根。命名空间的根可以通过单击包然后选择“开发>源代码>选项>将包设置为命名空间的根”功能区选项来设置。

HelpPackage不是作为帮助直接生成的，而是充当HelpTopic及其自己的子元素的容器。帮助包和帮助主题元素同名很重要。

HelpTopic

A HelpTopic元素对应一个 HTML 页面。

重要的是，在最终生成的输出中， HelpTopic “别名”属性设置为帮助主题所需的文件名。别名在整个帮助系统中必须具有唯一名称，并且不应包括扩展名。例如，“requirements_management”（不带引号）是一个有效的别名，生成时将提供文件名“requirements_management.html”。

HelpTopic元素通常包含一些介绍性文本（在元素'注记'字段中）来解释主题的目的以及它如何适合它所属的任何主题结构。

一个包中只能有一个HelpTopic元素。 HelpTopic可以是大多数其他帮助元素的父级， HelpTopicProxy 、 HelpTableRow和HelpTableRowProxy除外。

HelpTopicProxy

A元素捕获现有HelpTopic元素及其子元素的内容，并将它们复制到另一个HelpPackage HelpTopicProxy 。因此，您将HelpTopicProxy元素作为HelpPackage的子项插入。

您为HelpTopicProxy提供了自己的主题名称和适当的别名。在元素的属性窗口中，对于“refTopic”标记值，您单击图标并找到并选择要复制的HelpTopic 。

您不需要在HelpTopicProxy或HelpPackage元素中执行任何else操作。

HelpSection

A HelpSection元素对应于一个页面中的一个或多个相关段落，讨论一个特定的主题。 HelpSection名称将显示为标题，元素注记为内容。

A只能是HelpTopic的子元素，不能包含HelpSection其他元素。

如果一个主题下有多个HelpSection元素，它们将按照它们在浏览器窗口和规范管理器中出现的顺序出现在生成的页面中。您可以在HelpSection内容中嵌入指向图表和屏幕截图的链接，这些将根据需要在 Web 或 PDF 内容中复制。

名称为“注记” HelpSection A元素位于HelpTopic中的倒数第二个（在“了解更多”部分之前，如果存在的话），包含关于主题主题的附加要点的项目符号列表，例如执行任务可能需要哪些Enterprise Architect或 DBMS 权限。

HelpSectionProxy

与HelpTopicProxy类似， HelpSectionProxy复制现有HelpSection的内容。您将HelpSectionProxy作为HelpTopic元素的子项插入到HelpTopic下对等HelpSection 、 HelpSectionProxy 、 HelpTable和HelpTableProxy元素的序列中的适当位置。

HelpSectionProxy有自己的元素名称。在元素的属性窗口中，对于“refSection”标记值，单击图标并找到并选择要复制的HelpSection 。

HelpSectionDiagram

A元素用作将作为图像出现在帮助中的图表HelpSectionDiagram占位符/容器。

该图应该建在HelpSectionDiagram元素下面；图表中出现的任何元素或构造不会出现在 HTML、网络或 PDF 文档本身中。这允许创建解释性图表，而无需将每个表示的元素放入帮助文档本身的负担。然而，图表中的元素将列在浏览器窗口和规范管理器中。

您可以在此元素中包含文本。由于图表本质上从属于HelpSectionDiagram元素，属于元素的文本将显示在图表上方。

除了为HelpSectionDiagram元素提供名称外，您不必设置任何属性。

这元素通常用于说明一般特征或概念的独立图表。如果图表或图像是HelpTopic 、 HelpSection或HelpTableRow中解释的点的示例，则文本中有超链接机制，用于链接到模型或图像管理器中其他地方保存的图表或图像。

HelpSystemVideo

A元素是视频控件的容器，它将在正在查看帮助HelpSystemVideo浏览器中播放视频。这允许包含来自您网站的简短“操作方法”视频，这些视频可以从在线帮助中启动。

为元素命名后，您可以通过完成这组标记值来设置此功能。

• VideoTitle - 视频标题或标签中的类型
• VideoURL - 单击图标并找到并选择要播放视频的 url； URL 可以是绝对值或相对值，它被插入到生成的文档中而无需修改
• VideoType -类中文件的类型；例如，视频/mp4
• Duration -类型视频播放所花费的时间，以秒为单位
• ThumbnailURL -类型在代表视频的图标的位置； URL 可以是绝对值或相对值，它被插入到生成的文档中而无需修改

HelpSlideshow

与HelpSystemVideo元素类似， HelpSlideshow元素使用户能够运行描述过程中各个阶段的静态屏幕的幻灯片，或输出示例，或说明帮助帮助主题的其他图像。同样，您为元素提供一个名称，并完成这些标记值：

• 图标 - 单击图标，从图像管理器中找到并选择图像，用户将在该图像上单击以开始幻灯片放映；此图像可能是您所有幻灯片放映的标准
• Image1 - 单击图标，从图像管理器中找到并选择代表要显示的最后一张幻灯片的图像；请参阅此列表下方的说明
• DiagramRef - 待定义

1. 根据需要创建尽可能多的附加“Image1”标记值，没有限制。每个新的标记值都被添加到列表的顶部，并且都具有相同的名称，它们将在序列中从上到下进行操作，因此也许只需首先添加标记值并在所需的序列中添加幻灯片图像当你完成时。
   由于这些都是'Image1'标记值和定义的一部分，它们将出现在构造型标记值部分的'元素'选项卡中，按照从新到旧的顺序（如果不是，请单击元素并单击重新回到它上面）。
2. 创建最多四个类型的标记值HelpSystem::Image2 到 HelpSystem::Image5。将幻灯片中的第一张图片添加到“Image2”标记值，然后将下一张添加到“Image3”，依此类推。这些标记值是 HelpSystem 配置文件的一部分，但不是HelpSlideshow构造型定义的一部分，因此它们列在属性窗口的“标记”选项卡中。所有标记值均按字母数字顺序按标签名称进行处理，因此HelpSlideshow标签将从“ H elpSystem::Image2”到“HelpSystem::Image5”到“ Ic on”再到“ Im age1”进行处理。

HelpTable

HelpTable元素有多种格式，具体取决于分配的构造型。

在属性窗口中使用标记值应用列名。在三列库表中，第三列包含指向其他帮助主题的超链接（在HelpTableRow元素中设置），其标题在帮助生成器中默认为“也见”。注记“也见”列未在 PDF 中重现从帮助源生成的输出。

A元素只能HelpTableRowProxy HelpTopic元素的子元素，并且只能包含HelpTable或HelpTableRow子元素。

帮助系统表主题中提供了完成表A及其构造型。

HelpTableProxy

A在不同帮助主题中以任何样式和格式复制现有HelpTable的内容HelpTableProxy定义。这包括现有HelpTable可能具有的所有HelpTableRow和HelpTableRowProxy元素。 HelpTableProxy元素只能是HelpTopic的子元素，本身不能有任何子元素。

为元素命名后，在元素的属性窗口中选择“refTable”标记值，单击图标并找到并选择要在当前主题中复制的HelpTable 。

HelpTableRow

A库表行元素表示表帮助的单个行。通常，元素名称成为行标题，注记字段成为行描述。但是，元素在属性窗口中定义了各种标记值，支持不同类型的行标题和列内容。这些都是：

• ImageRef - 您可以用图像替换行标题文本，在这种情况下，您可以使用图像管理器中的图像名称作为元素名称；单击图标并从图像管理器中找到并选择图像
  如果你想要一个行标题和一个图像，给HelpTableRow元素那个标题作为它的名字
• Lytebox - 待定
• ImageArtifact - 如果您想将图像工件中的图像添加到该行，或用该图像替换行标题（使用与 ImageRef 相同的原则），请单击图标并从您的文件中找到并选择图像浏览器
• ImageLink - 单击图标并定位并选择用户单击图像时显示的帮助主题
• SeeAlso - 使您能够添加指向另一个帮助主题的链接，该主题的名称将显示在也见列中（适用于表类型）
  注记这些链接只能指向HelpTopic元素，不能指向任何其他类型的object ；如果您需要链接到网站或其他 URL，请使用注记字段在第二列中创建链接

HelpTableRowProxy

A元素复制模型HelpTableRowProxy其他地方的现有HelpTableRow元素的内容。它没有自己的内容。对于其他代理元素，在给元素命名后，在元素的属性窗口中选择“refTableRow”标记值，单击图标并找到并选择要在当前表中复制的HelpTableRow .

HelpSectionLearnMore

HelpSectionLearnMore元素用于提供相关主题的超链接列表，这些主题未在主题的其他地方链接，也未显示在生成的帮助主题旁边的帮助层次结构中。它通常放在HelpTopic最后，以免分散对HelpTopic正文中呈现的材料的注意力；但是，如果内容很多，例如参数、属性或方法的长库表，则可以在此类材料上方插入了解更多部分，靠近帮助页面的开始。

在Enterprise Architect帮助中，该部分通常包含一个简单的项目符号列表，其中包含指向其他帮助主题或相关网站的超链接。但是，您可以根据需要添加解释性文本，或者如果除了主题其余部分中已链接的参考点之外没有其他参考点，则可以省略该部分。

PDF 生成器会忽略此元素，因此链接列表不会显示在 PDF 文档中。