This context-sensitive access to help files is exclusive to user documentation for libraries.
It is a good practice to create the CHM or HTML documentation of your library by using the CODESYS LibDoc Scripting Collection tool. The library documentation created with this tool allows you to access the help topic that is related to the open library element (a function block, for example) by pressing the F1 key on the keyboard. For detailed information, refer to the Library Development Summary part of the EcoStruxure Machine Expert online help.
The following prerequisites must be fulfilled:
A library mapping file (*.librarymapping) is available in the folder.
A library element is selected in the Library Manager.
Or
An element corresponding to a library element (for example, a variable name or a CFC element) is selected in a logic editor in EcoStruxure Machine Expert Logic Builder.
The library mapping file defines where the documentation of a library can be found. A mapping entry must be available for each library.
The structure of the mapping file must comply with the following example, substituting the elements in the example with your library mapping information:
<?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>|
Element |
Description |
|---|---|
|
|
Enter the name of the library as displayed in the Title field of the Project Information of the library project. |
|
|
Enter the name of the vendor of the library as displayed in the Company field of the Project Information of the library project. |
|
|
Enter the name of the CHM or HTML file or a URL (Uniform Resource Locator) referencing the online help to be displayed. |
|
|
Use |
|
|
Use |