Modulare Hilfesysteme

Modulare Hilfesysteme, auch bekannt als Merging von mehreren Hilfedateien, kann sehr hilfreich sein wenn ein Hilfesystem aus vielen Themen besteht. Hier ist es sinnvoller, mehrere .chm Dateien miteinander zu verknüpfen als alle Themen in einer großen .chm Datei darzustellen.

Sinnvoll ist das Merging auch, wenn von Software Paketen nur verschiedene Module erworben oder installiert werden. Hier kann durch modulare Hilfesysteme gewährleistet werden, dass nur die Hilfen installiert werden, die der Benutzer auch wirklich benötigt.

Wenn ein modulares Hilfesystem richtig konzipiert und erstellt wurde, werden beim Hinzufügen neuer Module zu dem Hilfesystem das Inhaltsverzeichnis, der Index und die Volltextsuche des Hauptmoduls automatisch um die entsprechenden Themen des neuen Moduls erweitert.

Vor dem Konzipieren eines solchen Systems muss feststehen, aus welchen verschiedenen Modulen das endgültige Hilfesystem bestehen soll.

Zu beachten ist, dass sich alle Module eines modularen Hilfesystems im gleichen Ordner befinden müssen.

Um ein modulares Hilfesystem aufzubauen kann wie folgt vorgegangen werden:

Es wird ein Hauptmodul erstellt, welches in jedem Fall installiert oder vorhanden sein soll. Dann werden die einzelnen weiteren Module erstellt, die bei Bedarf hinzugefügt werden sollen. Alle Module werden wie ganz normale Hilfedateien erstellt. Mit Inhalt, Index usw.

Die einzelnen Module (.chm Dateien) müssen dann im [MERGE FILES] Abschnitt der Projektdatei (.hhp) des Hauptmoduls aufgenommen werden. Hierdurch werden die Einträge der einzelnen Module in den Index und die Volltextsuche des Hauptmoduls übernommen. Die einzelnen Module müssen auf jeden Fall aufgenommen werden, auch wenn sie noch nicht fertig sind oder nicht installiert wurden. Ist dies der Fall und einzelne Module befinden sich nicht in dem Ordner wie das Hauptmodul, werden die entsprechenden Themen auch nicht im Index und in der Volltextsuche angezeigt. Erst wenn das Modul dem Ordner hinzugefügt wurde, werden die entsprechenden Einträge übernommen.

Beispiel:

[MERGE FILES]
Modul1.chm
Modul2.chm
Modul3.chm

Um die einzelnen Module im Workshop hinzuzufügen wird folgendermaßen vorgegangen: 

Change project options  In der Registerkarte "Project" das Button "Change project options" drücken. 

In dem nun erscheinenden Dialogfeld "Options" die Registerkarte "Merge Files" auswählen und über die Schaltfläche "Add" das Dialodfeld "Add Merge Files" aufrufen. 

Screenshot anzeigenScreenshot anzeigen

Dort den Namen des Moduls eintragen, dass mit dem Hauptmodul verknüpft werden soll. Diese Prozedur für alle Module durchführen, die in das System integriert werden sollen.

Screenshot anzeigenScreenshot anzeigen

Um die Inhalte der einzelnen Module in das Hauptmodul zu übernehmen ist ein weiterer Schritt notwendig.

Im Workshop das Hauptmodul öffnen und die Registerkarte "Contents" auswählen. Dann den Eintrag markieren unter dem das Inhaltsverzeichnis des z.B. ersten Moduls erscheinen soll. 

Diesen Eintrag mit der rechten Maustaste anklicken und aus dem Kontextmenü "Insert File" auswählen. 

Screenshot anzeigenScreenshot anzeigen

In dem nun erscheinenden Dialogfeld "Include File" das erste Modul wie folgt eintragen: Modul1.chm::/modul1.hhc

Screenshot anzeigenScreenshot anzeigen

Den Hinweis des Workshops, dass die Datei nicht gefunden werden kann einfach ignorieren und die Datei trotzdem einbinden lassen. Nach dem gleichen Schema dann die weiteren Module an den Stellen zufügen an denen die Inhaltsverzeichnisse erscheinen sollen.

Screenshot anzeigenScreenshot anzeigen

Nach einer erneuten Kompilierung erscheinen nun die entsprechenden Einträge, wie gesagt nur, wenn sich die Module im gleichen Ordner befinden wie das Hauptmodul.