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

Zitat von Daniel:

Eins vielleicht noch: Wenn Ihr "nur" ein HTTP-GET auf die Delphi-Referenz absendet (und kein HTTP-POST), dann braucht es die zusätzlichen Parameter nicht mehr

Die Modifikation des Programmteils wurde zeitnah umsgesetzt. Vielen Dank für Ihre Mitarbeit.

Diese Nachricht wurde maschinell erstellt, und ist ohne Unterschrift gültig

[Pilloker]

Danke Euch; werde es mal testen

[MarcoWarm]

Es gab gerade ein minor update:

http://theunknownones.googlecode.com...ustomHelp/1.1/

Die meisten Änderungen gehen auf das Konto von a-s-z-work.

Vielen Dank

edit:
minor statt major

[toms]

Zitat von MarcoWarm:

Es gab gerade ein major update:

Changelog?

[MarcoWarm]

Die genauen Änderungen kannst du bei asz-work erfragen.
Ein laufendes ChangeLog gibts hier

Gruß
Marco

[MarcoWarm]

Version 1.2 ist da.

Neuerungen:

• Suche per Shell-Kommando
• Suche dynamisch via RSS-Feeds. (z.B. Suchresultate von Bing)
• Es ist hübscher

Ein Beispielvideo gibts im 1. Post oder hier

Gruß
Marco

[MarcoWarm]

Und kurz vor dem Wochenende Version 1.2.1

Neues?

• Auswahlmöglichkeit, an welcher Stelle Drittanbiterhilfen (z.B. madHelp) in den Resultaten erscheinen.
• Farbauswahl pro Drittanbieterhilfe

Achtung: madHelp funktioniert (noch?) nicht unter BDS2006 zusammen mit CustomHelp. Unter D2009 geht es problemlos.

Gruß
Marco

[chaosben]

Das gehört jetzt zwar nicht direkt hierher, aber passt trotzdem:

Wer öfter mal die WelcomePage schließt (weil man sich darin die Hilfe angeschaut hat oder warum auch immer) aber möchte, das man sie hat, sobald keine Projekte mehr offen sind, kann mal den WPForcer (WelcomePage-Forcer ) probieren ... der macht nämlich genau das.

[MarcoWarm]

Version 1.2.2

Unter Delphi 2010 (manchmal auch unter 2009) kam es vor, daß nur nach dem aktuellen Unitnamen gesucht wurde. Das passierte dann, wenn das Hilfesystem eine Typendeklaration nicht auflösen kann. (z.B. wenn die Unit, die den Typ implementiert, nicht eingebunden ist) Dann sucht das Hilfesystem mittels "erroneous type" bzw. "meineUnit.erroneous type" ... Version 1.2.2 ermittelt in diesem Fall das Wort unter dem Cursor und sucht dann damit in der Hilfe.
Delphi 2006 ist davon nicht betroffen.

Gruß
Marco

[Stéphane Wierzbicki]

Hello,

I just wanted to thank you for this awesome help expert
This saved my day....

DANKE SCHOEN !

BR

Stephane

Ps : Sorry aber mein Deutsch ist sehr schlescht