[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 HeikoAdams:

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

Naja ... das ist das OLE-Fehler-Problem. Im Moment habe ich das nur durch eine try except abgefangen. Dadurch werden im schlimmsten Fall alle HX-Hilfen (also auch die Delphi-Hilfe) ignoriert.

Dummerweise tritt das OLE-Problem bei mir nicht auf - deswegen stehe ich mit der Sache ein bißchen im Regen. Aber noch ist nicht aller Tage Abend.

[ckluss]

OK, danke für die Versions-Einführung. Customhelp2 scheint auch mit 15 (statt 14) unter Delphi 2010 zu funktionieren dann lasse ich es erst mal so.

[Kalfany]

Nachdem mit die Delphi (2007) Hilfe mal wieder nervt dachte ich mir vorhin ich probiere mal die Version 2 vom CutomHelp. Hab mal die aktuellste Version ausm Trunk genommen. Leider mag der die HLP Dateien irgendwie nicht mehr, die Delphi 5 HLP werden garnichtmehr geöffnet und bei den anderen wird keine Suche mehr durchgeführt. Gibts da irgendwelche Änderungen bzgl. HLP (hab die letzten 6-7 Seiten jetzt nichtmehr gelesen)

Eine Anregung hätte ich noch ... bei den Dialogen fürs Einstellen der Helpprovider wärs supi wenn man die per ESC schließen könnte (also ESC = OK)

[chaosben]

Zitat von Kalfany:

Gibts da irgendwelche Änderungen bzgl. HLP (hab die letzten 6-7 Seiten jetzt nichtmehr gelesen)

Nö .. nicht wirklich ... das ist in Wirklichkeit nur ein Starten von "winhlp32.exe -k Keyword d:\deine\datei.hlp". Das kannste ja mal in der cmd ausprobieren. Wenn du ne bessere Art kennst .hlp-Dateien zu benutzen, lass es uns bitte wissen.

Zitat von Kalfany:

bei den Dialogen fürs Einstellen der Helpprovider wärs supi wenn man die per ESC schließen könnte (also ESC = OK)

Joa ... wird eingebaut. Danke

[Kalfany]

also über cmd gehts wunderbar, habs jetzt einfach als Shell-Hilfe eingerichtet
(bessere Möglichkeit kenn ich leider auch nicht)

Dann hätte ich da gleich noch was:
im DockableHelpGUI kann man in die ComboBox nix per STRG+V einfügen (X und C geht auch nicht )

Und was mich auch extrem irritiert (war in der Version 1 glaub ich auch schon)
Wenn man den Config-Dialog aufmacht dann ist die Liste der Helpprovider jedes mal anders sortiert (scheinbar passiert das nur wenn überall Priorität 0 eingetragen ist)

[HeikoAdams]

Zitat von Kalfany:

Und was mich auch extrem irritiert (war in der Version 1 glaub ich auch schon)
Wenn man den Config-Dialog aufmacht dann ist die Liste der Helpprovider jedes mal anders sortiert (scheinbar passiert das nur wenn überall Priorität 0 eingetragen ist)

Anscheinend werden die Provider nur nach der Priorität sortiert. Vielleicht wäre es sinnvoller, die Provider nach Priorität und Name zu sortieren.

[chaosben]

In Version 1 konnte man die Provider in der Listbox draggen und droppen und so die Sortierung vorgeben.
In Version 2 gehts ausschließlich über die Priorität. Also einfach jedem Provider eine eindeutige geben und schon bleibt die Liste wie ihr sie haben wollt (Vielleicht bauen wir noch mal den Drag'n'Drop Sortierung ein.)

[MarcoWarm]

Neue Version 2.0 beta 2

Dateien hier: http://code.google.com/p/theunknowno...mHelp/2.0beta2
SVN hier: https://theunknownones.googlecode.co...mHelp/2.0beta2

Was ist neu?

• Ole Fehler wurde behoben
• Esc-Taste beendet den Konfigurationsdialog
• Sortierung der Provider mittels Drag'n'Drop
• Indexnamen pro HxNamespace sind jetzt wählbar bzw. frei eingebbar.

Gruß
Marco

[himitsu]

Blos mal 'ne Frage:

Ich suche was, um die Delphi-Reference in die Delphi-IDE einzubinden.

Allerdings steht diese möglichkeit hier nur als 'ne Art "Addon" mit dabei.
Ist das hier nun die Einzige möglichkeit, um die Delphi-Reference via F1 in Delphi zu nutzen oder gab's da noch was Anderes?


Die Integrierte OH im Delphi ist ja sowas von garnicht nutzbar (ständig nur "kenn ich nicht" als Antwort, aber auf docwiki.embarcadero.com ist nun doch abundzu mal was zu finden),
wobei dieses ja auch netter Weise in der Delphi-Referenz mit gelistet wird.

[MarcoWarm]

Zitat von himitsu:

Ich suche was, um die Delphi-Reference in die Delphi-IDE einzubinden.

Das ist zur Zeit nicht möglich. CustomHelp ist ja darauf angewiesen prüfen zu können, ob es ein gültiges Suchergebnis gibt oder nicht. Im Falle einer Websuche ist das jedoch nicht möglich, ohne das Resultat zu parsen. Daher bieten wir die Suche über RSS provider an. Ein schönes Beispiel ist:

http://codelib.theunknownones.net/ ... das ist unser Hilfeindex für unindizierte Referenzen auf :

• docwiki.embarcadero.com
• help.delphi-jedi.org
• www.delphibasics.co.uk

Falls du Daniel überreden möchtest seine Suchergebnisse als RSS zur Verfügung zu stellen, steht der Nutzung der Delphi-Reference in CustomHelp nichts im Wege.

Gruß
Marco