[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

[MarcoWarm]

Hallo Andre,

soweit ich das bis jetzt rausbekommen habe, ist der Fehler einizig und allein auf den THelpSelector beschränkt. Ich denke es könnte irgendein Problem bei der Referenzzählung des IHelpSystem sein. Aber wie man dem entgegenwirkt?

[MarcoWarm]

neue Release... Alle Änderungen von a-s-z-work sind jetzt eingepflegt.
+ Möglichkeit der Prüfung, ob ein Keyword überhaupt in einer WindowsHilfe (*.hlp) Datei vorkommt. z.B. d7.hlp

[Kalfany]

Das Projekt lässt sich unter D2007 nicht mehr laden:

Zitat:

Das Projekt kann nicht geladen werden, weil die erforderliche Personality Delphi.Personality.12 nicht zur Verfügung steht.

(kommt bei beiden Projekt Dateien, D100 & D120)

[chaosben]

Ich hab dir mal ein D2007-Projekt ins Repository gepackt. Probiers mal damit.

[mleyen]

Die Direktive VER180 und VER185 sind beide aktiv, d.h. REG_ROOT_KEY wird doppelt definiert.
VER180 entfernt und es läuft super unter D11. Danke

[chaosben]

Hey, danke! So ist das wenn man kein D2007 zur Hand hat. Habs im Repository korrigiert.

[MarcoWarm]

Neue Woche neue Version.

Es ist jetzt möglich neben Urls und HtmlHelp, WinHelp Dateien auch beliebige Pfade als Hilequelle anzugeben.
Der Suchbegriff wird entsprechend dem Platzhalter $(HelpString) eingefügt.
z.B.:

Code:

"C:\Program Files (x86)\Adobe\Reader 9.0\Reader\AcroRd32.exe" /A "zoom=50&navpanes=1=OpenActions&search=$(HelpString)" "C:\Users\MaWarm\Documents\Help\BDS4 Reference.pdf"

öffnet und sucht in einer PDF-Datei.

Es werden nun auch alle anderen Umgebungsvariablen ersetzt (z.B. $(BDS) )

viel Spaß damit

Gruß
Marco

[Kalfany]

Zitat von chaosben:

Hey, danke! So ist das wenn man kein D2007 zur Hand hat. Habs im Repository korrigiert.

Funktioniert, Danke!

[chaosben]

Da wir nun endlich die Idee hinter SVN so halbwegs verstanden haben, hat sich die URL im ersten Beitrag geändert.

Es gibt jetzt im SVN unter tags/Release/CustomHelp eine saubere Release-Kultur, damit ihr nicht jeden Blödsinn mitmachen müsst, den wir verbrechen.

[mkinzler]

Deshalb hat er bei mir gestern, alles neu heruntergeladen