Symbolschaltflächen hinzufügen

Anleitung: So fügen Sie der CHM-Hilfe eigene Symbolschaltflächen hinzu und verknüpfen zu bestimmten Seiten der Online-Hilfe.

Standard-Schaltflächen

Eine Standard-Schaltflächenleiste im CHM-Standard-Output sieht folgendermaßen aus:


Standardschaltflächen
Abbildung 1. Nur 4 Schaltflächen im CHM-Output

Neue Schaltflächen hinzufügen

Es sollen einige Schaltflächen hinzukommen:


Schaltflächen hinzufügen
Abbildung 2. Weitere Schaltflächen hinzufügen
Besonders wichtig erscheinen mir hier die Navigationsschaltflächen.
  • Vorherige - Vorheriges Topic im Inhaltsverzeichnis. Im Beispiel also nach oben auf Nachrichtentelegramm.
  • Nächstes - Nächstes Topic nach unten im Inhaltsverzeichnis.
  • Zurück - Zum zuvor geöffneten Topic in der Historie.
  • Vorwärts - Zum danach geöffneten Topic in der Historie.

Die beiden Schaltflächen, die das Blättern durch das Inhaltsverzeichnis ermöglichen, benötigen als Vorraussetzung den Eintrag Binary TOC=Yes. Dieser Eintrag steht in der HTML-Workshop-Projekt-Datei Dateiname.hhp. Entweder Sie editieren diesen Eintrag direkt im Editor oder nutzen dafür die Oberfläche des HTML-Workshops.

Einen kleinen Nachteil hat jedoch der Einsatz der Inhaltsnavigation. Es sind nun keine individuellen oder erweiterten Icons für das Inhaltsverzeichnis mehr möglich. Es können nur noch die Standard-Icons Buch und Seite eingesetzt werden.

HTML-Workshop erlaubt den Einsatz von 2 individuellen Schaltflächen, die zur einer Inhaltsseite Ihrer Wahl verlinkt werden kann. Im Beispiel verlinkt die Schaltfläche Was ist neu zu einer Seite, die die Neuerungen in der Software als auch in der Online-Hilfe aufzeigt.

Die Projektdatei .hhp

Es mussten einige Einträge in die Projektdatei geschrieben werden. Im Bereich [OPTIONS] kamen hinzu:

Binary TOC=Yes
Default Window=main

Zwischen OPTIONS und FILES wurde ein weiterer Bereich eingefügt: [WINDOWS]. Dem folgt eine lange Zeile. Wie diese Zeile zustande kommt, ist in vielen HTML-Workshop-Internetseiten gut dokumentiert. Ein guter Weg wäre es auch, die Schaltflächen in der Oberfläche des HTML-Workshops hinzufügen und das Ergebnis in der Projektdatei Dateiname.hhp anschließend zu betrachten und als Grundlage für das DITA-xsl-Stylesheet zu nehmen. Hier der WINDOWS-Bereich zum obigen Screenshot.

[WINDOWS]
main=,"Dokupedia.hhc","Dokupedia.hhk","topics\common\default.html",
"topics\common\home.html",
"topics\common\erste-individuelle-schaltflaeche.html",
"Beschriftung Individuelle Schaltfläche",,,0x3520,,0x64204e,,,,,,,,0

Man beachte jedoch, dass nach dem Wort main alles in einer Zeile geschrieben sein muss!

Das Stylesheet map2hhpImpl.xsl

Damit die Individualisierung der CHM-Datei automatisch bei jedem build aus dem DITA-OT generiert wird, müssen die Neuerungen der Projektdatei in das für die Projektdatei verantwortliche XSL-Stylesheet geschrieben werden. Dies ist die Datei DITA-OT\xsl\map2htmlhelp\map2hhpImpl.xsl im XSL-Ordner der Toolkit-Installation. An 2 Stellen erfolgt die Anpassung im Stylesheet. Diese sind jeweils grün gefärbt.


Options-Einträge
Abbildung 3. Options-Einträge

Windows-Einträge
Abbildung 4. Windows-Einträge
Im Beispiel der WINDOS-Einträge ist die default-Datei eineDatei namens a0_start_NAV_startseite.html. Diese Datei ist zugleich der Symbolschaltfläche Home zugeordnet. Es wurde eine individuelle Schaltfläche Was ist neu? hinzugefügt, die auf die Seite wasistneu_startseite_con.html verlinkt.

Nachteil der Hartkodierung

Sobald man obige Windows-Einträge in die DITA-XSL-Datei hartkodiert, provoziert man bei anderen Projekten anderen Namens unweigerlich eine Fehlermeldung. Vielleicht wäre eine Plugin-Lösung besser?

Links zum Artikel

  • Inoffizielle HTML-Help-Spezifikation, zum Link