Hilfe erstellen

[Delbor]

Hi zusammen

Einmal mehr beschäftige ich mich mit dem Thema Anwendungshilfe. Meine bisherigen Versuche mit dem Helpworkshop sind sehr unbefriedigend - soweit ich das Verstanden habe, müsste ich, um eine neue Seite zu integrieren, alle schon integrierten Seiten in der richtigen Reihenfolge neu einfügen und kompilieren, an der richtigen Stelle die neue Seite einfügen und kompilieren und schliesslich mit dem Rest der bisherigen Seiten genau so verfahren - das ist eindeutig zuviel arbeit, besonders wenn ein/einige Elemente (Frames, Forms etc. neu zum Projekt hinzugekommen sind und auch gleich dokumentiert werden sollen. So hab ich mich denn entschlossen, meine eigenen Hilfeseiten zuu erstellen.

Was ich bisher habe und das vom offiziellen Weg bislang nicht abweicht, ist zum einen einen "TLBWhatsThis"-Button:

Delphi-Quellcode:

procedure TSQLiteTestMain.TLBWhatsThisClick(Sender: TObject);
begin
  DefWindowProc(handle, WM_SYSCOMMAND, SC_CONTEXTHELP, 0);
end;

Das verwandelt mir den Mauscursor in ein Fragezeichen. Wenn ich die Maus über die Form bewege und an einer bestimmten Stelle klicke, geschieht das:

Delphi-Quellcode:

function TSQLiteTestMain.AppHelp(Command: Word; Data: nativeint; var CallHelp: Boolean) : Boolean;
var helpstring : String;
 var LActCtrl : TControl; C : String;
begin
 LActCtrl := SQLiteTestMain.ActiveControl;
//   LActCtrl := FindDragTarget(Mouse.CursorPos, True);
   C := LActCtrl.HelpKeyword;
  Showmessage('Das Helpkeyword der fokussierten' + sLinebreak +
  'Komponente ist  : ' + LActCtrl.HelpKeyword + sLinebreak +
  'Die fokussierte Komponente ist := '+ LActCtrl.Name + sLineBreak +
  'Der Wert des Parameters Command ist: ' + inttostr(Command));
  helpstring := Screen.ActiveForm.Name + '.hlp';
  MessageDlg('Using ' + helpstring + ' as the help file.', mtInformation, [mbOK], 0);
  Application.HelpFile := helpstring;
  Showmessage('F1 wurde gedrückt');
  CallHelp := True;
end;

Obige Prozedur wird auch aufgerufen, wenn ich F1 drücke.
Mit den ersten beiden Parametern (Command und Data) kann ich allerdings herzlich wenig anfangen; ich vermute lediglich, dass ich durch Auswerten dieser Parameter erfahren könnte, wohin ich geklickt habe. Embarcadero weist zwar daauf hin, dass bei Microsoft mehr darüber zu erfahren sei. Wenn ich diesem Hinweis folge und das in Delphi integrierte Menue "Windows PlattForm SDK Bibliothek" aufrufe, steh ich erstmal vor diesem Fenster - und da darf dann selbst nach der richtigen Nadel im Heuhaufen...äähhh - der richtigen Info gesucht werden.
Weiss jemand, wie die angesprochenen Parameter ausgewertet werden können?
LActCtrl := SQLiteTestMain.ActiveControl; Damit nehm ich mal einfach an, dass Activcontrol dasjenige Control ist, das ich zuletzt angeklickt habe, nachdem ich den Button "TLBWhatsThisClick" gedrückt habe, bin mir allerdings wirklich nicht sicher, ob dem auch so ist.

Gruss
Delbor

[himitsu]

Siehe OH?

Command gibt an was es für eine Hilfe ist. (Context oder Keyword)
und in Data ist dann entweder der Context (Integer) oder das Keyword (PString) drin.

Und in CallHelp gibst DU an, ob du die Hilfe-Anfrage verarbeitet hast, oder ob es doch noch an Standardbehandlung weitergereicht werden soll.

[add] Der Anfang von etwas, dass ich mal vor paar Jahren schrieb.

Delphi-Quellcode:

function THelpModul.ApplicationEvents1Help(Command: Word; Data: Integer; var CallHelp: Boolean): Boolean;
...
begin
  Log := '';
  try
    {$REGION 'originalen Hilfeaufruf loggen'}
    case Command of
      HELP_CONTEXT:      S := ' - HELP_CONTEXT (Display topic in ulTopic)';
      HELP_QUIT:         S := ' - HELP_QUIT (Terminate help)';
      HELP_INDEX:        S := ' - HELP_INDEX/HELP_CONTENTS (Display index)';
      HELP_HELPONHELP:   S := ' - HELP_HELPONHELP (Display help on using help)';
      HELP_SETINDEX:     S := ' - HELP_SETINDEX/HELP_SETCONTENTS (Set current Index for multi index help)';
      HELP_CONTEXTPOPUP: S := ' - HELP_CONTEXTPOPUP';
      HELP_FORCEFILE:    S := ' - HELP_FORCEFILE';
      HELP_CONTEXTMENU:  S := ' - HELP_CONTEXTMENU';
      HELP_FINDER:       S := ' - HELP_FINDER';
      HELP_WM_HELP:      S := ' - HELP_WM_HELP';
      HELP_SETPOPUP_POS: S := ' - HELP_SETPOPUP_POS';
      HELP_KEY:          S := ' - HELP_KEY (Display topic for keyword in offabData)';
      HELP_COMMAND:      S := ' - HELP_COMMAND';
      HELP_PARTIALKEY:   S := ' - HELP_PARTIALKEY';
      HELP_MULTIKEY:     S := ' - HELP_MULTIKEY';
      HELP_SETWINPOS:    S := ' - HELP_SETWINPOS';
      else               S := '';
    end;
    Log := Log + Format('CallHelp: Command=%d%s   Data=%d'#10, [Command, S, Data]);
    if Command = HELP_COMMAND then
      Log := Log + '   Keyword/JumpID="' + PChar(Data) + '"'#10
    else if (Command = HELP_CONTEXT) or (Command = HELP_CONTEXTPOPUP) then
      Log := Log + '   ContextID=' + IntToStr(THelpContext(Data)) + #10
    else
      Log := Log + '   Keyword/ContextID/JumpID nicht erkannt'#10;
    {$ENDREGION}

    {$REGION 'nicht alle Komandos verarbeiten (z.B. wird beim F1 ein HELP_SETPOPUP_POS vor dem HELP_COMMAND aufgerufen)'}
    //if not (Command in [HELP_INDEX, HELP_CONTEXT, HELP_COMMAND, HELP_WM_HELP, HELP_QUIT]) then
    //  Exit(True);
    case Command of
      HELP_INDEX, HELP_CONTEXT, HELP_CONTEXTPOPUP, HELP_COMMAND, HELP_WM_HELP, HELP_QUIT: ;  // mit CASE, da IN einen zu kleinen Wertebereich zur Verfügung stellt
      else Exit(True);
    end;
    {$ENDREGION}

    {$REGION 'HELP_QUIT: das Hilfefenster soll geschlossen werden'}
    if Command = HELP_QUIT then begin
      FreeAndNil(HauptFormAbstract.FormWebBrowser);
      Exit(True);
    end;
    {$ENDREGION}

    ...

[Delbor]

Hi himitsu
Vielen Dank für deinen Code! Allerdings habe ich etliche Verständnisprobleme, mir die Funktionsweise der in Delphi integrierten Hilfe-Objekte und deren Zuammenarbeit vorzustellen. Ausgehend von dem Codeschnipsel in meinem Eingangspost:

Delphi-Quellcode:

procedure TSQLiteTestMain.TLBWhatsThisClick(Sender: TObject);
begin
  FToolHelp := True;   //FToolHelp wurde von mir eingefügt. Damit soll bei OnmouseDown &Co zwischen Hilfeanforderung  und 'normaler' Behandlung unterschieden werden.
  DefWindowProc(handle, WM_SYSCOMMAND, SC_CONTEXTHELP, 0);
end;

Wenn das ausgeführt wird, verwandelt sich der Mauszeiger bis zum nächsten Mausereignis in ein Fragezeichen, danach wird AppHelp aufgerufen. Mit deinem Code könnte ich also den Wert des Parameters auswerten und den String S belegen. Soweit, so gut - oder aber auch nicht, je nach Verständnis. und meines ist trotz OH immer noch unter aller...

Zitat:

Command gibt an was es für eine Hilfe ist. (Context oder Keyword)
und in Data ist dann entweder der Context (Integer) oder das Keyword (PString) drin.

Also die Werte der Propertys HelpKeyword und HelpContext der angeklickten Komponente? Und wie weiss ich (kann ich auslesen/erkennen), wo sich die angeklickte Komponente befindet? Befindet sie sich auf einer Toolbox der Mainform oder auf einem Frame? Das ist entscheidend, um zu erkennen, zu welchem Aufgabenbereich/Funktionsumfang sie gehört und damit entscheidend für den Aufruf einer bestimmten Hilfeseite. Es sei denn, ich setze Helpkeywords/HelpContexts ein, die zusammen einen dicken Schmöker füllen würden.

Aber wahrscheinlich denke ich einfach zu verquer oder in die falsche Richtung - oder beides.

Ich hab jetzt mal ausprobiert, wie ich an verdeckte/dynamische Komponente per OnmouseDown herankomme, im folgenden an einem Memo, das auf einem Frame liegt:

Delphi-Quellcode:

procedure TSettingsFrame.Memo1MouseDown(Sender: TObject; Button: TMouseButton;
  Shift: TShiftState; X, Y: Integer);
    var i :  integer;  S: String;  T : TComponent;
begin
  for i := 0 to Self.Componentcount -  1 do
  begin
//    S := S + Components[i].Name + sLinebreak;
    T := Components[i];
    if T is TFrame then
    begin
      S := (T as TFrame).Name;
      S := S + '.HelpKeyword' + (T as TFrame).HelpKeyword;
    end;
  end;
  Showmessage(s);
end;

Die auskommentierte Zeile listet mir alle auf dem Frame befindlichen Komponenten auf, inklusive der auf der Mainform erstellten Frameinstanz.

Soweit ich das bislang überschauen kann, müsste ich also etwa so vorgehen:
Statt in meinem Anfangs gezeigten 'TLBWhatsThisClick' DefWindowProc aufzurufen, müsste ich da nur FToolhelp setzen, den Cursor in ein Fragezeichen umwandeln, um per Klick(...) obige Prozedur aufzurufen, in dieser am Ende DefWindowProc aufrufen, um so dass Hilfesystem und damit AppHelp zu aktivieren.
Und in Apphelp kann ich schliesslich alles machen, was mir lustig ist - eine eigene HelpApplikation aufrufen, zum Bleistift...

Gruss
Delbor

[ManfredG]

"Meine bisherigen Versuche mit dem Helpworkshop sind sehr unbefriedigend..."

Nur so als Tip: Habe mir gerade HelpNDoc installiert, um chm-Hilfe zu schreiben. Programm ist sehr hübsch zu bedienen, ich würde es kaufen, hat aber noch nicht alles, was ich suche.
Es setzt auch aus Help-Workshop auf, man muß sich aber nicht um die Innereien kümmern.

Gruß Manfred

[Uwe Raabe]

Eigentlich sollte die ganze Hilfeanzeige automatisch geschehen. Je nach Typ der Hilfedatei muss man die passende HelpViewer Unit einbinden. Für hlp ist das Vcl.WinHelpViewer und für chm wäre das Vcl.HtmlHelpViewer. Für eine kontextsensitive Hilfe müssen dann natürlich die Properties HelpType und HelpContext bzw. HelpKeyword passend gesetzt sein.

Zur Erstellung der Hilfe verwende ich persönlich Help & Manual. Das geht super einfach und ich bin sehr zufrieden damit.

[Harry Stahl]

@ ManfredG + @ Uwe : Ich denke beide Programme bieten aber keine Cross-compile Lösung für alle Plattformen (Windows, MACOS und Linux) an, oder?

Deswegen habe ich mir ein eigenes Tool entwickelt, das erstellt z.B. aus den Daten des HTML-Workshops eine Hilfedatei im eigenen Format (*.cHelp für CrossHelp), die ein FMX-Programm dann sowohl unter Windows als auch unter MAC OS und Linux zur Anzeige der Hilfe-Texte verwenden kann (incl. Volltextsuche). Diese Hilfe-Datei ist komprimiert und noch kleiner als die vergleichbare .chm-Datei.

Bislang hatte ich für MAC und Linux die einzelnen html-Dateien in den Resourcen-Ordner gepackt und die HTML-Dateien vom lokalen Browser anzeigen lassen. Das war immer ein ziemlicher Aufwand für die Bereitstellung in Delphi und auch ziemlich unübersichtlich.

[Uwe Raabe]

Zitat von Harry Stahl:

Ich denke beide Programme bieten aber keine Cross-compile Lösung für alle Plattformen (Windows, MACOS und Linux) an, oder?

Nun, FMX kennt das Konzept von Hilfe zur Zeit gar nicht. So gibt es weder ein Application.HelpFile, noch Eigenschaften wie HelpContext oder HelpKeyword. Insofern sind sowohl die Problemstellung als auch die Antworten und erwähnten Hilfsmittel ausschließlich auf VCL ausgerichtet. Lösungen auf Basis von FMX müssen mangels vorhandener Standards im Framework zwangsläufig Eigenentwicklungen sein. (im Übrigen kann H&M auch HTML erstellen)

[Harry Stahl]

Es existieren auch unter FMX die Properties HelpContext, HelpKeyword und Helptype und inzwischen (jedenfalls im aktuellen Delphi 10.2) werden die Daten sogar in der Form gespeichert und wieder geladen. Klick dazu doch einfach mal auf einen TButton und versuch es selbst.

Allerdings stimmt es schon, es gibt kein fertiges System, welches damit etwas anfangen kann.

[Uwe Raabe]

Zitat von Harry Stahl:

Es existieren auch unter FMX die Properties HelpContext, HelpKeyword und Helptype und inzwischen (jedenfalls im aktuellen Delphi 10.2) werden die Daten sogar in der Form gespeichert und wieder geladen.

Stimmt. Bei den Controls gibt es das, beim Form selbst offenbar nicht. Leider ist das dort aber meiner Meinung nach viel wichtiger, denn häufig sind die Hilfskapitel passend zur Form aufgebaut (zumindest bei mir). Das ist ja bei der VCL ganz praktisch, da der Kontext ja rekursiv über den jeweiligen Parent ermittelt wird, wenn das aktive Control keinen liefert.

[himitsu]

Nja, FMX war ja anfangs vorallem für's Mobile und da gibt es nunmal keine Hilfe-Taste.

Aber Hints gab es anfangs auch nicht, ob es im Mobilen auch kein MouseHover gibt.



Im letzten Projekt, wo eine Hilfe eingebaut wurde, da hab ich F1 (TApplicationEvents.OnHelp) selbst abgefangen und hole zum aktiven Control oder zu dessen Parents (GroupBox, TabSheet, Form) aus der Datenbank den zugehörigen Hilfeeintrag (Form+Componentname) und leite zu einer HTML-Hilfe weiter (Help&Manual, aber nicht über deren schrottigen Hilfeserver, sondern über einen eigenen oder direkt auf eine Netzwerkfreigabe)