commandref-Darstellung

[Markus Bloch]

Funktionieren damit auch Links die auf Attribute in anderen Modulen verweisen? <a href="#disable"> bedeutet ja nicht "lad das Modul disable". Typischer Fall ist ja hier immer <a href="#dummy">

Ich habe mir die Änderungen angeschaut, bin mir aber nicht sicher, ob dies abgedeckt ist.

Gruß
Markus

[rudolfkoenig]

Dann solltest es probieren, Klick auf disable klappt bei mir verlaesslich. Musste etwas betruegen, da etliche Module disable mit <a name="disable"> definieren: ich uebernehme die erste Definition, un das ist im at Modul, was mir gehoert

Btw: manche Module verwenden das # mAn falsch, insb. in CUL_HM und HMInfo sind die meisten Namen mit # definiert, und das ist eigentlich nicht im Sinne der Erfinders: name gehoert ohne #, href mit #. @Martin: bitte fixen
Ich habe mich selbst bei dem Unsinn auch ertappt, und habe 3 Module korrigiert

[Markus Bloch]

Top! Funktioniert 

[UliM]

Hallo,
schon seit einiger Zeit finde auch ich, dass das Inhaltsverzeichnis der commandref immer unübersichtlicher wird.
Möchte dazu einen Vorschlag zur Diskussion stellen und bin bei der Suche nach Vorhandenem auf diesen thread gestoßen.

@Markus: Was ist denn daraus geworden? Soll hier noch was passieren, wie soll es aussehen, was müssen einzelne developer beitragen?

Über das (soweit ich gelesen habe) bereits Vorgeschagene hinaus möchte ich zur Diskussion stellen, die Module zu kategorisieren.
Helper / Nicht-Helper gibt's ja schon, das scheint mir angesichts der Anzahl der Module aber mittlerweile etwas knapp.
Ich möchte gerne 2 Dimensionen vorschlagen mit zB diesen initialen Wertelisten:
1. Übertragungsweg: Funk, dediziertes Kabel/Bus, LAN/WLAN, Webservice - auf dieser Ebene würde auch die Kategorie Helper passen
2. Anwendungsgebiet:  Messen, Schalten, Regeln, Multimedia, ClimateControl, EnergyControl, GUI-representation (für readingsProxy etc)
In beiden Dimensionen sollen Mehrfachnennungen möglich sein.
Initle Befüllung der Parameter könnte ich übernehmen an hand Analyse vorhandener Threads im Forum in den entspr. Themengebieten.
Als Nutzen erwarte ich, dass vor allem Anfänger sich leichter einen Überblick verschaffen können welche Anwendungsgebiete fhe abdeckt, und welche Modue dafür jeweils vorhanden sind.
Welche Dimensionen mit welchen Werten am Ende verwendet warden sollen, kann man ja gemeinsam erarbeiten, im ersten Schritt geht's mir um das "ob", noch nicht um das "wie".

Erste Frage an Markus als Thread-Eröffner: passt das hier rein oder soll ich nen separaten Thread aufmachen?

Gruß, Uli

[Loredo]

Ein sehr guter Vorschlag.

Lässt sich in dem Atemzug auch noch über die Formatierung nachdenken? Auch wenn das bedeutete, dass man jedes Modul dafür anfassen müsste, fände ich es besser die Doku in Markdown Format zu hinterlegen. Ich gebe zu die Formatiererei ist aktuell so aufwändig, dass dies auch ein Grund ist die Doku eher knapp zu halten oder nicht gut zu pflegen. Etwas wie Markdown würde mir da wirklich sehr helfen, vielleicht geht es ja auch anderen so?


Gruß

Julian

[rudolfkoenig]

Was ist denn daraus geworden? Soll hier noch was passieren, wie soll es aussehen, was müssen einzelne developer beitragen?

Man kann fuer die eigene FHEM-Installation die Anzeige/Generierung des commandrefs umstellen auch modular.
Leider verwendet das Feature FHEM bzw. das help Befehl, funktioniert also nicht auf http://fhem.de/commandref.html.
Dazu muessten wir noch was ueberlegen, ist bei mir unten auf der TODO Liste. Falls jemand vorpreschen moechte, nur zu.

Zu deiner weiteren Kategorisierung habe ich keine fertige Meinung.
Nur die Angabe hilft nicht, man braeuchte auch eine geaenderte Darstellung.

fände ich es besser die Doku in Markdown Format zu hinterlegen

Und ich haette gerne FHEM als node.js Projekt umgebaut, waere deutlich schneller, und das leidige blockieren Thema waere auch weg. Sorry, das war unhoeflich, aber ich finde deinen Vorschlag sehr aufwendig umzusetzen, insb. die Tests, dass es in allen Browsern mit allen Styles funktioniert. Doku & SVN-Hooks sind auch nicht zu vergesessen. Und dann muessen alle Modulautoren ueberzeugt werden, es gibt bestimmt welche, die lieber dieses eingeschraenkte HTML machen. Aber falls du fuer die Umstellung fertige Skripte hast, und das Ergebniss deutliche Vorteile hat, dann koennen wir das zur Diskussion stellen.

[Loredo]

Sorry, das war unhoeflich

Sehr.
-> /dev/null

[UliM]

Nur die Angabe hilft nicht, man braeuchte auch eine geaenderte Darstellung.

Stimmt. Ich würd mir etwas vorstellen was neumodisch "tabs" heisst.
Also als default-Darstellung "Everything" wie bisher, alternativ (nach klick) nach Kategorie A (Uebertragungsweg / connection type) oder B (Anwendungsgebiet / usage area) sortiert/gegliedert. M.E. einzig fraglicher Punkt ist Darstellung bei Mehrfachzuordnung in einer Kategorie.

Voraussetzung sind aber sinnvolle Kategorien und Werte, das ist m.E. der Dreh- und Angelpunkt.

Rudi, wenn Du kein Veto einlegst, würde ich mal nen konkreten Vorschlag machen.
Wäre eine Umsetzung dann über zusätzliche POD-Parameter möglich?

Gruß, Uli

[rudolfkoenig]

Rudi, wenn Du kein Veto einlegst, würde ich mal nen konkreten Vorschlag machen.

Nur zu. ich schlage "=item category XX,YY,ZZ" vor, wobei die bisherigen "=item command", "=item device" und "=item helper" noch beruecksichtigt werden, damt nicht alles umgebaut wird.

Wofuer willst du es einbauen? commandref_join.pl oder commandref_modular.pl? Ich sehe die Zukunft in commandref_modular.pl, da fehlt aber noch die "statische" Unterstuetzung, damit es ohne fhem.pl auf fhem.de laufen kann.

[UliM]

ich schlage "=item category XX,YY,ZZ" vor, wobei die bisherigen "=item command", "=item device" und "=item helper" noch beruecksichtigt werden, damt nicht alles umgebaut wird.

Wenn es 2 Dimensionen gibt, aber nur einen identifier "category", dann müssten die Werte Tupel sein:
=item category connection:WLAN,LAN;usage:Multimedia,ClimateControl
Geht das?

Würde bevorzugen
=item connection WLAN,LAN
=item usage Multimedia,ClimateControl
Oder geht nur genau ein einziges tag?

Wofuer willst du es einbauen? commandref_join.pl oder commandref_modular.pl? Ich sehe die Zukunft in commandref_modular.pl, da fehlt aber noch die "statische" Unterstuetzung, damit es ohne fhem.pl auf fhem.de laufen kann.

Na wenn Du da die Zukunft siehst, würde ich's an commandref_modular.pl versuchen

M.E. sollte die neue Darstellung primär in der commandref auf fhem.de platziert werden.

Gruß, Uli

[rudolfkoenig]

Oder geht nur genau ein einziges tag?

Tags gibts einerseits beliebig viele (weil =item von mir enteignet wurde), andereseits sollten wir fuer einen Zweck nicht beliebig viele erfinden, da weiss man naemlich nicht mehr, was wozu ist. Und ich habe den Verdacht, dass du mit connection und usage nicht am Ende bist. Vorschlag: mehrere =item category Zeilen, dann kannst du den Trenner auch sparen.