[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

[chaosben]

Thank you Will for this suggestion. We'll think about it and maybe you'll read something about it in this thread.
Please be patient.

[MarcoWarm]

Neues Version 1.3

Hier zum SVN: http://code.google.com/p/theunknowno...state%3Dclosed
Oder zum SVN-Checkout: https://theunknownones.googlecode.co...CustomHelp/1.3

Ihr könnt jetzt so ziemlich alles finden
Wir haben jetzt als neues Feature die Windows Desktop Search eingebaut. Mit der Richtigen Abfrage könnt ihr also jetzt alle Dateien finden, die das Suchwort enthalten.

zum Beispiel:

Code:

ext:pas path:"C:\Users\MaWarm\Documents\Projects\Jedi\jwapi" $(HelpString)

Hier werden alle Pascal-Dateien gesucht, die in dem ausgewählten Pfad liegen und das Hilfewort enthalten.
Vorraussetzung ist natürlich, daß Pascaldateien mit Klartextfilter indiziert werden.

Vielleicht gefällts euch

Gruß
Marco

[chaosben]

Zitat von willw:

I wondered if you could allow easily-configurable grep searches from within your tool?

Hi Will,

It's not exactly grep but maybe it works for your purposes... Have a look at Version 1.3 for the Windows Search feature.

cheers
Ben

[chaosben]

Neues Release (bestimmt nicht fehlerfrei, aber entschieden smarter und hübscher) ... siehe oben

[youuu]

[DCC Fataler Fehler] CustomHelp_D140.dpk(38): E2202 Package 'TUOCommon' wird benötigt, konnte aber nicht gefunden werden

Erhalte ich als Fehlermeldung.

[chaosben]

Sorry ... hab ich wie immer vergessen: TUOCommon gibts per SVN hier

[Trigger2003]

Erstmal auch von meiner Seite vielen Dank und großes Lob für das tolle CustomHelp.

CustomHelp2 muß ich wohl leider erstmal lassen, da die Hilfe zu den von mir sehr viel verwendeten DevExpress-Komponenten anscheinend auch keinen DefaultIndex enthält.

[MarcoWarm]

Zitat von Trigger2003:

Erstmal auch von meiner Seite vielen Dank und großes Lob für das tolle CustomHelp.

CustomHelp2 muß ich wohl leider erstmal lassen, da die Hilfe zu den von mir sehr viel verwendeten DevExpress-Komponenten anscheinend auch keinen DefaultIndex enthält.

Wir haben die DevExpress Hilfe leider nicht zur Hand. Mit den Bordmitteln der API lässt sich (soweit wir wissen) leider nicht ermitteln welche Indizes in der Hilfe vorhanden sind. Eine Möglichkeit wäre den Indexnamen manuell einzugeben. Dazu müsste man ihn allerdings wissen. CustomHelp2 hat das Codemäßig schon vorgesehen (nur der Konfigurationsdialog kann es noch nicht)
Wenn ihr uns also nen Tipp geben könnt, wie der Index heißt oder wie man aus dem Hilfenamespace die verfügbaren Indizes bekommt... immer her damit. Und sagt nicht MSDN - die sagen dazu keine Silbe .
Was ich zum !DefaultKeywordIndex sagen kann ist, daß es er eben default ist (d.h. man sollte davon ausgehen können, daß er immer da ist) ... Das sagt auch die Anleitung zum Hilfeerstellen - aber das wiederrum ist ja das Problem von DevExpress.

Gruß
Marco

[youuu]

Hm, wie kommt dieser Fehler zustande?

Package C:\xxxxx\Bpl\CustomHelp_D140.bpl kann nicht geladen werden.
Das angegebene Modul wurde nicht gefunden.

Die .bpl ist aber aufjedenfall dort vorhanden.

[mkinzler]

Aber vielleicht eine andere Bpl, welche von ihr benötigt wird nicht