11 Mai 10 Zugangsweg in Online-Hilfe darstellen

{lang: 'de'}

Anleitung: So koppeln Sie den Zugangspfad zu einem Fenster aus den Handlungsschritten aus und kennzeichnen den Zugang per ditaval-Datei.

Der Hinweis auf den Zugangsweg zum Fenster soll durch Flagging in der ditaval-Datei mit einem Cursor-Icon gekennzeichnet werden.

Abbildung 1. Cursor-Icon vorm Zugangspfad
Schreiben Sie dazu folgenden Eintrag in die ditaval-Datei:
```
<prop att="otherprops" val="zugang" action="flag">
  <startflag imageref="images/icon_cursor.gif"><alt-text>So kommen Sie hin.</alt-text></startflag>
</prop>
```
Bitte achten Sie auf die Pfadangabe bei imageref. Sie muss genauso übernommen werden. Im Beispiel liegt die ditaval-Datei und das Bild in eigenen Verzeichnissen unterhalb des Output-Hauptverzeichnisses:
```
\filters\zugang.ditaval\images\icon_cursor.gif
```
Erstellen Sie eine Topic-Datei, in der Sie das Bild icon_cursor.gif einbinden.
Binden Sie diese Topic-Datei (kann auch ein Concept u.a. sein) in die ditamap-Datei ein und stellen das Attribut
toc=no
ein. Dieses Einbinden garantiert, dass das icon_cursor.gif rechtzeitig! in den Output-Bilderordner kopiert wird.

Versehen Sie den Absatz, der den Zugangsweg beinhalten soll, mit dem Attribut otherprops="zugang". Der obige Screenshot wurde über einen Absatz im prereq-Tag realisiert:

<prereq>
<p id="konfigbzr" otherprops="zugang" outputclass="zugang">Klicken Sie
im <wintitle>Hauptmenü</wintitle> auf
<menucascade>
<uicontrol>Systemarbeiten</uicontrol>
<uicontrol>Konfiguration Module</uicontrol>
<uicontrol>BZR.</uicontrol>
</menucascade></p>
</prereq>

Optional:
Weitere Überlegung sollte sein, diesen Zugangsweg nur einmal zu editieren und dann per conref-Mechanismus in die jeweilige Handlungsanleitung zu ziehen. Falls sich doch mal ein Bildschirm oder Menü ändert, brauchen Sie nur in der Originaldatei den Pfad oder ähnliches ändern und durch Content Referenzierung wird die Änderung in sämtlichen Handlungsanleitungen übernommern.
Optional:
Falls Sie wie im Beispiel um den Zugangsweg einen Rahmen ziehen möchten, vergeben Sie neben dem otherprops-Attribut noch ein outputclass-Attribut und erstellen in der CSS-Datei eine Deklaration gleichen Names.


	Titel des Downloads:	Ideen für Dokumentationen und Online-Hilfen
	Art der Publikation:	Kapitel
	Beschreibung:	Das gesamte Kapitel als PDF-Datei. Ohne Leerseiten für die A4-Ausgabe optimiert.
	Aktualisiert am:	10.03.2011
	Anzahl der Downloads:	457

Tags: kontextsensitive Hilfe, Zugangsweg zum Bildschirm

Filed in Ideen für die Dokumentation with 0 Comments

11 Mai 10 Kontextsensitive Hilfe per Ditamap

{lang: 'de'}

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.

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.xmldient lediglich als Anzeige im TOC.

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.

Abbildung 3. Einbinden in die Haupt-ditamap


	Titel des Downloads:	Ideen für Dokumentationen und Online-Hilfen
	Art der Publikation:	Kapitel
	Beschreibung:	Das gesamte Kapitel als PDF-Datei. Ohne Leerseiten für die A4-Ausgabe optimiert.
	Aktualisiert am:	10.03.2011
	Anzahl der Downloads:	457

Tags: Ditamap, kontextsensitive Hilfe

Filed in Ideen für die Dokumentation with 1 Comment

11 Mai 10 Zugangsweg in Online-Hilfe darstellen

11 Mai 10 Kontextsensitive Hilfe per Ditamap

Vorteile des Map-Processings nutzen

Beispiel einer Hilfeseite

Ditamap für die Links

ditamap einbinden in Haupt-Map

Seiten

Kategorien

Schlagwörter

Der Autor

Download

Blogroll

Monatsarchiv

Meta