Querverweise in commandref untergraben help / device specific help

[betateilchen]

Hallo Rudi,

die Idee, bestimmte Attribute nur noch mit einem Link in der commandref eines Moduls zu hinterlegen, wenn das Attribut in einem anderen Modul beschrieben ist, ist zwar gemeint. Das führt aber dazu, dass in "help <ModulName>" bzw. in der "device specific help" verwirrende Informationen entstehen.

Beisipiel: Die Attribute endPlotNow und endPlotToday innerhalb der commandref zu SVG. Dort sind Links hinterlegt, die zur Attributbeschreibung in FHEMWEB führen.

In der device specific help und in "help SVG" funktionieren diese Links aber nicht, da hier ja nur der gerade benötigte commandref-Teil aus dem Modul selbst geladen wird und die Links dann ins Leere führen.


--

[rudolfkoenig]

In der Tat.

Ich finde aber, dass eine Vervielfaeltigung der Beschreibungen auch keine gute Loesung ist, insb. bei sowas wie ignore/disableForIntervals.

Wenn wir ueberall name auf id wie hier: https://forum.fhem.de/index.php/topic,118915.msg1135123.html#msg1135123 beschrieben umstellen, dann kann man das Problem relativ einfach per Programmcode loesen, weiss nicht, ob Dir das schon reicht.

Andere Ideen/Meinungen?

[betateilchen]

weiss nicht, ob Dir das schon reicht.

um das klar zu sagen: mir ist das eigentlich ziemlich egal. Aber inzwischen wundern sich schon die Anwender darüber, dass die Inhalte zwischen "device specific help" und "commandref" nicht identisch sind, weil es nicht für jedermann auf den ersten Blick erkennbar ist, dass man eigentlich die Beschreibung aus einem anderen Modul präsentiert bekommt.

https://forum.fhem.de/index.php/topic,119144.0.html


--

[rudolfkoenig]

Ich habe jetzt die SVG-Attribut-Dokumentationen, die in FHEMWEB beschrieben wurden, nach SVG.pm kopiert.

Weiterhin habe ich fhemweb,js erweitert, damit beim Attributauswahl die Beschreibung der global und FHEMWEB Attribute (userattr) angezeigt wird..