Help 2.0-Addin für SharpDevelop

[MathiasSimmack]

So, ich stelle hier mal mein erstes, richtig großes CSharp-Projekt rein. Es rüstet SharpDevelop mit einer integrierten Hilfe aus, ähnlich dem Visual Studio. Das heißt, ihr habt Inhalt, Index und Volltextsuche in der Entwicklungsumgebung und müsst den externen Betrachter eigentlich nicht mehr starten.

Ein paar Hinweise:

1. Ohne Help 2.0 geht es jetzt auch. Das heißt: Eigentlich geht es nicht, aber zumindest verursacht das Addin nun keinen Fehler mehr, und SharpDevelop startet. Die Controls sind dann eben bloß alle deaktiviert und lassen sich nicht benutzen. Ohne Hilfesystem ja auch irgendwie logisch.
2. Die Anordnung der Pads kann ich leider nicht beeinflussen. Standardmäßig gehören Index- und Suchergebnisse nach unten (zu Ausgabe und Aufgaben), das müsstet ihr bitte selbst machen.
3. Das Addin sucht standardmäßig nach einem bestimmten Namespace. Wenn der nicht vorhanden ist, dann benutzt es die erste Help 2.0-Collection, die es findet. Das ist ein Kompromiss, weil ich ja nicht weiß, was auf euren Systemen alles installiert ist. Über "Extras/Optionen/Tools/Help 2.0-Environment" könnt ihr aber einstellen, was ihr sehen wollt. Das kann das .NET Framework SDK sein, das PSDK, oder sogar Luckies Win32-API-Tutorials ...
4. Die aktuell angezeigte Collection und eure Favoriten findet ihr in zwei XML-Dateien (help2*.xml) im Konfig-Ordner von SharpDevelop (%Profil%\Anwendungsdaten\.ICSharpCode\SharpDevelo p).
5. Es kann passieren, dass die Toolbar plötzlich verschwindet und der Hintergrund eures Desktop zu sehen ist. Ich habe keine Ahnung, was für dieses Problem verantwortlich ist. Auch die normale SharpDevelop-Toolbar wird nicht anders eingebunden als meine. Na ja, , einmal minimieren und maximieren, bzw. die Toolbar manuell nach unten ziehen, und die Sache ist erledigt.

Jetzt zum Quellcode und damit zu den Leuten, die nicht die o.g. Version haben. (So wie ich mit meiner CVS 1.1.0.1839.) Zum Kompilieren solltet ihr am besten NAnt benutzen. Das Tool befindet sich normalerweise im "src"-Ordner von SharpDevelop. Ich habe zwei Dateien vorbereitet, die ihr an eure Rechner anpassen müsst. Zum einen die "HtmlHelp2.build" (XML), wo ihr folgende zwei Angaben findet

Code:

<property name="dir.repository" value="H:/SharpDevelop.Repository/SharpDevelop"/>

Benutzt wird hier der Knoten, der auf meine CVS-Version zeigt. Darunter auskommentiert ist quasi der gleiche Knoten, nur dass hier der Ordner zur installierten Version angegeben ist. Benutzt einen davon und tragt euren Pfad zu SharpDevelop ein. Die zweite Datei ist die "build.bat", in der ihr folgendes findet:

Code:

set NAnt="H:\SharpDevelop.Repository\SharpDevelop\src\Tools\nant\bin\NAnt.exe"
::set NAnt="%ProgramFiles%\SharpDevelop\src\Tools\nant\bin\NAnt.exe"

Das selbe: Benutzt wird der CVS-Ordner, auskommentiert darunter steht der Ordner der installierten Version. Nehmt eins von beiden, passt es ggf. an, dann beendet SharpDevelop und startet die Batchdatei. NAnt kompiliert den Quellcode und kopiert alle benötigten Dateien in die o.g. Ordner. Wenn ihr SharpDevelop dann startet, solltet ihr das Addin auch haben.

Bitte Probleme, Kritik, Lob und/oder Anregungen hier posten.

[Robert_G]

Eigentlich müsstest du mit dem CodeDom zusammen arbeiten, um den Typen eines Bezeichners zu erfahren.
Wenn ich den Cursor auf Miep haben, wobei Miep ein Button ist, würde ich erwarten, dass ich die Hilfe zum Button sehe.

Übrigens aktualisiert das VS die dyn Help nicht wirklich in Echtzeit sondern etwas verzögert. Vielleicht reicht es auch einfach einen Handler im OnChange des Editors zu registrieren und alle halbe Sekunde bei Veränderungen die ersten 10 passenden Beiträge aus dem Index, sowohl oben mögliche Treffer in der Sprachreferenz darzustellen?

btw: Was muss ich machen, damit die SDK Doku dort auftaucht? Wie gesagt, bei mir ist da leider nix...

[MathiasSimmack]

Wenn bei dir nichts angezeigt wird, , dann mal in die Optionen rein und dort unter Tools/Help 2.0-Umgebung was anderes aussuchen. Filter (Combobox) hängen halt immer von der Collection ab.


Die Integration meinte ich anders. Momentan hätte ich eine unlösbare Gleichung: Addin erfordert Main-Bibliothek zum Kompilieren, aber Main-Assembly enthält Editor, der seinerseits wieder auf das Addin zugreifen und die Dynamische Hilfe ansteuern muss. Ein Teufelskreis.
Deswegen müsste zumindest die DH aus dem Addin genommen und direkt in die/das Main-Assembly rein, damit dort der Editor entsprechend erweitert werden kann. Aber ich denke, für Fidalgo wird das sowieso nicht mehr integriert.

Im Augenblick muss ich erst mal den aktuellen Stand für Corsavy wegschicken. Die warten schon, die Jungs. Kamen schon 2 Erinnerungsmails.