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: 313
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: 313
Teilen Sie die URL Ihren Xing-Kontakten mit.

11 Mai 10 Seiteninhaltsverzeichnis für DITA-Concepts

{lang: 'de'}
Bei Concepts sollen die Überschriften jeder section am rechten Rand als kleines Inhaltsverzeichnis dieser Konzept-Seite erscheinen.

Auf der Suche nach FAQ-Template

Bisher hatte ich für jede Frage der FAQ-Liste eine eigene Concept-Datei erstellt. Dies war jedoch zu viel Arbeit. Es sollte eine Ein-Datei-Lösung her. Oben die Fragen als Link, weiter unten dann die Frage/Antwort-Einträge. Was lag näher, als die Demo-FAQ-Spezialsierung im DITA-OT\demo-Ordner anzuschauen? Jedoch nach einem Tag gab ich es auf. Die Pfade in der build_demo.xml und der faq2html_shell.xsl zum DTD-Verzeichnis stimmten nicht, da die Verzeichnisse im DITA OT 1.5 neu geordnet wurden. Auch glaube ich, dass mit jeder neuen FAQ-Datei, die man erstellen möchten, man diese im build-Script erwähnen muss.

Nun weiß ich, warum ich keine Beispiele zu dieser FAQ-Spezialisierung gefunden habe: sie ist nicht dokumentiert und in der Handhabung etwas umständlich.

XSL-Stylesheet in der Dokumentation

Natürlich habe ich versucht, selbst XSL-Stylesheet-Anpassungen zu kreieren. Das Ergebnis: keine Fehlermeldung und kein Inhaltsverzeichnis. Bis ich in der Datei DITA-OT\xsl\xslhtml\dita2htmlImpl.xsl auf den Eintrag

<xsl:template name="gen-user-sidetoc">

stieß. Schnell danach gegoogelt und hier die Rettung in der neuen Toolkit-Dokumentation und einem XSL-Tutorial gefunden. Hier das Beispielskript vom DITA-OT:

<!-- override for main stub -->
<xsl:template name="gen-user-sidetoc">
<!-- if there are nested topics... -->
<xsl:if test="descendant::*[contains(@class,' topic/topic ')]">
<p><table width="150" align="right" border="1" frame="box" rules="none">
<tr><td height="5" bgcolor="#0033CC" align="center">
<b><font color="#FFFFFF">Contents:</font></b></td></tr>
<xsl:for-each select="descendant::*[contains(@class,' topic/topic ')]">
<xsl:variable name="ttext"><xsl:value-of select="*[contains(@class,' topic/title ')]"/>
</xsl:variable> <tr><td class="toc">
- <a href="#{generate-id()}"><xsl:value-of select="$ttext"/></a>
<!--recursive call for subtopics here"/--> </td></tr>
</xsl:for-each></table></p></xsl:if>
</xsl:template>

XSL-Stylesheet individuell anpassen

Durch trial and error habe ich das Template derart angepaßt, dass immer nur in Concepts rechts oben ein Seiteninhaltsverzeichnis erscheint, welches die section titles – sprich die Überschriften zu jeder Sektion – auflistet.

Abbildung 1. Die Sektionsüberschriften am rechten Rand des Concepts

Section TOC

<xsl:template name="gen-user-sidetoc">
<xsl:if test="descendant::*[contains(@class,' topic/section ')]/*[contains(@class,' topic/title ')]">
<p><table class="table" width="200" align="right" border="0">
<tr><td class="tablehead" align="center">Seitenübersicht</td></tr>
<xsl:for-each select="descendant::*[contains(@class,' topic/section ')]/*[contains(@class,' topic/title ')]">
<xsl:value-of select="*[contains(@class,' topic/title ')]"/>
<tr><td><a href="#{generate-id()}"><xsl:value-of select="text()"/></a></td></tr>
</xsl:for-each>
</table></p>
</xsl:if>
</xsl:template>

Anker generieren

Es mußte noch ein Template her, um Namensanker zu erstellen.

<xsl:template name="id">
<a name="{generate-id()}"/>
</xsl:template>

Dieses Anker-Template muss nun innerhalb des Template für die section-titles aufgerufen werden, damit in jeder section ein Namensanker generiert wird:

<xsl:call-template name="id"/>

Stylesheet auslagern in ein Plugin

Damit die geänderte Datei dita2htmlImpl.xsl nicht beim nächsten DITA-OT-Update verloren geht, ist es ratsam, das gen-user-sidetoc-Template in ein Plugin auszulagern. Sie können das Plugin tocofsections auf der Startseite www.ditalog.com downloaden.

Sections und ePub

Bei der Generation von ePUB-Dateien wirkt jedoch die Section-Übersicht am rechten Rand als störend. Dann ist es besser, einfach den Plugin-Ordner herauszunehmen bzw. umzubenennten.

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: 313
Teilen Sie die URL Ihren Xing-Kontakten mit.

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

Kontextsensitive Hilfe

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?

Kontextsensitive Hilfe per Ditamap

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

ditamap in Haupt-Map

 

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: 313
Teilen Sie die URL Ihren Xing-Kontakten mit.

11 Mai 10 E-Mail-Link für Feedback in DITA-Dateien

{lang: 'de'}

Einen E-Mail-Link für jede Seite als Rückmeldungselement setzen.

Feedback des Nutzers

Durch einen E-Mail-Link auf jeder Seite der Dokumentation wird der Nutzer der Hilfe animiert, eher ein Feedback zur Dokumentation zu geben bzw. speziell Hilfe zur Seite anzufordern.

Abbildung 1. Feedback-Element zur Seite

E-Mail für Rückmeldung

Ein Klick auf den Link öffnet das E-Mailprogramm, in dem der Dateiname der Doku-Seite in der Betreffseite bereits vorgetragen ist.

Abbildung 2. Adresse und Betreff schon voreingetragen

E-Mail als Rückmeldung
Abbildung 3. Link funktioniert auch im PDF-Output

E-Mail in PDF

Attribute des xref-Elements

Die Attribute des xref-Elements sind besonders wichtig: format=”txt” und
scope=”external” müssen gesetzt sein.

Abbildung 4. Abstract-Element

Attribute des xref-Elements

Beschränkung auf Content-Seiten

Dieser Mail-Link sollte sich möglichst auf Content-Seiten beschränken. Auf Seiten, die nur der Navigation dienen, sorgt dies für Unübersichtlichkeit und ist somit überflüssig. Besonders prekär zeigt sich dies im PDF-Output.

Abbildung 5. Metaangaben der Navigationsdatei HTML-Format sind überflüssig

Überflüssiges Feedback

Spam

Sollte die Hilfe tatsächlich online – also im Internet veröffentlicht werden, ist die Veröffentlichung der E-Mailadresse natürlich eine Überlegung wert.

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: 313
Teilen Sie die URL Ihren Xing-Kontakten mit.

11 Mai 10 Schriftart für Zahlen

{lang: 'de'}
Die Schriftart CombiNumerals hilft, Zahlen auf einem Kreis darzustellen.

Wozu diese Schriftart?

Abbildung 1. CombiNumerals in Photoshop
Zahlenschriftart

Die Schriftart hilft, schnell Nummerierungen auf Screenshots anzulegen. Wählt man wie im Bespiel die Art Solid, werden die Zahlen invers dargestellt. Die Zahl 2 wird erzeugt durch den Buchstaben c.

Hinweise vom Autor zum Gebrauch

Den beiden TTF-Dateien ist eine Readme-Datei zum Gebrauch sowie der Installation beigelegt. Hier die Hinweise zum Gebrauch der Schrift:

CombiNumerals(tm) is a typeface for creating circled numbers, popular for use in Web graphics,
documentation and instructional material, maps, signs and guide books, for example. With CombiNumerals, you can create any number between 0 and 99.
Here’s how:

SINGLE-DIGIT NUMBERS – The numbers 0 through 9 are
created by pressing the A, B, C, D, E, F, G, H, I, and J keys respectively
(you can type either lower- or uppercase).

DOUBLE-DIGIT NUMBERS -
The numbers 00 through 99 are created by first pressing one of the number
keys (0-9), followed by Shift-number. For example, to create the number
67, press the 6 key followed by Shift-7. You can also create two-digit
circled numbers with a leading zero, 07 (0, Sh-7), for example.

MULTIPLE WEIGHTS – CombiNumerals is available in two weights — Open and Solid.
The Open weight displays numbers inside hollow circles. The Solid weight displays white numbers inside filled circles. The Solid weight is the Bold version of the Open weight.

ADDITIONALCH ARACTERS – Several other characters besides numerals are available in
this font. For instance, arrows, hands, pointers, and the Mac OS and
Windows logos (including circled M and W characters) can be created. These
characters are commonly used by people writing documentation, but are also
used for things like maps, signs, posters, guide books, etc.

Der Autor

CombiNumerals was designed and created by Sean Cavanaugh, the author of Digital Type Design Guide, The Page Designer’s Guide to Working with Type, published by Hayden Books (ISBN 1-56830-190-1). You can contact the author via e-mail <seanc@compuserve.com>.

Links zum Artikel

  1. Download der kostenlosen Version von CombiNumerals von www.maxfonts.com
  2. Buch des Autors mit Schrifterweiterung

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: 313
Teilen Sie die URL Ihren Xing-Kontakten mit.