Forum zur Thematik Windows Hilfen und Hilfesysteme

CHM: Aufruf über Index-Kennwort bei mehrstufigem Index?

Guido Carl @, Montag, 14. Mai 2007, 12:29 (vor 3994 Tagen) @ Ulrich Kulle

Hallo Ulrich,

» ich habe einige Zeit in einen Lösungsversuch investiert, um das auch für
» andere Verwendungen einmal zu klären. Um es vorweg zu nehmen - es wird
» meines Wissens nicht funktionieren. Aber ein paar Fragen sind offen
» geblieben.
Erstmal vielen Dank für die Zeit, die Du investiert hast. Das ist ja alles andere als selbstverständlich.

» » » Wird über die HH API oder über .Net Framework Funktionen aufgerufen>
» » » Bitte Code-Ausschnitt oder Modul übersenden.
» » In dem Aufruf wird eine Framework-Funktion benutzt:
» » Help.ShowHelp(Nothing, HelpFile, Helpnavigator.KeywordIndex, Text)
» Hier konnte ich zwar den Aufruf des Themas, aber nicht den gleichzeitigen
» und synchronen Aufruf des markierten Schlüsselwortes auf der
» Index-Registerkarte *und* der gleichzeitigen Anzeige des Themas im Fenster
» rechts erreichen. Dies ist mir nur mit einem Trick gelungen!
»
» Ist das wirklich so, dass bei dir beides synchron angezeigt wird>
Nein. Das hatte ich wohl nicht genau beschrieben: Im Index wird der Eintrag weder in der Liste markiert noch wird er als Schlüsselwort angegeben. Es wird aber das passende Thema im Hauptfenster angezeigt.

» Außerdem ist mir nicht ganz klar, warum der Aufruf über die Keywords
» erfolgen soll. Für Kontext-sensitive Hilfe könnte mann doch auch das
» zugehörige Thema direkt aufrufen.
» Ist das wirklich über die Keywords erforderlich>
Eine gute Frage. Und es stimmt, ein Direktaufruf wäre natürlich auch möglich. Um unser Vorgehen zu erklären, muss ich ein bisschen weiter ausholen.
Die Hilfe gehört zu einer Entwicklungsumgebung für eine Programmiersprache (ADbasic). Dabei werden Hilfethemen zu Fenstern der Umgebung direkt aufgerufen. Den Aufruf über den Index nutzen wir, um die Hilfe zu einem im Quelltext markierten Kennwort aufzurufen.
Beispiel: Im Quelltext steht die Zeile "PAR_1 = ADC(PAR_2)". Wenn ADC markiert ist, ruft F1 das Hilfethem zu diesem Befehl auf.
Der Aufruf über den Index ist für uns praktisch, weil dauernd neue Befehle in die Programmiersprache aufgenommen werden. Der Hilfeersteller muss dann nur den Index um die neuen Befehlsworte erweitern, für den Programmierer ändert sich nichts. Das hat den Vorteil, dass die Entwicklungsumgebung nicht wegen neuer Befehle (und der entsprechenden Hilfeänderung) neu kompiliert werden muss.
Dieses Verfahren haben wir aus der alten WinHelp übernommen und funktioniert verlässlich.

Leider ergeben sich in jüngster Zeit Probleme, weil es immer häufiger für ein Befehlswort mehrere Hilfethemen gibt. Genau hier wird der Index mehrstufig.

Ich denke aber, wir werden vom Index-Aufruf abkommen müssen und stattdessen tatsächlich die Themen direkt aufrufen. Mal sehen, wie wir das realisieren können.

» Die Erstellung eines guten mehrstufigen Index ist ohnehin recht aufwändig.
» Allerdings bin auch ich ein Befürworter eines Schlüsselwortindex. Über die
» Tiefe kann man allerdings diskutieren. Ich denke zwei Ebenen sind genug.
» Die Tendenz geht heute mehr zu aufgabenorientierten Hilfe.
Soweit es um die Hilfe zur Entwicklungsumgebung geht, stimme ich Dir voll zu. Bei den Topics zu den einzelnen Befehlen passt das allerdings nicht.
» Bei Bedarf kann der Entwickler mit mir auch noch einmal direkt Kontakt
» aufnehmen.
Vielen Dank, ich werde es weiterleiten.

Guido


gesamter Thread:

 

powered by my little forum