帮助模板文件

Enterprise Architect在从您的帮助模型生成 HTML 内容时使用一系列模板文件。每个模板文件都包含一些格式信息，以及将插入生成内容的占位符。

当渲染每个模型元素时，相应的模板文件被加载到内存中，元素数据被替换到适当的占位符中。页面内容随着每个元素的呈现而构建，直到最后，页面内容被替换到“主模板”文件中的相应占位符中。

有一个特定的模板文件对应于帮助模型中可用的每种类型的元素，以及两个示例“主模板”文件。

所有这些模板文件都作为Enterprise Architect的一部分提供，并且在您第一次从帮助模型生成文件时，将被复制到指定输出文件夹中名为“模板”的子文件夹中。

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

在尝试自定义任何模板文件之前，您应该具备良好的 HTML 应用知识。

主模板文件

主模板文件是唯一的，因为您可以指定开始生成时要使用的文件的名称。我们鼓励您复制并重命名此文件，并根据您的需要进行编辑。本质上，它用作生成内容的容器，您可以随意编辑内容的布局。

下表描述了可在主模板文件中使用的内容占位符的使用。

TOPIC_TITLE	此占位符替换为 «HelpTopic»元素的名称。在主模板文件的默认内容中，该值用于设置生成网页的标题。 Web 浏览器使用页面标题来标记浏览器中的各个选项卡。
SITE_PATH	此占位符被替换为“站点文件夹路径”的值，取自“生成帮助”对话框。 A用途是在页面的面包屑导航控件中创建初始项。例如： <li class = "家" > <a href = "#SITE_PATH#/index.html" >索引</a></li>
BREADCRUMB	此占位符替换为string HTML 代码，用于创建面包屑样式导航控件。 HTML string被构造为指向与当前主题所在的每个父包关联的生成页面的超链接列表。主模板文件中的默认内容用 <div>、<table> 和 <ul> 标记包装此占位符，这些标记指定将超链接列表显示为面包屑控件所需的 CSS 类。如果你想删除面包屑控件，你应该删除整个 <div> 片段。
PREV_LINK	此占位符与“ PREV_LINK_CLOSE ”占位符结合使用，用于创建一个按钮，该按钮提供指向与帮助模型中“上一个”主题关联的网页的超链接。如果您不想显示“Prev”和“Next”按钮，您应该删除以<表类= "hnavright" >开头的整个表片段
PREV_LINK_CLOSE	此占位符替换为 HTML 代码，该代码关闭使用“ PREV_LINK ”占位符打开的标签。
NEXT_LINK	此占位符与“ PREV_LINK_CLOSE ”占位符结合使用，用于创建一个按钮，该按钮提供指向与帮助模型中“上一个”主题关联的网页的超链接。如果您不想显示“Prev”和“Next”按钮，您应该删除以<表类= "hnavright" >开头的整个表片段
NEXT_LINK_CLOSE	此占位符替换为 HTML 代码，该代码关闭使用“ NEXT_LINK ”占位符打开的标签。
TOPIC_TEXT	该占位符被替换为 HTML 文本string ，构成生成的网页的主体。生成器处理 «HelpTopic»元素中的每个子元素，使用与每个子元素类型相对应的模板文件，并构建一个包含当前帮助主题的所有模型内容的单个 HTML string 。
NAVIGATION	这个占位符被一个超链接列表所取代，在网页的左侧产生一个菜单，支持导航帮助当前主题的兄弟主题。也就是说，在模型层次结构中处于同一级别的主题。

HelpTopic

下表描述了可在名为“ HelpTopic .html”的模板文件中使用的内容占位符的使用。如果需要，您可以编辑此文件的内容，但我们建议您不加修改地使用它 - 至少在开始时不要修改。

您不能重命名此模板文件 -帮助生成器希望找到具有此名称的文件。

占位符名称	描述
TOPIC_NAME	此占位符替换为 «HelpTopic»元素的名称。模板文件“ HelpTopic .html”的默认内容使用帮助主题名称作为页面标题。
NOTES	此占位符替换为 «HelpTopic»元素的注记。模板文件“ HelpTopic .html”的默认内容显示紧跟在页面标题之后的帮助主题的注记。
PAGE_CONTENT	此占位符将替换为处理 «HelpTopic»元素的子元素后生成的页面内容。模板文件“ HelpTopic .html”的默认内容在 «HelpTopic»元素的注记之后显示此“页面内容”。
LEARN_MORE	目前没有使用。此时，此占位符被替换为“回车”字符。

HelpSection

下表描述了可在名为“ HelpSection .html”的模板文件中使用的内容占位符的使用。如果需要，您可以编辑此文件的内容，但我们建议您不加修改地使用它 - 至少在开始时不要修改。

您不能重命名此模板文件 -帮助生成器希望找到具有此名称的文件。

占位符名称

描述

ELEMENT_NAME

这个占位符被替换为正在处理的元素的名称。

此模板文件的默认内容将元素名称呈现为从元素生成的内容的标题。

NOTES

此占位符替换为 «HelpSection»元素的注记。

此模板文件的默认内容，紧跟在元素标题后显示元素的注记。

HelpTableNN

下表描述了可在名为“ HelpTableNN .html”的模板文件集中使用的内容占位符的使用。如果需要，您可以编辑这些文件的内容，但我们建议您不加修改地使用它们 - 至少在开始时不要修改。

您不能重命名这些模板文件——帮助生成器希望找到一个名称与正在处理的表类型相对应的文件。

这些模板文件的默认内容构造为元素名称显示为标题，然后是与元素相关联的任何注记，然后是表，列标题横跨顶部，然后是库表表行的内容在那之下。

占位符名称	描述
ELEMENT_NAME	这个占位符被替换为正在处理的元素的名称。此模板文件的默认内容将元素名称呈现为从元素生成的内容的标题。
NOTES	此占位符替换为正在处理的元素的注记。此模板文件的默认内容，紧跟在元素标题后显示元素的注记。
TAGGED_VALUES	此占位符替换为生成的 HTML 代码string ，构成表定义的开头。它包括从元素的标记值生成的列标题，名为“Column1”、“Column2”，在三列库表的情况下，“Column3”。
TABLE_ROWS	此占位符被替换为通过处理作为正在处理的 «HelpTable»元素的子元素的 «HelpTableRow» 元素生成的 HTML string 。

HelpTableRow

下表描述了可在名为“ HelpTableRow .html”的模板文件中使用的内容占位符的使用。如果需要，您可以编辑此文件的内容，但我们建议您不加修改地使用它 - 至少在开始时不要修改。

您不能重命名此模板文件 -帮助生成器希望找到具有此名称的文件。

占位符名称	描述
ELEMENT_NAME	这个占位符被替换为正在处理的元素的名称。此模板文件的默认内容在表行的第一个（最左侧）单元中呈现元素名称。
NOTES	此占位符替换为正在处理的元素的注记。此模板文件的默认内容在表行的第二个单元中呈现注记。
ROWS_LINKS	此占位符仅可用于三列库表的模板文件。它被替换为从正在处理的表行元素的“也见”标记值中包含的数据生成的超链接。此模板文件的默认内容在表行的第三个单元中呈现“也见”超链接。

占位符名称

描述

ELEMENT_NAME

这个占位符被替换为正在处理的元素的名称。

此模板文件的默认内容在表行的第一个（最左侧）单元中呈现元素名称。

NOTES

此占位符替换为正在处理的元素的注记。

此模板文件的默认内容在表行的第二个单元中呈现注记。

ROWS_LINKS

此占位符仅可用于三列库表的模板文件。

它被替换为从正在处理的表行元素的“也见”标记值中包含的数据生成的超链接。

此模板文件的默认内容在表行的第三个单元中呈现“也见”超链接。

HelpSectionLearnMore

下表描述了可在名为“ HelpSectionLearnMore .html”的模板文件中使用的内容占位符的使用。如果需要，您可以编辑此文件的内容，但我们建议您不加修改地使用它 - 至少在开始时不要修改。

您不能重命名此模板文件 -帮助生成器希望找到具有此名称的文件。

占位符名称	描述
ELEMENT_NAME	这个占位符被替换为正在处理的元素的名称。此模板文件的默认内容将元素名称呈现为从元素生成的内容的标题。通常，元素会被命名为“了解更多”
NOTES	此占位符替换为正在处理的元素的注记。此模板文件的默认内容，紧跟在元素标题后显示元素的注记。

占位符名称

描述

ELEMENT_NAME

这个占位符被替换为正在处理的元素的名称。

此模板文件的默认内容将元素名称呈现为从元素生成的内容的标题。

通常，元素会被命名为“了解更多”

NOTES

此占位符替换为正在处理的元素的注记。

此模板文件的默认内容，紧跟在元素标题后显示元素的注记。

HelpSlideshow

下表描述了名为“ HelpSlideshow .html”的模板文件中使用的内容占位符。模板文件“ HelpSlideshow .html”的默认内容将生成的 HTML 内容排列为单行两列的表。代表幻灯片的图标位于第一列。第二栏包含写成标题的元素名称，元素注记放在标题下方。如果需要，您可以编辑此文件的内容，但我们建议您不加修改地使用它 - 至少在开始时不要修改。

您不能重命名此模板文件 -帮助生成器希望找到具有此名称的文件。

占位符名称	描述
FIRST_LB_IMAGE	此占位符替换为 HTML 代码，该代码打开用于灯箱样式控件的标签并指定幻灯片放映的第一张图像。
TAGGED_VALUES_ICON	此占位符将替换为指定要显示为幻灯片图标的图像的 HTML 代码。
FIRST_LB_IMAGE_END	此占位符替换为关闭第一个幻灯片图像的标记的 HTML 代码
TAGGED_VALUES_IMAGE	此占位符被替换为列出幻灯片中所有后续图像的 HTML 代码。
ELEMENT_NAME	这个占位符被替换为正在处理的元素的名称。此模板文件的默认内容将元素名称呈现为幻灯片图标右侧的标题。
NOTES	此占位符替换为正在处理的元素的注记。此模板文件的默认内容，在元素标题的正下方显示元素的注记。

HelpSystemVideo

此表描述了可在名为“ HelpSystemVideo .html”的模板文件中使用的内容占位符的使用。如果需要，您可以编辑此文件的内容，但我们建议您不加修改地使用它 - 至少在开始时不要修改。

您不能重命名此模板文件 -帮助生成器希望找到具有此名称的文件。

占位符名称	描述
VIDEO_TITLE	此占位符被元素的标记值“VideoTitle”替换。此模板文件的默认内容将标题显示为 HTML 视频控件上方的标题。
VIDEO_URL	此占位符将替换为元素的标记值“VideoURL”。这在 HTML“video”标签中使用，为“源”标签的“src”属性提供 URL 值。此模板文件的默认内容显示全宽视频控件。单击“播放”按钮时，控件将加载并播放在指定 URL 中找到的视频文件。
VIDEO_TYPE	此占位符将替换为元素的标记值“VideoType”。这在 HTML“video”标签中使用，为“源”标签的“type”属性提供值。

占位符名称

描述

VIDEO_TITLE

此占位符被元素的标记值“VideoTitle”替换。此模板文件的默认内容将标题显示为 HTML 视频控件上方的标题。

VIDEO_URL

此占位符将替换为元素的标记值“VideoURL”。这在 HTML“video”标签中使用，为“源”标签的“src”属性提供 URL 值。

此模板文件的默认内容显示全宽视频控件。单击“播放”按钮时，控件将加载并播放在指定 URL 中找到的视频文件。

VIDEO_TYPE

此占位符将替换为元素的标记值“VideoType”。这在 HTML“video”标签中使用，为“源”标签的“type”属性提供值。

HelpVideoLocal

当前未使用模板文件“ HelpVideoLocal .html”。

占位符名称	描述

HelpSectionDiagram

此表描述了可在名为“ HelpSectionDiagram .html”的模板文件中使用的内容占位符的使用。如果需要，您可以编辑此文件的内容，但我们建议您不加修改地使用它 - 至少在开始时不要修改。

您不能重命名此模板文件 -帮助生成器希望找到具有此名称的文件。

占位符名称	描述
IMAGE_LOCATION	此占位符替换为图表图像的生成路径名。生成的 HTML 仅包含包含图表图像的文件的路径名。它不包括元素名称或注记。

注记

模板文件中的内容占位符前后都被一个“#”字符包围（并且必须保留），以便帮助生成器将它们识别为占位符。