创作帮助系统内容

Enterprise Architect帮助系统模型提供了所有结构、格式和样式，您可以立即创建和生成类似于Enterprise Architect帮助本身的帮助主题。然后您可以编辑 CSS 文件和模板来定制输出以反映您的组织自己的标准和表示。

源帮助材料的格式主要由Enterprise Architect控制，然后由模板和 CSS 文件定义的 HTML 和 PDF 生成器解释。但是，在编写帮助文本时可以采用多种格式和样式，这些将在本主题的各个部分中进行讨论。

使用规范管理器

编写帮助内容的主要工具是规范管理器。这是一个可自定义的“类似文档”帮助作者。要打开规范管理器，请在浏览器窗口中选择一个HelpPackage ，然后：

• 按 Ctrl+0
• 右键单击并选择规范管理器，或
• 选择设计>包>规格视图功能区选项。

规范管理器有许多栏目可以帮助您检查和维护帮助元素的属性，例如状态、优先级和构造型。您可能还希望隐藏除“项目”之外的所有列，它只会显示元素名称和注记内容（帮助文本）。您可以使用“字段选择器”上下文菜单选项添加列，只需将列标题拖出标题栏即可将其隐藏。

当您打开规范管理器时，规范-指定功能区会自动显示。功能区中的有用选项包括：

• '元素> 插入 > 显示工具箱' - 显示图表工具箱，您可以将其固定到帮助系统页面，以便它始终在该页面打开。
• '元素>上移'和'元素>下移'，帮助您重新排序同级元素的序列
• '显示 >注记格式'，使您可以将注记文本放在最适合您阅读和编辑的位置，可以是帮助元素名称下方或右侧，也可以隐藏列标题（'文档视图')
• 'Display > Level Numbering'，它 - 在更复杂的主题结构中 - 对父元素和子元素进行编号，以便您可以看到哪些元素是哪些父元素的子元素
• Display >粗体名称'，加粗元素名称并使它们在文本块中更加明显
• 'Display > Collapsible区域' 将子元素隐藏在其父元素之下，这样你就可以只展开你想要处理的元素组（当你有多个库表时非常有用，尤其是有很多行时）
• “显示 > 字体大小”，允许您更改所有文本的显示大小以使其更易于阅读，或在窗口区域内包含更多文本

注记窗口

开发帮助文本的第二个重要窗口是注记窗口，它使通过注记窗口工具栏选项进行格式化和超链接变得更容易一些。

注记中一些有用的快捷方式是：

• Ctrl+。开始或结束项目符号列表
• Ctrl+0 开始或结束编号列表
• Ctrl+B 设置粗体打开或关闭
• Ctrl+I 打开或关闭斜体
• Ctrl+U 设置下划线打开或关闭

参考图像

在规范管理器中使用图像是通过使用普通的注记窗口来实现的。要链接到图像，请打开注记窗口并使用超链接工具栏按钮将超链接添加到图像管理器中的图像（选择超链接类型为“图像管理器”），或作为保存在图像中的图像资产参考图（选择超链接类型为“元素图像”）。也可以将超超链接直接添加到同一项目中的图表（选择超链接类型为“图表图像”）。

样式和格式注意事项

由于您将编辑稍后生成的文档，因此大多数格式和样式注意事项已在生成时自动处理。尽量避免手动将粗体、斜体、下划线或颜色应用于文本。而是使用词汇表按类别一致地标记术语（请参阅词汇表的后面部分）。

如果HelpSection或HelpTable包含大量代码，您可能更喜欢将文本格式化为等宽。您可以通过选择元素属性窗口的“标签”选项卡并添加值为“基本”的新标记值“ContentType”来完成此操作。

词汇表的作用

添加内容时，您可能会看到一些带下划线的术语；这是因为它们在词汇表中有定义，并且会以特殊的颜色或外观出现在最终的帮助文档中。如果您要包括用户界面元素、热键或特殊术语的新术语，您可能应该将它们添加到词汇表的适当部分。您可以通过突出显示该术语并使用上下文菜单来创建 |词汇表定义。将术语添加到适当的位置并检查您生成的内容以确保它按预期显示。

模型词汇表还在定义您编写帮助文本所用的母语以及您将其翻译成的任何其他语言方面发挥作用。请参阅翻译功能帮助主题。