FHEM - Entwicklung > FHEM Development

Modulare Commandref

(1/2) > >>

Dr. Boris Neubert:
Hallo,

wegen der vorgesehenen neuen Grundeinstellung, dass die Commandref modular ist, habe ich mir diese nochmal angesehen.

Eine modulare Hilfe ist besser als diese riesige monolithische Hilfe.

Meiner Meinung nach gibt es aber noch Verbesserungsbedarf:
- Beim Einblenden der Hilfe zu einem Modul bleiben die statischen Inhalte der Webseite erhalten. Mich irritiert das. Ich fände es besser, wenn auch die allgemeinen Abschnitte, die als statische Links voran- und hintenangestellt sind, modularisiert würden.
- Bei Auswahl von Weather erscheint noch ein Hinweis "Module: 46_TRX_WEATHER.pm Maintainer: KernSani Forum: RFXTRX" darüber. Das ist nicht gewollt.
- Unterhalb von der Überschrift "Device modules" steht ein einsames "global".
- Ceterum censeo... Helper modules gehört abgeschafft. Oder es überzeuge mich jemand, dass ein Anwender weiß, ob er in Device modules oder Helper modules nach einem Gerät suchen muss.

Grüße
Boris


Beta-User:
Anderere Aktionspunkte, von denen ich nicht weiß, wie viele Module sowas - ggf. mit unterschiedlichem Schwerpunkt - betrifft:
- Wenn man Shelly in der modularen Variante anklickt, kommt man auf den  Hinweis, dass "Absichtlich keine deutsche Variante existiert." MAn. ist ein solcher Hinweis überflüssig, ich kann zwar verstehen, dass man die Rückfrage leid ist, ob es Absicht sei, würde mir aber trotzdem wünschen, dass man  gleich auf der betreffenden englischen Seite landet;

- Das "klicken", um auf die englische Variante zu kommen klappt aber in dem Fall auch nicht (genausowenig übrigens wie bei "help", wo man allerdings woanders landet als in einer loop)...
Der Link ist in dieser Form hinterlegt:

--- Code: ---<a href="commandref.html#Shelly">Shelly</a>
--- Ende Code ---

Stressfrei wäre wohl

--- Code: ---<a href="#Shelly">Shelly</a>
--- Ende Code ---


Betrifft zwar nicht speziell Modular, aber wer sowieso eine Umstellung auf "id" machen möchte, könnte das gleich auch noch gegenchecken; wer dazu Fragen hat, findet hoffentlich ausreichend Material in https://forum.fhem.de/index.php/topic,120779.msg1166266.html#msg1166266 bzw. dem ganzen Thread.

PS an "den einen" hier mitlesenden User: Diese Umstellung auf "id" ist nicht wirklich schwer und eher eine Fleißaufgabe. Vielleicht bietest du einem Maintainer deiner Wahl an, ein oder zwei seiner Module entsprechend durchzusehen und lieferst einen "patch" (auf jedem linux-System per diff -u zu erstellen) (oder einfach die komplette commandref) ;) .

rudolfkoenig:

--- Zitat ---Ich fände es besser, wenn auch die allgemeinen Abschnitte, die als statische Links voran- und hintenangestellt sind, modularisiert würden.
--- Ende Zitat ---
Ich faende es auch besser, ein Umbau ist aber gar nicht so einfach.


--- Zitat ---- Bei Auswahl von Weather erscheint noch ein Hinweis "Module: 46_TRX_WEATHER.pm Maintainer: KernSani Forum: RFXTRX" darüber. Das ist nicht gewollt.

--- Ende Zitat ---
Scheinbar doch: "help WEATHER" liefert das zurueck. Bestellt habe ich es zwar nicht, schlecht finde ich es trotzdem nicht.


--- Zitat ---- Unterhalb von der Überschrift "Device modules" steht ein einsames "global".
--- Ende Zitat ---
Stimmt, weiss aber nicht, wo es besser hinpassen wuerde.


--- Zitat ---Helper modules gehört abgeschafft.
--- Ende Zitat ---
Ich wollte mehrere Abschnitte bauen, und habe mit helper, command, device angefangen. Haenge nicht wirklich dran, wenn Mehrere sich fuer eine Abschaffung aussprechen.


--- Zitat --- würde mir aber trotzdem wünschen, dass man  gleich auf der betreffenden englischen Seite landet;
--- Ende Zitat ---
Das passiert automatisch, wenn man keine deutsche Doku einbaut.
Und bei mir funktioniert "Englische Doku für Shelly laden" ohne Probleme, auch fuer help.

Beta-User:
Hauptsystem ist einigermaßen aktuell, version meldet für 98_help.pm: 24900, global steht auf language DE.

Help shelly liefert den Hinweis, dass keine deutsche Dokumentation existieren würde, was nicht ganz richtig ist, denn dieser Hinweis IST die commandref-de, deine (zutreffende) Bemerkung paßt daher eben auf dieses Variante nicht...

--- Zitat von: rudolfkoenig am 16 September 2021, 19:14:22 ---Das passiert automatisch, wenn man keine deutsche Doku einbaut.

--- Ende Zitat ---

Jedenfalls taucht bei help shelly ein Link auf, der dahin verweist:

--- Code: ---http://<server>:8083/commandref.html#Shelly
--- Ende Code ---
Klicke ich darauf, lande ich auf der Seite, die ich via defaultRoom als Startseite für FHEMWEB definiert habe...
Kann natürlich sein, dass das System an irgendeiner Stelle verbogen ist oder der Browser (ff) da was falsch versteht ??? .


--- Zitat von: rudolfkoenig am 16 September 2021, 19:14:22 ---Und bei mir funktioniert "Englische Doku für Shelly laden" ohne Probleme, auch fuer help.

--- Ende Zitat ---
Wenn man die englische Seite direkt ansteuert (help shelly EN) ist das kein Problem.

Beim Klick auf commandref im Menü und anschließender Auswahl von Shelly aus der Modulliste lande ich auf

--- Code: ---http://<server>:8083/fhem/docs/commandref_DE.html#Shelly
--- Ende Code ---
Das ist wieder die Hinweisseite, dass es keine de-Doku gibt, und der angeboten Link ist wieder der mit dem _DE-Zusatz....

Falls das irgendeinen Unterschied macht: global-Doku steht bei mir schon ewig auf modular.

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...

Ad Vor- und Nachspann etc.:
- Ich fände ein Vorziehen von "global" überlegenswert;
- Wer nur den Text zum Modul haben will, kann "help" aufrufen;
- Grade für Anfänger finde ich es nicht unbedingt optimal, wenn die allgemeine Einbettung verloren ginge;
- evtl. wäre eine Voreinstellung denkbar, dass man das Laden des Rahmens unterbinden kann?

Bzgl. helper etc meine 2ct: Die Unterscheidung ist schon irgendwie - na ja - .... Aber alles in einem Wust ist auch nur bedingt hilfreich. Commands getrennt ist m.E. in jedem Fall weiter sinnvoll. Vielleicht könnte man die Bitte, alle Module im Hinblick auf commandref nochmal anzusehen erweitern dahingehend, dass die Verschlagwortung für den Installer möglichst nachgezogen wird. (Ich habe das zwar bei meinen Modulen vor längerem gemacht, aber auch nicht die vertiefte Idee, was damit genau passieren soll).

Dr. Boris Neubert:

--- Zitat von: rudolfkoenig am 16 September 2021, 19:14:22 ---Scheinbar doch: "help WEATHER" liefert das zurueck. Bestellt habe ich es zwar nicht, schlecht finde ich es trotzdem nicht.

--- Ende Zitat ---

Nee, das scheint ein Bug in 98_help.pm zu sein:


--- Code: ---  my ($err,@text) = FileRead({FileName => "$modPath/MAINTAINER.txt", ForceType => 'file'});
  foreach my $l (@text) {
    @line = split("[ \t][ \t]*", $l,3);
    $found = ($l =~ m/.._$mod.pm/i);
#    $found = ($l =~ m/_$mod/i);
    last if ($found);
  }
--- Ende Code ---

Das Module ist 59_Weather.pm und der Match findet 46_TRX_WEATHER.pm. Folgende Änderung in Zeile 268 löst das Problem:


--- Code: ---    $found = ($l =~ m/\d\d_$mod.pm/i);
--- Ende Code ---

Udo, liest Du mit?

Viele Grüße
Boris


Navigation

[0] Themen-Index

[#] Nächste Seite

Zur normalen Ansicht wechseln