[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

[PeterPanino]

Zitat von chaosben:

@Peter: Guck mal, wer bei dir für das Protokoll "ms-help://" als Default-Handler registriert ist.

Mhm, wo kann man das nachgucken bzw. einstellen?

Wenn ich in Firefox ms-help:// eingebe, erscheint diese Meldung:

http://img249.imageshack.us/img249/6324/mshelp.gif

[chaosben]

Naja ... das Problem ist: Der Firefox kann keine MS-Help Dateien anzeigen, weil er einfach nicht weiß, wie er damit umgehen soll. Daher kommt der IE. Eine Alternative ist der MSHelp-Viewer. Da siehst du dann alles im selben Fenster. Oder du nimmst die WelcomePage.

[MarcoWarm]

Zitat von PeterPanino:

Mhm, wo kann man das nachgucken bzw. einstellen?

Hi Peter,

eine volle Diskussion (in Englisch) zu diesem Thema gibt es hier.
Die Essenz aus diesem Thread... -> Firefox kann kein ms-help.

Gruß
Marco

[KHJ]

Zusammen mit der Hilfe von EDB2 (Elevate Software) bekomme ich einen Fehler beim Start von Delphi wie in dem JPG zu sehen.
Ist das ein Fehler von EDB2?
Kann man den Fehler auch so abfangen, dass Delphi mit dem Start weitermacht und nicht auf OK wartet?

Danke für das tolle Tool.


Karlheinz

[chaosben]

Das ist jetzt Ansichtssache.
Einerseits ist es ein Fehler von EDB, das sie ihrer Hilfe keinen Default Index gegeben haben.
Andererseits kann man es auch anders sehen.
Für den Moment müsstest du mal auf diese Hilfe verzichten und wir denken man über eine Lösung nach.

[PeterPanino]

Ich habe jetzt - um das oben von mir angesprochene Problem zu lösen - den Microsoft Document Explorer als Viewer eingestellt. Funktioniert auch soweit gut, nur bei Google Codesearch gibt es ein Problem (bei Koders.com nicht): Die Suchergebnisseite wird zwar im Microsoft Document Explorer angezeigt, aber wenn ich auf einen Link klicke (XYZ.pas oder Zeilennummer), erscheint immer eine Fehlermeldung "In dem Skript auf dieser Seite ist ein Fehler aufgetreten". Kennt jemand eine Lösung für dieses Problem?

Alle diese Probleme könnten vermieden werden, wenn man den Viewer nicht generell für alle Suchergebnisse sondern je nach Hilfeprovider-Kategorie einstellen könnte, z.B.:

• Microsoft help 2.x: Microsoft Document Explorer

• Static Web based providers: Default Browser

Wenn ihr das einbauen könntet, würde ich euch für den Delphi-Nobelpreis vorschlagen!

[Alter Mann]

Hi,

CustomHelp -> Super!!!

Aber: Ich habe in einem Project die Konstante IOCTL_STORAGE_GET_MEDIA_TYPES markiert und F1 gedrückt.
Gesucht wird aber nicht der Konstantenbezeichner sondern der Wert hinter der Konstante2952192,
damit kleiner Minus-Punkt, schade.

Trozdem weiterso.

[MarcoWarm]

Zitat von Alter Mann:

Aber: Ich habe in einem Project die Konstante IOCTL_STORAGE_GET_MEDIA_TYPES markiert und F1 gedrückt.
Gesucht wird aber nicht der Konstantenbezeichner sondern der Wert hinter der Konstante2952192,
damit kleiner Minus-Punkt, schade.

Ja, das ist wirklich schade. Das hat aber mit dem Delphi-Hilfesystem an sich zu tun. Wir greifen "nur" das Keyword auf, daß von der IDE an das Hilfesystem gesendet wurde und suchen damit in den Hilfeprovidern. Der Konstantenwert wird also nicht von CustomHelp geparsed sondern wird von Delphi schon so an CustomHelp übergeben.

Wenn man nun ein System hätte um zu entscheiden, ob ein Suchwort sinnvoll ist oder nicht... na dann wär ich sicher schon bei google *lol*

Aber trotzdem danke für das Lob.

Übrigens. Wenn jemand für oben genanntes Problem eine schöne Lösung parat hat. Immer her damit. Im Moment sind unsere Entwicklerkapazitäten leider gebunden. (OT Datenbankreplikation mit Firebird... hmmmm feine Sache *grins*)

Gruß
Marco

[MarcoWarm]

Zitat von PeterPanino:

Wenn ihr das einbauen könntet, würde ich euch für den Delphi-Nobelpreis vorschlagen!

Ja das wär was... aber wie eben gesagt: Wir haben im Moment kaum Zeit dafür. Vielleicht reichst du ja ein Patchfile dafür ein Dann darfste den Nobelpreis auch mal halten (war ein Scherz)

Gruß
Marco

[willw]

Hi,

Please excuse me for rudely posting in English - my German is not up to the task. I am here courtesy of Google's translator.

CustomHelp is a superb tool, for which many thanks. I am singing its praises to my Delphi-using friends. Embarcadero should take note and copy.

You ask for suggestions. I have one. I very often find myself searching/grepping code for, typically, Windows API functions. I already know which Windows API function I need to call, but I first want to search the code base of the VCL and JEDI, to discover if the Delphi code to use it has already been written.

I realise that there are various tools for grepping from within the IDE - for example GExperts - but I wondered if you could allow easily-configurable grep searches from within your tool? I imagine being able to set up several searches on the VCL, JCL, JVCL etc. CustomHelp could shell to the grep that I believe is still included with Delphi, and provide clickable links to the hits that it found, each opening files at the appropriate place.

Apologies if this idea has already been proposed and rejected - or if you have better things time than extend this very complete tool.

Regards

Will Watts