Ist es an der Zeit, das Delphi-Hilfedateisystem zu überdenken?

Question

Die meisten Komponenten, die für Delphi verfügbar sind, haben keine HTML-Hilfedateien für Delphi 2009. Viele Komponenten, darunter einige sehr beliebte kommerzielle Komponenten, haben nur HLP- und CHM-Hilfedateien.

Viele der Komponenten von Drittanbietern werden nicht mehr aktiv entwickelt, werden aber von vielen Entwicklern verwendet. Infolgedessen gibt es für diese Komponenten keine IDE-Hilfe.

Es gab nur sehr wenige Beschwerden über die alten CHM-Hilfedateien, aber heute gibt es eine große Anzahl von Beschwerden über das Hilfesystem. Vielleicht ist es für Codegear an der Zeit, die Art des verwendeten Hilfedateisystems zu überdenken.

Eine der Beschwerden, die ich darüber habe, ist, dass selbst bei der Installation von Komponenten, die HTML-Hilfedateien bereitstellen, die Registerkarte "Inhalt" beschädigt wird, wenn die zuvor installierten Komponenteninhalte entfernt werden.

Gibt es mögliche Alternativen, die Codegear in Betracht ziehen könnte?

Answer 1

Ich habe das gleiche Gefühl. Das alte Hilfesystem hilft mir schneller, eine Antwort zu finden.

Answer 2

Eine Idee ist, es vielleicht nach dem Vorbild des Delphi-Wiki zu gestalten: http://delphi.wikia.com/wiki/Delphi_Wiki

Das Wiki ist eigentlich gar nicht so schlecht aufgebaut, vor allem mit dem VCL-Link im linken Frame.

Sie ist recht angenehm anzusehen, hat eine gute Suchfunktion, enthält Themen, Beispiele, Querverweise und, was mir am besten gefällt, Kommentare und Tipps von Benutzern.

Was die Benutzerkommentare und Tipps angeht, so gefällt mir die PHP-Dokumentation unter www.php.net/docs.php (was meiner Meinung nach ist die beste Programmierdokumentation, die ich kenne ) sind die Kommentare und Tipps der Nutzer.

Wenn sie das großartige Layout integrieren können, das Sie bei Delphi-Grundlagen hinzufügen und Komponenten von Drittanbietern erlauben, ihre Hilfedateien hinzuzufügen, dann haben sie eine vollständige Referenz. (Aber die Drittanbieter werden natürlich ihre Hilfedateien in das neue Format umstrukturieren müssen - wie auch immer es am Ende aussehen wird).

Das Wiki hat auch Abschnitte für Tutorials, Tipps und Tricks, Referenzen und beliebte Artikel. Und ich denke, es könnte auch das allumfassende Code-Repository werden, das wir uns alle wünschen.

Es sollte eine Option zum Herunterladen des Hilfe-Wikis vorgesehen werden, damit es auch offline zugänglich ist.

Und sie müssen herausfinden, wie die F1-Taste funktioniert, um das Wiki/die Hilfedatei richtig zu durchsuchen, egal ob online oder offline, und die relevantesten Ergebnisse anzuzeigen.

Das Problem mit dem Wiki ist, dass es nicht vollständig ist, und dass der gesamte Satz von Delphi-Hilfedateien in das Wiki integriert werden muss.

Das mag ein Wunschtraum sein, aber so etwas wäre mein Ideal.

Answer 3

Das ist eine Lieblingsbeschäftigung von mir. Die Delphi-Hilfe hat sich gerade verschlechtert, auch wenn es kürzlich eine leichte Verbesserung gab. Ich glaube ehrlich gesagt, dass dies einer der Gründe ist, der die Akzeptanz von Delphi behindert.

Answer 4

Micosoft hat Help3 für VS2010 eingeführt, also werden wir es vielleicht auch in Delphi sehen:

Hier ist ein Blogbeitrag, der die Frage "Warum ein neues Hilfesystem?" beantwortet.

http://thirdblogfromthesun.com/2010/10/the-story-of-help-in-visual-studio-2010/

Er zitiert ein internes Papier, das Anfang 2008 zum neuen Projekt "Help3" führte Anfang 2008 führte:

"Das Papier beschrieb die folgenden Probleme mit der Hilfeerfahrung in Visual Studio:

1. Die benötigten Informationen nicht finden zu können, ist eine häufige Problem. F1-Hilfe und Suche funktionieren nicht funktionieren nicht so gut, wie sie sollten.
2. Die Leistung des Hilfesystems - in erster Linie der Start, das Laden von Themen, lokalen Suchergebnissen - ist eines der größten Probleme.
3. Die Offline-Installation der MSDN-Bibliothek ist aufgrund der Komplexität der des Hilfesystems.
4. Die proprietäre Natur unseres Hilfeformats bietet wenig Anreiz für Partner, Autorentools zu entwickeln und kann nicht einfach von Entwicklern Entwickler in ihre eigenen Produkte übernehmen.
5. Auf der Seite der Inhaltserstellung gibt uns die Hilfsplattform folgende Aufgaben an die Hand veraltete Werkzeuge und Prozesse.
6. Und schließlich, und das ist das Wichtigste, ist kein einzelnes Team bei Microsoft für die Lösung von Problemen zuständig. dieser Probleme."