Beschriftung im Editor

[wuestenfuchs]

Es wurde seinerzeit mal diskutiert, ob nicht im CometVisu-Editor jedes Element beschriftbar sein soll, damit die einzelnen Elemente im Editor leichter auseinander gehalten werden können... um Situationen wie im Anhang dargestellt zu vermeiden. Ich finde den Thread aber nicht mehr. Wie ist der Status hierzu?

[mwKNX]

.... für eine solche Änderung im Editor wäre ich auch zu haben

[jolt]

Das ist der falsche Ansatz. Ihr müsst nur schreiben wie viele Kästen Bier ihr bereit seit zu spenden um jemanden zu Überzeugen das Feature einzubauen.

Wenn jemand den alten Thread findet könnte ich mir das mal angucken, bin eh gerade am Editor dran...

[jolt]

Ach ja, und einen Mockup bitte wie das ganze aussehen soll. Manche Widgets haben ja schon eine Beschriftung (Pages, Groups).

[wuestenfuchs]

Okay, ich arbeite an einem Mockup. Gib mir ein paar Minuten...

[wuestenfuchs]

So, Mockup ist hochgeladen - siehe Anhang.

[jolt]

Was passiert bei pages & groups? Sollen die auch eine Description bekommen? Falls ja, wie wird das dann dargestellt? Statt des Namens? Zusätzlich?

[wuestenfuchs]

Ich denke, Descriptions könnten auch ruhig für pages und groups vorgesehen werden. Ist die Description für ein Element leer, dann wird im Tree der Name angezeigt, so wie bisher auch. Sobald aber eine Description eingetragen wird, wird anstatt des Namens die Description angezeigt.

[wuestenfuchs]

Oder die Beschriftung wird zusätzlich in Klammern angezeigt. Hab auch hier mal ein Mockup erstellt.

Generell wären solche Beschriftungsmöglichkeiten vermutlich für jedes Element sinnvoll.

[NetFritz]

Hallo
Wird denn die description auch in der config eingetragen?
Denn auch in der config kann man nicht alle Elemente auseinander halten.
z.B. in Gauge gibt es keine Beschriftung und ohne Kommentare ist es ein Blindflug.
Gruß NetFritz

[jolt]

So, habe mir das ganze gerade mal angeschaut. Im wesentlichen ist eigentlich bereits alles dar was benötigt wird. Per Default wird geschaut ob es ein "name" Attribut im Widget gibt und ob es nicht leer ist. Ist beides der Fall, wird der Inhalt dieses Attributes benutzt, um im Widget Tree einen Hinweis darzustellen. Das ist der Grund, warum einige Elemente bereits einen Hint anzeigen.

Wie gesagt, default ist das "name" Attribut. Man kann diese Verhalten aber im XSD überschreiben. Dazu muss man pro Widget, dass eine Beschriftung im Tree anzeigen soll, ein zusätzliches Tag einfügen:

<xsd:annotation>
    <xsd:appinfo>descriptor:<attribut name></xsd:appinfo>
</xsd:annotation>

Statt <attribut name> setzt man einfach den Namen des Attributes ein, dass die Beschreibung enthält, die man darstellen möchte. Natürlich kann man dabei auch neue Attribute anlegen. Unten ein Beispiel wie das ganze mit einem "description" Attribut aussieht. Ich habe dabei exemplarisch das page Widget erweitert. Man kann den zweiten Block aus dem Patch aber in jedes beliebige andere Widget kopieren, um dort ebenfalls eine Beschreibung zu erhalten.

NetFritz Die Beschreibung wird dann natürlich auch in der Config abgespeichert und ist dort sichtbar.

Zwei kleine Einschränkungen gibt es allerdings:

1. Wenn man die Anzeige auf ein eigenes Attribut umbiegt, dann wird dieses statt des "name" Attributes dargestellt. Also nicht beides gleichzeitig. Wer das gewünschte Verhalten <name> (<description>) haben möchte, muss also den Inhalt aus "name" und die Klammern zusätzlich in das description Feld mit eintragen.

2. Aktuell gibt es einen Bug im Editor. Sofern ein Widget ein "name" Attribut hat und man dieses ändert, wird im Tree wieder der Inhalt von "name" angezeigt und nicht das Custom Attribut. Die Daten bleiben trotzdem erhalten, nach einem Reload im Editor wird wieder die korrekte Beschreibung angezeigt. Ist also nur ein Darstellungsbug. Sollte trivial zu fixen sein.

Bottom line: Ich würde erst einmal gar nichts ändern wollen. Wer diese Funktionalität braucht, kann sich das über Anpassungen im XSD zurecht basteln. Reicht euch das?

Grüße,
Florian

diff --git a/src/visu_config.xsd b/src/visu_config.xsd
index 724da93..c7a8ced 100644
--- a/src/visu_config.xsd
+++ b/src/visu_config.xsd
@@ -317,7 +317,12 @@
     </xsd:simpleType>
   </xsd:attribute>
 
-
+  <xsd:attribute name="description" type="xsd:string">
+    <xsd:annotation>
+      <xsd:documentation xml:lang="en">Description of this widget to be shown in the editor</xsd:documentation>
+      <xsd:documentation xml:lang="de">Beschreibung des Widgets, die im Editor angezeigt wird</xsd:documentation>
+    </xsd:annotation>
+  </xsd:attribute>
 
   <!-- complex elements -->
   <xsd:element name="pages">
@@ -482,6 +487,10 @@
 
   <!-- define a page -->
   <xsd:complexType name="page">
+    <xsd:attribute ref="description" use="optional" />
+    <xsd:annotation>
+        <xsd:appinfo>descriptor:description</xsd:appinfo>
+    </xsd:annotation>
     <xsd:sequence>
       <xsd:element name="layout" type="layout" minOccurs="0" maxOccurs="1"/>
       <xsd:choice minOccurs="0" maxOccurs="unbounded">

[jolt]

Achso, einen Hinweis noch: Falls bei euch keine Hilfe im Editor angezeigt wird und der Complex Button keine Funktion hat, dann wird auch die Beschriftung nicht funktionieren. Es gibt aktuell ein Problem mit webKit basierten Browsern. Fix ist hier: https://github.com/CometVisu/CometVisu/pull/212

[wuestenfuchs]

Ich könnte mir gut vorstellen, dass ich nicht der Einzige mit diesem Problem bin. Insofern könnte eine Implementierung allen Nutzern zu Gute kommen.

Wenn es wirklich so trivial ist, könnte ich vermutlich mit meinen bescheidenen Programmierkenntnissen die Umsetzung weitgehend übernehmen, bräuchte aber etwas Zeit, um mich in die ganze Thematik (Git usw.) einzuarbeiten.

Möchte dazu aber erst die Meinung und das OK des Maintainers haben. Gerne auch Ideen/Vorschläge/Kritiken von anderen Nutzern!

[jolt]

Was ich mir vorstellen könnte ist, das man das Default von "name" auf "description" ändert und ggf. als weiteres Suchfeld hinzufügt. Dann müsste man nicht bei jedem Widget ein appinfo Tag vergeben.

Programmiert werden muss bei der XSD Anpassung übrigens rein gar nichts. Ist "nur" XML.