Externe Bausteinhilfe erzeugen und öffnen

Externe Bausteinhilfe erzeugen

logi.cals empfiehlt Ihnen, eine externe Bausteinhilfe erst nach dem Fertigstellen der Bausteinschnittstelle zu erzeugen.

So erzeugen Sie die externe Bausteinhilfe mit Hilfe von logi.CAD 3 :

  1. Klappen Sie das ST- oder FBS-Objekt im Projektexplorer auf.
  2. Öffnen Sie das Kontextmenü für das in der Unterebene angezeigte Element (= für den erstellten Baustein).
  3. Wählen Sie den Befehl Hilfe bearbeiten.
  4. Ergänzen Sie die geöffnete Datei um die benötigten Texte.
    (info) Bei der Datei handelt es sich um eine Textile-Datei. Informationen und Beispiele zur möglichen Syntax in Textile finden Sie unter: https://textile-lang.com – Auf dieser Website können Sie Ihre Texte in der Textile-Syntax auch gleich ausprobieren.
    Die Datei enthält bereits automatisch generierte Informationen, wie z.B. den POE-Namen und eine Tabelle mit den Ein-/Ausgängen. Löschen oder ändern Sie diese generierten Informationen nicht, da sie wieder automatisch generiert werden, wenn Sie den Befehl Hilfe bearbeiten erneut auswählen.
  5. Speichern Sie diese ergänzte Datei.
  6. Falls erforderlich (z.B. für einen Funktionsbaustein oder eine Funktion), erstellen Sie die Bausteingrafik für die Hilfe so:
    1. Öffnen Sie den Schnittstellen-Editor für das Objekt.
    2. Im Schnittstellen-Editor: Drücken Sie Strg+Umschalt+P.
    3. Schließen Sie den Schnittstellen-Editor wieder.
  7. Öffnen Sie wieder das Kontextmenü für das in der Unterebene angezeigte Element und wählen Sie den Befehl Hilfe erzeugen.
    Ergebnis: Die Dateien für die HTML-Hilfe (inkl. der Bausteingrafik) sind im Ordner .olh abgelegt. Dieser Ordner liegt parallel zum ST- oder FBS-Objekt und ist standardmäßig nicht im Projektexlorer sichtbar.

Beachten Sie Folgendes:

  • Falls Sie die Baustein-Schnittstelle dennoch nach dem Erzeugen der Bausteinhilfe ändern (z.B. den Namen des Bausteins ändern oder neue Ein-/Ausgänge erstellen), müssen Sie einige Schritte durchführen, damit die Dateien für die HTML-Hilfe aktualisiert sind. Details: siehe "Hilfedateien bei nachträglicher Änderung der Baustein-Schnittstelle aktualisieren"
  • Es ist möglich, die Bausteinhilfe in Deutsch und in Englisch zu erzeugen. In diesem Fall gehen Sie am besten so vor:
    1. Erzeugen Sie die Bausteinhilfe zuerst in einer Sprache (z.B. in Deutsch), wie oben beschrieben.
    2. Beenden Sie logi.CAD 3
    3. Ändern Sie die Sprache für die Benutzeroberfläche.
    4. Starten Sie logi.CAD 3 in der anderen Sprache.
    5. Erzeugen Sie die Bausteinhilfe für die zweite Sprache (z.B. in Englisch), wie oben beschrieben.

Alternative: Sie können die externe Bausteinhilfe auch selbst erzeugen, indem Sie Ihre bevorzugen Werkzeuge zum Erzeugen/Bearbeiten von HTML-Dateien verwenden.  logi.CAD 3  benötigt nur die passende HTML-Datei im entsprechenden Ordner. Informieren Sie sich unter "Ablage der Hilfedateien" für die Details.

Externe Bausteinhilfe öffnen

So lassen Sie die HTML-Hilfe für eigene Bausteine in  logi.CAD 3  anzeigen:

  • mit Hilfe des Befehl Hilfe anzeigen im Projektexplorer
    1. Klappen Sie das ST- oder FBS-Objekt im Projektexplorer auf.
    2. Öffnen Sie das Kontextmenü für das in der Unterebene angezeigte Element (= für den erstellten Baustein).
    3. Wählen Sie den Befehl Hilfe anzeigen.
  • mit Hilfe der F1-Taste im entsprechenden Editor
    • Im ST-Editor: Positionieren Sie den Textcursor auf den Aufruf einer Funktion oder auf die Deklaration eines Funktionbausteins und drücken Sie die F1-Taste.
      Um die Hilfe für einen im ST-Code deklarierten Baustein anzuzeigen: Positionieren Sie den Textcursor auf die entsprechenden Zeilen mit der Deklaration (z.B. FUNCTION_BLOCK name1 und END_FUNCTION_BLOCK) und drücken Sie die F1-Taste.
    • Im FBS-Editor: Selektieren Sie den Aufruf einer Funktion oder eines Funktionbausteins und drücken Sie die F1-Taste.
      Um die Hilfe für den aktuell geöffneten Baustein anzuzeigen: Selektieren Sie keines der Elemente im FBS-Editor und drücken Sie die F1-Taste.

Ablage der Hilfedateien

Die Dateien für die HTML-Hilfe müssen entweder im Ordner olh oder im Ordner .olh abgelegt sein. Beide Ordner müssen parallel zum Baustein liegen, für den die Hilfedateien bestimmt sind. Der Ordner olh ist standardmäßig im Projektexlorer sichtbar, der Ordner .olh jedoch nicht.

Der Name einer HTML-Hilfedatei für einen Baustein muss so lauten:

Gegebenheit

In der deutschen  logi.CAD 3 -Version

In der englischen  logi.CAD 3 -Version

Der Baustein ist in einem →Namespace deklariert.

Namespace-Name.Baustein-Name.DE.html

Namespace-Name.Baustein-Name.EN.html

Der Baustein ist nicht in einem Namespace deklariert.Baustein-Name.DE.htmlBaustein-Name.EN.html

Beispiele:

  • Für den Funktionsbaustein FB1, der im Namespace N1 deklariert ist, lautet die Hilfedatei: N1.FB1.DE.html
  • Für den Funktionsbaustein FB2, der ohne Namespace deklariert ist, lautet die Hilfedatei: FB2.DE.html

Übersicht zur Suchreihenfolge

Die folgende Übersicht veranschaulicht, wo und in welcher Reihenfolge  logi.CAD 3  nach der Hilfedatei für den Baustein MyBlock sucht, der im Namespace my.blocks deklariert ist.
Das Kürzel XX in der Grafik wird durch das Sprachkürzel DE oder EN ersetzt, mit dem gesucht wird. Zuerst sucht logi.CAD 3  nach der Hilfedatei in der Sprache, mit der  logi.CAD 3  gestartet wurde. Wird dabei keine Hilfedatei gefunden, so wird nach englischen Hilfedateien gesucht. 

help_workflow

Falls logi.CAD 3  keine Hilfedatei findet, wird diese Meldung in der Sicht Fehlerprotokoll ausgegeben: Keine Hilfeinhalte für "Name" vorhanden.