[FHEM Tablet-UI] Dokumentation (Diskussionsthread)

Begonnen von Standarduser, 06 Februar 2017, 18:03:03

Vorheriges Thema - Nächstes Thema

drhirn

Habe mal das Label Widget online gestellt. Bin aber leider nicht ganz fertig geworden und komme wahrscheinlich erst nächste Woche wieder dazu. Wer möchte, darf also gerne ;)

tomster

So, zurück aus der Internetdiaspora.
Hui, da hat sich ja Einiges getan im Wiki. Respekt, Jungs.

Kurze Frage:
Gibt es irgendwo eine "Assign-List", auf der man erkennen kann, wer an welchem Wiki-Eintrag arbeitet? Ich muss gestehen, dass ich die letzten 8 Seiten nur überflogen habe, aber so direkt rauslesen, welche noch nicht veröffentlichten Seiten bereits vergeben sind konnte ich nicht...

Fall nichts entegenspricht, würde ich mich über "Spinner" hermachen. Scheint noch nicht vergeben, oder?

drhirn

Zitat von: tomster am 09 Februar 2017, 15:20:50
Gibt es irgendwo eine "Assign-List", auf der man erkennen kann, wer an welchem Wiki-Eintrag arbeitet? Ich muss gestehen, dass ich die letzten 8 Seiten nur überflogen habe, aber so direkt rauslesen, welche noch nicht veröffentlichten Seiten bereits vergeben sind konnte ich nicht...

Am einfachsten ist's, wenn du dir direkt auf der Tablet UI Seite die Links zu den Widgets ansiehst. Ein rote Link sagt, die Seite gibt's noch nicht. Ein blauer, dass die Info noch von einer externen Seite übernommen werden muss. Die grünen musst du dir genauer ansehen. Verlinken sie auf eine eigene Seite ist's gut. Verlinken sie noch auf die alte Beschreibung direkt auf der Tablet UI-Seite, müssen die auch noch gemacht werden.

ZitatFall nichts entegenspricht, würde ich mich über "Spinner" hermachen. Scheint noch nicht vergeben, oder?

Spricht nichts dagegen. Danke!

tomster

Zitat von: drhirn am 09 Februar 2017, 15:54:02
Am einfachsten ist's, wenn du dir direkt auf der Tablet UI Seite die Links zu den Widgets ansiehst. Ein rote Link sagt, die Seite gibt's noch nicht. Ein blauer, dass die Info noch von einer externen Seite übernommen werden muss. Die grünen musst du dir genauer ansehen. Verlinken sie auf eine eigene Seite ist's gut. Verlinken sie noch auf die alte Beschreibung direkt auf der Tablet UI-Seite, müssen die auch noch gemacht werden.

Da hab ich mich mißverständlich ausgedrückt. Das oben Beschriebene ist mir auch schon aufgefallen. Es könnte jedoch sein, dass Jemandem ein Widget zugeordnet ist, und der noch gar nicht angefangen hat... Wollte nur vermeiden, dass man sich Arbeit 2 Mal macht ;-)

Spinner_V0.1 setht online


drhirn

Zitat von: tomster am 09 Februar 2017, 16:19:33
Da hab ich mich mißverständlich ausgedrückt. Das oben Beschriebene ist mir auch schon aufgefallen. Es könnte jedoch sein, dass Jemandem ein Widget zugeordnet ist, und der noch gar nicht angefangen hat... Wollte nur vermeiden, dass man sich Arbeit 2 Mal macht ;-)

Das haben wir bisher im ersten Post dieses Threads gemacht.

Zitat
Spinner_V0.1 setht online

Super!


drhirn

Wobei's eigentlich fast sinnvoller wäre, ein paar Beispiele direkt auf der Wiki-Seite darzulegen. Inkl. Bilder. setstate erlaubt uns sicher, seine Beispiele auszuleihen ;)

tomster

Zitat von: drhirn am 09 Februar 2017, 16:40:19
Wobei's eigentlich fast sinnvoller wäre, ein paar Beispiele direkt auf der Wiki-Seite darzulegen. Inkl. Bilder. setstate erlaubt uns sicher, seine Beispiele auszuleihen ;)

Touché.. War ich gerade zu faul, reich ich aber die Tage nach.

Ulm32b

So, jetzt habe ich mich als Wiki-Neuling einigermaßen orientiert und auch schon etwas korrekturgelesen.

Lt. Seite 1 ist "weather" noch nicht vergeben. Da kenne ich mich etwas aus und könnte das übernehmen.

Standarduser

#115
Zitat von: Ulm32b am 09 Februar 2017, 14:10:31
Gibt es eine Einstiegsseite mit einer Übersicht zu den schon erstellten neuen Widget-Dokus? Dort könnte man ja seinen Claim abstecken, damit nicht zwei Leute an der selben Sache arbeiten.
Ich hätte auch nichts dagegen, wenn man in der Doku ganz konkret offene Punkte vermerkt ("Tbd"). Das wird sich dann bestimmt schnell klären.

Zitat von: drhirn am 09 Februar 2017, 14:22:26
Im ersten Beitrag dieses Threads war eigentlich geplant, festzuhalten, wer an was arbeitet und was zu tun ist. Könnten wir wieder aufgreifen.

Zitat von: tomster am 09 Februar 2017, 15:20:50
Kurze Frage:
Gibt es irgendwo eine "Assign-List", auf der man erkennen kann, wer an welchem Wiki-Eintrag arbeitet? Ich muss gestehen, dass ich die letzten 8 Seiten nur überflogen habe, aber so direkt rauslesen, welche noch nicht veröffentlichten Seiten bereits vergeben sind konnte ich nicht...

Ich versuche, alles Relevante immer im ersten Post dieses Threads mitzuschreiben. Wenn sich jemand meldet, der sich um eine Seite kümmern möchte, schreibe ich das dahinter. Ist eine Seite fertig, so steht das eigentlich auch da. Also am besten, Ihr schaut vor jeder Aktion nochmal in den ersten Post, damit sich keiner die Mühe umsonst macht.
Machmal bin ich aber auch offline (selten, aber passiert ;) ) Dann vielleicht nochmal die letzten Posts anschauen, ob sich irgendwer schon für ein Widget interessiert.

Zitat von: drhirn am 09 Februar 2017, 16:40:19
Wobei's eigentlich fast sinnvoller wäre, ein paar Beispiele direkt auf der Wiki-Seite darzulegen. Inkl. Bilder. setstate erlaubt uns sicher, seine Beispiele auszuleihen ;)

Das Ziel sollte sein, eine komplett unabhängige Doku zu erstellen. Bisher haben wir alle Beispiele direkt in die Wiki-Seiten integriert und ich fände es super, wenn da alle mitziehen würden.

Zitat von: Ulm32b am 09 Februar 2017, 14:10:31
Haben wir schon eine generelle Übereinkunft, dass jeder ohne Rückfrage Änderungen in der Doku vornehmen kann (insbes. auch kleine Schreib- und Formatierungsfehler)? Und sollte man das dann in der Änderungshistorie oder sonstwo beschreiben?

Bitte erstmal nicht dazwischen funken, aber gern auf Fehler hinweisen. Ich glaube, wir lernen ja hier alle noch dazu, somit ist der Lerneffekt für die betroffenen auch besser. Wir wollen aber natürlich schnellstmöglich in den normalen Wiki-Betrieb übergehen, wo dann jeder auch an jeder Seite mitarbeiten darf.

Zitat von: Ulm32b am 09 Februar 2017, 17:17:07
Lt. Seite 1 ist "weather" noch nicht vergeben. Da kenne ich mich etwas aus und könnte das übernehmen.

Zitat von: tomster am 09 Februar 2017, 15:20:50
Fall nichts entegenspricht, würde ich mich über "Spinner" hermachen. Scheint noch nicht vergeben, oder?

Ist notiert -> 1. Post im Thread

Noch ein paar generelle Anmerkungen zur Vorgehensweise:
Die Tablet-UI Hauptseite im Wiki besteht momentan (vereinfacht gesagt) aus:
- Einleitung
- Auflistung aller Widgets
- Konfiguration aller Widgets
- Beispiele zu allen Widgets

Wenn jemand eine Seite erstellt hat, dann bitte das entsprechende Widget (Konfiguration und Beispiele) aus der Hauptseite löschen und den Link in der Widget-Liste auf die neue Seite umlenken. So gibt es keine doppelte Doku. Bei der Zusammenfassung der Änderung schreibt Ihr dann bitte hinein, dass die Doku für dieses Widget auf eine neue Seite ausgelagert wurde.
Tipp: Manchmal sind die Beispiele von der Hauptseite besser, als die auf Github.

Standarduser

Achja, alles was im ersten Post noch nicht als "done" markiert ist, muss noch erledigt werden  ;D

Standarduser

Zitat von: drhirn am 09 Februar 2017, 09:42:33
Ist erledigt.
In der linken Zelle steht jetzt der fehlerhafte Klassenname, in der rechten "Fehler: Klasse ist nicht vorhanden".
Bunt schreiben geht leider nicht.

Funktioniert echt gut  ;)

Ulm32b

#118
Zitat
Bin ja übrigens gespannt, wann das erste Widget von den anderen kommt, die so begeistert von der Idee waren ;)
Zitat
Vielleicht sollten wir uns den Badge "FTUI Doku-Team" verpassen, damit die anderen vor Ehrfurcht erstarren und vor Angst einfach loslegen 
Bin weder ehrfürchtig noch ängstlich, vielleicht etwas sorgfältig. :D

Bitte schön, mein erster Wiki: https://wiki.fhem.de/wiki/FTUI_Widget_Weather

Etwas Hilfe brauche ich noch: Wie klappt man den etwas umfangreichen Code ein?

Übringens: Geht es euch auch so? Doku schreiben finde ich gerade spannender als als meine FTUI-Seite zu optimieren. ;D

Standarduser

Zitat von: Ulm32b am 10 Februar 2017, 04:53:13
Bitte schön, mein erster Wiki: https://wiki.fhem.de/wiki/FTUI_Widget_Weather
Sieht gut aus! Zum Thema "Bitte prüfen" hätte ich folgendes beizutragen:
Die Einleitung zur Seite sollte so aussehen: Das [[{{PAGENAME}}|Widget Weather]] ist ein Widget für [[FHEM Tablet UI]]... Das hat aber All-Ex schon hinzugefügt.

Bitte nicht in der Attribute-Tabelle in der Spalte "Standard-Wert" verlinken, das könnte zu Missverständnissen führen. Die links stehen doch schon in der Beschreibung und weiter oben.

Könntest Du vielleicht 1 bis 2 Sätze zu den Beispielen hinzufügen, was da zusehen ist und wie das funktioniert, und den Beispielen richtige Namen verpassen? Ich würde die vielleicht "Einfaches Symbol mit min- und max-Temperatur", sowie "Detaillierte Wetteranzeige mit Vorhersage" nennen (oder so ähnlich). Ich fände es auch schön, wenn der Code richtig eingerückt und das Bild darüber, statt darunter wäre.

Kopiervorlage:
<li data-row="1" data-col="1" data-sizex="4" data-sizey="4">
<div class="sheet">
<div class="row">
<div class="col-1-3">
<div data-type="label" class="cell top-space narrow">morgens</div>
<div data-type="weather" data-device="Proplanta" data-get="fc0_weatherMorningIcon" data-imageset="kleinklima" class="cell"></div>
<div data-type="label" data-device="Proplanta" data-get="fc0_weatherMorning" class="cell top-narrow"></div>
<div data-type="label" data-device="Proplanta" data-get="fc0_temp06" data-unit="%B0C%0A" class="cell bigger" data-limits='[-50,0]' data-colors='["#5858FA","white"]'></div>
</div>
<div class="col-1-3">
<div data-type="label" class="cell top-space narrow">mittags</div>
<div data-type="weather" data-device="Proplanta" data-get="fc0_weatherDayIcon" data-imageset="kleinklima" class="cell"></div>
<div data-type="label" data-device="Proplanta" data-get="fc0_weatherDay" class="cell top-narrow"></div>
<div data-type="label" data-device="Proplanta" data-get="fc0_temp12" data-unit="%B0C%0A" class="cell bigger" data-limits='[-50,0]' data-colors='["#5858FA","white"]'></div>
</div>
<div class="col-1-3">
<div data-type="label" class="cell top-space narrow">abends</div>
<div data-type="weather" data-device="Proplanta" data-get="fc0_weatherEveningIcon" data-imageset="kleinklima" class="cell"></div>
<div data-type="label" data-device="Proplanta" data-get="fc0_weatherEvening" class="cell top-narrow"></div>
<div data-type="label" data-device="Proplanta" data-get="fc0_temp18" data-unit="%B0C%0A" class="cell bigger" data-limits='[-50,0]' data-colors='["#5858FA","white"]'></div>
</div>
</div>
</div>

<div class="container top-space-3x">
<div data-type="label" class="cell bigger darker">Morgen</div>
</div>

<div class="sheet">
<div class="row">
<div class="col-1-3">
<div data-type="label" class="cell top-space darker">morgens</div>
<div data-type="weather" data-device="Proplanta" data-get="fc1_weatherMorningIcon" data-imageset="kleinklima" class="cell half-transparent"></div>
<div data-type="label" data-device="Proplanta" data-get="fc1_weatherMorning" class="cell top-narrow darker"></div>
<div data-type="label" data-device="Proplanta" data-get="fc1_temp06" data-unit="%B0C%0A" class="cell bigger" data-limits='[-50,0]' data-colors='["#a3a3fc","grey"]'></div>
</div>
<div class="col-1-3">
<div data-type="label" class="cell top-space darker">mittags</div>
<div data-type="weather" data-device="Proplanta" data-get="fc1_weatherDayIcon" data-imageset="kleinklima" class="cell half-transparent"></div>
<div data-type="label" data-device="Proplanta" data-get="fc1_weatherDay" class="cell top-narrow darker"></div>
<div data-type="label" data-device="Proplanta" data-get="fc1_temp12" data-unit="%B0C%0A" class="cell bigger" data-limits='[-50,0]' data-colors='["#a3a3fc","grey"]'></div>
</div>
<div class="col-1-3">
<div data-type="label" class="cell top-space darker">abends</div>
<div data-type="weather" data-device="Proplanta" data-get="fc1_weatherEveningIcon" data-imageset="kleinklima" class="cell half-transparent"></div>
<div data-type="label" data-device="Proplanta" data-get="fc1_weatherEvening" class="cell top-narrow darker"></div>
<div data-type="label" data-device="Proplanta" data-get="fc1_temp18" data-unit="%B0C%0A" class="cell bigger" data-limits='[-50,0]' data-colors='["#a3a3fc","grey"]'></div>
</div>
</div>
</div>
</li>


Bitte auch nicht vergessen, Weather aus der Hauptseite zu entfernen und den Link in der Liste umzulenken. Dazu hatte ich hier schonmal etwas geschrieben.

Zitat von: Ulm32b am 10 Februar 2017, 04:53:13
Etwas Hilfe brauche ich noch: Wie klappt man den etwas umfangreichen Code ein?
Bin ich garnicht so der Fan, aber drhirn hat das hier schonmal verwendet: https://wiki.fhem.de/wiki/FTUI_Widget_Link

Zitat von: Ulm32b am 10 Februar 2017, 04:53:13
Übringens: Geht es euch auch so: Doku schreiben finde ich gerade spannender als als meine FTUI-Seite zu optimieren. ;D
Absolut! Ich hab in den letzten Tagen garnichts mehr an meiner FTUI gemacht, außer den Versuch zu starten, alle Widgets mal auf eine Seite zu packen - da arbeite ich aber noch dran  ;)

BTW: was sind das eigentlich für Uhrzeiten, zu denen Du aktiv bist?  ;D

Ansonsten möchte ich mal allen, die sich hier beteiligen, meinen Dank aussprechen. Ich hatte eingangs schon die befürchtung, dass das 'ne Nullnummer wird. Aber das hat ja ganz schön Fahrt aufgenommen und das Ergebnis kann sich echt schon sehen lassen.