预订演示
前页 后页

链接文档

在开发模型中的元素时,您可能希望为元素提供详尽的文档,以便提供比在元素“注记”字段中创建的更具结构化的文本。在这种情况下,您可以创建一个链接到元素格式化文档。您可以从头开始创建链接文档,也可以从使用链接文档模板编辑器定义的一系列链接文档模板中选择一个模板来创建。链接文档保存在模型中。

使用链接文档

任务

细节

也见

创建链接文档

您可以通过以下方式创建链接文档:

  • 在附加到您的模型元素文档工件元素内,或者
  • 直接在模型元素上
使用文档工件托管链接文档的优点包括:
  • 文档工件以及链接文档在浏览器窗口中的可见性
  • 由于一个元素中只能有一个链接文档,因此将多个文档分别托管在其自己的文档工件中,并将多个文档工件连接到一个模型元素,意味着您可以提供更广泛的信息
  • 类似地,通过将多个元素连接到宿主文档工件元素,将多个元素与一个文档关联起来,意味着您可以共享信息,而不是复制它
直接在元素上使用链接文档的优点包括:
  • 将文档内容与元素更紧密地绑定在一起,从而减少信息所指内容的歧义
  • 将文档本身与元素更紧密地绑定在一起,这样,在不参考其所属元素的情况下,文档被更改、移动或删除的风险就会更小
创建文档工件 在元素上创建链接文档

创建链接文档模板

您可以根据系统提供的一系列模板之一来创建链接文档,每个模板代表一种项目文档类型。

您还可以在浏览器窗口的“资源”选项卡中的“链接文档”文件夹中创建和使用您自己的链接文档模板。

创建链接文档模板

编辑链接文档

您可以在创建文档的模板和文档本身中定义链接文档的样式、格式和布局。您可以在文档窗口和链接文档编辑器中通过选定的元素编辑链接文档。

编辑链接文档模板 编辑链接文档

在链接文档中创建超链接

链接文档与特定元素紧密相关,但您也可以在文档中创建直接指向模型中其他元素的超链接。通过链接,您可以对该元素执行任何常规操作。

类似地,您可以创建要链接的新元素或图表。

您还可以创建指向其他形式文档的超链接。

超链接来自链接文档 从文档创建元素

在 RTF 报告中包含链接文档

无论如何创建链接文档,当您在文档模板设计师中选中“链接文档”复选框时,它们都会呈现到文档报告中。

报告链接文档

找到链接的文档

在图表中,任何具有链接文档的元素都在右下角标有“ A ”符号。

您还可以使用模型搜索功能来搜索具有链接文档的元素,可以使用系统定义搜索的“发布”组中的“查找链接文档”搜索(返回标准链接文档),也可以创建包含此#

自定义搜索#

查询(返回链接文档的所有变体):

SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE,名称AS物件, Object_Type AS [类型],构造型,作者,状态,状态,相,CreatedDate,ModifiedDate

来自 t_object

其中 t_object.Style LIKE '#WC#MDoc=1#WC#'

创建搜索定义 属性Window -图表

删除链接文档

您可以从元素中完全删除链接文档,也可以删除文档的内容并将其替换为外部文件的内容。

替换或删除链接文档

注记

  • 您可以创建一个文档工件元素来包含Enterprise Architect所有版本中的链接文档
  • 您可以在Enterprise Architect的所有版本中创建文档并将其链接到模型中的任何UML元素
  • 您可以通过接口使用方法 GetLinkedDocument()、DeleteLinkedDocument()、SaveLinkedDocument( string Filename) 和 LoadLinkedDocument( string Filename) 处理链接文档

了解更多