Weiterentwicklung commandref, war: Deutsche commandref-Sektion für 99_SUNRISE_EL.pm

[Christoph Morrison]

Da hier alles zum Thema "Deutsche commandref-Sektion für 99_SUNRISE_EL.pm" gesagt ist, habe ich einen Moderator geben die Off-Topic-Beiträge abzutrennen und den Thread geschlossen.

[Dr. Boris Neubert]

[verschoben]

[Dr. Boris Neubert]

bei

Code Auswählen Erweitern

57_Calendar.pm
Calender -> Calendar (Zeile 3183, Titel...)
ist es nur ein Schreibfehler CalendAr != Calender (ist mir nur aufgefallen, weil bei den ersten varianten der Anchor-Name zur Überschrift passen musste)

gefixt

[Dr. Boris Neubert]

Wir müssen uns z.B. mal Gedanken darüber machen, wo die Grenze zwischen Wiki-Beiträgen und CommandRef liegt. DOIF ist ein gutes Beispiel, wo ich finde, dass die ganzen Beispiele besser im Wiki aufgehoben sind und die CommandRef lediglich als Befehlsreferenz mit wenigen Beispielen und dafür gerne einem Link aufs Wiki dienen sollte. Ich finde die Anzahl der Beispiele bei SUNRISE_EL z.B. im Gegensatz wieder zu wenige, da durch das Design des Moduls (und die aktuell noch mangelhafte englische Doku) die Syntax deutlich besser erklärt werden kann als durch eine reine Beschreibung.

Ja, es ist sinnvoll, sich darüber Gedanken zu machen, wo die Grenze zwischen CommandRef und Wiki-Beitrag liegt.

Meiner Meinung nach muss die CommandRef den durchschnittlich versierten Anwender in die Lage versetzen, das Modul in Betrieb zu nehmen, und einfache Beispiele liefern, wie es benutzt wird. Trickreiche Verwendungen, ausgearbeitete Beispiele für praktische Anwendungen, und ausführliche Anleitungen gehören ins Wiki.

[Dr. Boris Neubert]

Ich bleibe bei Nein.

In welchem Kontext steht das Nein-Doch-Nein? Mir fehlt der Bezug im ersten Nein.

[betateilchen]

Meiner Meinung nach muss die CommandRef den durchschnittlich versierten Anwender in die Lage versetzen, das Modul in Betrieb zu nehmen, und einfache Beispiele liefern, wie es benutzt wird.

Genau so nutze ich auch die commandref (genauer: die device secific help, die daraus generiert wird) wenn ich ein neues Modul erstmalig in Betrieb nehme "help modulName" und dann erwarte ich, dass ich alle Informationen bekomme, um ein grundsätzlich funktionsfähiges device dieses Typs anlegen zu können. Dass dieses neue device dann sofort 100% all meiner Wünsche erfüllt, erwarte ich nicht, und das ist auch nicht meine Erwartungshaltung an die commandref.

Meine Erwartung an die commandref jedes Moduls:

• alle set sollten aufgeführt und in ihren Grundzügen beschrieben sein
• alle get sollten ... (siehe oben)
• alle attr sollten ... (siehe oben)

Leider werden dieser Erwartungen selbst von zentralen Modulen nicht immer erfüllt (was in vielen Fällen daran liegt, dass Attribute kreuz und quer zwischen Modulen verlinkt sind)

[igami]

Die readings sollten auch Beschrieben werden

[betateilchen]

Besser: readingNames, die keiner Beschreibung/Erklärung bedürfen

Und wenn ein Reading wirklich einen so komplzierten Namen hat wie das teilweise bei Homematic der Fall ist, dann gehört die Erklärung ins Wiki.

[herrmannj]

Nix da. Muss ja auch möglich sein mit einem Modul allein mit der amtlichen Anleitung, aka commandref, zu arbeiten.

[betateilchen]

Da hättest Du aber als Homematic Neueinsteiger schlechte Karten...

[rudolfkoenig]

so ich glaube das ist die schönere variante....

Habs eingecheckt, und auf fhem.de ausgerollt. Theoretisch fehlt noch die Anpassung fuer die anderen Styles, aber da wird es kompliziert, weil manche nicht mehr aktiv betreut werden.

P.S.: eigentlich gehoert dieser Beitrag in das geteilte Thema https://forum.fhem.de/index.php/topic,81087.msg730869.html#msg730869 aber wenn man da Antwortet, dann landet die Antwort in diesem Thema. Und keine Ahnung, wie ich das dahin verschieben soll. Kann jemand helfen?

[igami]

Besser: readingNames, die keiner Beschreibung/Erklärung bedürfen

Und wenn ein Reading wirklich einen so komplzierten Namen hat wie das teilweise bei Homematic der Fall ist, dann gehört die Erklärung ins Wiki.

Ich möchte schon wissen welche readings erzeugt werden.

[nils_]

Habs eingecheckt, und auf fhem.de ausgerollt. Theoretisch fehlt noch die Anpassung fuer die anderen Styles, aber da wird es kompliziert, weil manche nicht mehr aktiv betreut werden.

irgendwie wurde das css nicht Übernommen??
lokal sieht das bei mir so aus wie im anhang.
also etwas kleiner und ohne zeilenumbruch.

P.S.: eigentlich gehoert dieser Beitrag in das geteilte Thema https://forum.fhem.de/index.php/topic,81087.msg730869.html#msg730869 aber wenn man da Antwortet, dann landet die Antwort in diesem Thema. Und keine Ahnung, wie ich das dahin verschieben soll. Kann jemand helfen?

sollen wir dafür ein neues thema eröffnen??
es geht ja eher um den grundsätzlichen inhalt der commanref (und was ins wiki sollte).
aber wir posten hier was dazwischen was eher mit dem parsen zu tun hat

[rudolfkoenig]

irgendwie wurde das css nicht Übernommen??

Doch, vtml. brauchst du einen ordentlichen Reload.

sollen wir dafür ein neues thema eröffnen??

Gerne.

[nils_]

Gerne.

für die Anpassungen am "Parser" usw. -> https://forum.fhem.de/index.php/topic,81238.0.html