[IDE-Experte (2006,07,09,10,XE,XE2)] CustomHelp

[chaosben]

CustomHelp (2.irgendwas )

... ist ein IDE Experte, der die Delphi Hilfe um ein paar nützliche Funktionen erweitert.

Was soll das?
Du "stehst" in deinem Quellcode und brauchst Hilfe zu einer bestimmten Funktion. Du drückst F1 und bekommst deine vertraute Delphi Hilfe. Jetzt hättest du natürlich auch gern ein Beispiel zu deren Anwendung oder du fragst dich, ob jemand in der DP schonmal das gleiche Problem damit hatte mit dem du dich gerade herumschlägst. Oder du sehnst dich nach der "alten" Delphi 7 Hilfe. Also musst du die vertraute schützende Umgebung deiner IDE (ja das ist doppelt gemoppelt) verlassen und dich durch die verschiedenen Suchmaschinen und Hilfedateien hangeln.
Hier hilft CustomHelp. Der Assistent fasst deine Suchanfrage in einem niedlichen kleinen Fenster zusammen, von dem aus du in deinen Lieblingssuchmaschinen und Hilfedateien blättern kannst.

Die Features im Überblick ... oder warum sollte ich weiterlesen? (Für alle die lieber Video gucken anstatt zu lesen ... siehe unten. )

• Suche über F1 (keine ungewöhnlichen Tastenkombinationen)
• Suche über alle im System registrierten Hx Namespaces (Microsoft Entwicklerhilfe Umgebung) (z.B. Jedi Hilfe)
• Suche über die Html-Hilfe (*.chm) Dateien
• Suche über die gute alte Hilfe (*.hlp-Dateien)
• Suche per Shell-Kommando
• Suche dynamisch via RSS-Feeds.
• Einstellungen werden pro Delphi-Version gespeichert
• Ab Version 1.3 Mit Windows Search die indizierten Dateien durchsuchen
• Ab Version 2.0 Native Suche in der Google Codesearch
• Ab Version 2.0 Erweiterbar durch eigene Provider und eigene GUI's (Fenster in dem die Hilfe angezeigt)
• Ab Version 2.0 Erweiterte Formatierung (Schriftstile + Farbe)
• Ab Version 2.1 Thread-Unterstützung zur Beschleunigung
  

Wie (de-)installiere ich CustomHelp?
Am einfachsten ist es über das SVN-Repository von TUO (Wer es ganz heiß mag und die neuesten Neuerungen und Bugs haben will, kann auch den Trunk nehmen). Vermittels eines SVN-Clients ist das überaus einfach. Andernfalls kann man sie die Dateien auch per Browser und Handarbeit runterladen - jeder eben wie er will.
Dann einfach das Package (auf passende Delphi-Version achten) laden und installieren. Fertig. Zum deinstallieren einfach das entsprechende Package aus der Liste der Entwurfs-Packages entfernen. Nach einer eventuellen Deinstallation ist ein Neustart der IDE erforderlich.
Vorher sollte man auf gleiche Weise TUOCommon installieren. (Hier auschecken und installieren)

Alles weitere über die Benutzung erfahrt ihr im Video (siehe unten)

Vorschläge für Hilfe-Provider (bitte die URLs aus den Links kopieren)

• RSS
  • Alle Ergebnisse die Bing liefert
  • Jedi-Hilfe via Bing
  • MSDN Online
• Statische Websuche
  • DP-Referenz
  • DP-Codelib
  • Koders Codesuche
• Dateibasierend
  • "$(ProgramFiles)\Adobe\Reader 9.0\Reader\AcroRd32.exe" /A "search=$(HelpString)" "Pfad:\zu\deiner\Datei.pdf" -> Suche via Adobe Acrobat Reader
• Windows Search
  • ext:pas path:"C:\Users\JohnDoe\Documents\Projects\Jedi\jvc l\" $(HelpString) -> Suche wo in der JVCL das Schlüsselwort implementiert ist
  • Für alle möglichen Abfrageparameter frag: Microsoft

Known Issues

• Unter D2006 darf man das Package nur einmal installieren. Beim zweiten Mal gibts jede Menge Fehler. Als Workaround startet man Delphi nach der Installation einfach neu.
• CustomHelp bewahrt nicht davor, die Original-Hilfe zu installieren. Leider prüft Delphi bevor es irgendetwas tut, ob diese installiert.

FAQ

• Gibts das auf deutsch?.... Nein. Das bissl englisch verträgt jeder Entwickler
• Gibts das als fertige bpl?.... Nein. Der Aufwand fertige Packages aktuell zu halten ist uns zu groß.
• Kann ich helfen?.... Ja. Wenn du noch Ideen und Anregungen hast?... Immer her damit.
• Warum habt ihr so wenige Kommentare im Code?.... Diese Projekte sind primär für unseren eigenen Bedarf geschrieben. Wir stellen sie OpenSource zur Verfügung, weil wir selbst gern von OpenSource profitieren. Es ist kein Lehrprojekt . Wenn ihr jedoch Fragen zu dieser oder jener Funktion habt, könnt ihr Marco oder mich gern fragen.
• Wie kann ich einen eigenen Provider schreiben? .... CustomHelp2 requiren, Ich2Provider implementieren und bei ch2Main registrieren.
• Wie kann ich eine eigene GUI schreiben? .... CustomHelp2 requiren, Ich2GUI implementieren und bei ch2Main registrieren.

Danke an ...

• RWarnecke fürs XE2-Projekt
• HeikoAdams fürs Debuggen und Testen
• allen anderen für das Feedback

Viel Spaß damit.
wünschen Marco und Benny

Videos
Version 2.0
Version 1.2
Version 1.0

[Pille]

Bei mir funktioniert jetzt die Hx Hilfe nicht mehr. Anfangs war alles in Ordnung, nachdem ich noch einige Hilfe Provider eingetragen habe, werden zwar Trefferergebnisse angezeigt. Wenn man aber auf eines Clickt, passiert gar nichts. Lohnt es sich, erstmal alle weiteren Hilfeprovider wieder zu löschen?
Ich habe Windows 7 und Delphi XE.
Edit: Jetzt geht's wieder, komisch.

mfg
Pille

[chaosben]

CustomHelp war bisher sehr langsam. Das haben wir nun geändert und dem Experten ein paar Threads spendiert.
Dadurch kann man jetzt schon mit den ersten Suchergebnissen arbeiten während die anderen noch auf dem Weg sind.

Die neueste Version gibts wie immer per SVN.

Viel Spass!

[chaosben]

Dank Rolf gibts jetzt auch ein Projekt für XE2. Und laut seinen Aussagen funktionierts auch.

[schöni]

Hallo,

bin soeben dabei, mir die Quelltexte Schritt für Schritt zu kopieren. Da beim Anklicken des jeweiligen Quellcodelink's der Quelltext auf der Webseite angezwigt wird, muss ich die Quellen sukzessive per Copy & Paste übernehmen. Dabei ist mir die folgende Zeile in uchProviderWindowsSearch.dfm und uchProviderStaticWebSearch.dfm aufgefallen:

inline frame_Deco: Tch2FrameHelpItemDecoration Ich habe 2 Fragen dazu:

1) Ab welcher Delphi Version gibt es das Schlüsselwort Inline in der .dfm Datei?

2) Was bedeutet dieses Schlüsselwort? (Im Gegensatz zu "Object", wie ich das kenne.

Ich brauche CustomHelp für Delphi 2006 -> die kostenlose Turbo Delphi Version, die keine Fremdpackages installiert. Deshalb kann ich nur zur Lauzeit instantiieren und brauche möglicherweise einen Workaround für dieses Problem.

Ich habe mir zum Download CustomHelp 2.0 gewählt.

Muss ich möglicherweise eine niedrigere Version bevorzugen für Delphi 2006, weil das Wort Inline da noch gar nicht bekannt ist?

[SpTBX]

Bei mir lässt sich das übersetzte Package nicht in TDE 2006 installieren. Ist halt die eingeschränkte kostenlose Version. Hab schon die Embas nach einer Lizenz gefragt, aber es ist ja Wochenende.

Als Workaround versuche ich gerade eine Anwendung derart zu erstellen:

Delphi-Quellcode:

unit hlpmain;

interface

uses
  Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
  Dialogs, ComCtrls, ToolWin, Menus, ExtCtrls, Buttons,
  uch2ProviderWindowsSearch,
  uch2ProviderStaticWebsearch
  ;

type
  THelpExplorer = class(TForm)
    StatusBar1: TStatusBar;
    Panel1: TPanel;
    MainMenu1: TMainMenu;
    Hilfedatei1: TMenuItem;
    Installieren1: TMenuItem;
    N1: TMenuItem;
    Beenden1: TMenuItem;
    Bearbeiten1: TMenuItem;
    Kopieren1: TMenuItem;
    Markieren1: TMenuItem;
    Panel2: TPanel;
    SpeedButton1: TSpeedButton;
    TreeView1: TTreeView;
    Splitter1: TSplitter;
    HlpOpen: TOpenDialog;
    procedure SpeedButton1Click(Sender: TObject);
    procedure Beenden1Click(Sender: TObject);
    procedure Installieren1Click(Sender: TObject);
  private
    { Private-Deklarationen }
    FHelpFile: AnsiString;
    //Das WinHelp-Config Formular
    FWinHlpInstallForm: Tuch2FormProviderWindowsSearch;
    //Das WebHelp-Config Formular
    FWebHlpInstallForm: Tch2FormConfigStaticWebsearch;
    procedure InstallHelpFiles;
  public
    { Public-Deklarationen }
  end;

var
  HelpExplorer: THelpExplorer;

implementation

{$R *.dfm}

procedure THelpExplorer.Beenden1Click(Sender: TObject);
begin
  Application.Terminate;
end;

procedure THelpExplorer.InstallHelpFiles;
var
  Install: Tch2FormConfigStaticWebsearch;
begin
  //Hier will ich eine Instanz des WebHelp-Configurations-Formulars erstellen
  //um dann die Konfiguration vornehmen zu können
  FWebHlpInstallForm := Tch2FormConfigStaticWebsearch.Create(self);
end;

procedure THelpExplorer.Installieren1Click(Sender: TObject);
begin
  if HlpOpen.Execute then
  Begin
    FHelpFile := HlpOpen.FileName;
    //Hilfedatei hier registrieren

  End;
end;

procedure THelpExplorer.SpeedButton1Click(Sender: TObject);
begin
  Panel1.Visible := false;
end;

end.

Da erhalte ich allerdings bereits zur Entwurfszeit Fehlermeldung, das Tch2FormConfigStaticWebsearch nicht bekannt sei.

Ich konnte das Package problemlos übersetzen (Beta2) kann aber keine Kompos installieren und das Package auch nicht.
Ich erhalte bei Laden der Units für WinSearch und StaticWebsearch Fehlermeldung Klasse ... nicht bekannt.

Die Anwendung soll ein Hilfefenster bereitstellen und mit einem Menüpunkt Hilfe installieren die Konfig Formulare aufrufen um die Hilfedateien oder Weblinks entgegenzunehmen.

Aber ich kann die Anwendung nicht übersetzen. Was muss ich anders machen?

[Nintendo]

Hello,

Habe Probleme mit dem DocumentExplorer von MS. Wollte deshalb HelpExplorer probieren, der von hier runter zu laden geht:

http://download.cnet.com/Help-Explor...77ca9ceb&dlm=0

Habe den nun installiert und würde diesen nun gerne anstelle des dexplore.exe als Help Viewer verwenden.

Habe mit der Delphi-Menüfunktion "In Dateien suchen" die Datei dexplore.exe im Quellverzeichnis meiner CustomHelp Units gesucht, aber nicht gefunden. Werde jetzt noch in die Registry schauen, ob ich was finde.

Auf jeden Fall steht die Frage im Raum:

Wie kann ich diesen Help Explorer nun anstelle des dexplore.exe als Helpviewer verwenden?

Der kann alle Hilfeformate von Windows, einschließlich HxS anzeigen und wohl sogar HTML Hilfe.

Wer weiß Rat?


Momentan beschwert sich das schon mal installierte CustomHelp Package im Menü "Packages installieren" über eine nicht korrekt installierte dexplore.exe und das Häkchen wird von Delphi automatisch entfernt, auch wenn ich es per Mausklick wieder setzen will. Ich verwende Turbo Delphi Portable. Derzeit kein .NET installiert. Die portable Version akzeptiert das, aber ich habe dann keine integrierte Hilfe.

Wenn ich Registry-Einträge in den CustomHelp-Units an die Lage von HelpExplorer in der Registry anpassen muss, dann muss ich ja noch wissen, in welchen Units ich ändern muss. Leider komme ich da im Moment nicht weiter.


.