预订演示
前页 后页

设计自定义文档模板

如果您想记录和记录您的模型的详细信息,您可以使用一系列文档报告来做到这一点,每个报告都使用文档模板生成。为了满足您的特定要求,可以通过开发自己的模板来定制报告;在此过程中,您还可以选择生成测试报告,以便在开发时审阅您的设计输出。您可以开发的自定义模板包括完整的文档模板和独立的样式表、封面和目录。

您可以使用文档模板设计师创建和编辑报告模板以定义:

  • 要报告的模型组件
  • 要提取的每个组件的信息和
  • 报告的样式和布局
可以从头开始创建模板,也可以通过复制和编辑另一个自定义模板或系统模板。如果您想审阅系统模板,您可以使用文档模板设计师列出和显示它们,并确定已经存在的模板以提取您需要的信息,或作为您自己设计的起点。

访问

当您在文档模板设计师中打开模板编辑器时,“文档 - 编辑”功能区也会自动打开。

功能区

发布>模型报告>模板编辑器

其它

浏览器窗口的“资源”选项卡 |报告模板|系统模板| <模板组>:右键单击模板|复制

浏览器窗口的“资源”选项卡 |报告模板|定制模板| <模板组>:右键单击模板|打开

文档模板设计师

文档模板设计师包括:

  • 工具栏A ,您可以通过它创建或选择要处理的模板、保存您的工作以及生成和查看测试报告
  • “部分” A ,您可以在其中选择要报告的模型的组成部分
  • “内容” A ,您可以在其中使用广泛的上下文菜单选项来开发报告的内容和布局

工具栏菜单选项

名称

行动

也见

新的

创建一个新的模板。

将显示A提示让您输入新模板的名称,也可以输入要用作基础的现有模板的名称。

所有关于文档模板

打开模板

“打开模板”选项卡现在指向在“资源”选项卡中打开“模板”视图。

节省

保存对当前模板的更改。

另存为

将当前模板保存为新模板。

提示显示新模板名称的A 。

模板选项

显示一系列文档选项,您可以设置这些选项以应用于使用模板生成的所有报告。这些选项可过滤和组织报告中显示的信息。

文档选项

在资源浏览器中查找

打开浏览器窗口和/或包含当前显示的文档模板的文件夹的“资源”选项卡,并突出显示模板名称。

浏览器-资源

显示部分

在文档生成器视图中切换显示“部分层次结构”面板和隐藏它。

设置报告部分

生成文件

根据模板生成并显示测试报告。

要生成测试报告,您需要指定目标文件并在浏览器窗口中选择一个包、图表或元素来运行报告。您可以为此开发一个特殊的测试包。

视图文件

显示文件路径字段中指定的文件中保存的报告。

您可以多次返回生成的报告,同时审阅您正在编辑的模板的不同部分的效果。

部分和内容面板

功能

描述

也见

部分面板

由模型组件的层次结构及其属性组成,每个都带有一个复选框。要在报告中包含有关某类组件的信息,请选中它对应的复选框。

当您选择复选框时,相应的打开/关闭标记对会显示在“内容”面板中;例如:

部分面板

Selecting Sections in a Documentation Template for reporting using Sparx Systems Enterprise Architect.

内容面板

Section Markers set in an Enterprise Architect Report Template.
设置报告部分

内容面板

编辑区域,您可以在其中开发模板的结构和内容。

当您向模板添加节标记时,会自动添加包含提示的文本以在标记之间提供指导,例如:

The Element Section of an Enterprise Architect Report Template.

将提示文本替换为一系列字段(从您的模型中提取信息)和手动输入的静态文本。

添加部分内容

编辑模板

您在创建和更新文档模板时所做的大部分工作都是使用“文档 - 编辑”功能区的功能完成的,当您打开文档设计师器时会自动显示该功能。有关使用这些功能的指导,您可以参考:

  • 文档 -编辑功能区,直接描述功能,或
  • 编辑文档和模板,它描述了跨Enterprise Architect的文档编辑功能
  • 自定义模板设计选项,它识别您可能想要执行的编辑任务,并将您引导至执行这些任务的功能
自定义模板设计选项 编辑文档和模板 文档-编辑功能区

内容面板上下文菜单

如果您右键单击时间菜单显示的“内容”面板的字段标记文本或背景,上下文提供许多附加选项:

  • 插入从显示列表中选择的字段,其中条目特定于您选择的部分标记 - 您还必须删除部分标记之间的文本提示;生成报告时,字段名称替换为模型中的对应值
  • 插入从您在“生成文档”对话框的“项目常量”选项卡中定义的项目常量中选择的项目常量
  • 插入从标准列表中选择的报告常数;这些常量从元素和包属性中派生值
  • 将模板中使用的样式表更新为子菜单中列出的样式表之一,可以是系统提供的,也可以是用户自定义的;或者,从定制样式表切换回标准 Normal.rtf 样式表
  • 隐藏或显示“部分”面板,提供有关添加哪些部分的指导,或提供更多空间来开发报告的内容
  • 剪切或复制选定的文本,并将剪贴板中的文本粘贴到新位置
  • 以相反的顺序序列您所做的更改或一系列更改,或根据需要重做撤消的更改
设置报告部分 关于创建样式表的注记 项目常量 Normal.rtf 样式模板 报告常数 自定义模板设计选项

注记

  • A名为 Normal.rtf 的全局文档样式标准文件会自动应用于您从头开始创建的所有新模板;可以编辑 Normal.rtf 以根据您的要求定制样式,并在模板中覆盖这些样式
  • 您还可以创建特殊定制的目录表和封面页,以选择性地在任何文档报告中使用,以代替报告模板中内置的任何封面页或目录表,以及可以选择覆盖 Normal.rtf 样式的样式表或报告模板中的任何已编辑样式
  • 您可以使用“设置>模型>传输>导出参考”和“导入参考”功能区选项在模型之间传输模板

了解更多