"Device specific help"

[LuBeDa]

Hallo FHEM-Entwickler,
ich finde FHEM sehr gut und sehr mächtig. Das ist eigentlich auch mein Problem....

Ich muss häufig in der Commandref (deutsch/english) und im Wiki nachlesen.

Daher fände ich es eine große Erleichterung wenn unten, dort wo jetzt "Device specific help" steht, direkt drei Links dazu ständen.

Und zwar zur deutschen und englischen Commandref und, falls vorhanden, zum dazugehörigen Wiki Eintrag.

Die Links sollten jeweils in einem neuen Fenster oder Browser-Tab aufgehen. Die Commandref Sache sollte einfach sein.
Der Link zum Wiki müsste eigentlich in den Modulen als Attribut hinterlegt werden. Das wäre schwerer umzusetzen aber aus meiner Sicht eine Klasse Sache.

Vielleicht für die 5.9er Version

Danke für dieses mächtige Werkzeug und Gruß aus Datteln

Ludger

[marvin78]

Wiki macht keinen Sinn, da keine offizielle Doku  und überhaupt nicht mit der commandref vergleichbar. Es gibt kaum Regeln zum Wiki. Dazu: Wer soll das pflegen? Es gibt keinerlei Standard für zu Modulen gehörige Wiki-Artikel. Wiki Artikel sollten zudem, meiner Ansicht nach, weiterführend oder übergreifend sein (ich weiß, dass das leider meistens nicht der Fall ist) und umfassen deshalb häufig mehr, als nur Infos zu einem Modul.

Neues Fenster: rechte Maustaste -> in neuem Fenster öffnen.

Die englische commandref ist in der Regel der Standard, sehr viele Module sind in deutsch gar nicht dokumentiert. Umstellen kann man die Sprache jedoch.

[Thorsten Pferdekaemper]

Ich muss häufig in der Commandref (deutsch/english) und im Wiki nachlesen.

Ich auch noch im Forum und im Coding, das ist normal.

Daher fände ich es eine große Erleichterung wenn unten, dort wo jetzt "Device specific help" steht, direkt drei Links dazu ständen.
Und zwar zur deutschen und englischen Commandref und, falls vorhanden, zum dazugehörigen Wiki Eintrag.

Ja, und für mich dann noch zum entsprechenden Forenbereich und zum Coding.
Nein, nicht wirklich. Ich will damit nur sagen, dass das auch verwirrend werden kann. Fünf Doku-Links würden das ganze nicht gerade einfacher machen. Es sollte klar sein, dass die (englische) Commandref im Zweifelsfall die "verbindliche" Doku darstellt. Der Modulautor "darf" aber durchaus auch Links ins Wiki in seine Commandref schreiben. Dann sollte aber auch dafür gesorgt werden, dass der Wiki-Artikel gut gepflegt ist.

Der Link zum Wiki müsste eigentlich in den Modulen als Attribut hinterlegt werden. Das wäre schwerer umzusetzen aber aus meiner Sicht eine Klasse Sache.

Naja, dann müsste es aber auch zu jedem Modul ein Wiki-Artikel geben und der müsste auch "stabil" bleiben. Außerdem gibt es schon genügend z.T. verwirrende Attribute. In dem Fall wäre ein Attribut etwas seltsam, da das bedeuten würde, dass der Anwender den Wiki-Link pro Device einstellen kann.

Zu dem Thema passen auch zwei Posts, die ich mal vor Kurzem geschrieben habe:
https://forum.fhem.de/index.php/topic,71033.msg627344.html#msg627344
Den anderen finde ich jetzt nicht mehr. Da ging es darum, dass die Doku kontextsensitiver werden sollte und man auch eigene Notizen an ein Device/Attribut/Reading etc. hängen können sollte. Ich hatte dazu mal angefangen, einen Prototypen anzulegen, aber jetzt will ich erst einmal ein paar andere Sachen fertig bekommen.

Gruß,
   Thorsten

[viegener]

Ja, ich denke ebenfalls es ist normal, dass man noch in Commandref etc nachschauen muss. Und selbst eine Google suche mit fhem oder fhemwiki als Stichwort mache ich häufig.

Meine Nutzung:
- Generell habe ich bei Arbeiten an fhem sogar die commandref als eigenen Tab immer offen und suche darin über die Browsersuche (deshalb auch die Gesamtansicht offen)
- Fhemwiki-Suche kann ich eher über Google empfehlen aber wie bereits gesagt gibt es keine vorgegebene Artikelstruktur im wiki (und sollte es auch nicht geben) und nicht immer Artikel zu einem Thema
- Genauso wie generelle Forensuche sehr gut über google geht (insbesondere bei verschreibern) --> site:forum.fhem.de
- Suche im Forum sollte man immer darauf achten wo man sich gerade befindet, denn das Suchfeld oben im Forum sucht im aktuellen Umfeld (Thread, unterforum oder ganzes Forum)

Trotz allem wäre es sicherlich sinnvoll über Verbesserungen nachzudenken und da könnten auch kleine Elemente helfen (Link aufs Forum zu einem Modul oder wenn vorhanden auf fhemwiki aus der Commandref als Standard wäre ein solcher Schritt) --> Das sollte aber in einem anderen Thread diskutiert werden

[KernSani]

Ich kann mich da nur anschließen... Gute Diskussion, falscher Platz - nur wohin damit? Mir fällt jetzt kein (öffentliches) Subforum ein, wo sowas hinpassen würde.

Ich könnte mir vorstellen, dass z.B. ein Link auf das passende Subforum relativ leicht aus der maintainer.txt extrahiert und in die device-specific help eingebaut werden könnte...

[Manul]

Umstellen kann man die Sprache jedoch.

Wie denn?

[Icinger]

Code Auswählen Erweitern

attr global language DE

Sofern es eine deutsche commandref gibt, wird dann diese benutzt.