预订演示

请注意 : 本帮助页面不适用于最新版本的Enterprise Architect. 最新的帮助文档在这里.

前页 后页

创建学习中心页面

作为技术开发人员,您可以创建一组学习中心页面,以支持您已经开发并加载到Enterprise Architect任何MDG技术。您将每个学习中心页面创建为“文档工件”元素的“链接文档”。这些元素被组织到Packages的层次结构中,其中Package名称成为Learning Center中主题文件夹的名称。然后,您运行两个脚本;第一个生成“学习中心”文件夹和主题,第二个(作为Add-In或技术激活的一部分)将“学习中心”结构导入文件位置, Enterprise Architect可以从该文件位置加载它。

不再建议将学习中心资料作为MDG技术定义的一部分进行开发的原始过程。

设置学习中心主题的链接文档模板

虽然不是强制性的,但建议您为学习中心文档创建一个或多个链接文档模板,以为学习中心页面的布局,结构和内容提供一致的标准。

行动

也可以看看

1个

规划学习中心主题的内容,并考虑:

  • 您应该如何呈现说明性或描述性文字
  • 您应该如何安排直接行动任务中的步骤
  • 您应如何参考和/或链接到其他文档,网站和文件目录中的信息
  • 您可能需要合并哪些公司样式,标准和徽标

2

打开浏览器窗口的“资源”选项卡(“开始”>“桌面”>“共享”>“资源”),并为您的主题创建适当的链接文档模板。

创建链接的文档模板

设置软件包层次结构以组织学习中心主题

行动

也可以看看

1个

为学习中心文档创建根软件包。包名称将成为文档文件夹结构的起点,因为Enterprise Architect就是其产品学习中心主题。

2

显示此Package元素的“属性”窗口(选择“设计>模型>管理>属性”功能区选项),然后在“文件名”字段中键入生成学习中心文档的文件位置。

属性窗口

3

在“浏览器”窗口中,为要创建的学习中心文档的每个类别创建一个子程序包,并在每个类别中为文档的任何其他子类别创建子程序包。您可以根据需要将子包创建到尽可能多的级别,但是建议您尝试将结构限制为少于五个级别。

还请考虑您可以在学习中心文档结构中将主题(文档工件元素)和文件夹(包)放在同一级别。

添加包裹

创建学习中心主题

您可以通过多种方法在包中创建Document Artifact元素,但是创建Document Document图表并向其中添加元素是一种简单的方法,可以使您对主题区域的内容有直观的印象。

行动

也可以看看

1个

在包含“学习中心”主题的每个“包”中的“浏览器”窗口中,创建一个“文档”图;那是:

  1. 右键单击包名称,然后选择“添加图”选项。
  2. 在“新图”对话框中,在“图”字段中键入适当的名称,单击“选择自”标题,然后选择“管理>显示所有透视图”选项,然后在“新图”对话框下面的面板中单击“扩展”。标头。
  3. 单击“图类型”面板中的“文档”。
  4. 单击确定按钮。

2

从图工具箱中,将文档工件图标拖到图上,并为其指定将包含的主题的名称。

该名称将显示在文档顶部和“学习中心”主题访问路径中,它将作为打开该主题的链接。

3

双击该元素,然后从“模板中的新链接文档”对话框中选择您的Learning Center文档模板(或任何其他合适的模板)。

4

将说明和/或过程文本添加到文档中。完成后,保存文档,并对下一个“文档工件”元素/学习中心主题重复此过程。

编辑链接的文档

5

在“浏览器”窗口中,检查“文档工件”元素的列出顺序。此顺序确定了学习中心主题的顺序。

如果要以不同的顺序显示学习中心主题,请在“浏览器”窗口中相应调整相应的“文档工件”元素的顺序。

在包内移动对象

编译学习中心文档

行动

也可以看看

1个

在“浏览器”窗口中,单击学习中心文档的根级软件包。

2

选择“专业化>工具>脚本”功能区选项。

显示脚本窗口。

脚本编写

3

展开“ 本地脚本”文件夹,然后单击“ VBScript-创建学习中心书籍”脚本名称。

4

单击“脚本”窗口工具栏中的“运行脚本”图标( Run script. )。

该脚本将生成“学习中心”文档,生成根包属性中“文件名”字段中指定的文件路径。

该脚本还会生成:

  • 来自文档层次结构中每个Package的order.txt文件,用于定义子文件夹或主题名称在该Package生成的文件夹中的显示顺序;您可以根据需要直接在学习中心中编辑此文件以更改主题顺序
  • 根文件夹中的index.txt文件,它为每个主题提供索引,该主题从生成主题的Document Artifact元素的GUID派生;该索引用于在引用和指向该主题的超链接中标识该主题,而不管该主题可能移至的位置。

加载学习中心文档

使用存储库方法“ AddDocumentationPath”将您为Add-In或技术创建的学习中心文档加载到学习中心中。通常,您可以将此代码写入创建的用于加载Technology本身的激活脚本中,但是也可以使用更简单的脚本来测试文档。调用类似于:

{

Repository.AddDocumentationPath('ToolGuide','C:\\ Temp \\ ToolLC',0)

}

笔记

  • 如果在工作期间多次加载同一学习中心文档,则每次加载将显示为一组单独的页面;原始文档未被覆盖

学到更多