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:

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. :stupid: 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 :-D ", 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 :mrgreen:
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:

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... :pale:

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

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. :stupid: 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. :oops: Nur ein paar alte Tools kann ich eben nicht anpassen. Die muss ich neu schreiben. :lol:

[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 :wall: )

Gruss

Thomas

[Daniel]

Bei mir im Büro auch. :stupid:
Die einzig sinnvolle Lösung wird wohl ein konfigurierbarer Shortcut sein. *seufz* Kommt. ;-)

[madtom]

Daniel,

ich staune nur, wie Du quasi taeglich neue Features in Dein PlugIn
einbaust. Ich als Hobby-Progger brauche fuer alles etwas laenger. :|

[Daniel]

Update auf Beta #4.
Ich habe zwei Fehler korrigiert, die für je eine Schutzverletzung verantwortlich waren.

[Sharky]

Hai Daniel,

könntest Du das ganze auch für Delphi 2006 machen?

[Daniel]

Ich denke schon. Kannst Du mal die Hilfe von TPanel aus dem Delphi 2006 aufrufen und mir die URL (mshelp:// ...) geben bitte? Ich denke, dass da irgendwas mit bds4 stehen sollte.

[edit]
Ich vergaß, dass ich hier ja selber ein Delphi 2006 habe. Ich kann den Experten auch für Delphi 2006 bereitstellen, muss dann aber die URLs anders aufbereiten. Mal gucken, wie der Tag läuft, ich hoffe, dass ich am Abend dazu kommen werde.
[/edit]

[Sharky]

Guckst Du:

Code:

ms-help://borland.bds4/bds4win32api_win32/html/DelphiWin32_ExtCtrlsTPanelClass.htm

[Daniel]

Ich habe das gerade mal geprüft. Die beworbene Binärkompatibilität ist tatsächlich gewährleistet, so dass das kompilierte AddIn (s. erster Beitrag) sowohl unter Delphi 2007 als auch unter Delphi 2006 läuft. Bleibt als letztes Problem der Hilfe-Index, den ich für Delphi 2006 noch nicht neu kompiliert habe.

Die Sourcen für den Indexer habe ich nicht hier im Büro, so dass ich da erst am Abend was z'ammenbasteln kann.

[Sharky]

Zitat:

Zitat von Daniel

.... sowohl unter Delphi 2007 als auch unter Delphi 2006 läuft. ....

Hmmm.... wen ich das Package installieren möchte kommt die Fehlermeldung im Anhang.

[MagicAndre1981]

warum braucht das Addin Indy? Den Müll hab ich nicht installiert und will ich auch nicht installieren.

[Phoenix]

Weil es mit der DP kommuniziert (Suchanfragen)? ;-)

[MagicAndre1981]

:cry: ok, dann kann ich es nicht ausprobieren. schade

[Phoenix]

Was hast Du denn gegen die Indys?

[MathiasSimmack]

Ein kleiner Einhaker (off-topic):

Zitat:

Zitat von Daniel

Ich denke, dass da irgendwas mit bds4 stehen sollte.

I lost track, wie man so schön sagt. Delphi 2007 bzw. die Turbos sind dann "borland.bds5"? :gruebel: Ich habe nämlich gerade beim Lesen an das Setup von Michas Tutorials gedacht, und siehe da: dort endet die Integration bei "bds4".

[Phoenix]

Ich dachte: Delphi 8 = BDS 1.0, BDS 2005 = BDS2, BDS 2006 = BDS3, demnach müste RAD Studio 2007 eigentlich BDS4 sein?

[mkinzler]

Du hat C#-Builder vergessen

[MagicAndre1981]

BDS2 war imho der C# Builder.

@Phoenix

ich will halt nur das nötigste installieren und Indy brauch ich einfach nicht.

[Daniel]

@Mathias:

Anbei jeweils drei exemplarische Help-URLs:
//Delphi 2007:
//ms-help://borland.bds5/delphivclwin32/StdCtrls_TButton.html
//ms-help://borland.bds5/delphivclwin32/StdCtrls_TButton_Click.html
//ms-help://borland.bds5/delphivclwin32/ExtCtrls_TPanel.html

//Delphi 2006:
//ms-help://borland.bds4/bds4win32api_win32/html/DelphiWin32_StdCtrlsTButtonClass.htm
//ms-help://borland.bds4/bds4win32api_win32/html/DelphiWin32_StdCtrlsTButtonClickMethod.htm
//ms-help://borland.bds4/bds4win32api_win32/html/DelphiWin32_ExtCtrlsTPanelClass.htm


@André:
Ich kann im Moment nicht nachvollziehen, warum Du die Indy-Komponenten pauschal als "Müll" abwatscht, aber ich werde das Addin umstricken, so dass dies kein Problem mehr darstellen wird. Ich habe hier gerade leichte Tumulte rund um das Erzeugen des Fensters - das klappt immer noch nicht in allen Fällen problemlos.


@Sharky: hups. Ich schaue mir das an.

[MagicAndre1981]

Müll ist vllt übertrieben, aber mir gefallen die Indys nicht. ich hatte vor Ewigkeiten nur Probleme und hab dann eine andere Kompo genommen.

[RavenIV]

Zitat:

Zitat von MagicAndre1981

Müll ist vllt übertrieben, aber mir gefallen die Indys nicht. ich hatte vor Ewigkeiten nur Probleme und hab dann eine andere Kompo genommen.

Was hast Du dann genommen?
Ich möchte nämlich die Indys auch loswerden...

[MagicAndre1981]

[OT]Ich hab dann Internet Component Suite (ICS) (http://www.overbyte.be) genommen.[/OT]

[Daniel]

Sodala ... ich habe Euch nicht vergessen. Der Experte ist jetzt ein DLL-Experte und damit habe ich die Probleme mit den Packages / Units erschlagen. (Dafür muss ich mir was zum Thema 'Installation' einfallen lasse - DLL-Experten müssen über die Registry installiert werden.) Die Fenster-Logik habe ich neu geschrieben und es schaut gut aus, keine Verklemmungen oder Schutzverletzungen bisher. Der Code lässt sich auch unter Delphi 2006 kompilieren, so dass ich diese IDE ebenfalls bedienen kann.

Aktuell sitze ich am Indexer, der nun für die verschiedenen Hilfedateien (Delphi 2007 f. Win32, Delphi 2006 f. Win32, PSDK f. Win32, Delphi 2007 f. .NET, Rave, Indy und was ich noch so finden kann) geeignete Index-Dateien erzeugen wird. Ich stelle mir vor, dass dieser Vorgang automatisiert ablaufen wird und bin da auch schon ganz gut dabei. Diese Phase ist gerade ein wenig "fummelig", da jede der o.g. Hilfe-Dateien syntaktisch etwas anders aufgebaut ist und ich somit einen wachsenden Haufen an regulären Ausdrücken vor mir habe, um die Stichworte den jeweiligen Seiten zuordnen zu können. Ich halte Euch auf dem Laufenden.

[GuenterS]

Ich habe es gerade probieren wollen, habe allerdings kein BDS sondern eine Turbo Delphi Prof. Version. Hat damit leider nicht so problemlos funktioniert, bekam nur Fehlermeldung:

Zitat:

Zitat von Turbo Delphi: bds.exe - Einsprungspunkt nicht gefunden

Der Prozedureinsprungspunkt "@Dwmapi@initialization$qqrv" wurde in der DLL "rtl100.bpl" nicht gefunden.

Ok, ich habs schon auch gelesen dass a) beta ist b) nur von Delphi 2007 & 2006 die Rede war, aber vielleicht ist eine Modifikation möglich, dass auch die Turbo Delphi Prof. Besitzer dieses Addin verwenden können.

[halinchen]

Zitat:

Zitat von Daniel

:!: 16. Okt. 2007: Update auf Beta #4
- bugfix: AddIn konnte ggf. nach ein- oder mehrmaligen Schließen und Neu-Aufrufen eine Schutzverletzung verursachen

Wenn ich es angedockt habe, zeigt es das PlugIn bei jedem Start der IDE an. Man kann auch was eingeben und es funktioniert. Wenn ich die IDE beende kommt ein Fehler "ungültige Zeigeroperation". Das ganze aber nur, wenn es angedockt ist. Sonst kommt kein Fehler.

[Daniel]

So, im ersten Beitrag gibt's eine neue Version, die nun hoffentlich stabiler läuft und - das ist neu - sowohl Delphi 2006 als auch Delphi 2007 bedient.

[Insider2004]

Reife Leistung!!! Damit wird D2007 zum ersten Mal brauchbar!

Was fehlt (1. Gedanke):

-History (mit Combobox)
-Filter für Kategorien
-Speicherung des letzten Zustandes
-Installer (a la DelphiSpeedup). Nimm doch den von Andreas ;-)

[RavenIV]

Zitat:

Zitat von Daniel

[*]Benutzung:
Im Menü 'Hilfe' den Eintrag 'Delphi-PRAXiS 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. 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.[/list]

Warum lautet der Menueintrag "Delphi-PRAXiS Help-Booster anzeigen"?
Hätte "Help-Booster" oder ähnlich nicht auch gereicht?

[MagicAndre1981]

:shock: Wow, das Ding ist echt praktisch :thumb:

Ein Installer währe noch ganz nett :)

[Prototypjack]

Moin,

Wow, ich bin beeindruckt! Sehr gute Arbeit, die du da geleistet hast!
Ich habe mit meinem Delphi 2006 Prof. keinerlei Probleme (im Gegenteil, das Ding funktioniert so gut, ich fang' gleich an zu heulen :mrgreen: )

Für diejenigen, die die GExperts installiert haben gibt es einen alternativen und leichteren Weg zur Installation. Man klicke einfach auf "Expert Manager..." und fügt dort die entsprechende Version des DP-Experten hinzu. Noch die IDE neustarten und wuppdi!

Grüße,
Max

[jbg]

Ist das Absicht, dass die Indy-Units implizit in die DLL eingebunden wurden statt die Indy-BPLs in die Runtime-Package Liste aufzunehmen?

[Daniel]

Ich wollte eigentlich alles an Bord haben, um auch bei denen, die die Indys rausgeworfen haben ( = Dateien physikalisch gelöscht) eine Online-Suche bieten zu können.

Du hast da ohne Zweifel deutlich mehr an Erfahrung. Ist mein Ansatz denn keine so gute Idee?