Script Manager / AHK Help Style Template

Stelle Fragen zur Programmierung mit Autohotkey

Moderator: jNizM

BNOLI
Posts: 548
Joined: 23 Mar 2020, 03:55

Script Manager / AHK Help Style Template

29 Apr 2020, 02:00

Moin, heute mal zwei Fragen:

Nach Suche, finden sich für AHK lediglich 3 Script-Manager die jedoch bereits > 10y alt sind (sofern überhaupt verfügbar).
a) benutzt jmd von Euch aktuell einen AHK-Script-Manager? Wenn ja, welchen?? Erfahrung mit weiteren?? ...

Die AHK-Hilfe benutzt ein spezielles Style-sheet/theme (mkdocs.org ?).
b) ist bekannt welches? Gibt es sowas wie einen "Hilfeseiten"-(Online)-Generator?

Danke fürs Zuhören :)
Remember to use [code]CODE[/code]-tags for your multi-line scripts. Stay safe, stay inside, and remember washing your hands for 20 sec !
just me
Posts: 7098
Joined: 02 Oct 2013, 08:51
Location: Germany

Re: Script Manager / AHK Help Style Template

29 Apr 2020, 04:27

Moin BNOLI,

zu a) kann ich nichts sagen. Zu b) frag mal @Ragnar (absoluter AHK-Hilfe-Experte).
User avatar
Ragnar
Posts: 306
Joined: 30 Sep 2013, 15:25

Re: Script Manager / AHK Help Style Template

29 Apr 2020, 06:28

Die AHK-Hilfe benutzt weder ein fremdes Style-sheet/theme noch wurde sie mit einem "Hilfeseiten"-(Online)-Generator erstellt. Alles in Eigenregie entstanden. CSS stammt hauptsächlich von Chris/Lexikos/mir, das Theme basiert auf das Standard-Theme des Forums und die ganzen zusätzlichen Features drumherum wie Navileiste, Toolleiste usw. ist zu 90% mein Werk (außer die Suchfunktion).

Ja, es gibt Hilfeseiten-Generatoren. Für AHK-Code gibt es hauseigene Varianten wie GenDocs oder DocGen (einfach via Google nach "document generator autohotkey" suchen). Für Programme und Sonstiges zum Beispiel FAR HTML 5.
BNOLI
Posts: 548
Joined: 23 Mar 2020, 03:55

Re: Script Manager / AHK Help Style Template

29 Apr 2020, 13:55

Hab ich schonmal angemerkt, das all Jenen, die sich um die AHK-Hilfe verdient gamacht haben mein immerwährender Dank gehört?
Nicht?? Dann isses jetzt soweit: :thumbup:

[Ehrengarde] :clap: :clap: 8-) DANKE 8-) :clap: :clap: [/Ehrengarde]
Remember to use [code]CODE[/code]-tags for your multi-line scripts. Stay safe, stay inside, and remember washing your hands for 20 sec !
BNOLI
Posts: 548
Joined: 23 Mar 2020, 03:55

Re: Script Manager / AHK Help Style Template

06 May 2020, 03:28

... Frage a) ist offensichtlich auf geringes Interesse gestossen :shock:
Nun, meine Überlegung war wie folgt: praktisch jede von AHK-Mitgliedern bereitgestellte Funktion (oder ein Script) wird mit einem Header verkommentiert, welcher z.B. Informationen zum Developer/Credits/Anleitungen/Verlinkungen etc. enthalten kann. Legt man sich nun ein Archiv solcher Funktionen an, geht, sofern die Dateinamen nicht 'sprechend' sind, irgendwann die Übersicht verloren was den so "an Lager" ist. Ein einfacher Parser/Verwalter würde die jeweils genannte Datei im Header auf Schlüsselbegriffe ('description,author,...), oder fixe Zeilen durchgehen und diese retournieren, als Liste/Index in einer Datei, oder einer GUI retournieren. Mir schwebte etwas in Richtung Verschlagwortung/tags vor ... DatenBank | SQL | function | just me | ...

Etwas Aktuelles in der Richtung habe ich für AHK nicht gefunden. Bei der Recherche nach einem SAP-Thema wurde heftigst auf AutoIT verwiesen, und mir ist aufgefallen, das dort scheints 'genormte' header für UDF's verwendet werden, was ein Erfassen wie oben beschrieben sicher vereinfacht. Solche vereinbarten Standards gibts für AHK nicht, oder??

:)
Last edited by BNOLI on 06 May 2020, 07:21, edited 1 time in total.
Remember to use [code]CODE[/code]-tags for your multi-line scripts. Stay safe, stay inside, and remember washing your hands for 20 sec !
just me
Posts: 7098
Joined: 02 Oct 2013, 08:51
Location: Germany

Re: Script Manager / AHK Help Style Template

06 May 2020, 04:04

Moin,

vielleicht kannst DU ja etwas von Ixiko's collections of functions and libraries für Deine Zwecke abzweigen.

Das Thema 'Styleguide' kannst Du für AHK vergessen. Es gibt schlichtweg kein Interesse daran. Jeder schreibt seine 'UDF's, wie es ihm gerade in den Sinn kommt, und stellt sie dann ohne neutrale Qualitätskontrolle ins Forum. Und zumindest solange es keine 'offiziellen' UDFs gibt, die Bestandteil der AHK-Distrbution sind, wird sich daran auch nichts ändern.
BNOLI
Posts: 548
Joined: 23 Mar 2020, 03:55

Re: Script Manager / AHK Help Style Template

06 May 2020, 07:20

Merci :thumbup:
Remember to use [code]CODE[/code]-tags for your multi-line scripts. Stay safe, stay inside, and remember washing your hands for 20 sec !
BNOLI
Posts: 548
Joined: 23 Mar 2020, 03:55

Re: Script Manager / AHK Help Style Template

10 May 2020, 02:45

just me wrote:
06 May 2020, 04:04
Das Thema 'Styleguide' kannst Du für AHK vergessen. Es gibt schlichtweg kein Interesse daran. Jeder schreibt seine 'UDF's, wie es ihm gerade in den Sinn kommt, und stellt sie dann ohne neutrale Qualitätskontrolle ins Forum. Und zumindest solange es keine 'offiziellen' UDFs gibt, die Bestandteil der AHK-Distrbution sind, wird sich daran auch nichts ändern.
Offensichtlich gab es dazu schon einmal ernsthafte Bemühungen!!?
https://github.com/ahkscript/ASPDM/blob/master/Specifications/Guidelines.md
http://aspdm.ahkscript.org/#afc

Vielleicht ist ein solch "verwaltungstechnischer" Ansatz etwas 'to much' AKA 'overkill' für den average/gemeinen User?
Remember to use [code]CODE[/code]-tags for your multi-line scripts. Stay safe, stay inside, and remember washing your hands for 20 sec !
User avatar
hoppfrosch
Posts: 405
Joined: 07 Oct 2013, 04:05
GitHub: hoppfrosch
Location: Rhine-Maine-Area, Hesse, Germany
Contact:

Re: Script Manager / AHK Help Style Template

11 May 2020, 00:28

Lange Geschichte - kurzes Summary: Es gab schon einige Versuche ein vereinheitliches System für UDFs für Autohotkey zu schaffen. Das passierte auf unterschiedlichen Komplexitätsebenen (angefangen von Vorschlägen zu standardisierten Dokumentationsheadern bis hin zu ausgewachsenen Paketverwalungssystemen (http://aspdm.ahkscript.org/#afc)). Alle sind bisher glorreich gescheitert - zu wenig Interesse, zu wenig Konsens, zu wenig Kooperation, zu viel Egoismus ...

Z.B.:
* https://www.autohotkey.com/boards/viewtopic.php?f=76&t=132
* https://www.autohotkey.com/boards/viewtopic.php?f=13&t=55617 -
* https://autohotkey.com/board/topic/71751-gendocs-v30-alpha002-create-stdlib-documentation-easily/

usw. usf. --- das sind nur ein paar Threads von vielen, in denen sowas diskutiert wurde. Die meisten komplexen Lösungen beinhalten meines Erachtens auch Standardisierung der Dokumentation.

Aktuell sehe ich die AHK-Community weiter als je zuvor von einem so ehrgeizigen Ziel entfernt. Ich wünsch dir viel Erfolg (ernsthaft), sowas erfolgreich zu initieren und zu realisieren.
BNOLI
Posts: 548
Joined: 23 Mar 2020, 03:55

Re: Script Manager / AHK Help Style Template

12 May 2020, 07:53

IMHO sind Egos der hinderlichste Grund, nicht nur in diesem Kontext. Selbst kleinste Projekte scheitern am "sich nicht mehr Einlassen wollen", weil bereits ab zwei Personen einer denkt, er wäre fremdbestimmt. IMHO sind da die Freunde von AutoIt einfach professioneller unterwegs, denn da zählt(e) in Stylingfragen offensichtlich die Sache. :eh: :wtf: :yawn:
Remember to use [code]CODE[/code]-tags for your multi-line scripts. Stay safe, stay inside, and remember washing your hands for 20 sec !

Return to “Ich brauche Hilfe”

Who is online

Users browsing this forum: No registered users and 23 guests