Die Bearbeitung von Hilfepunkten erfolgt über die SOGXmlHelp-Bearbeitungsmaske.
Hier ist es möglich eine Überschrift festzulegen, einen Vater-Hilfepunkt festzulegen, der darüber entscheidet, wo in der Baumstruktur der Hilfepunkt eingebettet wird, sowie über das Datenfeld "Steuerung" einzustellen, ob der Hilfepunkt eine evt. vorhandene "Standardhilfe" ergänzt oder ersetzt. Dabei sollte "Ergänzen" immer bevorzug verwendet werden.
Geben Sie in dem Datenfeld "Überschrift" die beiden Buchstaben "dd" an, so wird versucht, aus dem zu dem beschriebenen Datenfeld gehörenden Data-Dictionary, aus dem Attribut "VTitle", die Maskenüberschrift zu lesen, und diese als Überschrift für den Hilfetext zu verwenden!
Der eigentliche Text des Hilfepunktes wird in dem Textfenster in der Mitte des Bildschirm dargestellt und bearbeitet.
Dazu steht ein RichtText-Editor zur Verfügung.
Oberhalb des Textfensters befinden sich einige Schaltflächen, über die Formatierungselemente verfügbar sind.
Unterhalb finden Sie einen Slider "Zoom" mit dem die Schriftgröße bei der Bearbeitung eingestellt werden kann.
Wenn Sie über den Schaltflächen mit der Maus schweben, werden Führungstexte (Tooltips) angezeigt.
Die Schaltflächen haben folgende Bedeutung:
Umschalten zwischen dem Zeichen einfügen und Zeichen überschrieben Modus.
Ist die Schaltfläche aktiviert, können durch drücken der Tab-Taste Tabulatoren und Einrückungen eingegeben werden.
Ist der Tab-Modus aktiviert, kann durch "Einrücken" der Einzug der aktuellen Zeile vergrößert werden
Ist der Tab-Modus aktiviert, kann durch "Ausrücken" der Einzug der aktuellen Zeile verringert werden
Markierten Text Fett schalten, bzw. Fettschaltung aufheben.
Markierten Text unterstreichen, bzw. Unterstreichung aufheben.
Markierten Text Kursiv (Italic) darstellen, bzw. Kursiv-Schaltung aufheben.
Wandelt die aktuelle Zeile in eine Aufzählung.
Wandelt die aktuelle Zeile in eine Liste.
Setzt den aktuellen Absatz linksbündig.
Setzt den aktuellen Absatz mittig.
Setzt den aktuellen Absatz rechtsbündig.
Setzt den aktuellen Absatz links und rechtsbündig.
Fügt eine neue Tabelle ein.
Fügt einen Hyperlink oder eine Hilfe-Sonderfunktion ein.
Einstellen der Schriftart des aktuell markierten Bereichs
Aktuell markierten Bereich in einen Fix-Font wandeln. So markierte Bereiche haben Sonderfunktionen. (Siehe untern: Formatierung mit einem Fix-Font)
Legt die aktuelle Schriftgröße fest.
Festlegen der Hintergrundfarbe.
Festlegen der Textfarbe.
Einbetten eines Bildes oder einer Grafik
Das Einbetten eines Bildes erfolgt über Einfügen aus der Zwischenablage.
Der Bearbeitungscontrol unterstützt eine Rechtschreibprüfung.
Auf der Bearbeitungsmaske finden Sie unten links eine Schaltfläche "Text löschen".
Diese löscht den aktuellen Text vollständig aus dem Hilfesystem heraus.
Verweise auf den Text aus Vaterknoten bleiben bei dieser Form des löschens jedoch erhalten.
Über die Listbox "Unterpunkte" können Unterpunkte zu dem aktuellen Hilfepunkt festgelegt werden. Durch einen Doppelklick kann ein vorhandener Unterpunkt bearbeitet (also der Name geändert) werden. Mit "Auf" und "Ab" können Sie die Reihenfolge der Unterpunkte beeinflussen.
Wird der Schalter "Sortieren" gesetzt, werden die Unterpunkte bei der Erzeugung der Baumstruktur automatisch alphabetisch sortiert.
Bei der Festlegung von Unterpunkten können Sie manuell Unterstrukturen für die Darstellung im Hilfe-Strukturbaum erzeugen.
Verwenden Sie das Zeichen "/" um Unterstrukturen und Namen der Hilfepunkte voneinander zu trennen.
Beispiel:
Unterstruktur/Hauptname.Hilfepunktname
Erzeugt in dem Strukturbaum, unterhalb des aktuellen Hilfepunktes, eine Unterstruktur mit dem Namen "Unterstruktur", und stellt dort den Hilfepunkt mit dem Namen "Hauptname.Hilfepunktname" dar.
Bei dieser Definition kann auch dafür gesorgt werden, dass mehr als ein Unterpunkt gleichzeitig dargestellt wird! Trennen Sie die Hilfepunkte dabei mit einem "|" Zeichen!
auskv1|auskv1sm0|global.anwmatch
Diese Techniken lassen sich auch kombinieren:
Unterstruktur/auskv1|auskv1sm0|global.anwmatch
Einbinden von DataDictionary Feldern
Geben Sie als Unterpunkt "DD:{DataDictionaryName}" an, um automatisch alle Datenfelder eines ganzen Data-Dictionairies als Unterpunkte einzubinden.
"DD:{DataDictionaryName}.{Typename} bindet alle 88er Stufen eines bestimmten Datentyps ein.
Drücken Sie Strg-F um die Suchfunktion zu aktivieren.
Nach Eingabe eines Suchtextes kann dieser mit F3 oder Shift-F3 vorwärts oder Rückwärts gesucht werden.
Formatierung mit einem Fix-Font
Bereiche die mit einem Fix-Font formatiert sind, stellen für das Hilfesystem eine Besonderheit dar.
Solche Bereiche werden nicht auf "Black-List" Worte geprüft, sodass sie hier beliebigen Text schreiben können.
Verwenden Sie außerdem den Fix-Font zur Markierung von Kommandos, Klassendefinitionen, Ein- oder Ausgaben.
Über Hyperlinks können Sie entweder auf einen anderen Teil der Hilfe verweisen, oder bestimmte Hilfe Sonderfunktionen auslösen.
Dies sind:
Externe Url: Verweis auf eine URL im Internet.
Funktionskürzel: Einbetten eines Programmnamen.
Standardlink: Einbetten eines Standardverweises.
Softkeytext: Einbetten einer Softkeybeschriftung.
Datei einbetten: Einbetten einer externen Datei.
Alternativ externe PDF anzeigen: Festlegen einer externen PDF Datei, die anstelle des aktuellen Hilfepunktes angezeigt werden soll
Include Funktion: Einfügen einer Textpassage aus einem anderen Hilfepunkt.
ReleaseNodes: Verweisen Sie auf ReleaseNodes indem Sie einen Hyperlink in dem Format "relnode:{NODENAME}" definieren. Beispiel: relnode:20190329-192510 . Zur Laufzeit wird der verwendete Text durch die Überschrift der ReleaseNode ausgetauscht. Beispiel: : fun:relnode:20190329-192510
Zugriff auf Beschriftungen von Softkeydefinitionen
Über einen Hyperlink mit der Funktion "Softkeytext" können Sie eine Beschriftung eines Softkeys automatisch einblenden.
Fügen Sie einen Hyperlink mit dem Inhalt: auskv1sm0.2031 und der Funktion Softkeytext ein !
Angezeigt wird daraufhin: Auswahl
Dies ist die aktuelle Beschriftung des betreffenden Softkeys.
Das Einbinden von Textpassagen wird im Moment durch eine Verweis (links) auf den entsprechenden Text realisiert.
Beispiel: Fügen Sie einen Hyperlink mit dem Inhalt: global.match und der Funktion Include Funktion ein !
Angezeigt wird dann: Siehe: Personenmatchcode
Einbinden von Textpassagen aus externen Dateien
Fügen Sie einen Hyperlink mit dem Inhalt: ${PROJ}\hhproj.txt und der Funktion Datei einbetten ein !
Angezeigt wird daraufhin: <pre>
sogerp
</pre>
Dynamische Anzeige von Funktionskürzeln
Da SOG ERP (VACOS) die Möglichkeit bietet, Funktionskürzel anzupassen, sollte innerhalb der Dokumentation immer mit einer Umsetzung eines Funktionsnamens in das aktuelle Funktionskürzel gearbeitet werden. Funktionskürzel werden im Programm c084 "Shortcuts" unter der Spalte StandardShortcut gepflegt. Um innerhalb der Hilfe auf solche Definitionen zurückzugreifen, kann wir folgt vorgegangen werden:
Fügen Sie einen Hyperlink mit dem Inhalt: p700 und der Funktion Funktionskürzel ein !
Angezeigt wird daraufhin: p700 - Aufgabensuche (ausu)
Automatische Korrektur von Vater-Kind Beziehungen
Nach Auslösen der Maske mit der "OK" Schaltfläche wird geprüft, ob der aktuelle Hilfepunkt in seinem eingetragenen Vater als Kind-Punkt aufgeführt ist. Ist dies nicht der Fall, erscheint ein entsprechender Dialog, über den dieser Eintrag automatisch durchgeführt werden kann.
Wird die Vater-Sohn Beziehung durch Überschreiben des "Vater" Feldes verändert, wird geprüft, ob der aktuelle Hilfepunkt noch im "alten Vater" eingetragen ist. Ist dies der Fall, wird über einen entsprechenden Dialog gefragt, ob diese Beziehung aufgehoben werden soll.
Mit dem Kennzeichen "Veröffentlichung" kann gesteuert werden, wie weit ein Text veröffentlicht wird.
Mögliche Zustände sind:
Der Text ist nur in der Basisdokumentation sichtbar.
Der Text ist in Basis und Projektdokumentation sichtbar.
Der Text ist bis zum Anwender Vorort sichtbar.
Fügen Sie Tabellen über die Tabelle einfügen - Taste ein:
Spalte 1 Zeile 1 | Spalte 2 | Spalte 3 |
Spalte 1 Zeile 2 |
| Spalte 3 |
Auch das Verschachteln von Tabellen ist möglich:
xxx | xxx | ||||||
| xxx | ||||||
xxx | xxx |
Es ist möglich eine Blacklist mit verbotenen Worten zu erstellen, welche dann im Bearbeitungsfenster rot hervorgehoben werden. Beim Speichern wird der Text überprüft und ggf. ein Dialog mit Verbesserungsvorschlägen angezeigt, der es ermöglicht die Vorschläge automatisch zu übernehmen. Ebenso kann man den Speichervorgang abbrechen und manuell die Fehler korrigieren oder, falls notwendig, auch die Überprüfung ignorieren. Durch den Button "Korrektur" lässt sich diese Funktion zudem manuell starten, ohne den Hilfeeintrag zu speichern.
Die Blacklist kann in config\sogxmlhelp_blacklist.xml konfiguriert werden und erlaubt die Nutzung regulärer Ausdrücke. Groß-/Kleinschreibung wird beim Suchen der Begriffe ignoriert.
Mittels der Formatierung mit einem Fix-Font können Textstellen von der Überprüfung ausgenommen werden.
#blacklist #autocorrect
In der Hilfe können Hashtags benutzt und gesucht werden. Hashtags können an beliebiger Position im Text hinzugefügt werden und werden als Links interpretiert, welche zur Suchfunktion führen.
Erlaubte Zeichen: A-z,0-9,-,_
Beispiel: #hashtag
Durch Verwenden eines Fix-Fonts können Hashtags als Text eingefügt werden, ohne dass die Hashtag-Sonderfunktion darauf angewendet wird.
Beispiel: #hashtag
Ansprungmarken
Ist die erste Textnode in einem Absatz Fett, so wird diese als Ansprungmarke festgelegt.
Ansprungmarken können bei der Definition von Verweisen verwendet werden, um nicht an den Anfang eines Texte zu springen, sondern auf einen bestimmten Unterabsatz.
Beispiel: SOGXmlHelp.EditMask