预订演示
前页 后页

创建学习中心页面

作为技术开发人员,您可以创建一组学习中心页面来支持您开发并加载到Enterprise Architect中的任何MDG 技术。您创建每个学习中心页面作为文档工件元素的链接文档。这些元素被组织成包的层次结构,其中包名成为学习中心中主题文件夹的名称。然后你运行两个脚本;第一个生成学习中心文件夹和主题,第二个(作为插件

的一部分)插件

或技术激活)将您的学习中心结构导入到Enterprise Architect可以从中加载它的文件位置。

不再推荐开发作为MDG 技术定义一部分的学习中心配置文件的原始过程。

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

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

行动

也见

1

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

  • 您应该如何呈现解释性或描述性文本
  • 您应该如何安排直接行动任务的步骤
  • 您应该如何引用和/或链接到其他文档、网站和文件目录中的信息
  • 您可能需要纳入哪些企业风格、标准和徽标

2

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

创建链接文档模板

设置包层次结构来组织学习中心主题

行动

也见

1

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

2

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

属性窗口

3

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

考虑在同一学习中心文档结构中还可以有主题(文档工件包你的文档)和文件夹。

添加一个包

创建学习中心主题

您可以在文档工件包中创建一个直接的元素数量,但在文档图上添加元素是一种简单的方法,可以让您对主题区域的内容产生直观的印象。

行动

也见

1

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

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

2

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

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

3

双击元素并从“从模板新建链接文档”对话框中选择您的学习中心文档模板(或任何其他合适的模板)。

4

将描述和/或过程文本添加到文档中。保存文档并完成下一个文档工件的过程时,请元素此过程/学习中心主题。

编辑链接文档

5

在窗口中,检查文档工件浏览器的列出顺序。此顺序决定了序列中心主题的顺序。

如果您希望学习中心主题的呈现顺序不同,请在浏览器中相应调整序列中相应文档工件元素的排列顺序。

移动包内的对象

编译学习中心文档

行动

也见

1

在浏览器窗口中,单击您的学习中心文档的根级别包。

2

选择“特定>工具脚本”功能区选项。

脚本窗口显示。

脚本

3

展开Local Scripts文件夹并单击VBScript - Create Learning Center Books脚本名称。

4

点击脚本窗口工具Run script.运行脚本

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

该脚本还生成:

  • 来自文档层次结构中每个包的 order.txt 文件,用于定义从该包生成的文件夹中子文件夹或主题名称的显示顺序;如有必要,您可以直接编辑此文件以更改学习中心的主题顺序
  • 根文件夹中的一个.txt 文件为每个主题提供了一个索引,该索引是从该文档工件的GUID生成的主题元素中生成的;此索引用于在主题的引用和超链接中识别主题,无论主题可能移动到何处

加载学习中心文档

您为插件

创建的学习中心文档插件

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

{

存储库.AddDocumentationPath('ToolGuide','C:\\临时\\ToolLC',0)

}

注记

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

了解更多