PDF-Hilfe, onEvent_Help

Informationen

• Kategorien: GUI
• Version: Developer.11449
• Veröffentlichungsdatum: Dienstag, 19. März 2019
• Entwickler: Eiteljörge
• Benötigt Datenbankänderung: Nein
• Betreff: PDF-Hilfe, onEvent_Help

Beschreibung

Neue Funktionen

Das Hilfesystem öffnet nun auch PDF-Dateien.

Das Event Help kann von Klassenformeln verarbeitet werden, um eigene Hilfen anzubieten.

Beschreibung

Das pit-Fm Hilfesystem hat bisher nach *.chm Dateien (HTML-Hilfe) gesucht. Jetzt werden auch gleichnamige *.pdf Dateien gesucht und bevorzugt geöffnet.

PDF-Dokumente sind für Dokumente vorgesehen und wenig für ein Hilfesystem geeignet. In meisten Fällen wird die Hilfe einfach nur das PDF-Dokument selbst öffnen, ohne eine bestimmten Text-Passage zu zeigen.

Die Hilfe mit PDF-Dokumente kann sinnvoll genutzt werden, wenn eine HTML-Hilfe nicht funktioniert, weil zum Beispiel die Hilfe-Datei im Netzwerk liegt und von dort aus nicht geöffnet werden darf. Die PDF-Hilfe ist daher als Alternativlösung anzusehen.

Einstellungen

In den Einstellungen kann für die PDF-Hilfe folgende Parameter konfiguriert werden.

System\Hilfe\PDF Programm Optionale Angabe eines Dateipfades eines PDF-Lese-Programm wie z.B. Adobe Reader. Wenn leer, dann wird das für PDF-Dateien registrierte Programm verwendet.

System\Hilfe\PDF Parameter mit Thema Optionale Angabe von Parameter für das PDF-Leser-Programm, wenn Kapitel-Hilfe geöffnet wird. Die Parameter können den Platzhalter %TOPIC% enthalten. Dieser wird durch den Kapitelnamen ersetzt. Wenn leer, dann wird der Parameter /A "nameddest=%TOPIC%" verwendet.

System\Hilfe\PDF Parameter mit Schlüsselwort Optionale Angabe von Parameter für das PDF-Leser-Programm, wenn Schlüsselwort-Hilfe geöffnet wird. Die Parameter können den Platzhalter %KEYWORD% enthalten. Dieser wird durch das Schlüsselwort ersetzt. Wenn leer, dann wird der Parameter /A "search=%KEYWORD%" verwendet.

Event Help

Ein pit-FM Anwendungsentwickler kann über Klassenformel eine eigene oder eine zusätzliche Hilfe-Unterstützung implementieren. Dafür muss eine Klassenformel für das Event Help angelegt und implementiert werden. Nachfolgende ein grobes Beispiel dafür.

Das Event wird gesendet, wenn der Anwender eine Hilfe angefordert hat. Das interne Hilfesystem wird anschließend nur ausgeführt, wenn die Klassenformel den Wert 0 zurück liefert.

Klassenformel onEvent_Help

define const int #HelpTypeHelp = 0; define const int #HelpType1TopicHelp = 1; define const int #HelpTypeKeywordHelp = 2;

int onEvent_Help( int $HelpType, string $HelpFile, string $HelpContext ) { // $HelpType: Die Art der Hilfe (Help, Topic, Keyword). // $HelpFile: Die vom System verwendete Hilfedatei. // $HelpContext: Leer ($HelpType == #HelpTypeHelp) // Kapitelname ($HelpType == #HelpType1TopicHelp) // Schlüsselwort ($HelpType == #HelpTypeKeywordHelp)

if ( $HelpType == #HelpTypeHelp )
{
    // Hilfedokument öffnen und erste Seite anzeigen.

    return 1; // Es wurde eine eigene Hilfe geöffnet.
}
else if ( $HelpType == #HelpType1TopicHelp )
{
    // Hilfedokument öffnen und Kapitel mit gegebenen Namen ($HelpContext) anzeigen.

    return 1; // Es wurde eine eigene Hilfe geöffnet.
}
else if ( $HelpType == #HelpTypeKeywordHelp )
{
    // Hilfedokument öffnen und Abschnitt mit gegebenen Schlüsselwort ($HelpContext) anzeigen.

    return 1; // Es wurde eine eigene Hilfe geöffnet.
}

return 0; // Es wurde keine eigene Hilfe geöffnet.
          // Die Hilfe des Systems ($HelpFile) soll angezeigt werden.

}