Widget-Dokus; War: svgplot widget update - wie update "hochladen"?

Begonnen von curt, 18 Oktober 2018, 21:52:42

Vorheriges Thema - Nächstes Thema

ph1959de

Zitat von: drhirn am 15 November 2018, 09:01:46
Mit dem Kasten hast du dich in ein Minenfeld begeben! Die Info-Box ist nur für FHEM-Module. Und ein FTUI-Widget ist kein FHEM-Modul. Über die Idee mit so einer Hinweisbox selbst mag ich nicht urteilen. Ich hab da keine Meinung dazu. Könnte auch alles einfach im Einleitungssatz vorkommen. Aber diese Vorlage für die Info-Box deklariert die ganze Wiki-Seite als FHEM-Modul (Kategorie: Modul (inoffiziell)). Das ist ganz, ganz schlecht. Also wenn man so eine Info-Box wollte, müsste man selber eine Vorlage basteln.

Einen Autor zu erwähnen, der unbekannt ist, halte ich übrigens nur für bedingt sinnvoll.
Minenfeld würde ich nicht unbedingt sagen - Curt hat bei mir im Wiki ja auch schon angefragt wegen der Infobox. Ich schaue mir mal an, ob man die bestehende Vorlage anpassen kann oder (wahrscheinlich besser) eine neue speziell für Widgets erstellt.

Peter
Aktives Mitglied des FHEM e.V. | Moderator im Forenbereich "Wiki"

drhirn

Ja, hab ich gelesen.
Ich persönlich würde - wenn überhaupt - eine eigene bevorzugen. Bin auch gerne bereit, die zu erstellen. Ich sehe nur den Sinn dahinter noch nicht (macht's nur kompliziert). Und man müsste sich einigen, was darin alles stehen sollte.

ph1959de

Zitat von: drhirn am 15 November 2018, 09:14:41
Ich sehe nur den Sinn dahinter noch nicht (macht's nur kompliziert).
Gleichartige Information auf allen (Widget-)Seiten in gleicher Anordnung... -
Zitat von: drhirn am 15 November 2018, 09:14:41
Und man müsste sich einigen, was darin alles stehen sollte.
Mit einem sinnvollen Basissatz anfangen - das bei ein paar Widgets (den zugehörigen Wiki Seiten natürlich) exemplarisch einfügen - falls nötig dann später erweitern.

Peter
Aktives Mitglied des FHEM e.V. | Moderator im Forenbereich "Wiki"

drhirn

Die gleichartige Anordnung haben wir mit dem Einleitungssatz auch. Der Aufbau der Seite ist bei den meisten Widgets gleich.

Um konkreter zu werden, wenn ich mich auf die Info-Box, wie sie derzeit auf der Svgplot-Seite ist, beziehe:
- Zweck / Funktion: Steht im Einleitungssatz
- Typ: irrelevant, weil eh klar
- Dokumentation: Sollte genau diese Wiki-Seite sein
- Support (Forum): Link dahin bisher am Ende der Seite unter "Weblinks"
- Modulname: irrelevant
- Ersteller: bedingt relevant

curt

Zitat von: ph1959de am 15 November 2018, 09:10:53
Minenfeld würde ich nicht unbedingt sagen

Na gut, dann bin ich auf die einzige Mine getreten, die auf weitem Feld lag ... <lacht>

Zitat von: ph1959de am 15 November 2018, 09:10:53
Curt hat bei mir im Wiki ja auch schon angefragt wegen der Infobox. Ich schaue mir mal an, ob man die bestehende Vorlage anpassen kann oder (wahrscheinlich besser) eine neue speziell für Widgets erstellt.

Ich würde eine neue Infobox bevorzugen.

Der Denkfehler ist -darf ich das so sagen- , das alle denken: Oh, Infobox muss mindestens sieben Punkte haben. Nein, muss nicht. Wenn es nur zwei sind - ist das auch nicht schlimm. Der zweite Denkfehler ist, dass alle denken, dass in den drei Feldern auch Infos stehen müssen. Nein, muss nicht: Wenn da nichts steht, ist das auch eine Information. (Begründung unten).

Ich sehe folgende Anstriche:
* letzter bekannter Autor (ggf. Nickverlinkung)
* wann lief das Widget erfolgreich?
* Diskussionsthread im Forum

Den schon geäußerten Bedenken trete ich wie folgt entgegen:
Wenn eine/mehrere/alle Informationen unbekannt sind, dann steht da u/i oder deutsch "unbekannt". DAS ist auch eine Information!
02:54:06 ludwig5: -0,3°C, Raureif, trocken. Chries war nich da.

Ich begründe wie folgt:
Ich beschäftige mich seit ... pühh, höchstens drei Monaten mit FTUI. Und ärgere mich ständig über nicht vorhandene Dokus: Es gibt so viele so tolle widgets (ich beziehe mich nicht auf die wohldokumentierten solchen). Manche werden auf der Wiki-FTUI-Seite erwähnt, sind aber "rot". Andere schlummern als upload in den Tiefen des Forums. Manche kann ich sofort zum Leben erwecken, eins konnte ich mit der Hilfe von @setstate uswusf. Noch andere Widgets sind offenbar kaputt.

Das Problem mache ich an mir selbst aus: Ich bin oft kurz vor dem aufgeben: Wenn es zu einem der selten genutzten Widgets eine auch nur rudimentäre Doku gäbe, die im  Kasten mit den Autor sagt (oder eben auch NICHT sagt), die mir sagt, dass 2018-08 jemand das Ding zum Laufen bekam (oder da steht u/i) wäre das für mich eine sehr wertvolle Information.

P.S: Argument für die unbedingte Nennung/Verlinkung des Nicks des Autoren, soweit bekannt:
Der Autor hat pseudonym (kein Klarname, nur Nick) im Forum durch das Hochladen ein Widget verfügbar gemacht, sein Beitrag ist weltweit findbar/lesbar. Er muss es sich gefallen lassen, dass er zitiert wird. Er muss es sich gefallen lassen, dass auf seinen Beitrag Bezug genommen wird. (Und wenn ihm das nicht passt, steht es ihm frei, im Wiki-Artikel in der Infobox "obsolent" "nicht funktional" "wird nicht weiterentwickelt" einzutragen. - Das klingt hart. Aber so ist die Lage.
RPI 4 - Jeelink HomeMatic Z-Wave

drhirn

Zitat von: curt am 17 November 2018, 03:17:10
Ich begründe wie folgt:
Ich beschäftige mich seit ... pühh, höchstens drei Monaten mit FTUI. Und ärgere mich ständig über nicht vorhandene Dokus: Es gibt so viele so tolle widgets (ich beziehe mich nicht auf die wohldokumentierten solchen). Manche werden auf der Wiki-FTUI-Seite erwähnt, sind aber "rot". Andere schlummern als upload in den Tiefen des Forums. Manche kann ich sofort zum Leben erwecken, eins konnte ich mit der Hilfe von @setstate uswusf. Noch andere Widgets sind offenbar kaputt.

Das ist jetzt vielleicht eine blöde Frage, aber was erwartest du jetzt? Dass alles, was von irgendjemand gebastelt wird auch gleich von der Person im Wiki dokumentiert wird? Oder eine Person ständig sämtliche Threads im Forum durchsucht, ob's vielleicht ein neues Widget gibt und das gleich dokumentiert? Wenn's keine Doku zu einem Widget gibt, dass du gerne verwenden würdest, schreib doch einfach eine.

Wann ein Widget erfolgreich lief, ist eigentlich egal. Die Frage ist, ob's auf einem aktuellen System noch läuft. Wenn es das nicht tut, roter Hinweis an den Anfang der Wiki-Seite. Fände ich viel praktischer.