FHEM - Entwicklung > FHEM Development

Modulare Commandref

<< < (2/2)

Beta-User:

--- Zitat von: Beta-User am 16 September 2021, 20:05:52 ---Nachtrag: Evtl. sollte man die mit dem Hinweis "Keine deutsche Hilfe gefunden!" (der z.B. kommt, wenn man help WeekdayTimer aufruft, der in der Tat (absichtlich! & wirklich) keine hat) möglicherweise verbundene Erwartungshaltung, es müsse eine geben irgendwie anders formulieren. Mir fällt dazu auf die Schnelle aber auch nichts sinnstiftendes ein...

--- Ende Zitat ---
Vielleicht ein paar Gedanken dazu (falls es hier zu OT ist, können wir das gerne abtrennen):

Es gibt einige Module, die hinsichtlich der Doku zweigleisig fahren - englische Commandref, deutsche Doku via Wiki. Im Prinzip ist das ja ok, nur dass die Wiki-Doku halt nicht offline verfügbar ist und nicht unter der vollen Kontrolle des Maintainers steht.
Von Wiki steht aber aaO. nichts (in dem konkreten Fall ist es auch noch eine Baustelle).
Eventuell wäre es möglich, den Help-Text zu modifizieren, entweder, indem man ein entsprechendes "flag" setzt

--- Code: ---=item wiki_DE Modul_Shelly
--- Ende Code ---
das dann v.a. help verstehen müßte und in einen entsprechenden Text+Link ins Wiki umsetzen könnte (unabhängig davon, wie man allgemein zum Thema Wiki steht), oder indem man die DE-Commandref eben auf "ein Wort" beschränkt (was dann help und commandref_.*.pl verstehen müßten, dass damit gerade keine DE-commandref geliefert wird, sondern es sich um einen Link ins Wiki handelt).

Wollte das nur mal in den Raum werfen, gibt sicher bessere Ideen.

rudolfkoenig:
Ich bin fuer ein Link im englischen Doku aufs Wiki, ob vorne oder hinten ist mir egal aber sinnvollerweise gleich.
Das kann man selbst fuer "vollstaendige" Dokus machen, nach dem Motto: mehr Details/Beispiele/etc gibts <hier>.

Beta-User:

--- Zitat von: rudolfkoenig am 17 September 2021, 10:48:56 ---Ich bin fuer ein Link im englischen Doku aufs Wiki, ob vorne oder hinten ist mir egal aber sinnvollerweise gleich.
Das kann man selbst fuer "vollstaendige" Dokus machen, nach dem Motto: mehr Details/Beispiele/etc gibts <hier>.

--- Ende Zitat ---

Finde ich einen guten Vorschlag.

Es fragt sich nur, warum sich einige Varianten von dem finden was ich als "der Maintainer mag den Standardtext nicht" interpretieren würde, wenn man über die Commandref_join drüberfliegt. Weiteres Beispiel:

--- Zitat --- Eine deutsche Beschreibung ist aktuell nur im WIKI verfügbar.
 Wiki MediaList
--- Ende Zitat ---
Oder (auch als Diskussionsbasis):
--- Zitat ---Deutsche Dokumentation im Wiki vorhanden, die englische Version gibt es hier: OWX
--- Ende Zitat ---
Wobei die Deutsche Dokumentation vermutlich nicht direkt eine Übersetzung der englischen Version ist. Vielleicht wäre sowas in der Art hier eine Option:

--- Zitat ---In deutsch ist eine Dokumentation im Wiki verfügbar. Englische commandref: OWX
--- Ende Zitat ---

Zu den Testbedingungen noch:
Interessanterweise funktionieren die Links (einschließlich Shelly) auf meinem Testsystem (im Unterschied zum Hauptsystem) aus der commandref heraus, aber (soweit erkennbar nur) Shelly weigert sich auch auf diesem System hartnäckig, aus help heraus die commandref zu öffnen)

betateilchen:

--- Zitat von: Dr. Boris Neubert am 16 September 2021, 20:50:11 ---Udo, liest Du mit?

--- Ende Zitat ---

jetzt ja, ich war ein paar Tage in Urlaub...


--- Zitat von: Dr. Boris Neubert am 16 September 2021, 20:50:11 ---Nee, das scheint ein Bug in 98_help.pm zu sein:

--- Ende Zitat ---

Das ist kein wirklicher Bug, das ist ein Problem von fehlenden Konventionen zur Namensgebung von Moduldateien.


--- Zitat von: Dr. Boris Neubert am 16 September 2021, 20:50:11 ---Das Module ist 59_Weather.pm und der Match findet 46_TRX_WEATHER.pm. Folgende Änderung in Zeile 268 löst das Problem:

--- Ende Zitat ---

Jede Änderung der regexp an dieser Stelle löst ein bestimmtes akutes Problem (zu dessen Lösung eine Änderung vorgeschlagen wurde) und schafft gleichzeitig 2-3 neue Probleme an anderer Stelle. Eine wirklich sinnvolle Lösung habe ich dafür noch nicht gefunden, obwohl die Stelle schon mehrfach angepasst wurde.

Deine vorgeschlagene Änderung werde ich mal einbauen, dann hole ich mir eine Tüte Popcorn und warte, bis sich der Nächste meldet, der dann ein Problem mit der Namensauflösung hat.

Navigation

[0] Themen-Index

[*] Vorherige Sete

Zur normalen Ansicht wechseln