Umgang mit Widersprüchen zwischen CommandRef, Wiki und dem Rest des Internets

Begonnen von Dr. Boris Neubert, 30 Januar 2018, 06:57:03

Vorheriges Thema - Nächstes Thema

ph1959de

Zitat von: Beta-User am 30 Januar 2018, 13:01:34
... aber "sofern vorhanden" ist m.E. irreführend
Habe ich nur "auf die Schnelle" so formuliert, weil ich den Aufwand zur unterschiedlichen Behandlung von offiziellen / inoffiziellen (für die es ja keinen commandref-Eintrag gibt) Modulen gerade nicht spendieren kann.
Aktives Mitglied des FHEM e.V. | Moderator im Forenbereich "Wiki"

nils_

sollte man auch erwähnen das es einen unterschied gibt/geben kann zwischen lokaler und online commandref?
ich bin mir nicht sicher, ob dies auch jedem klar ist.
viele Wege in FHEM es gibt!

Beta-User

Link auf der Hauptseite ist eingebaut. Leider fällt das optisch nicht so sehr ins Auge, da grün auf grün, ich wollte den Text aber auch nicht zu sehr betonen. Wer Vorschläge hat, wie man das besser lösen kann: her damit...

Zitat von: ph1959de am 30 Januar 2018, 13:42:11
Habe ich nur "auf die Schnelle" so formuliert, weil ich den Aufwand zur unterschiedlichen Behandlung von offiziellen / inoffiziellen (für die es ja keinen commandref-Eintrag gibt) Modulen gerade nicht spendieren kann.
Schon irgendwie klar, und der Einwand, dass es bei inoffiziellen Modulen nicht paßt, ist ja auch richtig.
Wie wäre es mit "Bei offiziell mit FHEM ausgelieferten Modulen enthält im Zweifel immer die (englische) commandref die aktuellste Dokumentation."

Wenn es dann noch "Ausreißer" bei den "offiziellen" gibt, sollten wir die möglichst einfangen (deutscher Text in engl. commandref-flags bzw. unvollständig); das dürfte allg. im Sinne des Projekts sein ;) .
Server: HP-elitedesk@Debian 12, aktuelles FHEM@ConfigDB | CUL_HM (VCCU) | MQTT2: MiLight@ESP-GW, BT@OpenMQTTGw | MySensors: seriell, v.a. 2.3.1@RS485 | ZWave | ZigBee@deCONZ | SIGNALduino | MapleCUN | RHASSPY
svn: u.a MySensors, Weekday-&RandomTimer, Twilight,  div. attrTemplate-files

Amenophis86

Naja eine Checkbox vor einem Update brauche ich auch nicht, darüber könnte man lediglich bei einem Major Relase oder wichtigen Änderungen wie umbennenung von Attributen nachdenken. Aber ein Hinweis zusätzlich bei der ersten Installtion sollte in meinen Augen nicht verkehrt sein. Und eine News-Device, welches einem Hinweise zu aktuellen Sachen gibt finde ich auch nicht schädlich. Aber ich wiederhole mich und bin still :)
Aktuell dabei unser neues Haus mit KNX am einrichten. Im nächsten Schritt dann KNX mit FHEM verbinden. Allein zwei Dinge sind dabei selten: Zeit und Geld...

Benni

Zitat von: Amenophis86 am 30 Januar 2018, 14:53:25
Und eine News-Device, welches einem Hinweise zu aktuellen Sachen gibt finde ich auch nicht schädlich. Aber ich wiederhole mich und bin still :)

Wie sollte denn das News-Device "gefüttert" werden?

Ein rssFeed-Device wäre evtl. eine Möglichkeit. Das gibt es schon und man bräuchte dafür nur einen geeigneten Feed, der von irgendjemandem mit den entsprechenden Nachrichten/Informationen befüllt werden müsste.

Für die Code-Changes ginge, nur mal so als Beispiel sowas jetzt schon:


define rssFHEMCodeChanges rssFeed https://svn.fhem.de/trac/log/trunk?format=rss&rev=HEAD&limit=200&mode=stop_on_copy 14400


Wie und wo man das sowas optisch sinnvoll einbinden könnte ist dann auch noch dieFrage.

Update: Teilweise präzisere Formulierung

Amenophis86

An RSS habe ich auch gedacht. Ich meinte aber auch nicht, dass jede Änderung in einem Modul eine Meldung generieren muss. Viel mehr in dieser Form:

- Es gibt ein "News" Device, welches regelmäßig auf Neuigkeiten prüft
- Neuigkeiten können sein:
-- Wichtige Änderungen in FHEM (Major Relase, Änderung von Attr. Namen (siehe aktuelle Diskussion))
-- SVN etc. Down oder Update (wie aktuell oben rechts im Forum)
- Entscheidung was News sind und nicht hat nur ein ausgewählter Kreis und nicht jeder Developer, sonst wird es zu voll und die Gefahr, dass es "missbraucht" wird steigt

Aber das ist eigentlich ein anderes Thema. Für das hier genannte Thema würde ich eher empfehlen, dass bei der Erstinstallation ein entsprechender Hinweis kommt. Aktuell erhält man ja die Sicherheitswarnung bezüglich allowed etc. Genau hier könnte man auch Informationen zur Doku verankern. Warum? Viele, die FHEM das erst Mal installiert haben noch keinen Plan wirklich und sehen diese Meldung als erste, so soll es ja auch sein. Wieso dann nicht direkt hier auf entsprechende Sachen wie CommandRef, Wiki, Forum etc. hinweisen mit dem Hinweis was die einzelnen Dinge sind? Ein Hinweis im Wiki auf der Startseite überlese ich, weil ich vielleicht direkt über die Google Suche in einem Beitrag gelandet bin, gleiches gilt fürs Forum. Wenn ich was neu installiere lese ich vermutlich doch recht genau, was das Programm mir bei der ersten Installation mitteilt.
Aktuell dabei unser neues Haus mit KNX am einrichten. Im nächsten Schritt dann KNX mit FHEM verbinden. Allein zwei Dinge sind dabei selten: Zeit und Geld...

pc1246

Moin
Ich will kurz mal auch etwas dazu posten. Ich finde es immer wieder laestig, dass, egal ob auf irgendwelchen (Blog-)Seiten oder auch im fhem-Wiki, das Aenderungsdatum ganz unten steht. So manches Mal habe ich waerend des Lesens schon vergessen, dass ich mal schauen wollte, wie alt der Eintrag ist. Warum macht man das nicht ganz prominent nach oben? Damit kann auch jede(r) Hilfesuchende recht gut erkennen wie aktuell der Eintrag ist, und als normal Denkende(r) ihre/seine Schluesse ziehen!
Nur so mein Gedanke
Gruss Christoph
HP T610
Onkyo_AVR;3 Enigma2; SB_Server ; SB_Player; HM-USB mit 15 HM-CC-RT-DN, 3 HM_WDS10_TH_O, 6 HM-Sec-SCo, 4 HM-Sec-MDIR-2, 1 HM-Sen-MDIR-O-2, 8 Ferion 5000 OW ; PhilipsTV; 4 harmony hub; Jeelink mit 9 PCA301; Somfy; S7-300; 3 LGW; HUE; HM-IP auf Charly

marvin78


Markus Bloch

Ich werde die kommenden Tage mal folgende Mediawiki Extension testen und ggf. im Wiki aktivieren: https://www.mediawiki.org/wiki/Extension:LastModified

Gruß
Markus
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

pc1246

Zitat von: Markus Bloch am 31 Januar 2018, 15:56:22
Ich werde die kommenden Tage mal folgende Mediawiki Extension testen und ggf. im Wiki aktivieren: https://www.mediawiki.org/wiki/Extension:LastModified

Gruß
Markus
Hallo Markus
Ich sehe jetzt nicht, dass das den gewuenschten Erfolg bringt! Das ist doch sogar schon implementiert, oder?
Nur eben leider ganz am Ende, und nicht ganz oben!?
Oder bin ich auf dem falschen Dampfer?
Gruss Christoph
HP T610
Onkyo_AVR;3 Enigma2; SB_Server ; SB_Player; HM-USB mit 15 HM-CC-RT-DN, 3 HM_WDS10_TH_O, 6 HM-Sec-SCo, 4 HM-Sec-MDIR-2, 1 HM-Sen-MDIR-O-2, 8 Ferion 5000 OW ; PhilipsTV; 4 harmony hub; Jeelink mit 9 PCA301; Somfy; S7-300; 3 LGW; HUE; HM-IP auf Charly

Markus Bloch

Die Extension würde das aber prominent oben neben dem Seitentitel postieren (siehe Screenshot auf der Seite). So das man sofort sieht, wann die letzte Aktualisierung erfolgte.

Gruß
Markus
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

pc1246

Ah
Sorry, das hatte ich nicht gesehen. Wenn man was anderes erwartet, sieht man den Wald vor lauter Baeumen nicht.
Finde ich gut, ist sogar fast noch besser, da sofort sichtbar ist wie alt der Eintrag ist.
Gruss Christoph
HP T610
Onkyo_AVR;3 Enigma2; SB_Server ; SB_Player; HM-USB mit 15 HM-CC-RT-DN, 3 HM_WDS10_TH_O, 6 HM-Sec-SCo, 4 HM-Sec-MDIR-2, 1 HM-Sen-MDIR-O-2, 8 Ferion 5000 OW ; PhilipsTV; 4 harmony hub; Jeelink mit 9 PCA301; Somfy; S7-300; 3 LGW; HUE; HM-IP auf Charly

krikan

Mir gefällt ein solch prominenter Hinweis auf die letzte Aktualisierung überhaupt nicht. Ich halte sie für deutlich kontraproduktiv.

Das letzte Aktualisierungsdatum sagt doch gar nichts über die Gültigkeit des Artikels oder gar die Qualität aus. Man muss die Infos aus Wikiartikeln im Zusammenhang mit den weiteren Infos, insbesondere der commandref, bewerten. Erst dann kann man etwas zur Gültigkeit/Qualität/Aktualität eines Artikels aussagen. Das erfordert die mMn für FHEM wichtige Lernbereitschaft.

Das prominente Platzieren der letzten Aktualisierung führt doch vmtl. nur dazu, dass Artikel mit altem Aktualisierungsdatum nicht gelesen werden, selbst wenn sie noch aktuell und gültig sind. Und das sind nicht wenige. Stattdessen fragt man direkt im Forum und erhöht den Supportaufwand. Natürlich kann ich auch unnötige Pseudoaktualisierungen vornehmen, um Aktualität zu dokumentieren.

Die commandref ist die Befehlsreferenz und das muss jedem klar sein. Deshalb wird/wurde das eben noch mehr betont. Ein Wiki bleibt aber ein Wiki. Es ergänzt und das sollte jedem klar sein. Es enthält eben auch Fehler. An der Beseitigung kann auch jeder mitwirken und man lernt auch daraus.

Gruß, Christian

Dr. Boris Neubert

Idee: im Template der Wikiseite einen Link auf Commandref vorsehen (bitte um Nachsicht, wenn das schon drin ist - kann das gerade nicht prüfen).
Globaler Moderator, Developer, aktives Mitglied des FHEM e.V. (Marketing, Verwaltung)
Bitte keine unaufgeforderten privaten Nachrichten!

krikan

Zitat von: Dr. Boris Neubert am 31 Januar 2018, 19:11:59
Idee: im Template der Wikiseite einen Link auf Commandref vorsehen (bitte um Nachsicht, wenn das schon drin ist - kann das gerade nicht prüfen).
In der klassischen Ansicht haben wir das vor ca. einem Jahr in die Sidebar aufgenommen.
In der mobilen Ansicht ist es leider nicht vorhanden; Sidebar ist dort nicht sichtbar.