Borland Developer Studio 2006 - Hilfe erweitern

[hirnstroem]

'loha Folks,

nachdem ich folgenden Thread bereits gelesen habe und eigenlich nicht schlauer wurde, muss ich dieses thema nochmals aufgreifen:
http://www.delphipraxis.net/internal...&highlight=hlp

Es geht darum, dass ich gerne Hilfedateien in die Borland-Hilfe integrieren würde. Mit Delphi 5, welches ich bis anhin ab und zu einmal benutzt habe, ging dies relativ einfach. Bei Delphi 2006 finde ich allerdings keine Möglichkeit dies zu realisieren.

Im wesentlichen handelt es sich um HLP-Hilfedateien (von der ComPort Library, IntraWeb usw.). Da ich diese sonst jedesmal suchen und öffnen muss, wäre es schön, jegliche Hilfestellungen über die F1-Taste zu erreichen.

Und bitte sagt mir jetzt nicht, dass dies nicht möglich sei. Danke!

Grüsse
hirnstroem

[MagicAndre1981]

geht nicht, da die alten Hilfedateien (hlp) anders aufgebaut sind, als die MS Help 2.0

[MathiasSimmack]

Doch geht. Umwandeln von HLP -> Help 2.0 (meinetwegen auch über den Umweg per CHM), und dann als Plugin in die Borland-Hilfe einklinken. Die Umwandlung ist aufwändig, aber machbar ist es. Ich habe doch schon mehrfach gesagt, dass das Help 2.0-Format in der Hinsicht gut ist. Nach dem Muster integrieren sich ja auch die Win32-API-Tutorials (die Help 2.0-Version) in die Borland-Hilfe.

Ach ja, die Frage ist noch: Sind es deine Hilfedateien? Oder von externen Komponenten/Firmen? In dem Fall hast du natürlich ein Problem. Wenn die Firmen keine Help 2.0-Version anbieten, dann musst du die Umwandlung leider selbst vornehmen. Und du darfst das natürlich auch nur für dich selbst nutzen.

[MagicAndre1981]

Hi mathias,

kannst du so ein Tool anbieten, dass das macht?

[hirnstroem]

Okay. Die HLPs sind leider nicht von mir. Die Sache wäre aber very nice to have.

Aber danke einenweg (k.A. ob das deutsch ist).

[MathiasSimmack]

Zitat von MagicAndre1981:

kannst du so ein Tool anbieten, dass das macht?

• Umwandlung von HLP -> CHM = HTML Help Workshop von Microsoft. Funktioniert aber nur mit HLP-Projekten (keine fertige HLP-Datei!) und ist extrem umständlich zu warten, da der Konverter selbst zufällige Dateinamen vergibt.
• Aus einer HLP-Datei ein Hilfeprojekt erzeugen -> HelpDeco (Help-Decompiler). Dürfte nicht 100% legal sein, insbesondere wenn man fremde HLPs dekompiliert, aber solange man dies wirklich nur für die eigenen Zwecke tut, müsste es im Graubereich sein.
• Der VSHIK von Microsoft hilft beim Umwandeln von HTMLHelp-Projekten und -Dateien (*.chm) ins Help 2.0-Format. Eigentlich ist es das Programm "hxconv.exe", das die Konvertierung durchführt.
• Einbinden von Help 2.0-Collections im System: die im VSHIK gelieferten Beispielprogramme nutzen. Ich weiß aber nicht, wie das mit der Lizenz war. Die Weitergabe ist bei Microsoft wohl nur mit MSI-Installern erlaubt. Entsprechende Module liegen bei. Alternativ dazu lässt sich auch kostenlos (!) mein eigenes Tool verwenden. Die Win32-Version liegt den Tutorials bei und zeigt mit zwei XML-Dateien, wie a) die Tutorials im System registriert, und b) die Tutorials in die Delphi 2005/2006-Hilfe eingebunden werden. Die .NET-Version liegt bei SharpDevelop bei, ist nur eine Kommandozeilenversion, funktioniert aber mit den selben Parametern.

Wichtig: Damit man die eigene Hilfe als Plugin in andere Collections einbinden kann, muss es sich auch um eine Collection handeln. Eine einfache HxS-Hilfedatei reicht also nicht. Man muss zusätzlich noch bestimmte Collectiondateien schreiben. Hier einfach mal einen Blick auf die Tutorials und andere Help 2.0-Collections werfen. Hilfedateien (*.HxS) und Indexdateien (*.HxI) sind ein Teil. Zur Collection gehören die *.HxC, *.HxT (der Inhalt der kompletten Collection) und diverse *.HxT-Dateien, damit bspw. der Index von allen Hilfedateien innerhalb der Collection angezeigt wird, usw.

Bei fremden Hilfedateien würde ich die Firma fragen, ob die eine Umsetzung ins Help 2.0-Format planen, und wenn nicht, ob sie etwas dagegen haben, wenn ich das für private Zwecke selbst mache. Unter Umständen lässt sich die Firma darauf ein und schickt dir das originale Hilfeprojekt, so dass du den HLP-Dekompiler nicht brauchst. Fragen kostet nichts.

[Union]

Oder Du verwendet das Borland Helpkit. Mein Beileid. Je mehr ich mich mit dem Thema MsHelp beschäftige, desto weniger sehe ich die Vorteile und den Sinn dahinter. Wahrscheinlich eine ABM-Maßnahme...

[MathiasSimmack]

Die MSHelp ist keine offizielle Hilfeplattform für die Allgemeinheit, so wie HLP oder CHM. Sie ist nur für Entwicklungsprodukte gedacht. Einen Support oder eine Runtime für andere Betriebssysteme gibt es nicht.

Wer seine Hilfe bereits jetzt als CHM (HtmlHelp) schreibt, hat kaum Probleme mit der Umwandlung. Dafür liefert Microsoft einen Konverter mit. Die Projektdateien ändern sich (XML-Format), der Content bleibt nach wie vor HTML, wird bei Bedarf aber um spezielle MSHelp-Befehle ergänzt (Filter, Index-, Sucheinträge, dynamische Hilfe, usw.).

Wer seine Hilfe im HLP-Format schreibt, hat bereits beim Konvertieren ins HtmlHelp-Format ein Problem. Der Assistent in Microsoft HtmlHelp Workshop erzeugt Dateinamen, bei denen man durchdreht. In dem Fall ist es sinnvoller, gleich bei Null zu beginnen und die Hilfe neu zu schreiben, als Zeit zu vergeuden, indem man das konvertierte HLP-Projekt auf Vordermann bringt.

[Union]

Zitat:

Die MSHelp ist keine offizielle Hilfeplattform für die Allgemeinheit, so wie HLP oder CHM. Sie ist nur für Entwicklungsprodukte gedacht

Dass dort verschiedene Hilfesysteme verwendet werden (Entwickler/Anwender) scheint mir ein Zeichen von geistiger Umnachtung zu sein. Gibt es irgendwo "Best Practices" wo man nachlesen kann, welches Hilfesystem wann eingesetzt werden soll?

[MathiasSimmack]

Zitat von Union:

Gibt es irgendwo "Best Practices" wo man nachlesen kann, welches Hilfesystem wann eingesetzt werden soll?

Auf Anhieb fällt mir keins ein, aber vereinfacht gesagt:

• Läuft dein Programm von Windows 95 bis Windows 2003 -> HLP, weil es auf diesen Systemen sofort einsetzbar ist.
• Läuft dein Programm von Windows 95 bis Vista -> CHM. Ab Windows 98 offiziell dabei, für Windows 95 die Runtime mitliefern.
• Schreibst du Assemblies o.ä. -> CHM oder Help 2.0. NDoc erzeugt aus deiner Klasse auf Wunsch beides. Einsatzzweck hängt von dir ab, bzw. von der Hilfedokumentation, in die du deine Hilfe integrieren möchtest.
• Ergänzung speziell zu Vista: Neben CHM könnten als Notlösung noch HTML und PDF zum Einsatz kommen, wobei es hier aber kein API gibt, um Themen aufgaben- und kontextbezogen anzuzeigen. Später dann noch AP Help, sobald Microsoft die notwendigen Tools, Dokus und Runtime veröffentlicht. Vom HLP-Format ist abzuraten. Das läuft unter Vista tatsächlich nur noch, wenn man die Runtime mitliefert.

Zitat:

Zeichen von geistiger Umnachtung

Eigentlich nicht. Die Help 2.0 war durchaus mal als offizieller Nachfolger von HtmlHelp (CHM) gedacht. Microsoft hat diese Pläne nur verworfen. Warum auch immer. Deswegen gibt es auch keine Enduser-Runtime und Dokus, usw. Den Einsatz mit Entwicklungsprodukten, etwa Visual Studio, halte ich für gut, denn die integrierte Hilfe (man muss das Programm nicht mehr verlassen) hat es mir angetan. Und auch die dynamische Hilfe ist eine feine Sache. Du stehst auf einem Control oder einer Variablen/einem Typ, und die Hilfe bietet Themen an, die dir helfen könnten.