Hilfedateien und Beschreibungsdateien für Bibliotheken

Sie können Ihre eigene anwenderdefinierte Dokumentation für die in der Bibliothek veröffentlichten Funktion/Funktionsbaustein-POEs hinzufügen. Damit können Sie den Anwender Ihrer Bibliothek mit Hilfeinformationen zu den FU/FB-POEs versorgen (beispielsweise zu deren Funktionsweise und Verwendung). Anwenderdokumentationen können als CHM-Hilfedateien oder als Beschreibungsdateien beigestellt werden.

Nachdem Sie die anwenderdefinierte Dokumentation erstellt haben, können Sie eine oder mehrere CHM-Hilfedateien und Bibliotheks-Beschreibungsdateien zu einer veröffentlichten Bibliothek hinzufügen, indem Sie diese im Dialog 'Als Bibliothek veröffentlichen' auswählen.

CHM-Hilfedateien

Mit CHM-Hilfedateien (Compiled HTML Help) können Sie detaillierte Beschreibungen Ihrer Funktion/Funktionsbaustein-POEs an Anwender weitergeben, die die POEs in ihren Projekten verwenden. Die Hilfe zu einer Funktion/einem FB wird geöffnet, wenn der Anwender <Umschalt>+<F1> drückt, während die POE in den KOMPONENTEN markiert ist, oder die 'Hilfe'-Direktschaltfläche für die POE im Code-Arbeitsblatt klickt.

Zum Erzeugen einer CHM-Hilfedatei kann der HTML Help Workshop (freies Microsoft Tool) oder jedes andere, geeignete Autorenwerkzeug für CHM-Hilfen verwendet werden.
Für CHM-Hilfedateien, die Sie zu einer veröffentlichten Bibliothek hinzufügen wollen, gilt folgendes:

Der Name der CHM-Hilfedatei muss mit dem Namen der Bibliothek beginnen, gefolgt von "_FBFun.chm" (z.B. "MeineBibliothek_FBFun.chm"), wobei die Groß-/Kleinschreibung übereinstimmen muss.
Der Dialog 'Als Bibliothek veröffentlichen' gibt eine Fehlermeldung aus, wenn der Hilfename nicht mit dem Bibliotheksnamen beginnt.
Es können lokalisierte CHM-Hilfedateien hinzugefügt werden (d.h. Hilfen in anderen Sprachen). Der Name der sprachspezifischen CHM-Hilfedateien muss wie folgt lauten:
<Bibliotheksname>_<Sprachcode>_FBFun.chm
wobei Sie als <Sprachcode> folgende Kennungen verwenden können: en, en-US, de, de-DE, …
Beispiel: MeineBibliothek_de-DE_FBFun.chm für eine deutsche CHM-Hilfedatei.

Inhalt einer CHM-Datei

Aufrufen eines Hilfethemas für eine Funktion/Funktionsbaustein-POE

Tipp: Der HTML Help Workshop bietet die Möglichkeit zum Dekompilieren bestehender CHM-Hilfedateien und kann dazu verwendet werden, Dateien aus einer CHM zu extrahieren. Dekompilieren Sie die vorhandene CHM-Hilfedatei zu einer mit PLCnext Engineer ausgelieferten Funktion/FB-Bibliothek, um zu sehen, welche Dateien die CHM enthält.

Hinweis
Diese Dokumentation beschreibt nicht, wie Sie CHM-Hilfedateien erstellen. Dazu lesen Sie bitte die Dokumentation zum HTML Help Workshop oder Ihrem Hilfe-Autorensystem.

Beschreibungsdateien zu Bibliotheken

Sie können in PLCnext Engineer Beschreibungsdateien für die in einer Bibliothek veröffentlichten POEs bereitstellen. Eine Bibliothek-Beschreibungsdateien ist eine Datei im XML-Format, für die Struktur und Inhalt vorgeschrieben sind. Die Beschreibungsdatei enthält die folgenden Informationen:

Kategorien, unter denen die Funktion/Funktionsbaustein-POEs in den KOMPONENTEN erscheinen.
Kurzbeschreibungen der POEs als Tooltip (dieser erscheint, wenn Sie den Mauszeiger im KOMPONENTEN-Bereich auf die POE setzen).

Für Beschreibungsdateien zu Bibliotheken gilt:

Der Dateiname muss LibraryDescription.xml sein.
Es können lokalisierte Beschreibungsdateien zu Bibliotheken hinzugefügt werden (d.h. Dateien in anderen Sprachen). Der Name der sprachspezifischen Beschreibungsdateien muss wie folgt lauten:
LibraryDescription.<Sprachcode>.xml
wobei <Sprachcode> das Kürzel gem. Systemgebietsschema für die verwendete Sprache ist (zum Beispiel, "de" für Deutsch, "fr" für Französisch, "zh-CN" für Chinesisch, ...).
Beispiel: "LibraryDescription.de.xml" für die deutsche Bibliothek-Beschreibungsdatei.
Abgesehen vom Inhalt der Description- und Name-Attribute der <ToolboxCategory>-Elemente, die in die Zielsprache zu übersetzen sind, sind Inhalt und Struktur der lokalisierten Bibliothek-Beschreibungsdatei gleich wie in der englischen Variante.
Das Encoding der XML-Datei muss UTF-8 sein.

Tipp: Verwenden Sie zu Beginn eine automatisch generierte Bibliothek-Beschreibungsdatei als Basis für Ihre eigene Beschreibungsdatei. Alle notwendigen Einträge können aus einer generierten Bibliotheken-Datei (*.pcwlx) kopiert werden. Die *.pcwlx-Datei ist eine gezippte Datei, die mit jedem geeigneten Unzip-Programm extrahiert werden kann. Passen Sie die automatisch generierte Datei nach Bedarf an und fügen Sie sie im Dialog 'Als Bibliothek veröffentlichen' hinzu.

Beispiel