Mit Einführung von SOGXmlHelp - dem Interaktiven Hilfesystem der SOG - ist eine Hilfesystematik eingeführt worden, die es Entwicklern, Projektleitern und Kunden gleichermaßen gestattet Dokumentationen, Workshopunterlagen, Arbeitsanweisungen und Hilfetexte zu hinterlegen.
Dabei wird von der SOG-Entwicklung die Hilfe zu SOG ERP (VACOS) als Standard gepflegt, und über Projektupdates in die SOG ERP (VACOS)-Kundenprojekte überstellt.
Entwickler und Projektleiter können projektindividuell diese Texte erweitern, ergänzen oder ggf. zum Teil ersetzen.
Nach Auslieferung der Hilfedateien auf das Kundensystem kann dort gleichermaßen die Hilfe ergänzt oder ggf. sogar ersetzt werden.
Die Hilfetexte brauchen dabei nicht generiert zu werden. Vielmehr wird der eigentlich angezeigte Text jeweils in dem Moment, da er zur Anzeige gebracht wird, aktuell dynamisch zusammengestellt. Dadurch ist es zum Beispiel auch möglich geworden, das Datenhandbuch in das Hilfesystem zu integrieren, und dieses immer aktuell aus den entsprechenden Data-Dictionairies darzustellen.
Anordnung der Hilfe in einer Baumstruktur
Die Hilfetexte werden grundsätzlich in einer Baumstruktur organisiert. Der Einstiegsknoten, also der erste Hilfetext, der bei Aufruf von SOGXmlHelp ohne weitere Parameter angezeigt wird, und der gleichzeitig "oberster" Vater aller Hilfepunkte im System ist, trägt den festen Namen "root".
Jeder Hilfepunkt kann eine Liste von "Unterpunkten" bekommen, die bei Darstellung des Hilfepunktes in der Baumstruktur als "Kinder" unterhalb des dargestellten Punktes angezeigt werden.
Daneben muss jeder Unterpunkt genau einen "Vater"-Punkt haben. Dieser Vaterpunkt bestimmt bei der Darstellung des Hilfepunktes welche Elemente in der Baumstruktur oberhalb des dargestellten Punktes angezeigt werden.
Navigieren innerhalb der Hilfe
Der Hilfebenutzer hat mehrere Möglichkeiten innerhalb der Hilfe zu "navigieren", also andere Hilfepunkte zu finden und anzuzeigen:
Anwählen eines Hilfepunktes in der Baumstruktur.
Über die Maus oder die Tastatur kann ein Hilfepunkt aus der Baumstruktur ausgewählt werden. Im Baum wird jeweils angezeigt: Der Aktuelle Hilfepunkt, der Vaterpunkt, alle Kinder des Vaters und alle Kinder des aktuellen Punktes.
Anwählen eines Hilfepunktes über die Navigationsleiste.
Am oberen, linken Rand des Hilfebildschirms wird - ähnlich wie in SOG Active Skin - eine Navigationsleiste dargestellt, in der der aktuelle Hilfepunkt und alle Vaterpunkte dargestellt sind. Durch einen Mausklick oder über die Tastatur kann hier direkt eine höhere Strukturebene der Dokumentation angezeigt werden.
Folgen eines Verweises innerhalb eines Hilfetextes.
Wie von Internetseiten bekannt, kann es innerhalb der Hilfetexte Verweise von einer Textstelle auf eine andere geben. Durch einen Klick auf einen solchen Verweis wird der neue Hilfepunkt zur Anzeige gebracht.
Navigation durch Nutzung der "Zurück"-, "Vor"- und "Aufwärts"- Tasten.
Am oberen, rechten Rand des Bildschirms sind 4 Schaltflächen verfügbar, mit denen in der Hinstorie der angezeigten Hilfepunkt zurück oder vorgeblättert werden kann. Über den "Aufwärts"-Pfeil kann der Vater des aktuellen Punktes angezeigt werden, mit der Schaltfläche "Aktualisieren" wird die aktuelle Anzeige neu dargestellt.
Finden eines Hilfepunkte über den Reiter "Suchen"
Über die Funktion "Suchen", die z.B. auch über die Tastenfolge Strg-F aufgerufen werden kann, können Hilfepunkte gefunden werden, die einem bestimmten Textmuster entsprechen. Durch Klicken in die Liste der gefundenen Punkte kann dieser zur Anzeige gebracht werden.
Hinweis: Über die Tasten "F3" und "Umschalt-F3" kann in der Liste der gefundenen Punkte vor- und zurückgeblättert werden
Direkte Anwahl eines Hilfepunktes über eine bekannten Namen.
Ist der Name eines Hilfepunktes bekannt, kann dieser direkt über die Menüfunktion "Bearbeiten - Url anzeigen" aufgerufen werden.
Hier können Sie auch mehr als einen Hilfepunkt gleichzeitig zur Anzeige bringen:
auskv1|auskv1sm0|global.anwmatch
Anwahl eines Hilfepunktes durch Auslösen der Hilfefunktion innerhalb von SOG ERP (VACOS)
Wird innerhalb von SOG ERP (VACOS) die Hilfetaste (F1) gedrückt, wird SOGXmlHelp aufgerufen, und der aktuelle Hilfekontext angezeigt. Ist SOGXmlHelp bereits aktiv, wird die laufende Instanz aktiviert und in dieser der gewünschte Hilfepunkt angezeigt.
Gleichzeitige Darstellung mehrerer Hilfepunkte
Wird innerhalb von SOG ERP (VACOS) die Hilfetaste (F1) gedrückt, werden meistens mehrere Hilfepunkte gleichzeitig zur Anzeige gebracht.
So wird nicht nur die Hilfe zu dem aktuellen Datenfeld, sondern gleichzeitig auch noch die Hilfe zum aktuellen Dialogschritt, sowie die Hilfe zur aktuellen Maske mit angezeigt.
Diese Funktion kann auch manuell ausgelöst werden, indem im Menüpunkt "Bearbeiten - Url anzeigen" nicht nur ein Hilfepunkt eingegeben wird, sondern gleichzeit mehere, jeweils durch "|" getrennt.
Beispiel:
auskv1|auskv1sm0|global.anwmatch
Sie können über das Suchfeld Begriffe suchen. Um weitere Suchfelder zu erschließen, können Sie unterschiedliche Suchstrings verwenden.
Beispiele:
%Begriff1%Begriff2
Beachtung von Groß- und Kleinschreibung