DP Help-Booster für Delphi 2006, 2007, 2009 und 2010 (BETA)

[Daniel]

Hallo zusammen,

ich habe eine Erweiterung für die Delphi-IDE geschrieben, die sich dem Thema 'Hilfe-Funktion' annimmt. Ein Problem der Hilfe ist die Tatsache, dass sie auf der sog. "MS Document-Explorer" aufbaut, der leider träge ist - und genau da setzt meine Erweiterung für die IDE an.

Meine IDE-Erweiterung bringt einen eigenen Index mit, der sich spürbar schneller aufrufen und nutzen lässt. Ganz wichtig hierbei: Diese Erweiterung bringt nur einen neuen Such-Index mit sich. Die Hilfe selbst muss im Rahmen von Delphi 2006 / 2007 bereits installiert und funktionsfähig sein.

Neben der Suche in der jeweils lokal vorliegenden Hilfe wird eine Online-Suche in der DP unterstützt: Mit den Direktiven dp:{Suchbegriff} bzw. cl:{Suchbegriff} könnt Ihr in der DP bzw. in der DP-Codelibrary suchen und gefundene Quellcode-Schnipsel über die Zwischenablage schnell in Eure Projekte einfügen.

• Installation:
  Herzlichen Dank an Andreas Hausladen, der mir einen auf Inno-Setup basierenden Installer für den Experten geschrieben hat. Download siehe unten. Dieser Installer beinhaltet alle benötigten Dateien für Delphi 2006 und Delphi 2007.
  
  
• Benutzung:
  Im Menü 'Hilfe' den Eintrag 'Help-Booster anzeigen' auswählen. Dann sollte sich ein neues Fenster öffnen, aus dem heraus gesucht werden kann. Beispielsweise nach 'hourglass', wenn man mal wissen will, wo die Cursor-Konstante 'crHourglass' definiert ist oder nach beliebigen anderen Dingen aus der Hilfe für Delphi f. Win32 sowie Teilen der PSDK für Win32 und .NET 2. Mit 'System.' vielleicht mal alle Funktionen, Typen und Konstanten aus der System.pas oder mit 'UTF8' sich einen Überblick verschaffen, welche Funktionen es in diesem Bereich so gibt.

Update 24. Januar 2008
Neue Version, die deutlich stabiler läuft als die Vorversionen. Download im Anhang. Wenn die letzten Startschwierigkeiten überwunden sind, können weitere Features hinzugefügt werden.


Update 29. Januar 2008
Die an diesen Beitrag angehängte Version funktioniert derzeit nur mit Delphi 2007. Ich werde am Abend eine Version erstellen, die dann wie geplant mit Delphi 2006 und Delphi 2007 funktionieren wird. Wer den HelpBooster mit Delphi 2006 einsetzen möchte, der lädt sich bitte die Datei herunter, die ich an folgenden Beitrag angeheftet habe: http://www.delphipraxis.net/internal...=838434#838434


Update 03. März 2008
Ich habe eine neue Version an diesen Beitrag angeheftet, sie beinhaltet die Neuerungen des Hilfe-Updates "Februar 2008" für Delphi 2007, einige Korrekturen im Index für Delphi 2006 sowie ein paar kleine Bugfixes. Das Setup ist für Delphi 2006 und Delphi 2007 geeignet.


Update 22. Oktober 2008
Beta für Delphi 2009 veröffentlicht. Download in Beitrag #81 dieses Threads.


Update 02. September 2009
Beta für Delphi 2010 veröffentlicht. Download in Beitrag #127 dieses Threads. Derzeit nur händische Installation ohne komfortables Setup.


Flash-Video, welches die Highlights demonstriert:
http://www.delphipraxis.net/videos/helpbooster/


Ausblick:
Neben Fehlerbereinigungen wird ein eigenständiger Konverter der nächste Schritt sein, mit dem jeder sich selbst seine Hilfe exportieren und in einen für den Help-Booster geeigneten Index konvertieren kann. Dies schließt dann die Hilfe von Drittanbietern explizit mit ein.

[MathiasSimmack]

Zitat von Daniel:

Ein Problem der Hilfe ist die Tatsache, dass sie auf der sog. "HTML-Help 2" aufbaut. Die dafür zuständige Maschinerie im Hintergrund ist der "MS Document-Explorer". Leider ist dieses Ding furchbar träge - und genau da setzt meine Erweiterung für die IDE an.

Darf ich korrigieren?

Dass die Hilfe von Delphi auf der MS Help 2.0 aufbaut, ist an sich erst mal kein Problem. Wenn man ihre Fähigkeiten richtig nutzt (geht an Borland, nicht an dich), dann ist sie durchaus nützlich. Und die zuständige Maschinerie im Hintergrund ist nicht der Document Explorer. Der DE nutzt die tatsächliche Maschinerie einfach nur. Ich habe für SharpDevelop auch nicht den DE genommen, sondern ich habe die Bibliotheken verwendet, die tatsächlich für die Hilfe zuständig sind.

[madtom]

Hallo Daniel,

wie immer vielen Dank für das PlugIn. Das Problem mit dem Anzeigen des PlugIn-Fensters habe ich nicht.
Ich habe das Fenster wie in Deinem Screenshot neben dem OI plaziert und den Desktop abgespeichert.
Und "Wuppdi ", auch nach dem 3. Start ist das PlugIn noch an seinem Platz.

Kleine Wunschliste:
1. Vielleicht einen Shortcut aka F11 für den OI oder F1 für die Hilfe, wie wäre es mit Strg + D + P
2. Das PlugIn als OpenSource, damit wir "Nicht-Profis" dazulernen können...

Beste Grüße

madtom

[halinchen]

Ich finde das prima!

Vorallem kann man nach <Klasse>.<Eigenschaft> suchen. Oder <Unit>.<Funktion>.

Mich würde es auch interessieren wie sowas geht.

@madtom: Toller Tipp. Bei mir geht's auch.

edit: Schade, es zeigt das PlugIn zwar bei jedem Start an, aber wenn man was eingibt passiert nichts.

[madtom]

Zitat von halinchen:

Ich finde das prima!

Vorallem kann man nach <Klasse>.<Eigenschaft> suchen. Oder <Unit>.<Funktion>.

Mich würde es auch interessieren wie sowas geht.

@madtom: Toller Tipp. Bei mir geht's auch.

edit: Schade, es zeigt das PlugIn zwar bei jedem Start an, aber wenn man was eingibt passiert nichts.

Sorry, das hatte ich dann nicht mehr geprüft...

[semo]

ich wollte das auch gerade einmal testen.
nur hindert mich folgendes am import der bpl:
unit virtualtrees ist bei mir bereits in einem package vorhanden....

[Daniel]

@Matthias: Ich werde mir SharpDevelop mal zum Vergleich installieren, danke für den Hinweis. Ich kannte bislang nur zwei konkrete Anwendungen, die dieses Hilfesystem [samt Document Explorer] nutzen (Delphi und das VisualStudio) und in beiden Fällen empfinde ich die jeweilige Wartezeit beim Suchen als störend.

@Marcus: urgs. Ich hatte sowas befürchtet. Wenn ich das richtig sehe, darf ich den VT nicht mit einkompilieren, sondern muss ihn in seinem Package lassen und selbiges mit ausliefern? Das sind so die Punkte, bei denen ich mal auf die Suche nach geeigneter Doku gehen muss.

[MathiasSimmack]

Zitat von Daniel:

Ich kannte bislang nur zwei konkrete Anwendungen, die dieses Hilfesystem [samt Document Explorer] nutzen (Delphi und das VisualStudio) und in beiden Fällen empfinde ich die jeweilige Wartezeit beim Suchen als störend.

Der DE wird immer installiert. Ich nehme an, Microsoft hat keinen anderen Viewer. Aber innerhalb des Visual Studio wird er nicht benutzt. Anders herum wird ein Schuh draus. Die Bibliotheken mit den Funktionen werden vom DE benutzt.

Und die Suchgeschwindigkeit hängt von der benutzten Hilfesammlung inkl. deren Plugins ab. Und davon, womit du suchst. Die Volltextsuche beansprucht sicher mehr Zeit als die dynamische Hilfe. Intern werkel der gleiche Suchmechanismus, nur wird ein anderer Indexwert genutzt, der bspw. bei der dynamischen Hilfe nur nach bestimmten Schlüsselworten geht. Eine echte Textsuche findet also gar nicht statt, sondern es werden nur bestimmte Werte ausgelesen und bei Übereinstimmung angezeigt.


Wie dem auch sei, ein bisschen bedaure ich, dass ich kein Delphi habe, um dein Plugin mal zu testen, oder um mal zu versuchen, die Hilfe zu integrieren, so wie das beim Visual Studio oder bei SharpDevelop der Fall ist. Andererseits mag ich den Umgang mit CSharp, und ich muss gestehen, ich vermisse Delphi nicht wirklich. Nur ein paar alte Tools kann ich eben nicht anpassen. Die muss ich neu schreiben.

[Daniel]

Update auf Beta #3, Download im ersten Beitrag.

[edit]
Ich hoffe, ich habe mir durch die Verwendung der INDYs kein neues "Ei gelegt". Durch die Fallstricke der Package- und Unit-Verwaltung innerhalb der IDE bin ich noch nhicht vollends durchgestiegen.

[/edit]

[madtom]

Hallo Daniel,

Dein ShortCut Strg + Shift + F12 beisst sich bei mir mit den Visual Forms,
die anscheinend genauso aufgerufen werden, jedenfalls oeffnet sich bei mir
nicht dein PlugIn, sondern die Visual Forms. (Sorry fuer die Umlaute, habe
hier nur eine franzoesische Tastatur )

Gruss

Thomas