通过 F1 键访问库帮助文件

概述

这种对帮助文件的上下文相关访问仅适用于库的用户文档。

建议使用 CODESYS LibDoc Scripting Collection 工具创建库的 CHMHTML 文档。使用此工具创建的库文档允许您通过按键盘上的 F1 键访问与开放式库元素(比如功能块)相关的帮助主题。有关详细信息,请参阅 EcoStruxure Machine Expert在线帮助的库开发概述部分。

必须满足以下前提条件:

  • 用户文档目录文件夹中必须有库映射文件 (*.librarymapping) 可用。

  • 库元素在库管理器中选择。

    或者

  • EcoStruxure Machine Expert Logic Builder 中的逻辑编辑器中选择与库元素对应的元素(例如,变量名称或 CFC 元素)。

库映射文件

库映射文件定义在何处可以找到库的文档。每个库必须有一个映射条目可用。

映射文件的结构必须符合以下示例,从而将示例中的元素替换为库映射信息:

<?xml version="1.0" encoding="utf-8"?>
<LibraryMapping>
<MappingEntry libraryName="UserLib" vendor="SE" helpBook="UserLib.html" openWith="WebBrowser" />
<MappingEntry libraryName="UserLib2" vendor="SE" helpBook="https://www.your.company.page.com/" openWith="WebBrowser" />
<MappingEntry libraryName="UserLib3" vendor="SE" helpBook="UserLib3.chm" openWith="Help" />
</LibraryMapping>

元素

描述

libraryName

如库项目的项目信息中的标题字段中所示,输入库名称。

vendor

如库项目的项目信息中的公司字段中所示,输入库供应商的名称。

helpBook

输入 CHMHTML 文件的名称或对要显示的在线帮助进行引用的 URL(统一资源定位符)的名称。

openWith="WebBrowser"

如果在线帮助以 HTML 文件或 URL 引用的形式提供,则使用 openWith="WebBrowser"

openWith="Help"

如果在线帮助以 CHM 文件的形式提供,则使用 openWith="Help"