Ein sehr wichtiger Teil jeder Dokumentation ist der Index. Doc-O-Matic unterstützt Sie auf verschiedenste Arten bei der Erstellung eines Indexes für Ihre Hilfe und für Ihre gedruckte Dokumentation. Für die HTML Hilfe werden zwei getrennte Indexe einer für das Index Feld der Hilfe und eine Indexseite erstellt.
Allgemeine Themen
Für allgemeine Themen können Sie manuell Schlüsselwörter und Untereinträge zu Schlüsselwörtern eingeben. Zusätzlich können Sie alle Thementitel zum Index hinzufügen, indem Sie auf der Seite Index das Kontrollkästchen Use topic title as index entry for generic topics aktivieren.
Symbolthemen
Es gibt verschiedene Möglichkeiten, wie Sie den Index für Themen von Symbolen gestalten können. Sie können:
Auf der Seite Symboltitel Variablen verwenden, um Indexeinträge für Symbole zu erzeugen.
Manuell Schlüsselwörter und F-Schlüsselwörter für die kontextbezogene Help2 und Help Viewer Online-Hilfe in den Topic Properties für jedes Thema hinzufügen.
Auf der Seite Index verschiedene Arten von Einträgen hinzufügen.
Indexeinträge für Verzeichnisse mit Hilfe von Variablen auf der Seite AutoDoc > Content > AutoDoc Topic Titles erstellen.
Buchstaben, die Sie zur Kennzeichnung aller Symbole verwenden, entfernen.
Um die Präfix zu entfernen, geben Sie diese in das Feld Prefixes auf der Seite Index-Präfixe ein und Doc-O-Matic entfernt die Präfixe bei Indexeinträgen.
Damit Doc-O-Matic die Indexeinträge auf Doc-O-Matics Indexseite entsprechend der Titel ohne Präfix sortiert die Titel aber mit Präfix anzeigt, aktivieren Sie das Kontrollkästchen Use modified index for sorting only.
Um die HTML-Hilfe in die Hilfe einer IDE zu integrieren
Klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings.
Klicken Sie auf die Registerkarte der entsprechenden Konfiguration.
Wählen Sie die Seite AutoDoc > Index aus.
Wählen Sie das Hilfesystem in das Sie Ihre Hilfe integrieren wollen in Index Presets aus.
Klicken Sie auf Apply und die entsprechenden Kontrollkästchen werden automatisch ausgewählt.
Um die Hilfe in die Hilfe von Visual Studio zu integrieren
Klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings.
Klicken Sie auf die Registerkarte Help Viewer.
Wählen Sie die Seite Files & Format > Help Viewer > Context Index aus.
Wählen Sie die entsprechenden Optionen aus.
Mit der Standardeinstellung erzeugen Sie die Einträge, die Sie für die Integration benötigen.