上一页 下一页

创建学习中心页面

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

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

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

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

步骤

描述

请参阅

1

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

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

2

打开“资源”窗口(“开始”>“浏览”>“浏览”>“资源”),为主题创建相应的链接文档模板。

创建链接的文档模板

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

步骤

描述

请参阅

1

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

2

显示此Package元素的Properties窗口(选择'Design> Package> Edit> Properties'功能区选项),然后在'Filename'字段中输入生成Learning Center文档的文件位置。

属性窗口

3

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

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

添加包

创建学习中心主题

您有许多选项可用于在包中创建文档工件元素,但创建文档图并向其添加元素是一种简单的方法,可让您立即直观地看到主题区域的内容。

步骤

描述

请参阅

1

项目浏览器中,在包含学习中心主题的每个包中,创建文档图; 那是:

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

2

Diagram Toolbox中,将Document Artifact图标拖到图表上,并为其指定它将包含的主题的名称。

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

3

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

4

将描述和/或过程文本添加到文档中。完成后,保存文档并对下一个Document Artifact元素/ Learning Center主题重复此过程。

编辑链接的文档

5

项目浏览器中,检查列出文档工件元素的顺序。此顺序确定学习中心主题的顺序。

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

移动包中的对象

编译学习中心文档

步骤

描述

请参阅

1

项目浏览器中,单击学习中心文档的根级包。

2

选择“代码>工具>脚本”功能区选项。

将显示“ 脚本”窗口

脚本

3

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

4

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

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

该脚本还会生成:

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

加载学习中心文档

您为加载项或技术创建的学习中心文档使用Repository方法“AddDocumentationPath”加载到学习中心。您通常会将此写入您为加载技术本身而创建的激活脚本,但您也可以使用刚刚加载文档的更简单的脚本来测试文档。这个电话类似于:

     {

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

     }

笔记

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

学到更多