TIA Bibliotheken #7 - Wie können eigene Dokumente und Hilfstexte mit Elementen der TIA-Portal Bibliothek verknüpft werden?

Hallo SIOS-Forum-Community,

oft stellt sich die Frage, wie kann ich zu einem eigens erstellten Objekt (FC, FB, DB usw.) eine Hilfedatei im TIA-Portal hinterlegen und diese per Tastenkombination anzeigen lassen?Insbesondere wenn es darum geht anderen Mitarbeitern die Funktionsweise Ihres Projekts oder die Verwendung einzelner Bibliothekselemente zu erläutern.

Mit der anwenderdefinierten Dokumentation (Anwenderhilfe) bietet das TIA-Portal für diese Anforderung eine einfache Lösung. Voraussetzung ist, dass das Objekt, welchem ein Dokument zugewiesen werden soll in der TIA-Portal Bibliothek verwaltet wird. Insbesondere erhalten Nutzer der Bibliothek wertvolle Informationen zur Funktionsweise der einzelnen Bibliothekstypen zu erläutern, können Sie selbst eine anwenderdefinierte Dokumentation erstellen.

Die Dokumentation kann für folgende Bereiche und Elemente der TIA-Portal Bibliothek bereitgestellt werden:

1. Typen und Kopiervorlagen
2. Ordner
3. OBs, FBs, FCs und DBs
4. Bilder
5. Bildbausteine
6. u.v.m.
   
   

Folgende Dateiformate werden unterstützt:

1. Microsoft Word / Excel / Powerpoint (.docx / .xlsx /.pptx / .ppsx)
2. HTML-Seiten & Compiled (.htm / .html / .chm)
3. HTML Microsoft XPS (.xps)
4. Rich Text Format (.rtf)
5. Textdokumente (.txt)
6. PDF-Dokumente (.pdf)
   
   

Funktionsweise:

Zunächst erfolgt die Selektion des Bibliothekselements (z.B. FB) im Projektbaum bzw. in der Projektbibliothek.

Durch Betätigen der Tastenkombination „Shift + F1“ wird dann das verknüpfte Dokument mit einem von Windows hinterlegten Standardprogramm für das entsprechende Dateiformat angezeigt.

Projektierungsschritte und Empfehlungen:

1. Zu beachten ist, dass der Dateiname (ohne Endung) des verknüpften Dokumentes identisch mit dem zu verknüpfenden Objektnamen in der Bibliothek ist.
   
   
2. Damit die anwenderdefinierten Dokumentationen von Bibliotheksbausteinen mit der Bibliothek ausgeliefert werden können, sind diese im folgenden Verzeichnis der globalen Bibliothek abzulegen:
   
   „…\UserFiles\UserDocumentation\\...“
    
3.  Die Ablage der Dokumente im TIA Projektverzeichnis muss nach folgendem Schema erfolgen:
   „…Laufwerk:\ …\<TIA-Portal-Projekt>\UserFiles\UserDocumentation\de-DE\Library Types…“
   
   Wichtiger Hinweis!
   Die Unterverzeichnisse (fett und kursiv) des Verzeichnisses „UserFiles“ müssen einmalig manuell angelegt werden!
   
   
4. Bei mehrsprachigen Projekten können die Hilfsdokumente in der jeweiligen Projektsprache über sprachspezifische Unterordner mehrsprachig organisiert werden.
   
   Beispiel: Verzeichnis für Typen einer Bibliothek Die deutschen und englischen PDF-Dateien der Typen der Bibliothek "LGF" werden in folgenden Verzeichnissen der globalen Bibliothek gespeichert.
   
   Deutsch: "...\UserFiles\UserDocumentation\de-DE\Library Types"
   Englisch: "...\UserFiles\UserDocumentation\en-US\Library Types"
   
   Übersicht zu sprachspezifischen Unterordnern, siehe:
   Leitfaden zur Bibliothekshandhabung im TIA Portal, S.89f
   
   
5. Es erweist sich als günstig, wenn die anwenderdefinierte Dokumentation als PDF-Datei vorliegt, damit die Anwenderhilfe plattformunabhängig auf verschiedenen Rechnern geöffnet werden kann.
   
   

<<<  Ergänzung Januar 2022! >>>
Ordnerstruktur als Vorlage zur Dokumentenablage jetzt als zip-File zum Download in der Anlage dieses Beitrags.

Vorgehen Installation:

• Datei "UserDocumantataion.zip" herunter laden und entpacken.
• Entpackte Ordnerstruktur (mit allen Sprachunterordnern) in Ordner "UserFiles" kopieren.
• Dokumente  sprachspezifisch in Unterordner "Library Types" ablegen.

Sonstige Möglichkeiten der anwenderdefinierten Dokumentation im TIA-Portal

Insofern eine anwenderdefinierte Dokumentation auch ohne Bibliotheksverwendung gewünscht ist, stellt das TIA- Portal weitere Möglichkeiten wie z.B. die zentrale Ablage von Dokumenten bereit.

Beschreibung, siehe: „Anwenderdefinierte Dokumentation bereitstellen“ (Online Hilfe TIA-Portal)

TIA Bibliotheken: Beitragsübersicht

Hinweis

Die in diesem Beitrag beschriebene Inhalte beziehen sich auf den Zeitpunkt der Erstellung (Stand: Mai 2021).

Viele Grüße

SIMATIC-FB-Allgemein-GER (PK)