Ditalog
msgbartop
DITA für Redakteure – von Single Source Publishing bis Self-Publishing
msgbarbottom

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.

  1. 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

    Zugangsweg zum Bildschirm
  2. 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
    
  3. Erstellen Sie eine Topic-Datei, in der Sie das Bild icon_cursor.gif einbinden.
  4. 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.
  5. 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>
    
  6. 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.
  7. 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.

Text als PDF downloaden
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: 247
Teilen Sie die URL Ihren Xing-Kontakten mit.

11 Mai 10 Zugangsweg zum Bildschirm voranstellen

{lang: 'de'}

Es soll der Zugang zum jeweiligen Bildschirm der eigentlichen Handlungsanweisung vorangestellt und somit extra aufgeführt werden.

Handbuch vs. kontextsensitiver Hilfe

Es gibt zweierlei Arten des Lesens einer Online-Hilfe: linear als Buch oder per Verknüpfung aus der Anwendung. Und immer dann, wenn letzteres geschieht, also eine Handlungsanleitung gezielt durch die kontextsensitive Hilfe geöffnet wird, bedarf es keiner Beschreibung mehr, wie man zum jeweiligen Bildschirm
gelangt ist.

Dies ist nur bei Online-Hilfen relevant, jedoch kann man dies getrost auch in Handbüchern übernehmen. Der doppelte Aufwand, beim PDF-Output den Zugang zum Bildschirm extra in die normale Handlungsanleitung als Step zu integrieren, wäre zu hoch. Denn meistens wird man diese immerwiederkehrende Arbeitsschritte per conref-Mechanismus zentral pflegen und einfügen.

Vorschlag einer Zugangsauszeichnung

Abbildung 1. Zugangsbeschreibung zum beschriebenen Bildschirm auskoppeln

Zugangsweg zum Bildschirm

Nutzer, die durch die kontextsensitive Hilfe zum Hilfetopic geleitet wurden, können gleich mit Schritt 1 anfangen.

Text als PDF downloaden
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: 247
Teilen Sie die URL Ihren Xing-Kontakten mit.