Microsoft WinHelp

Microsoft WinHelp ist ein proprietäres Format für Hilfedateien für Programme, die unter Microsoft Windows ausgeführt werden und von Microsoft entwickelt wurden. Es wurde auf dem Markt für Windows 3.x eingeführt und wird unter Windows XP weiterhin verwendet , wurde jedoch für Windows Vista eingestellt . Es wird durch Microsoft Compressed HTML ersetzt .

Für Windows 95 sprechen wir gleichgültig von Windows 95 Help oder WinHelp 4.0 .

Eigenschaften

Das Microsoft WinHelp-Format bietet:

• eine Online-Hilfe  : Es handelt sich um ein vom Computer durchsuchbares Handbuch (normalerweise über das Menü Hilfe zugänglich , manchmal bemerkt ? ) mit einem Inhaltsverzeichnis, Hypertext-Links und der Suche nach Schlüsselwörtern  .
• Eine kontextbezogene Hilfe  : Ein Tooltip (Popup) wird angezeigt, wenn wir ein Steuerelement (Textfeld, Schaltfläche, Kontrollkästchen ...) mit einem Klick auf die sekundäre Schaltfläche oder die Schaltfläche festlegen [F1].

Andererseits hängen die Hilfeblasen , die angezeigt werden , wenn der Cursor auf einem Objekt nicht bewegt wird (QuickInfos) , nicht von der Microsoft WinHelp-Hilfe ab, sondern befinden sich direkt im Programm. Sie können die Online-Hilfe auch anzeigen, indem Sie im Windows Explorer auf die Hilfedatei doppelklicken (Datei .HLP, siehe unten).

Hilfedateien

Die Microsoft WinHelp-Hilfe besteht aus zwei Dateien:

• eine Datei mit der Erweiterung .HLP(für Hilfe ), die die angezeigten Seiten enthält (Online-Hilfe und kontextbezogene Hilfe);
• eine Datei mit der Erweiterung .CNT(für Inhalt ), die das Inhaltsverzeichnis der Online-Hilfe enthält.

Wenn die Datei .CNTfehlt, können Sie jederzeit die kontextbezogene Hilfe verwenden. Sie können auch die erste Seite der Online-Hilfe anzeigen und mithilfe von Hypertext-Links oder den Schaltflächen "Zurück" und "Weiter" navigieren. Sie haben jedoch keinen Zugriff auf das Inhaltsverzeichnis, und auf einige Seiten kann auf diese Tatsache möglicherweise nicht zugegriffen werden. Für Windows 3.x gab es keine Datei .CNT. Das Inhaltsverzeichnis war eine Seite mit Links zu den verschiedenen Seiten; Unter Windows 95 ist das Inhaltsverzeichnis eine Registerkarte in einem schwebenden Fenster, die angezeigt wird, wenn Sie die Hilfe öffnen oder wenn Sie im Hilfefenster auf die Schaltfläche " Inhalt " klicken .

Wenn Sie zum ersten Mal eine Schlüsselwortsuche durchführen, generiert die Hilfe-Engine eine Datei .GID, die diese Suche ermöglicht (die Datei kann gelöscht werden und wird bei der nächsten Verwendung neu generiert ).

Wir können optional eine Datei .FTS (Volltextsuchindexdatei) und .FTG (Volltextsuchgruppendatei) haben .

Alle diese Dateien haben denselben Namen wie das Programm, auf das sie verweisen, nur ihre Erweiterung ändert sich.

Generieren von Microsoft WinHelp

Die Datei .HLPwird aus einer RTF- Datei mit einer bestimmten Formatierung generiert . Ein Hilfefenster, ein Thema , ob Online-Hilfe oder kontextbezogene Hilfe, ist eine Seite der RTF-Datei:

• Vor dem Titel stehen Fußnoten.
  • Die Notiz mit der Referenz "  # " enthält die eindeutige Referenz des Themas (Themen-ID) , die im Fall der kontextbezogenen Hilfe die Referenz des Objekts ist.
  • Die Notiz mit der Referenz "  K " enthält die Schlüsselwörter für die Suche.
  • Die Notiz mit dem Verweis "  $ " enthält den Titel des Themas.
• Der Text von Hypertext-Links wird zweimal unterstrichen (er wird in der letzten Hilfe nicht unterstrichen angezeigt. Diese Formatierung wird nur während der Kompilierung verwendet). Die eindeutige Referenz des Zielelements (vgl. vorheriges Element) in unsichtbarer Schrift wird an diesen Text angehängt.
• Die Bilder werden durch eine Zeichenfolge vom Typ "  {bmc nom_image.bmp} " ersetzt, nom_image.bmpwobei dies der Name der Bilddatei ist  .
• Zur kontextbezogenen Hilfe wird die Referenz des Objekts in eine Textdatei namens "Partition" (Karte) gestellt , die im Allgemeinen die Erweiterung .HMträgt und die Verbindung zwischen der Referenz und der binären Kennung herstellt. Diese binäre Kennung kann mit dem Programm spyxx.EXEvon Visual Studio abgerufen werden  . Diese Score-Datei kann vom Programm automatisch aus dem Quellcode generiert werden makehm.EXE(der Programmierer gibt dem Objekt im Quellcode eine Kennung , beginnend mit ID…, und es ist dieselbe Kennung, aber beginnend mit HID…dieser dient als Referenz).

Die Datei .CNTist einfach eine Textdatei. Jede Seite wird in einer Zeile der Datei referenziert. Die Zeile enthält:

• die Hierarchieebene der Seite ( 1für einen Haupttitel, 2für einen Abschnitt, 3für einen Unterabschnitt usw.);
• der Titel der Seite;
• die eindeutige Referenz der Seite, die durch ein Gleichheitszeichen vom Namen getrennt ist;
• die Art des Fensters, in dem es angezeigt wird: >mainfür das Hauptfenster, >procfür das schwebende Fenster (Prozedur).

Grundlegende Formatierungen wie Ausrichtung und Schriftart (einschließlich Fett- und Kursivschrift) werden wie in der generierten Hilfe dargestellt.

Beispiel für eine RTF-Dateiseite # K $ Titel des Abschnitts Dies ist der Text des Hilfethemas mit einem Hypertext- Linkfeld2 .   # Überschrift1 K Schlüsselwort $ Titel des Abschnitts

Im obigen Beispiel ist die unsichtbare Schriftreferenz mit einer gepunkteten Linie unterstrichen.

Es gibt Tools wie RoboHelp oder Doc-To-Help , die das manuelle Erstellen der RTF-Datei vermeiden . Das Einfügen eines Links oder eines Bildes erfolgt dann "mit der Maus" (RoboHelp), oder das Programm nimmt eine Microsoft Word- Datei und wandelt sie in eine RTF-Datei und BMP-Dateien um (Doc-To-Help, Begriff der einzelnen Quelle) , Single - Sourcing ). Diese Tools sind auch für die Generierung der Datei verantwortlich .CNT.

Die RTF-Datei und die BMP-Dateien werden dann vom Programm kompiliert HCRTF.EXE, um die Datei zu erstellen .HLP. Dazu muss eine Projektdatei mit der Erweiterung .HPJ (Hilfsprojekt) erstellt werden , in der die zu integrierenden Dateien aufgelistet sind (verschiedene RTF-Dateien, Ordner, in denen die Bilder abgelegt werden, Datei, die die Korrespondenz zwischen den Bezeichnern angibt

Anmerkungen

1. "Rechtsklick", wenn die Maus für Rechtshänder konfiguriert ist

Siehe auch

Literaturverzeichnis

• Beherrschen der Windows 95-Hilfe , Blue Sky Software Corporation (La Jolla, CA , USA), 1995 ( ISBN  0-9647236-0-3 )

Externe Links

• (de) Jafs Spickzettel zum Erstellen der Windows-Hilfe
• (in) RoboHelp (Adobe, ehemals Blue Sky Software)
• (de) ComponentOne , Herausgeber von Doc-To-Help (ehemals WexTech)