[FHEM Tablet-UI] Dokumentation (Diskussionsthread)

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

Vorheriges Thema - Nächstes Thema

drhirn

Hab das Link-Widget um die Navigation ergänzt: Navigationsbeispiel

Ist wirklich ein komplexes Beispiel. Aber ich denke, das kann man schon auf der Hauptseite abhandeln. Eine extra Seite für komplexe Beispiele könnte wieder unübersichtlich werden.


drhirn

Können wir bitte im Einleitungstext sowohl auf die Widget-Seite selbst, als auch auf FHEM Tablet UI verweisen? Damit gleich klar ist, wo der Inhalt dazu gehört falls einer zufällig auf die Seite kommt.

Analog zum Link-Widget z.B.:
Das [[{{PAGENAME}}|Link Widget]] ist ein Widget für [[FHEM Tablet UI]] mit dem ein Text-Link oder Button erstellt werden kann um Befehle an FHEM zu senden.

Standarduser

Zitat von: drhirn am 08 Februar 2017, 11:09:08
Hab das Link-Widget um die Navigation ergänzt: Navigationsbeispiel

Ist wirklich ein komplexes Beispiel. Aber ich denke, das kann man schon auf der Hauptseite abhandeln. Eine extra Seite für komplexe Beispiele könnte wieder unübersichtlich werden.

Würde es vielleicht Sinn machen, verschiedene Navigations-Varianten mal an einer Stelle zusammenzufassen, Beispiele hinzu, sowie Vor- und Nachteile aufzulisten?
Es sind ja doch so einige Varianten im Umlauf: Slideout, Tabbar, Pagetab, Pagebutton, Link, ...

Standarduser

Zitat von: drhirn am 08 Februar 2017, 11:35:50
Können wir bitte im Einleitungstext sowohl auf die Widget-Seite selbst, als auch auf FHEM Tablet UI verweisen? Damit gleich klar ist, wo der Inhalt dazu gehört falls einer zufällig auf die Seite kommt.

Analog zum Link-Widget z.B.:
Das [[{{PAGENAME}}|Link Widget]] ist ein Widget für [[FHEM Tablet UI]] mit dem ein Text-Link oder Button erstellt werden kann um Befehle an FHEM zu senden.

Klar, gute Idee. Baue ich gleich bei meinen Seiten ein.

drhirn

Zitat von: Standarduser am 08 Februar 2017, 11:38:17
Würde es vielleicht Sinn machen, verschiedene Navigations-Varianten mal an einer Stelle zusammenzufassen, Beispiele hinzu, sowie Vor- und Nachteile aufzulisten?

Ja, könnte man bei Gelegenheit machen.

Standarduser

Da fehlen übrigens 2 Kommas im Text.

Das Link Widget ist ein Widget für FHEM Tablet UI, mit dem ein Text-Link oder Button erstellt werden kann, um Befehle an FHEM zu senden.

Kermit20

Hallo Leute,

ich habe mit Interesse eure Beiträge verfolgt und mit Freude festgestellt das schon einiges getan wird. Aus Erfahrung möchte ich einen Ergänzenden Vorschlag machen:

Wie aus der IT so üblich, hat jeder seine "best practices"... leider führt das manchmal zu uneinheitlichen Erscheinungsbildern, Detailtiefe und möglichen Darstellungen. Da wir nun für das Thema bei "null" anfangen, sollten wir die Chance nutzen einen Standard für die Beiträge zu schaffen.

z.B.

die Darstellung von Atributen in einer Tabelle oder das Einfügen von Quelltext in einer Klappbox, Code Markierungen in Farbe und Form.

So sollten wir Wildwuchs eindämmen können.
RPi1: FHEM mit HMLAN und CUL Eigenbau: diverse Homematic Geräte; Technoline Temp/Feuchte 868 MHz // Schalsteckdosen 433 MHz
RPi2: FHEM mit Viessmann(optolink) mit VControl und 1W Sensoren
RPi3: Apache / Owncloud 9

Standarduser

Wir fangen zwar nicht bei null an, aber ich versteh schon, was Du meinst.

Zitat von: Kermit20 am 08 Februar 2017, 11:55:22
die Darstellung von Atributen in einer Tabelle
Machen wir doch

Zitat von: Kermit20 am 08 Februar 2017, 11:55:22
das Einfügen von Quelltext in einer Klappbox
Kommt sicher immer auf den Umfang des jeweiligen Beispiels an

Zitat von: Kermit20 am 08 Februar 2017, 11:55:22
Code Markierungen in Farbe und Form
Macht das Wiki automatisch, solange man den Parameter für die Sprache nicht vergisst

drhirn

Der Gedanke kam mir auch schon. Und dann ist mir die inzwischen jahrelange Diskussion mit meinem Vorgesetzten eingefallen. Der möchte nämlich in unserem Wiki auch zuerst alle Grundregeln festgelegt haben. Ich hingegen bin der Meinung, dass es schlauer ist, den Usern zuerst mal ihre Freiheiten zu lassen und dann nachzubessern, sobald Inhalt da ist. Das Ergebnis nach 4 Jahren Diskussion: Keine Inhalte im Wiki, weil noch immer kein Regelwerk erstellt wurde :D

Ich bleibe daher bei meiner Meinung. Die Tablet UI Dokumentation ist überschaubar. Da kann leicht im Nachhinein noch geändert werden. Was sowieso notwendig sein wird, weil's immer User geben wird, die die Regeln übersehen ;).
Und wenn man sich an die bisherigen vier Beispiele hält, kann kaum was schief gehen.

Ulm32b

Auch ich bin höchst beeindruckt. Als noch vergleichsweise unerfahrener Anwender kann ich mir noch die Brille des Newbees aufsetzen und möchte freundlich folgende Anregungen geben:

Zitatdata-url-xhr    URL, mit der der Verweis im Hintergrund aufgerufen werden kann
Was bedeutet das? Wird der Link im Hintergrund geöffnet und ständig aktualisiert, um beim Aufruf die Ladezeiten zu verkürzen?

Zitatdata-active-pattern    RegEx mit der der ermittelt wird, ob der Link aktiv ist. Der Check wird gegen die aktuelle "document location" durchgeführt
Bei RegEx bitte einen Verweis auf eine Erläuterung, was das ist und wofür das gut ist. Ich weiß nicht mehr genau, wo ich das seinerzeit gefunden habe, es existiert jedenfalls.

Zitatdata-active-color    Farbe des Textes oder Icons wenn das "active-pattern" zutrifft    same as data-color
Stammt der englische Text aus einem Copy-paste?

ZitatÜberschrift: Button zum Aufrufen einer URL
Sollte besser heißen: Button-ähnlicher Link zum Aufrufen einer URL. Sonst wähnt man sich hier in der Beschreibung von "Button". Für Button wird es aber doch wohl eine eigene Beschreibung geben. Das gilt auch für die nachfolgenden Überschriften.


drhirn

Werde ich alles korrigieren.

Bei data-url-xhr war ich mir leider nicht sicher, wie ich das am besten formulieren soll. Vorschläge erbeten.

Das mit der Farbe ist in der Tat ein Copy&Paste-Fehler.

Bzgl. RegEx: Hmm, es gibt hunderte Erklärungen im Web. Ich schau mal, ob ich eine gut verständliche Webseite finde und werde die verlinken.

Standarduser

#72
RegEx ist ja bei vielen Widgets möglich. Vielleicht sollten wir das direkt in die Hauptseite zur Tablet UI als separaten Abschnitt einfügen? Oder gleich als eigenständige Seite. Immerhin kann man da ganze Abhandlungen darüber schreiben, insbesondere zu Beispielen.

drhirn

RegEx ist in FHEM wichtig. Bin noch nicht ganz davon überzeugt, dass wir das überhaupt erklären sollen.

krikan