Kontextsensitive Hilfe per Ditamap

Eine Ditamap hilft, Hilfeseiten für die kontextsensitive Hilfe relativ einfach zu erstellen.

Vorteile des Map-Processings nutzen

Die Elemente <title> und <shortdesc> von eingebetteten Seiten werden immer dann als Vorankündigung angezeigt, wenn ein <topicref> andere <topicrefs> umschließt. Dieses normale ditamap processing kann sehr gut für die einfache und schnelle Erstellung von kontextsensitiven Hilfeseiten genutzt werden.

Beispiel einer Hilfeseite

Diese Seite wird extra zum Aufruf aus dem Programm über F1 bzw. der Hilfe-Schaltfläche geschrieben. Es ist eine leere Seite. Nur Titel und scortdesc sowie die gebräuchlisten Links zu den Neuigkeiten in den related links wurden gefüllt. Die 4 Links in der Mitte entstehen automatisch durch das map processing.


Beispiel kontextsensitive Hilfe
Abbildung 1. Kontextsensitive Hilfe per ditamap

Ditamap für die Links

Hier das Beispiel der ditamap für die Link-Generierung. Hier werden die Seiten im Navigationsbaum (TOC) mit angezeigt. Ändern Sie toc=”no”, kann man nur aus dem Programm auf diese Seite gelangen. Obiges Beispiel ist hier die Datei csh_ebgmain_con.xml. Sie umschließt in der Ditamap die 4 Dateien, die als Link oben zur Anzeige kommen. Auf die csh_ebgmain_con.xml wird wird von der Software per F1-Druck verlinkt. Die Datei csh_start_con.xml dient lediglich als Anzeige im TOC.


ditamap für Links
Abbildung 2. Sichtbarmachen in der Navigation?

ditamap einbinden in Haupt-Map

Da eine einzelne Map für ein Projekt doch sehr unübersichtlich werden würde, wurde sie im obigen Beispiel in eine Extra-ditamap geschrieben. Diese ditamap muss nun in die Haupt-Map eingebunden werden. Hier ist ebenfalls zu entscheiden, ob die Map für die kontextsensitive Hilfe in der Navigation erscheinen soll.


ditamap in Haupt-Map
Abbildung 3. Einbinden in die Haupt-ditamap