10/25/2021 7:51 PM | |
Posts: 257 Rating: (75)
|
Hello SIOS Forum Community, The question often arises as to how I can store a help file in the TIA Portal for an object I have created myself (FC, FB, DB, etc.) and display it using a key combination?especially when it is a matter of explaining the functionality of your project or the use of individual library elements to other employees. With the user-defined documentation (user help), the TIA Portal offers a simple solution for this requirement. The prerequisite is that the object to which a document is to be assigned is managed in the TIA Portal library. In particular, users of the library receive valuable information on the functionality of the individual library types to explain, you can create user-defined documentation yourself. Documentation can be provided for the following areas and elements of the TIA Portal library:
The following file formats are supported:
Functionality: First, the library element (e.g. FB) is selected in the project tree or in the project library. By pressing the key combination "Shift + F1", the linked document is then displayed with a standard programme stored by Windows for the corresponding file format. Project planning steps and recommendations: Please note that the file name (without extension) of the linked document is identical to the object name to be linked in the library. In order that the user-defined documentations of library modules can be delivered with the library, they must be stored in the following directory of the global library: "...\UserFiles\UserDocumentation\...". The documents must be stored in the TIA project directory according to the following scheme: "...Drive:\ ...\<TIA Portal Project>\UserFiles\UserDocumentation\de-DE\Library Types..." Important note! The subdirectories (bold and italic) of the "UserFiles" directory must be created manually once! In multilingual projects, the help documents can be organised multilingually in the respective project language via language-specific subfolders. Example: Directory for types of a library The German and English PDF files of the types of the library "LGF" are stored in the following directories of the global library. German: "LGF\UserFiles\UserDocumentation\de-DE\Library Types". English: "LGF\UserFiles\UserDocumentation\en-US\Library Types". Overview of language-specific subfolders, see: Guide to Library Handling in TIA Portal, p.89f It is useful if the user-defined documentation is available as a PDF file, so that the user help can be opened on different computers independently of the platform. Other options for user-defined documentation in the TIA Portal If user-defined documentation is also desired without using the library, the TIA Portal provides other options, such as central storage of documents. Description, see: "Providing user-defined documentation" (Online Help TIA Portal) With Best Regards, SIMATIC International Technical Support Hub |
Last edited by: Jen_Moderator at: 11/12/2021 11:44:39Edited text for better reading. |
|
Follow us on