diff --git a/.doc/docutils/directives/widget_example.py b/.doc/docutils/directives/widget_example.py index 41a60bb7dd8..6a3bedd4232 100644 --- a/.doc/docutils/directives/widget_example.py +++ b/.doc/docutils/directives/widget_example.py @@ -99,7 +99,7 @@ class WidgetExampleDirective(Directive): example_dir = path.join("cache", "widget_examples", "manual") screenshot_dir = path.join("doc", "manual", "examples") config_parts = { - "start": '', + "start": '', "meta": '', "content_start": '', "content_end": '', @@ -195,6 +195,11 @@ def run(self): "name": screenshot.get("name", name + str(shot_index)), "data": [] } + if screenshot.get("clickpath", None): + shot['clickPath'] = screenshot.get('clickpath') + if screenshot.get("waitfor", None): + shot['waitFor'] = screenshot.get('waitfor') + shot_index += 1 for data in screenshot.iter('data'): @@ -222,11 +227,14 @@ def run(self): # replace the design value in the config visu_config_parts['start'] = visu_config_parts['start'].replace("%%%DESIGN%%%", design) + if config.tag == "page": + visu_config_parts['content_start'] = "" + visu_config_parts['content_end'] = "" # build the real config source visu_config = visu_config_parts['start'] + \ visu_config_parts['meta'] + \ - visu_config_parts['content_start'] + \ + visu_config_parts['content_start'] + \ etree.tostring(config, encoding='utf-8').decode('utf-8') + \ visu_config_parts['content_end'] + \ visu_config_parts['end'] diff --git a/.doc/screenshots-spec.js b/.doc/screenshots-spec.js index deb9c90de43..c2f3d232534 100644 --- a/.doc/screenshots-spec.js +++ b/.doc/screenshots-spec.js @@ -188,6 +188,9 @@ describe('generation screenshots from jsdoc examples', function () { selectorPrefix = ""; mockedConfigData.mode = "editor"; } + if (settings.selector.includes(".activePage")) { + selectorPrefix = ""; + } mockupConfig.push(mockedConfigData); it('should create a screenshot', function () { @@ -240,6 +243,18 @@ describe('generation screenshots from jsdoc examples', function () { cvMockup.sendUpdate(data.address, data.value); }); } + if (setting.clickPath) { + + var actor = element(by.css(setting.clickPath)); + if (actor) { + actor.click(); + var waitFor = setting.waitFor ? setting.waitFor : selectorPrefix+settings.selector; + widget = element(by.css(waitFor)); + browser.wait(function() { + return widget.isDisplayed(); + }, 1000); + } + } widget.getSize().then(function (size) { widget.getLocation().then(function (location) { diff --git a/doc/manual/de/config/hydraulik.rst b/doc/manual/de/config/hydraulik.rst index 786a16b7275..5556acf04c6 100644 --- a/doc/manual/de/config/hydraulik.rst +++ b/doc/manual/de/config/hydraulik.rst @@ -175,8 +175,8 @@ ist die Leitung als Gruppe eingefasst class="pipe_group show_flow flow_control" data-cometvisu-active="1/0/3"> + .... + ..../> .. figure:: _static/XML4.png diff --git a/doc/manual/de/config/index.rst b/doc/manual/de/config/index.rst index 3fdd8da0e8c..f5104570eb4 100644 --- a/doc/manual/de/config/index.rst +++ b/doc/manual/de/config/index.rst @@ -87,11 +87,9 @@ Der strukturierte Aufbau der xml-formatierte Konfigurationsdatei ist in mehrere Sektionen unterteilt, innerhalb derer alle weiteren Einträge verschachtelt und durch Tags umschlossen aufgenommen werden. -.. TODO:: +.. toctree:: - - Aufbau der Konfiguration (Grundstruktur) - - *Attribute*: Allgemein erklären - - *Elemente*: Allgemein erklären + xml-format Navigationselemente in der CometVisu @@ -104,7 +102,7 @@ Navigationselemente in der CometVisu Die verfügbaren Designs ------------------------ -* :doc:`Metal ` - das wohl beliebteste Dasign +* :doc:`Metal ` - das wohl beliebteste Design * Pure - Standard-Design * Diskreet * Diskreet Sand diff --git a/doc/manual/de/config/xml-format.rst b/doc/manual/de/config/xml-format.rst index 3361b8cd635..10bd6297017 100644 --- a/doc/manual/de/config/xml-format.rst +++ b/doc/manual/de/config/xml-format.rst @@ -1,6 +1,188 @@ .. replaces:: CometVisu/XML-Elemente XML-Elemente +XML-Struktur +============ + +Eine XML-Datei besteht aus verschiedenen "Elementen", die insgesamt +einen Baum darstellen. Ein Element kann weitere Elemente einschließen. +Über "Attribute" kann ein Element Werte annehmen. Einige dieser +Attribute müssen zwingend vergeben werden. + +Die visu_config.xml (Header) +---------------------------- + +Die Konfigurationsdatei beginnt immer mit folgenden beiden Zeilen: + +.. code-block:: xml + + + + +In der zweiten Zeile ist folgende Einstellung relevant: + ++---------------------+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+------------+ +| Option | Beschreibung | Werte | Zwingend | ++=====================+=============================================================================================================+============================================================================+============+ +| ``design="pure"`` | Mit dieser Option wird das Standard-Design festgelegt, dass auf die Visualisierung angewendet werden soll | pure, metal, discreet, discreet_sand, discreet_slim, alaska, alaska_slim | JA | ++---------------------+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+------------+ + + + +Als nächstes kommen in der visu_config.xml alle Definitionen für +Plugins, Mappings, Stylings, Icons und die Statusleiste. Die Reihenfolge +ist wie folgt: + +.. code-block:: xml + + + + + + + + + Stop + Start + + + + + + red + green + + + + + + + + + by CometVisu.org + - Reload + - Widget Demo + ]]> + Edit + ]]> + normal Mode + ]]> + Check Config +
Version: SVN
+ ]]> + + + +Die Optionen von oben nach unten im Überblick: + +Plugins +------- + ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+------------+ +| Option | Beschreibung | Werte | Zwingend | ++==========================+======================================================================================================================================================+==================================+============+ +| ```` | Mit dieser Option werden die Plugins eingebunden. Hier wird der Name des Plugins eingetragen. Pro Plugin muss ein solcher Eintrag angelegt werden. | z.B. colorchooser oder diagram | NEIN | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+------------+ + +Mappings +-------- + ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+-------------+------------+ +| Option | Beschreibung | Werte | Zwingend | ++============================================+================================================================================================================================+=============+============+ +| ```` | Mit dieser Option wird der Name des Mappings definiert. Dieser wird auch im Web-Editor bei entsprechenden Widgets angezeigt. | z.B. | JA | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+-------------+------------+ +| ``NAME`` | Mit dieser Option wird einem Wert ein Namen zugewiesen. Für jeden möglichen Wert muss ein solcher Eintrag angelegt werden. | z.B. Stop | JA | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+-------------+------------+ + +Stylings +-------- + ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+------------+------------+ +| Option | Beschreibung | Werte | Zwingend | ++=============================================+================================================================================================================================+============+============+ +| ```` | Mit dieser Option wird der Name des Stylings definiert. Dieser wird auch im Web-Editor bei entsprechenden Widgets angezeigt. | z.B. | JA | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+------------+------------+ +| ``FARBE`` | Mit dieser Option wird einem Wert eine Farbe zugewiesen. | z.B. red | JA | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+------------+------------+ + +Icons +----- + ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------+------------+ +| Option | Beschreibung | Werte | Zwingend | ++===============================================+=========================================================================================================================================================================================================================================================================================================================================================================================+=========+============+ +| ```` | Mit dieser Option wird der Name des Icons definiert, welches sich unter dem in uri angegebenen Verzeichnis befindet. Auf die so definierten Icons kann dann im weiteren Verlauf über den einfacher zu merkenden Namen zugegriffen werden. Die Verzeichnisangabe ist im Beispiel relativ zur CV installation. Hier wurden vorher die Icons in einem eigenen Unterverzeichnis abgelegt. | z.B. | NEIN | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------+------------+ + +Statusbar +--------- + .. TODO:: - Inhalte übertragen \ No newline at end of file + Statusbar beschreiben + +Aufbau der Visu-Seiten +---------------------- + +Als erstes muss eine Seite als Startseite angelegt werden. Dies +geschieht mit dem obersten Container. Alle weiteren Widgets und Seiten +befinden sich innerhalb dieser Hauptseite. Die Position der Elemente +wird von oben nach unten verarbeitet. Das sieht schematisch so aus: + +.. widget-example:: + + + + Startseite mit Link zur Unterseite + + + Unterseite + 0 + + + + + + + + + + + +
1/0/5
+ + + + +
1/2/59
+
1/2/60
+
1/2/61
+ + + +Dieses kleine Beispiel erstellt eine Hauptseite mit dem Namen +**Startseite**. Auf dieser Startseite wird zu oberst ein Link zu einer +Unterseite mit dem Namen **Seite1** angelegt. Auf dieser Unterseite wird +zu oberst eine Schaltfläche mit dem Namen **Spot Fernseher** eingefügt. +Als nächstes wird auf der Hauptseite der Colorchooser mit dem Namen +**RGB Küche** eingefügt. + +Mit dieser Struktur können beliebig komplexe Seitenstrukturen angelegt +werden. Eine Beschreibung der einzelen Widgets mit den zugehörigen XML +Codes finden Sie in der :doc:`Widgetübersicht ` + +In der letzten Zeile der Config muss noch der Tag geschlossen werden. +Dafür muss also noch folgender Eintrag am Ende der Datei eingefügt +werden: + +.. code-block:: xml + + + +Damit ist die visu_config.xml vollständig und kann auf den Server +übertragen werden. \ No newline at end of file diff --git a/doc/manual/de/install/wiregate.rst b/doc/manual/de/install/wiregate.rst index 884e98ec722..0929b94bc7c 100644 --- a/doc/manual/de/install/wiregate.rst +++ b/doc/manual/de/install/wiregate.rst @@ -46,21 +46,18 @@ Schritte: öffnen (kann eine kurze Verzögerung geben) und ggf. das Textfeld zur besseren Übersicht mit dem Handle in der rechten unteren Ecke vergrößern -#. Das HTML-Element abändern auf **, also z.B. auf *Edit* +#. Das **-HTML-Element abändern auf **, also z.B. auf *Edit* #. Mit Klick ganz oben auf der Seite auf "preview" testen, ob die Seite wie gewünscht funktioniert #. Falls ja: mit Klick ganz oben auf der Seite auf "save" die Config abspeichern --------------- -Um die neueste Version der CometVisu (0.8.5) auf dem WireGate zu -installieren sind folgende Schritte durchzuführen: +Um die neueste Version der CometVisu (0.8.5) auf dem WireGate zu installieren sind folgende Schritte durchzuführen: -#. Installation des CometVisu-Paketes (d.h. die alte Version 0.6) um +#. Installation des aktuellsten CometVisu-Paketes um sicher zu stellen, dass alle Abhängigkeiten erfüllt sind - so diese - Version noch nicht genutzt wird. Siehe hier: `Installation Version - 0.6 `__ + Version noch nicht genutzt wird. #. Anmelden an der Konsole (Linux-Nutzer nehmen einfach ssh, Windows Nutzer nehmen z.B. das kostenlose Programm putty) #. An der Konsole werden diese Befehle benötigt: