[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]

Zitat von youuu:

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

Hast du das Package sauber umbenannt? Auch das Lib-Suffix? (Projekt->Optionen->Beschreibung)

[youuu]

Wieso umbenannt?
Ich habe es per SVN runter geladen und installieren wollen, ohne weiteres zu tun.
Hab ich da ewas vergessen?

[chaosben]

Weil da in dem Pfad "_D140" steht ... so ein Projekt haben wir aber im Repository (noch) nicht.
Für dein Delphi 2009 hat du bestimmt das Projekt aus dem D12-Ordner genommen ... richtig?

[youuu]

Nein ich hab es nur noch nicht hier aktualisiert, ich arbeite mit D2010.

CustomHelp_D140.dproj so hießen die Dateien die ich per SVN gelade habe.
Version 1.30

[MarcoWarm]

Zitat von youuu:

ich arbeite mit D2010.

Das ist leider unser Problem, wir (TUO) haben kein D2010 zur Hand. Ich denke Delphi findet beim laden von CustomHelp irgendein abhängiges Modul (bpl o.ä.) nicht. Aber wenn die Fehlermeldung so karg ist, wie du sie geschrieben hast steh ich ganz schön im Wald.
Vllt. sagt Delphi ja noch mehr?
Vielleicht hat ein anderer D2010 Nutzer ja nen Tip. Das D140 Package ist sozusagen bei uns im Blindflug entstanden, sorry.

Gruß
Marco

[youuu]

Zu allererst wird beim Compiliere dieser Fehler ausgeworfen

[DCC Fataler Fehler] CustomHelp_D140.dpk(53): F1026 Datei nicht gefunden: 'uCustomHelpTlbSearchAPILib.dcu'
[DCC Fataler Fehler] CustomHelp_D140.dpk(54): F1026 Datei nicht gefunden: 'uFrameConfigWinSearch.dcu'

Ok kein problem, habe ich pr Hand importiert.

Dann dieser Warnhinweiß
[DCC Warnung] CustomHelp_D140.dpk(59): W1033 Die Unit 'Spin' wurde implizit in Package 'CustomHelp_D140' importiert



Dann beim installieren:

2.1 Date : Mon, 20 Sep 2010 10:59:28 +0200
2.2 Address : 5003570B
2.3 Module Name : rtl140.bpl - (Embarcadero Component Package)
2.4 Module Version: 14.0.3593.25826
2.5 Type : EPackageError
2.6 Message : Package C:\Users\Public\Documents\RAD Studio\7.0\Bpl\CustomHelp_D140.bpl kann nicht geladen werden.
Das angegebene Modul wurde nicht gefunden.
2.7 ID : 1BCF
2.8 Count : 1
2.9 Status : New
2.10 Note :

Package C:\Users\Public\Documents\RAD Studio\7.0\Bpl\CustomHelp_D140.bpl kann nicht geladen werden.
Das angegebene Modul wurde nicht gefunden.

[MarcoWarm]

Danke für den ausführlichen Fehler....

allerdings weiß ich jetzt erstmal nicht weiter. Vllt kann jemand anderes was daraus machen. (oder uns ein D2010 schenken )

ich denke denke denke weiter drüber nach

Gruß
Marco

[MarcoWarm]

übrigens kannst du auch Version 2.0 Versuchen.
da gibts zwar noch kein D2010 Projekt aber das kann man sich ja aus dem D2009 Projekt selber erstellen.
Das geht dann vielleicht und ist auch noch nen Zahn cooler

Gruß
Marco

[ckluss]

Hi,

die D12 Version von TUOCommon.dpk und 2.0beta1/D12 von CustomHelp lässt sich unter Delphi 2010 zwar Problemlos installieren. Aber ich bekomme bei F1 die Meldung "Falscher Parameter" EOleException.

Habt ihr eine Idee, was da los ist?

Gruß
Christof

[HeikoAdams]

Zitat von ckluss:

die D12 Version von TUOCommon.dpk und 2.0beta1/D12 von CustomHelp lässt sich unter Delphi 2010 zwar Problemlos installieren. Aber ich bekomme bei F1 die Meldung "Falscher Parameter" EOleException.

Das selbe Problem hier mit der D10 Version und Delphi 2K6