HTMHelp - Automatische UDF-Dokumentation (04.08.2015/1.1.0)

Hallo allerseits!
Ich habe ein kleines Programm von mir heute "massenreif" gemacht. Diese Art der HTML-Dokumentation verwende ich gerne bei meinen UDFs, um eine anschauliche Dokumentation zu bieten, bei der man nicht immer wie wild in der au3-Datei rumsuchen und -scrollen muss. Beispiele findet ihr auch ohne Download auf meiner Website, zum Beispiel bei der ThumbBarButtons-UDF: Klick mich (Auf "Dokumentation" klicken)
Mit diesem kleinen Tool kann man aus AutoIt-UDFs mit standardkonformen Funktionsheadern mit wenigen Klicks eine grafisch ansprechende HTML-Hilfedatei generieren. Dabei werden die vorhandenen Informationen aus den Headern einfach übernommen. Für die HTML-Datei selber ist sowohl ein englischsprachiges als auch ein deutschsprachiges Template vorhanden.Außerdem gibt es die Möglichkeit, mit einem Klick einen Eintrag im Kontextmenü zu erstellen, um schnell über Rechtsklick -> "Hilfedatei generieren" diese Software aufzurufen. Auch ein einfaches "Draufziehen" des Skripts auf die ausführbare Datei ist möglich. Drag'n'Drop direkt ins Fenster kommt mit dem nächsten Update.

Alle mit dieser Software erstellten Hilfedateien dürfen selbstverständlich euren UDFs beigelegt werden. Es wäre nur nett, den Hinweis auf Software und Autor nicht zu entfernen.

Die etwas längere Startzeit rührt von der automatischen Update-Suche her. Eventuell wird diese Update-Funktion noch verlegt, wenn die Wartezeit als störend empfunden werden sollte.

Wenn jemand den Kontextmenüeintrag wieder entfernen möchte... Bis ich diese Funktion integriert habe, muss man das von Hand machen. Dazu einfach den Registry-Schlüssel HKEY_CLASSES_ROOT\AutoIt3Script\Shell\Hilfedatei generieren löschen.

• Projektseite auf meiner Website mit Download-Links
• HTMHelp-1.1.0-src.zip
• HTMHelp-1.2.2-src.zip

Vielleicht kann ja wer was damit anfangen. Ich würde mich über Fragen, Lob oder Kritik freuen.

Lieben Gruß

Ich hatte nicht bedacht, dass es auch noch andere Dateien dieser Art geben kann, die nicht von meinem Programm stammen. Die sollten ja bei einem Update überschrieben werden. Ich werde im Header meiner Dateien einfach einen HTML-Kommentar zum Erkennen einbauen, dass dann ggf. eine Abfrage wie "Die Datei XYZ.htm existiert bereits und stammt nicht von HTMHelp. Soll sie dennoch überschrieben werden?". Danke für den Hinweis und das Lob.

Mit Version 1.0.1 wurde eine Abfrage für das Überschreiben von Fremd-HTML-Dateien eingebaut. Das Update ist über die integrierte Update-Funktion erhältlich.

@water Oh, ja, du hast Recht. Ich habe zur Entstehungszeit des Hauptteils des Skriptes die Remarks-Sektion nicht genutzt, deswegen habe ich sie auch nicht in die Hilfe-Datei übernehmen lassen. Das werde ich dann morgen korrigieren. Danke für den Hinweis und für das Lob.

Edit: Mit Version 1.1.0 korrigiert.

Du hast ein Glück... Ein Wordpress-Update hat mir das gestern Abend zerhauen. Hatte noch keine Zeit, das zu korrigieren.

Natürlich steht das Tool noch zur Verfügung. Sobald ich wieder zuhause bin, lade ich alles mal als Forenanhang hoch.

Edit: @water HTMHelp-1.1.0-src.zip

Ohje. Hatte das hier völlig verdrängt, bin gerade selber darüber gestolpert... Ist nun im Startpost verlinkt.

Ich weiß nicht, warum, aber dieser Thread hier ist irgendwie völlig an mir vorbei gegangen...

water

Eins nach dem anderen:

Punkt 1:

Das Problem, was du vor einer halben Ewigkeit beschrieben hast... Was soll ich sagen? It's not a bug, it's a feature.

Mein Programm erkennt optionale Parameter und vermerkt dies auch in der Beschreibung. Einmal wird hinter dem Parametername "optional" vermerkt, und die entsprechenden Zeilen bekommen per CSS ein etwas abweichendes Aussehen. Außerdem werden beim Parsen für den "gelben Kasten" die Func-Zeilen verwendet, die ja die eckigen Klammern gar nicht enthalten. Da ist ja dann eigentlich durch den Default-Wert sofort erkennbar, dass die Angabe optional ist. War also tatsächlich eher eine Design-Entscheidung, als ein Problem. Aber der Aufwand, das als optionalen Switch in das Programm einzubinden, sollte sich in Grenzen halten.

Punkt 2:

Klar, das macht völlig Sinn, wenn man die Software in einen bestehenden Build-Prozess einbinden möchte. Stimme ich dir zu, setze ich um. Ist ja kein großer Aufwand.

Punkt 3:

Ja, das macht eigentlich auch mehr Sinn. Die gewählte Reihenfolge war eher nach Gefühl, aber so entspricht es ja ungefähr der logischen Reihenfolge. Hab da schon ein Bild vor Augen, wie sich das optisch macht.

Punkt 4:

Related gibt es doch. In dem Block werden sogar automatisch Sprunglinks zu den jeweiligen Funktionen gesetzt.

Ich würde mal vom Gefühl her sagen, dass ich am Wochenende wohl mal nen Stündchen dafür aufbringen kann.

Und du wirst lachen, es ist quasi deine Schuld, dass ich gerade wieder auf diesen Thread gekommen bin. Hab grade auf einem Rechner die AD.au3 runtergeladen und dabei dann registriert, dass da ja eine Doku im HTML-Format bei ist. Und dachte noch so "Ach, schau mal, sowas hast du doch auch mal programmiert".

So viel zum Wochenende...

Punkt 2 und 3 habe ich gerade umgesetzt.

Allerdings scheint nach ein paar Jahren der Update-Mechanismus nicht mehr so ganz so gut zu funktionieren. Hab's daher mal im ersten Beitrag neu verlinkt.

Von den CHM-Dateien hab ich nie so viel gehalten. Da finde ich HTMLs wesentlich universeller und besser zu handhaben.

Ein nettes Feature wäre es noch, automatisch auch eine CallTip-Datei zu generieren.