Befehlsreferenz nach Fhem Komponenten

[Karla]

Hallo,

ich wünsche mir eine besser strukturierte Befehlsreferenz.

Gerade Anfänger suchen sich in der rein alphabetisch sortierten Befehlsaufstellung dumm und dämlich und es dauert ewig, bis man die Möglichkeiten der über 500 Befehle von fhem ergründet hat.

Im Prinzip würde schon ein dynamisches Menu genügen, welches sich z.B. am Inhaltsverzeichniss der Systemübersicht im Wiki https://wiki.fhem.de/wiki/System%C3%BCbersicht orientiert:

Inhaltsverzeichnis
    1 Server
    2 perl
    3 Konfiguration
    4 Benutzeroberfläche
    5 Module
    6 Interfaces
    7 Protokolle
    8 Komponenten

Ich bin leider kein Webentwickler, aber der Aufwand für sowas scheint mir recht überschaubar.
Module für sowas bietet doch jedes CMS und eines sollte sich doch auch hier nutzen lassen.

Alternativ würde ich versuchen, die Inhalte der Kommandoreferenz in eine eigene Joomla-Installation zu übertragen ein entsprechendes Menü anzulegen, aber so ganz im Sinne freier Software finde ich das nicht.
Und eine dauerhafte Pflege der Inhalte wäre auch nicht gewährleistet.
Hätte ich Eure Erlaubniss die bestehende commandref.html hierfür zu nutzen?

greetz
Karla

[marvin78]

Was hälst du vom global Attribut commandref?

Es ist im Übrigen gar nicht so schwer, die Browsersuche nach Stichworten in der commandref zu verwenden. Ich habe noch nie mehr als 30 Sekunden darin gesucht.

[betateilchen]

ich wünsche mir eine besser strukturierte Befehlsreferenz.

Ich nicht, ich finde die schon gut und sinnvoll strukturiert. Und die Entwickler haben dazu eine Menge Zeit und Arbeit investiert, um diese Struktur aufzubauen.

Gerade Anfänger suchen sich in der rein alphabetisch sortierten Befehlsaufstellung dumm und dämlich und es dauert ewig, bis man die Möglichkeiten der über 500 Befehle von fhem ergründet hat.

Solange Du als Anfänger noch nichtmal verstanden hast, was in fhem "Befehle" sind, solltest Du besser die Finger von irgendwelchen von Dir ausgedachten Strukturen lassen. Da kann höchstwahrscheinlich nix sinnvolles rauskommen.

Alleine schon Dein "Inhaltsverzeichnis" ist haarsträubend.

[FranzB94]

@Karla:
http://www.duden.de/rechtschreibung/Erlaubnis

Er­laub­nis, die
Wortart: ℹ Substantiv, feminin

WUSSTEN SIE SCHON?   ℹ
Dieses Wort gehört zum Wortschatz des Zertifikats Deutsch.

[Karla]

@marvin78
Danke!

global Attribut commandref

hat die Sache tatsächlich schon viel übersichtlicher gestaltet
allerdings ist halt für viele Objekte keine Kurzbeschreibung hinterlegt, so das man immer noch ins Modul schauen muss um den Zweck zu ergründen.
Und warum zB das KM271 ein Hilfsmodul, km300 und KM273 aber normale Geräte sind, will sich mir nicht erschliessen.
Und natürlich habe ich die Suchleiste des Firefox griffbereit in der Symbolleiste liegen.

@betateilchen

Ich nicht, ich finde die schon gut und sinnvoll strukturiert.

Ok, deine Meinung.

Und die Entwickler haben dazu eine Menge Zeit und Arbeit investiert, um diese Struktur aufzubauen.

Ohne die Leistung Anderer schmälern zu wollen!
Der Aufbau der bestehenden "Struktur" ergib sich, von der groben Unterteilung in fhem-Befehle, Geräte und Hilfsmodule mal abgesehen, doch bislang nur aus der Wahl eines aussagekräftigen Namens für ein Device.
Und da sehe ich halt noch Möglichkeiten das zu verbessern? Was spricht denn bitte dagegen?
Die Qualität einer Software misst sich halt auch wesentlichen an ihrer Dokumentation.

Solange Du als Anfänger noch nichtmal verstanden hast, was in fhem "Befehle" sind, solltest Du besser die Finger von irgendwelchen von Dir ausgedachten Strukturen lassen. Da kann höchstwahrscheinlich nix sinnvolles rauskommen.

Alleine schon Dein "Inhaltsverzeichnis" ist haarsträubend.

Wo bitte geht es um "von mir ausgedachte" Strukturen?
Das nur als Vorschlag gepostete Inhaltsverzeichniss stammt aus dem WIKKI, ist als solches auch gekennzeichnet und ergibt sich aus dem logischen Aufbau von fhem.
Mein hier geäusserter Wunsch macht jedenfalls mehr Sinn als Deine "nett" formulierten Empfehlungen an mich.

@FranzB94
Bist Du die offizielle Rechtschreibprüfungsinstanz hier?
Oder nur noch einer der möglichst viele Posts geschrieben haben will?

Gut das es hier neben Blockwarten und Dummschwätzern auch noch echte Hilfe gibt.
Nur meine Frage nach der Weiterverwendung wurde leider noch nicht beantwortet.
Nu denn, das hat sich hier eh erledigt.

[Wuppi68]

License: GPL (v2)

sagt doch alles zur Weiterverwendung oder?

Und eine Referenz ist halt wie eine Inhaltsangabe zu verstehen: Kurz Knapp Klar

[Benni]

Alternativ würde ich versuchen, die Inhalte der Kommandoreferenz in eine eigene Joomla-Installation zu übertragen ein entsprechendes Menü anzulegen, aber so ganz im Sinne freier Software finde ich das nicht.

Die offizielle Doku findet sich in der Commandref, so wie sie ist, in jeder (aktuellen) FHEM-Installation und auf fhem.de:

https://fhem.de/commandref.html
https://fhem.de/commandref_DE.html

Und eine dauerhafte Pflege der Inhalte wäre auch nicht gewährleistet.

Es gibt schon genügend veraltete "Dokus", die die Anfänger verwirrt, wir brauchen bestimmt nicht noch eine!