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

17 Jan 12 FAQ-Plugin in das DITA-OT einbinden

{lang: 'de'}

Zum zweiten Mal habe ich den Versuch unternommen, das FAQ-Plugin, das standardmäßig im DITA-OT mit ausgeliefert wird, in mein Toolkit einzubinden. Mit Erfolg. In der DITA-Users-Group gab Eliot Kimber den Hinweis, nach welcher Anleitung man dabei vorgehen kann. Da sich bei mir jedoch einige Abweichungen ergaben, hier in folgender Anleitung meine Erfahrungen beim Einbinden der FAQ-DTD.

Weiterlesen als PDF

Lesen Sie den ganzen Artikel als PDF-Datei weiter »

Angaben zum Artikel

Artikel als PDF anzeigen
Aufrufe bzw. Downloads: 19
Aktualisiert am: 27.01.2012
Autor: Andreas Petersell
In Kapitelausgabe: Noch nicht enthalten.
Teilen Sie die URL Ihren Xing-Kontakten mit.

27 Sep 10 Neue Publikation für HTML, CHM und ePUB

{lang: 'de'}

Nun ist es mir schon wieder passiert: weil ich mir keine Notizen gemacht hatte, durfte ich von neuem herausfinden, warum mein HTML-Output mit dem Plugin TOCJS wieder die Umlaute nicht richtig darstellt.

Umlaute falsch in DITA TOCJS-Navigation

Falsche Darstellung der Umlaute im Navigationsframe des TOCJS-Plugins

Es gilt, die Datei \demo\tocjs\xsl\tocjs.xml zu editieren. Ändern Sie den Wert für encoding von utf-8 auf ISO-8859-1. So muß es am Ende aussehen:

<xsl:output method="text" encoding="ISO-8859-1"/>

Diese Aktualisierung des TOCJS-Plugins ist auch in die neue PDF-Publikation mit eingeflossen. In ihr sind sämtliche Kapitel mit den Ausgabeformaten HTML, CHM und ePUB mit eingebunden. Wenn Ihnen die Ditalog-Artikel eine Hilfe waren, schreiben Sie darüber in Ihrem Blog! Wenn Sie Ihnen keine Hilfe waren, schreiben Sie die Gründe ebenfalls in Ihrem Blog.

Text als PDF downloaden
Titel des Downloads: Ausgabeformate HTML und CHM
Art der Publikation: Kapitel
Beschreibung: Sämtliche Artikel zu den Ausgabeformaten HTML, HTML mit dem Plugin TOCJS (Javascript-Navigationsframe) sowie CHM (Windowshilfe). Ohne Leerseiten.
Aktualisiert am: 18.04.2011. Die EPUB-Generierung ist in der Kapitelausgabe "Dita4Publishers" zu finden.
Anzahl der Downloads: 273
Teilen Sie die URL Ihren Xing-Kontakten mit.

12 Mai 10 Symbolschaltflächen hinzufügen

{lang: 'de'}
Es sollen neue Schaltflächen in der CHM-Hilfe hinzukommen.

Standard-Schaltflächen

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

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

Standardschaltflächen in HTML-Help Workshop

Neue Schaltflächen hinzufügen

Es sollen einige Schaltflächen hinzukommen:

Abbildung 2. Weitere Schaltflächen hinzufügen

Neue Schaltflächen im HTML-Help-Workshop

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 stur das Inhaltsverzeichnis rauf und runter navigieren, benötigen als Vorraussetzung den Eintrag Binary TOC=Yes. Dieser Eintrag steht in der HTML-Workshop-Projekt-Datei Dateiname.hhp. Entweder Sie editieren dies 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 Datei .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/a0_start_NAV_startseite.html",
"topics\common\a0_start_NAV_startseite.html",
"topics\common\wasistneu\wasistneu_startseite_con.html",
"Was ist neu?",,,0x3520,,0x64204e,,,,,,,,0

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

Das Stylesheet map2hhp.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 map2hhp.xsl im XSL-Ordner der Toolkit-Installation. An 2 Stellen erfolgt die Anpassung im Stylesheet. Diese sind jeweils grün gefärbt.

Abbildung 3. Options-Einträge
Optionen editieren in der hhp-Datei des Projekts
Abbildung 4. Windows-Einträge
Windows in hhp-Datei editieren

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?

Teilen Sie die URL Ihren Xing-Kontakten mit.