Aufruf der Onlinehilfe

Gültig für: yuuvis® RAD Version 6.x

Die Onlinehilfe für yuuvis® RAD client kann aus yuuvis® RAD client im Browser angezeigt werden.

Sollten Anwender kein Zugriff auf das Internet haben, können sie trotzdem auf die Hilfe zugreifen. Hierzu werden die Hilfe-Dateien lokal abgelegt und für yuuvis® RAD client die Hilfe-URL entsprechend angepasst.

Sie können ebenfalls eigene Hilfe-Dokumente anlegen und über die Hilfe-URL einbinden.

Die Hilfe-Dateien für yuuvis® RAD client erhalten Sie auf Anfrage vom Produkt-Management von OPTIMAL SYSTEMS GmbH.

Schritte, mit denen Sie die Hilfe-URL anpassen:

Mit diesen Schritten legen Sie eine projektspezifische Konfiguration an und passen im entsprechenden Verzeichnis die Konfigurationsdatei für yuuvis® RAD client an.

  1. Legen Sie lokal die gewünschten Hilfe-Dateien ab.
  2. Öffnen Sie im Verzeichnis <install>\data\webresource\resources\client\custom\assets\config\ die Datei main.json in einem Text-Editor. Folgender Text wird angepasst:

    "about": {
    "docu": {
    "link": "https://help.enaio.com/yuuvis rad/user/###userLang###/index.html",
    "label": "eo.sidebar.help.manual"
    }
    }

    Der angezeigte Wert für den Parameter link ist die aktuelle URL der Standard-Anwenderhilfe für yuuvis® RAD client. Diese passen Sie an, sodass sie auf die Startseite der lokal abgelegten Hilfe zeigt.

    Der Teil ###userLang### ist optional. Falls Sie die Hilfe in mehreren Sprachen verfügbar machen, wird ###userLang### automatisch mit dem ISO-Code der in yuuvis® RAD client eingestellten Sprache ersetzt und die Hilfe dann in der entsprechenden Sprache angezeigt, sofern diese auch mit der entsprechenden URL vorliegt.

    Sie haben Hilfe-Dateien für Deutsch und Englisch in entsprechende lokale Verzeichnissen gelegt: .\help\yuuvisRAD\user\de\ und .\help\yuuvisRAD\user\en\. Um auf die Hilfe in der eingestellten Sprache zuzugreifen, muss die URL wie folgt angegeben werden: .\help\yuuvisRAD\user\###userLang###\index.html

  3. Speichern Sie die Datei.
  4. Der Parameter label entspricht dem Text, der im Hilfe-Link angezeigt wird. Der Parameter wird nicht angepasst. Stattdessen können Sie im Verzeichnis .\assets\i18n in der entsprechenden Sprachdatei (de.json, en.json, usw.) den Schlüssel eo.sidebar.help.manual mit entsprechenden Wert für die jeweilige Sprache einfügen.

  5. Führen Sie einen Neustart von yuuvis® RAD client durch.

Änderungen in der Konfigurationsdatei main.json können durch Aktualisierungen überschrieben werden. Wenn Sie die entsprechenden Parameter in die Konfiguationsdatei extend.json aus dem gleichen Verzeichnis eintragen, dann bleiben Änderungen erhalten.