预订演示
前页 后页

生成 HTML 文件

在Enterprise Architect中构建帮助模型后,您可以从模型生成 HTML 文件,适合上传到网站或在本地文件系统上使用。

生成过程与选择要为其生成帮助页面的包并调用“生成帮助”命令一样简单。在显示的对话框中,指定输出文件夹,指定模板文件的位置,指定要使用的主模板文件,然后单击“生成”。

访问

浏览器menu

在浏览器窗口中,右键单击 «HelpPackage»、«HelpTopic» 或 «HelpTopicProxy»元素,然后选择菜单选项“在当前项目上生成帮助”。

功能区

在浏览器窗口中选择了 «HelpPackage»、«HelpTopic» 或 «HelpTopicProxy»元素后,选择功能区选项“发布 >模型报告 >生成帮助”。

生成 HTML 文件的步骤

下面的表逐步完成了从您的帮助模型生成 HTML 文件过程,以最简单的形式,仅使用默认值。

“生成帮助”对话框在帮助主题“生成帮助对话框”的细节中进行了说明。

描述

也见

选择要生成包/主题

在浏览器窗口中,右键单击 «HelpPackage»、«HelpTopic» 或 «HelpTopicProxy»,然后选择命令“为当前项目生成帮助”。

显示“生成帮助”对话框。

“生成帮助”对话框

选择一个输出文件夹

使用“浏览”按钮选择文件系统上的现有文件夹,在其中写入生成的 HTML 文件。

注记:不要选择“C:\”作为输出文件夹,因为生成器无法将必要的文件提取到根文件夹中。

指定模板文件的位置

如果这是帮助发电机的第一次运行,“模板位置”字段到目前为止为空。当使用“浏览”按钮选择“输出文件夹”时,“模板位置”将更新为值“模板”,作为所选输出文件夹的子文件夹。

注记:如果文件不存在于该位置,帮助生成器将在每次运行将提供的模板文件集复制到指定的“模板位置”。

帮助模板文件

指定要使用主模板

“主模板”字段将填充默认值“HelpPageTemplate.html”。对于现在,保留此值不变。

帮助模板文件

生成

单击“生成”按钮为模型层次结构生成一组 HTML 文件,从选定的 «HelpPackage» 开始。

显示系统输出窗口,处理log被写入该窗口的“帮助系统”页面。

视图生成的文件

在系统输出窗口中处理log的顶部,您将找到为刚刚生成的模型分支的根包生成的文件的完整路径。

打开 Web 浏览器并加载在输出窗口中命名的文件。

模板文件

A组准备好使用的模板文件作为Enterprise Architect的一部分提供。每次生成 HTML 文件时,模板文件将被提取到指定输出文件夹中名为“模板”的子文件夹中。将文件复制到输出文件夹后,您可以根据自己的需要自由修改它们。下次生成 HTML 文件时,不会覆盖现有文件。

预计您将自定义主模板文件以满足您自己的需要,但是,您不太可能需要修改元素模板文件。

有关模板文件的详细信息,请参阅帮助主题帮助模板文件

CSS文件

A名为“user-guide.css”的 CSS 文件定义了生成的 HTML 使用的样式,也作为Enterprise Architect的一部分提供。生成 HTML 文件时,如果该文件不存在,它也会被提取到您指定的输出文件夹中。一旦该文件存在于您的输出文件夹中,您就可以更新它定义的样式以满足您的需要。

了解更多