Doku ergänzen

[mwKNX]

Liebe CV-Benutzer!

Die Doku im Wiki ist ja bekanntermaßen an einigen Stellen lückenhaft
Ich würde die gerne schließen. Folgende Widgets fehlen noch gänzlich:

• Designtoggle
• Diagramm_Info
• Group
• Include
• Layout
• Navbar
• Pagejump
• Refresh
• Reload
• RGB
• Shade
• URL-Trigger
• WG_Plugin_info

Hier die zusätzlichen:

• Diagram
• RSSLog
• RSS
• calendarlist
• clock
• svg
• timeout
• upnpcontroller

Wer was weiß, kann es hier schreiben, ich übernehme es ins Wiki!

Ich hoffe auch viele Mitschreiber!

[Chris M.]

Grundsätzlich gibt es ein paar Quellen die man anzapfen kann um die Grundlagen für eine Übersetzung in "Anwenderisch" zu haben:

• Demo-Config - die sollte jedes Widget mit "typischen" Parametern zeigen
• die XSD-Datei - die sollte alle erlaubten Parameter aufführen
• Source Code - auch wenn man JavaScript nur gebrochen lesen kann sollte man einiges schon herauslesen können

Und final natürlich einfach fragen

[mwKNX]

71 Mal wurde mein Post bisher angeklickt und somit offenbar gelesen. Schade, dass niemand etwas schreiben will. Benutzt keiner diese ansonsten so schöne und einfach zu konfigurierende Visu? Es kann doch nicht sein, dass Chris der einzig Aktive hier ist!
Klar, sehe ich in der Demo-Konfig was alles geht, aber viele Dinge würden sich besser erschließen, wenn auch nur ein oder zwei Sätze dazu im Wiki stehen würden. Wofür zum Beispiel dienen die Einstellungen "x", "y", "z" und "width" im group-Widget? Höhe? Breite? Länge? in Pixeln? in Zentimetern?
Zu den Plugins: Die hat doch irgendwer mal geschrieben und öffentlich gemacht. Warum gibt es dann keine Doku dazu? Will man vielleicht mit CV unter sich bleiben?
Da ich momentan noch in der Experimentierphase für eine Visu bin, überlege ich mir ernsthaft, mich von CV abzuwenden. Es gibt ja noch andere.... Schade!

[starwarsfan]

Ich muss zugeben, ich stehe mit der Konfig auch noch auf Kriegsfuß und gebe Dir absolut recht. Die Doku ist nahezu null, ich weiß nicht mehr wie oft ich schon auf leeren Wikiseiten gelandet bin oder schlichtweg nichts gefunden habe. Mühsam ist das schon, leider...

[Tqm]

Ich versuche hier mal etwas zu ergänzen ...

• Designtoggle = zwischen verschiedenen Designs wechseln => aus meiner Sicht nur für die Demo Interessant
• Diagramm_Info
• Group = etwas in Gruppen zusammenfassen um so mehr Übersicht auf der Seite zu bekommen(z.Bsp. Seite Wohnzimmer; Group Beleuchtung Wohnzimmer; Group Heizung Wohnzimmer - in den jeweiligen Groups finden sich dann wieder verschiedene Elemente wie z.Bsp. in Beleuchtung Wohnzimmer: Switches und Sliders für Deckenlicht, Wandleuchten, usw.)
• Include
• Layout = definieren der Größe von Groups, Info-Feldern, Schaltflächen o.ä
• Navbar = Menüleisten z.Bsp. zur Raumauswahl o.ä
• Pagejump = auf die Seite X wechseln z.Bsp. Raum Wohnzimmer, Raum Küche usw.
• Refresh = Aktualisieren (wenn z.Bsp. der Rechner aus dem Standby wieder hochkommt)
• Reload = Neu laden der Konfiguration
• RGB
• Shade
• URL-Trigger
• WG_Plugin_info

[mwKNX]

Das ist doch schon mal ein kleiner Anfang! Jetzt nur noch alle Parameter kurz aber prägnant beschreiben und die Doku nimmt Fahrt auf

[Chris M.]

Es kann doch nicht sein, dass Chris der einzig Aktive hier ist!

Nö, da gibt's mehrere. Das "Problem" bei einer Visu ist aber ganz simpel: wenn die mal läuft, läuft die.
D.h. sobald man seine Visu so hat, dass sie einem gefällt kümmert man sich um anderes. Daher sind die Beiträge (sowohl im Forum als auch beim Code) sehr phasenweise. Die einen haben bereits was passendes und sind daher nicht mehr aktiv, andere erstellen aktuell eine Visu und sind aktiv und wieder andere sind noch nicht so weit und informieren sich erst mal.

Aus Projekt-Sicht wäre es natürlich wesentlich schöner wenn alle mit funktionierender Visu hier aktiv weiter machen würden - aber realistisch ist das nicht. Im Gegenteil, sehr viele die die Visu nutzen sind nicht mal im Forum angemeldet, geschweige denn aktiv!
Auch dem Bauch heraus und ohne Fakten auf die ich mich stützen kann würde ich mal sagen, dass zu jedem Visu Nutzer im Forum 10 ohne Forum kommen.

Und wenn man ehrlich ist: das ist noch ein super Verhältnis! Wie viele nutzen den Linux Kernel und sind nicht auf der Kernel Mailingliste eingetragen - geschweige denn haben jemals eine Zeile Code beigetragen?
Spontan fallen mir 9 aktiv genutzte Geräte mit Linux-Kernel bei mit im Haushalt ein (inkl. Android, Fritz!Box und NAS), könnte programmieren und gehöre bei Linux doch nur zu den Leechern.

Klar, sehe ich in der Demo-Konfig was alles geht, aber viele Dinge würden sich besser erschließen, wenn auch nur ein oder zwei Sätze dazu im Wiki stehen würden. Wofür zum Beispiel dienen die Einstellungen "x", "y", "z" und "width" im group-Widget? Höhe? Breite? Länge? in Pixeln? in Zentimetern?

Da bin ich auch absolut dafür!

Zu den Plugins: Die hat doch irgendwer mal geschrieben und öffentlich gemacht. Warum gibt es dann keine Doku dazu?

Meist weil Programmierer nicht unbedingt gute Doku-Schreiber sind. (Diese Kombination ist eher selten...).
Und weil die Leute hier den Code in ihrer Freizeit schreiben. Also wird das gemacht was Spass macht und das was keinen macht weg gelassen.

Und "dokumentiert" ist's ja im Thread wo das neue Feature vorgestellt wurde. Sicher nicht anwenderfreundlich - aber aus Sicht des Programmierers nachvollziehbar.

Will man vielleicht mit CV unter sich bleiben?

Gäbe es dann dieses Forum?

Du darfst die CV nicht wie ein kommerzielles Software-Produkt sehen. Dort entwickelt eine Firma hinter verschlossenen Türen und wirft dann Info-Brocken und Software über den Zaun wenn es der Firmenleitung passt. (Offensichtlicher Nachteil: Bei Fragen bist Du auf Wohlwollen angewiesen. Googeln in deren Intranet geht nicht.)
Bei Open Source Software die wie die CV in der Öffentlichkeit entwickelt wird ist's ganz anders: (annähernd) alle Kommunikation ist öffentlich einsehbar (vgl. dieses Forum und die GitHub Seite). Fragen kannst Du Dir mit Google o.ä. selber beantworten, oder, falls es was neues ist, einfach bei den Entwicklern direkt nachfragen. Im GitHub siehst Du sogar genau wer welche Zeile Code beigesteuert hat. Und jeder kann antworten, ohne Filter der Firmenleitung.

[Robosoc]

Das Plugin RGB scheint noch nicht freigegeben/aktiviert zu sein. In der Demo wurde es m.E. nicht verwendet (habe die Quellcode durchsucht) und in der im Wiregate vorinstallierten visu_config.xsd ist auch kein entsprechender Eintrag vorhanden. Ein Hinweis in der Wiki darauf, dass dieses Plugin noch nicht genutzt werden kann, wäre schön.

Ich beziehe mich auf die CometVisu-Version: WireGate 0.8.5-4

Natürlich kann man das recht einfach über drei Slides selber erstellen.

[mwKNX]

... ich habe es in der Tabelle vermerkt!

[Ziegelstein]

Moin,

besteht die Möglichkeit die ganze Doku auf eine andere Plattform zu legen, in der die ganze Formatierung, Bildeinfügung, Tabellen und so irgendwie einfacher geht.
Bin mehr so der PowerPoint Typ..

Hab mich gerade seid langem mal wieder versucht - ist aber echt krampfig.. siehe Designtoggle - Wie kann ich die Bilder austauschen bzw. neue Pfad anlegen (hatte von Page kopiert)

[mwKNX]

Ein Wiki ist eigentlich nichts schlechtes, vor allem weil jeder mit Berechtigung ändern kann. Ich persönlich bin mehr der LaTeX-Typ, da ich einfach einen schönen Textsatz mag. Hat aber den entscheidenden Nachteil, dass Änderungen nur schwer nachzuvollziehen sind (wie auch bei jeder anderen Datei-basierten Lösung). Es sei denn, es gibt ein Redaktionsteam, dass die jeweilige Datei bearbeitet und zum Beispiel nach drei Monaten aktualisiert/korrigiert online stellt.
Aber wie schon so oft geschrieben, Hauptsache CV wird überhaupt dokumentiert

[Ziegelstein]

hast du dir die Designtoggle seite mal angeschaut? wie ändere ich die Bilder??
das erschließt sich mir nicht.. Finde es eben recht aufwändig in diesem Format zu dokumentieren - könnte mir gut vorstellen, dass es da bessere Tools gibt. Wiki an sich ist ja schon super. klar. Nur eben die Bedienung nicht.

Danke, schöne Start ins WE an alle.

[tuxedo]

Bzgl. der kleinen Plattformdiskussion:

OpenHAB geht den Github-Weg.
CV ist meist im Wiki, aber auch das eine oder andere auf Github zu finden. Wäre es nicht sinnvoll sich für eines zu entscheiden statt zweigleisig zu fahren?
Dem Wiki an sich fehlt etwas Struktur. Evtl. könnte man hier bei OpenHAB ein wenig abschauen?

[Chris M.]

Für die Doku haben wir extra auf MediaWiki gesetzt, da dass die gleiche Basis wie die der Wikipedia ist. D.h. jeder der Wikipedia editieren kann, kann auch CometVisu-Doku editieren. Und man findet unzählige Dokus im Netz wie man das macht.

MediaWiki zu nutzen ist aber nicht in Stein gemeißelt. Nur, was ist besser? (Also leichter zum editieren? Schönere Darstellung? Leichter zu administrieren? ...)

Die Trennung zwischen der CV-Homepage (also dem MediaWiki-System) und dem Wiki auf GitHub ist einfach (wenn auch schlecht dokumentiert ): GitHub richtet sich nur an Entwickler. D.h. Infos für Entwickler gehören nach GitHub.
Die Homepage wendet sich an Anwender. D.h. Widget-Doku gehört auf die Homepage in's MediaWiki.