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

@Christof und Heiko:
Probiert mal bitte die Version aus dem Trunk und sagt bitte Bescheid, ob sich was geändert hat.

[HeikoAdams]

Meldung "Falscher Parameter" kommt immer noch

[mleyen]

Genauso wie folgendes bei der erstmaligen Installation des CustomHelp Packages in D2k7+2010:

Code:

---------------------------
CustomHelp2 - CodeGear RAD Studio for Microsoft Windows - CustomHelp2.dproj
---------------------------
Error upon initializing MS Help Namespace "MS.NETFramework.v20.deu"
Die Auflistung hat keine Titel oder Titel fehlen

Namespace will be disabled.
---------------------------
OK   
---------------------------

Unter 2010 kamen ca. 5 solcher Meldungen.

[chaosben]

@Marcel:
Ja ... das ist "in Ordnung" so. Das passiert nur einmal am Anfang wenn CustomHelp versucht, alle HX-Hilfen zu benutzen.

[HeikoAdams]

Noch ein kleines Problem: Die DockableHelpGui funktioniert unter Delphi 2K6 nicht. Es passiert absolut nichts, wenn man auf F1 klopft

[chaosben]

Das "DockableHelpGui in 2k6"-Problem und der OLE-Fehler sind nun im Trunk gefixt.

[ckluss]

Hallo Benjamin,

mit den Versionen aus
http://theunknownones.googlecode.com...phi/TUOCommon/
http://theunknownones.googlecode.com...i/CustomHelp2/

geht es bei mir unter Delphi 2010 jetzt fehlerfrei, soweit ich es sehe.

Ich habe jetzt die aus D15 genommen, was hat es mit den D.. Versionen auf sich?

Gruß
Christof

[mkinzler]

D12 ist D2009
D14 ist D2010
D15 ist Delphi XE

[himitsu]

Code:

Name           IDE-Version    Compiler/VCL-Verion
Delphi 1      1             8.0  (VER80)
Delphi 2      2             9.0  (VER90)
Delphi 3      3             10.0 (VER100)
C++ 3         3.5           11.0 (VER110)
Delphi 4      4             12.0 (VER120)
Delphi 5      5             13.0 (VER130)
Delphi 6      6             14.0 (VER140)
Delphi 7      7             15.0 (VER150)
Delphi 8      8             16.0 (VER160)
Delphi 2005   9             17.0 (VER170)
Delphi 2006   10            18.0 (VER180)
Delphi 2007   11            19.0 (VER190)
Delphi 2009   12            20.0 (VER200)
gibt's nicht   (13)           (vonwegen Unglück und so)
Delphi 2010   14            21.0 (VER210)
Delphi XE      15            22.0 (VER220)

Mit XE sollte (laut einer Aussage auf den DT) ja die Versionsnummer verschwinden,
was eigentlich nicht schlecht ist, denn dann gäbe es nur noch eine Nummer (Compilerversion),
aber mit XE2 geht das Debakel leider wieder los

[HeikoAdams]

Eine Sache ist mir noch aufgefallen: Unter Delphi 2K6 lassen sich keine Artikel aus der Delphi-Hilfe öffnen.