Da in Dokumentationen sehr häufig immer wiederkehrende Begriffe verwendet werden, und diese Begriffe sinnvollerweise immer mit einem immer wieder gleichen Link ausgestattet werden sollten, bietet SOGXmlHelp eine Möglichkeit Standardlinks zu definieren.
Der Author eines Hilfetextes braucht dann nur noch bei Verwendung eines Standard-Schlüsselbegriffes diesen im Bearbeitungsfenster zu markieren, und mit einem Hyperlink mit der Funktion "Standardlink" zu versehen.
Beispiel:
Im Text wird der Begriff "ObjectSelector-Control" sehr häufig verwendet. (Dies ist ein Bedienelement aus SOG Active Skin).
Der Hilfeauthor möchte nun, das der Text "ObjectSelector-Control" mit der SOG Active Skin Beschreibung dieses Controls "verlinkt" wird.
Er markiert den Text im Bearbeitungsfenster und erzeugt einen Hyperlink mit der Funktion "Standardlink".
... im ObjectSelector-Control können Sie ...
ändert sich nun in
... im ObjectSelector-Control können Sie ...
Das Einrichten eines Links auf einen Standardbegriff ist nur dann möglich, wenn vorher dieser Standardbegriff bereits konfiguriert wurde.
Konfiguration von Standardbegriffen
Wählen Sie in der SOGXmlHelp-Grundmaske über das Menü "Bearbeiten - Standard Links" bearbeiten.
Sie werden nun in die Bearbeitung der Konfigurationsdatei der Standardlinks kommen.
Der Name der Konfigurationsdatei ist abhängig von dem Aufrufmods der SOGXmlHilfe. Er lautet
HelpStdLinks_base.xml
HelpStdLinks_proj.xml oder
HelpStdLinks_vorort.xml
je nachdem ob die Hilfe im Basisprojekt, im abgeleiteten Projekt oder Vorort aufgerufen wird.Beispiel für eine Standardbegriffs-Definitionsdatei:
<Config>
<Referenz Text="Aufgaben" Link="dhb.f000" />
<Referenz Text="ObjectSelector-Control" Link="ActiveSkin.CtrlObjectSelector" />
<Referenz Text="ObjectList-Control" Link="ActiveSkin.CtrlObjectList" />
<Referenz Text="SOG Active Skin Softkeys" Link="ActiveSkin.FrameSoftkeys" />
</Config>
In dieser Liste ist der Begriff "ObjectSelector-Control" mit dem Hilfepunkt "ActiveSkin.CtrlObjectSelector" verknüpft.