帮助系统Authoring

Enterprise Architect使您能够使用帮助系统模型为您开发的模型、系统和流程的用户提供支持。这是一个易于使用的模型，具有许多功能，可用于创建帮助主题的结构，以根据您的需要尽可能广泛和深入地记录您的模型或系统。这些功能包括：

A帮助配置文件，定义帮助原型，标记值和帮助页面的图表工具箱
A蓝图（从管理蓝图帮助访问）
帮助模型模式，为您使用帮助配置文件中的原型元素创建自己的帮助模型提供起点
帮助生成模板
您可以根据需要修改和扩展的基本 CSS A
一个 HTML 生成器和一个 PDF 生成器，从同一个源帮助模型构建文档

从您的帮助模型生成的 HTML 文件可以通过您自己的网站或本地文件系统部署在 Internet 上，然后可以使用任何网络浏览器查看。还可以为那些想要访问更“线性”版本的帮助用户生成 PDF 文档。

本主题的最后一部分简要说明了如何生成和查看正在创建的帮助页面。

介绍帮助系统模型

帮助系统模型是从一组标准的UML元素构建的，这些元素是使用自定义Enterprise Architect配置文件进行构造的。主要配置文件元素包括诸如HelpTopic 、HelpSections 和各种 HelpTables 之类的项目（请参阅帮助系统组件概述表。每个构造型都有一个特定的目的，并控制如何生成最终的 web 或 PDF 内容。重要的是使用正确的类型以确保一致和令人满意的结果。

此图标识可用于在帮助系统中构建帮助页面的元素，以及它们之间的关系。注记， HelpTable2A元素表示可用于帮助模型的库表元素的范围。

帮助模型组件概述

此表定义了帮助系统配置文件中用于构建在线帮助系统主要原型元素。帮助系统元素使用帮助主题的使用中提供了对每种元素类型的A详细讨论。

HelpPackage	每个单独的帮助主题都由一个 «HelpPackage»元素定义。这可以由父包或HelpPackage拥有，并且可以拥有子 HelpPackages 以形成主题层次结构，一般提供有关系统某些方面的更详细和具体的信息。每个HelpPackage元素包含一个 - 并且只有一个 - HelpTopic元素，它必须与其父HelpPackage具有相同的名称。
HelpTopic	A «HelpTopic»元素对应一个HTML页面。 HelpTopic “别名”属性用作生成主题的 .html 文件的名称。 HelpTopic元素通常包含一些介绍性文本来解释主题的目的以及它如何适合它所属的任何主题结构。 HelpPackage中只能有一个HelpTopic元素。 HelpTopic可以是其他帮助元素的父元素，除了：其它HelpTopics HelpTopicProxy元素 HelpTableRows，和 HelpTableRowProxy元素
HelpTopicProxy	如果您想复制现有的帮助主题，您可以将 «HelpTopicProxy»元素添加到HelpPackage而不是HelpTopic元素。您不要在HelpTopicProxy元素下添加任何其他元素，因为它会调用正在复制的主题的全部内容。
HelpSection	«HelpSection» A对应于页面中的一个或元素相关段落，讨论特定主题。 A只能是HelpTopic的子元素，不能包含任何其他HelpSection的元素，包括其他 HelpSections。您可以在一个HelpTopic下有多个 HelpSections，或者一个，或者没有。名称为注记HelpSection元素A位于HelpTopic下的倒数第二个位置（在“了解更多”部分之前），其中包含有关该主题主题的附加要点的项目符号列表。然而，有一个注记部分不是强制性的。
HelpSectionProxy	«HelpSectionProxy» A捕获系统中其他地方元素现有HelpSection的内容。您使用此元素在您的帮助结构中的一个或多个其他点复制材料。 A只能是HelpTopic的子元素，不能包含HelpSectionProxy其他类型的元素，并且没有自己的文本内容。
HelpSectionDiagram	«HelpSectionDiagram» A用作图表的占位符/容器，该图表将作为图像出现在帮助元素。该图应作为HelpSectionDiagram元素的子项创建；用于创建图表的任何（非帮助）元素或构造不会出现在 HTML 或 PDF 文档本身中。本元素中的图表通常是一个独立的图表，将主题作为一个整体进行说明。您还可以在HelpTopic 、 HelpSection或HelpTableRow中创建链接，以显示说明特定点的图表图像。
HelpSystemVideo	«HelpSystemVideo» A用作视频控件的容器，它将在正在查看帮助元素浏览器中播放视频。这允许包含来自您网站的简短“操作方法”视频，可以在用户指南”中“查看”这些视频。
HelpSlideshow	«HelpSlideshow» A用作幻灯片放映控件的容器，它将在正在查看帮助元素浏览器中播放序列幻灯片。这允许在您的网站上包含“这个特征看起来像什么”的幻灯片，可以在“用户指南”中查看。
HelpTable	« A xn » 根据所选的实际原型定义HelpTable几种类型的表中的一种。 HelpTable标识列数、相对列宽以及标记值中的列标题。帮助系统表帮助主题中描述了不同类型的表。帮助库表可以有任意数量的子HelpTableRow或HelpTableRowProxy元素。
HelpTableProxy	« A »元素捕获系统其他地方任何类型的现有HelpTable的内容。您使用此元素在您的帮助结构中的一个或多个其他点复制材料。 A只能是HelpTopic的子元素，不能包含HelpTableProxy其他类型的元素，并且没有自己的内容。
HelpTableRow	«HelpTableRow» A定义任何元素的表的单行内容。元素名称是行标题，元素注记提供行标题的描述或解释。标记值在“也见”列中定义支持帮助主题的超链接。如果表不支持“也见”列，则忽略那些标记值。 A只能是HelpTable的子项，不能包含HelpTableRow其他类型的元素。您还可以使用标记值将图标添加到行标题，或用图标替换标题文本。这帮助系统元素使用帮助主题的使用中进行了讨论。
HelpTableRowProxy	« A »元素捕获系统中其他地方的现有HelpTableRow的内容。您使用此元素在您的帮助结构中的一个或多个其他点复制材料。 A只能是HelpTable的子元素，不能包含HelpTableRowProxy其他类型的元素，并且没有自己的内容。
HelpSectionLearnMore	«HelpSectionLearnMore»元素用于提供相关主题的超链接列表，这些主题未在主题的其他地方链接，也未显示在生成的帮助主题旁边的帮助层次结构中。它通常放在主题的末尾，以免分散主题正文中呈现的材料的注意力。元素名字永远是“了解更多”； HelpTopic下只有一个“了解更多”部分，并且不能有任何子元素。 PDF 生成器忽略这个元素。

发电帮助

创建帮助元素的结构并添加内容和插图以形成帮助页面后，您可以生成并显示主题以检查它如何显示为实际的 HTML 页面。为此，请在您要生成的结构的最高点选择HelpTopic元素，右键单击它并选择“在当前项目上生成帮助”选项。系统输出窗口显示帮助生成的进度。然后可以在您最喜欢的网络浏览器中查看生成的 HTML 文件。

帮助主题生成帮助文件详细说明了如何从您的帮助模型生成 HTML 文件和 PDF 文件。

示例模型

用于创建此帮助主题的帮助模型的分支已被复制到Enterprise Architect示例模型中，位于“模型发布”部分。在那里，您可以探索示例帮助模型，从中生成文件并通过扩展或更新它进行试验。

要打开示例模型，请选择功能区选项“开始>帮助>帮助>打开示例模型”。