Help Viewer (OA Assistant)

Im /help-Ordner des WinCC OA Installationsverzeichnis finden Sie die komplette WinCC OA Online-Hilfe im QCH-Format. Die Hilfe kann mit dem Hilfe Assistent (einer Anwendung basierend auf dem Qt Assistant) geöffnet werden, der automatisch über das WinCC OA Setup installiert wird (siehe auch Installation).

Anmerkung: Der Hilfe Assistent ist ein Teil des UIs, daher muss zumindest das WinCC OA UI Package installiert sein.

Hilfe Assistent

Das Fenster der Online-Hilfe besteht im Wesentlichen aus zwei wichtigen Teilen (Frames):

1) Registerkarten

  • Contents: Baumdarstellung des Inhaltsverzeichnis. Einträge mit einem Pfeilsymbol enthalten Unterordner oder einzelne Seiten. Wenn Sie die Hilfe in einer logisch buchähnlichen Form bevorzugen, klicken Sie sich von oben nach unten durch das Verzeichnis.

  • Index: Der Index wird für die Anzeige der verfügbaren Control Funktionen und grafischen Eigenschaften von Objekten verwendet. Dieser dient für WinCC OA auch als Referenzpunkt wenn es darum geht Hilfeseiten für Control Funktionen direkt über das Kontextmenü des Skript Editors zu öffnen.

    Es ist ebenfalls möglich eigene Funktionen hier zu referenzieren, sofern diese als keyword für das Qt Help Project definiert wurden. Informationen diesbezüglich und allgemeinen Informationen zum Erstellen einer eigenen Qt Hilfe finden Sie hier.

  • Search: Hier haben Sie die Möglichkeit zur Volltextsuche. Geben Sie einen Begriff ein. Existiert das Wort, wird die entsprechende Seite angezeigt. Die Suchbegriffe werden nach Häufigkeit des Vorkommens sortiert. Die Verwendung von Wildcards wie * (steht für eine beliebige Anzahl an Zeichen) oder ? (steht für ein Zeichen) ist ebenfalls möglich. Durch Setzen von Begriffen in Hochkommata (z.B. "Config einfügen") können Sie das Suchergebnis einschränken. Um zu sehen, wo im Inhaltsverzeichnis sich die gefundene Seite befindet, klicken Sie auf die Schaltfläche (Sync with table of contents).
    Anmerkung: Ein Suchbegriff darf nicht mit der * Wildcard beginnen.
  • Bookmarks: Zeigt alle Seiten die Sie als Favoriten gespeichert haben. Mithilfe des Sterns, der sich links in der Address Leiste befindet, können Sie die aktuell gewählte Seite zu den Favoriten hinzufügen. Mit einem Doppelklick auf einen der Einträge wird die entsprechende Seite geöffnet. Mit einem Wiederholten Klick auf den Stern, wird der markierte Eintrag von den Favortien entfernt.
    Anmerkung: Sie können die Adress Leiste dafür verwendet , URLs zu kopeiren oder einzufügen.

2) Registerkarten

Die über die Registerkarten ausgewählte Seite wird im rechten Bereich des Fensters angezeigt.

UI Assistent

Das UI hat, ähnlich dem Assistenten, ein paar commandline Optionen erhalten, welche für install/uninstall gedacht sind:
WCCOAui -assistant register <file.qch>
Registiert eine Hilfedatei file und indiziert alles sofort
WCCOAui -assistand unregister <file.qch>
Deregistriert die Hilfedatei
WCCOAui assistant copyCollection <target.qhc>
Die aktuell verwendete Hilfe-Collection wird in das angegebene target.qhc kopiert
WCCOAui -assistent
Startet UI im Assistent mode und zeigt Hilfe an
WCCOAui -assistant showUrl <qthelp://url>
Zeigt zusätzlich die angegebene Seite an
WCCOAui -assistant debug <filter>
Interne Debug-Informationen zum .qch Inhalt
Anmerkung: Wenn Sie ihre eigenen help files registrieren wollen, müssen in einem Ihrer proj_path ein data/help.qhc collection file erzeugen. Die Aktion im Gedi Tools -> Projekt Dokumentation -> erzeugen macht das und erzeugt im Projekt eine Kopie von .qhc der Installation und registriert die generierte oxygen help zusätzlich.
VORSICHT: Früher war die per-Projekt help-collection nicht direkt im Projekt sondern am Filesystem pro User.

Im UI gibt es den Help Assistent nur einmal global. Man kann es auch mit der Funktion openHelpViewer() öffnen.

Hinweise

Benutzerdefinierte Dokumentation

Die WinCC OA basiert auf der QT Hilfe. Dies erlaubt es, auch eigens erstellte .qch- Pakete in WinCC OA zu registrieren. Dazu verwenden Sie den Registrierungsbefehl für das UI mit Verweis auf die relevante .qch Datei, z.B:

WCCOAui -assistant register D:\Projects\Help\custom_help.qch
Anmerkung: Das .qch file wird in einem Subprojekt registriert.

Icons

Folgende Icons werden innerhalb der Dokumentation verwendet:

  • Anmerkung:
    - Der Hinweis liefert zusätzliche Informationen.
  • VORSICHT:
    - Zeigt eine Warnung an, welche zu befolgen ist um Folgeprobleme zu vermeiden.