aus dem DMXControl-Wiki

DMXControl 2.9 Helpfile-Generierung

Erstellung von Hilfefiles für DMXControl

Hier kommt das Titelblatt incl Titelbild hin

http://www.dmxcontrol.de/

Anregungen und Ergänzungen bitte direkt über das DMXControl-Wiki http://dmxc.labnine.de/wiki/ oder an info@dmxcontrol.de.

(Dokumentenversion 1.0, DMXControl 2.9)

Voraussetzungen

DMXControl verwendet das Windows Helpsystem. Für jede unterstützte Sprache ist ein entsprechendes chm-file zu generieren. Dies erfolgt mit dem frei verfügbaren Microsoft-Tool. Htmlhelp-Workshop.

Das Helpsystem von DMXControl ist derartig aufgebaut, dass es einerseits zu jedem Tool eine direkte Hilfeseite anbietet (F1-Taste), anderererseits etliche Beiträge aus dem DMXControl-Wiki (dmxc.labnine.de/wiki ) integriert sind, um ein systematisches Nachlesen zu ermöglichen.

Erstellung des Sprachfiles

Wie erwähnt, benötigen wir ddas installierte Tool HTML Help Workshop. (Ich verwende die Version 4.74. Zuerst wird das Projekt geladen, z.B. DMXC_olh4.hhp. Neben den Options sieht man hier die Liste der verwendeten html-files, und die Aliases. Letztere werden aus dem DMXC_index.h File gelesen, um die Zuordnung der Themen zu den DMXC-Tools (Fenstern) herzustellen. Hier ein Ausschnitt:

#define IDH_S2L_TOOL             1000
#define IDH_AUDIOPLAYER_TOOL     1001
#define IDH_MAIN_WINDOW          1003
#define IDH_LIGHTSTAGE_TOOL      1004
#define IDH_DEVICELIST           1005

Gegebenefalls sind mit einer neuen DMXC-Version weitere Bezeichner für neue Tool zu genererieren. Dieses File dient logischerweise auch der Synchronisation mit dem Code, da Stefan die entsprechenden Bezeichner in die Formsdefinitionen einbringen muss, damit die F1-Hilfe funktioniert. Ein Alias wird also nur dann benötigt, wenn das entsprechende Thema direkt aus dem Programm aufgerufen werden soll.

Die eigentlichen html-files habe ich wegen schwachem Editor-Support nicht mit dem HTML Help Workshop bearbeitet, sondern mit einem externen HTML-Editor.

Ab Version 2.9 verwenden wir als Masterinformation die aktuellen DMXC-Wiki-Seiten. Bisher kenne ich keinen automatisierten Weg, aber manuell funktioniert es folgendermaßen:

• Im HTML-Workshop wird der Editor dür das entsprechende HTm-file aufgerufen.

• Im Webbrowser geht man für das gleiche Thema im Wiki auf die entsprechende Seite.

• Nun wird die Browser-Funktion „Quelltext anzeigen“ verwendet und der angezeigte HTML-Code kopiert.

• Im Editor werden die Inhalte ersetzt.

• Beim generierten File erscheint nun später der Titel in der folgenden Art:

• Effekt

  ’’’aus DMXCWiki, der freien Wissensdatenbank’’’

  Ein Effekt stellt einen Ablauf von Szenen dar, der ...

Das ist nicht schädlich sondern eher sogar gewünscht. Ebenso werden am Ende der Seite einige automatische links erzeugt, die dem Nutzer helfen, weitere Informationen zu finden.

Das Helpfile kann nun mit dem Compile-Kommando aus dem File-Menü generiert werden. Es erhält die extension .chm

Installation

Das generierte File <language>.lang.chm (eventuell noch mal die Zeit überprüfen, damit man kein altes File installiert) muß nun in das Installationsverzeichnis von DMXControl (Unterverzeichnis „Languages“) kopiert werden, z.B.

C:\Programme\DMXControl\Languages

DMXControl verwendet je nach eingestellter Sprache automatisch das richtige Helpfile..

Bei Fragen bitte an frank.burghardt@dmxcontrol.de wenden.