全局库或者企业库中的对象用于共享给其他工程师使用，如果使用者并不熟悉这些对象，对象的提供者或者开发者还需要编写相应的帮助文档。通常的情况下，将全局库和帮助文档放置在两个独立的文件夹中，为了便于查找方便，设置帮助文档与全局库中对象的层级和名称相同就可以了，但是这还达不到TIA博途集成的在线帮助的便利性，例如调用一个FB块，鼠标指向该FB块或者选择FB块按F1就可以找到该FB的在线帮助。帮助文档链接对象的功能对于文档的管理非常实用，TIA博途也提供了类似的文档管理功能，使用者只需使用鼠标点击对象，按下 <Shift+F1> 组合键就可以直接打开该对象的帮助文档，该功能还支持多语言切换功能，可编写不同语言的用户自定义文档，切换用户界面语言时，系统自动切换与语言匹配的文档，方便使用者快速查看库中元素的相关信息。

不但可以为库中的对象自定义文档，也可以为项目树、程序编辑器（支持 LAD 、 FBD 、 STL 、 SCL 和 GRAPH 编程语言）以及画面编辑器中的对象自定义文档。

帮助文档支持多种文件格式，格式如下：

- Microsoft Word (.docx)

- Microsoft Excel (.xlsx)

- Microsoft PowerPoint (.pptx 和 .ppsx)

- HTML 页面（ .htm 或 .html ）

- Microsoft XPS (.xps)

- 富文本格式 (.rtf)

- 文本文档 (.txt)

- 编译后的 HTML 帮助 (.chm)

- PDF 文档 (.pdf)

对象的帮助文档功能就是将对象与文档关联起来，该功能对帮助文档存储的路径有严格的要求，目前有三种方式可以选择：

- 存储于项目中

路径为： UserFiles\UserDocumentation\< 相应语言的文件夹 >\< 对象类别 >

如果为项目中的对象创建用户自定义文档，则该帮助文档将保存在项目文件夹中。在项目传递时，用户自定义文档也会一同传递。

- 存储于全局库中

路径为：UserFiles\UserDocumentation\< 相应语言的文件夹 >\< 对象类别 >

如果为全局库中的对象创建用户自定义文档，则该帮助文档将保存在全局库的目录中。在全局库传递时，用户自定义文档也会一同传递。

- 存储于硬盘驱动器或网络驱动器中

< 用户自定义文档的中央目录 >\< 相应语言的文件夹 >\< 对象类别 >

可以将用户自定义文档存储在硬盘驱动器中，这样可访问每个项目中的用户自定义文档；或者放在网络驱动器上，整个项目组成员均可访问该用户自定义文档。该路径必须使用 XML文件或在 TIA 博途的设置中指定。

切换TIA博途的用户界面语言可以打开不同语言编写的帮助文档，所以文档必须位于相应语言所对应的子文件夹内，语言文件夹需要创建。表1列出相应语言对应的文件夹。

表1

 

对象类别参考表2。

表2

下面分别以用户自定义文档存储于全局库和硬盘驱动器为例介绍用户自定义文档功能。

存储于全局库

1) 创建一个新的全局库并记住全局库的存储路径。

2) 创建一个FB块，符号名称为“电机控制”拖放到项目库中的类型中，最终复制到全局库中。

3) 编写FB块的在线帮助文档，可以按照不同的语言进行编辑，例如分别编写中英文在线帮助，FB块的在线帮助文档名称为“电机控制”，必须与程序块的符号名称相匹配。

注意：

中英文的文档名称相同，可以暂存于不同的文件夹中。

4) 在全局库的存储路径中，查找并打开文件夹“UserFiles”，如图1所示。

 

图1

在文件夹“UserFiles”中创建目录“UserDocumentation”，然后再创建两个子目录

“zh-CN”和“en-US”，在两个子目录中分别再次创建目录“Library Types”，最后

将已经编写完成的中英文帮助文档存放到对应的目录中。

5) 在项目中点击FB块，使用shift+F1就可以查看为程序块自定义的在线帮助了，同时可以切换界面语言例如从中文切换到英文，再次使用shift+F1就会打开英文的帮助文档。

存储于硬盘驱动器的中

1) 将FB块拖放到项目库的类型中并复制到全局库中。

2) 打开TIA 博途，在“选项”->“设置”->“常规”->“常规”->“用户文档”中使能“为用户自定义文档显示调用日志”和“在中央目录内搜索用户自定义文档”选项并设置存储路径，如图2所示。  

图2

选择“为用户自定义文档显示调用日志”是为了查看调用文档的日志文件，出问题时也可以查看故障的原因，如图3所示。

图3

3) 将文件复制到选定的目录中，目录路径为：<用户自定义文档的中央目录>\<相应语言的文件夹>\<对象类别>\，例如将英文帮助文档放到“D:\CorporateDocumentation\UserDocumentation\en-US\Library Types\”目录下；将中文帮助文档放到“D:\CorporateDocumentation\UserDocumentation\zh-CN\Library Types\”目录下。

注意：

存放到全局库的类型中，对象类型改变为“Library Types”。

4) 在全局库的类型中点击FB块，使用shift+F1就可以查看为程序块自定义的在线帮助了，切换界面语言，系统自动打开不同语言的帮助文档。

注意：

- 如果帮助文档只有一种语言，例如中文，界面语言切换到英文，如果找不到相应的英文文档，系统会自动搜素其它语言文件夹中的相应文档。

- 如果在目录中找不到相应的文件名称，系统将在项目下的目录中查找。

 

 【声明：本文/视频版权归西门子1847工业学习平台所有，未经允许，不得转载。】