Merge pull request #401 from peuter/develop

add page widget documentation

.doc/docutils/directives/common.py

@@ -208,9 +208,12 @@ def generate_complex_table(self, element_name, include_name=False, mandatory=Fal
                         sub_parent = "%s\n * %s" % (parent, element_name)
                     else:
                         sub_parent = element_name
-                    self.generate_complex_table(name, include_name=include_name,
-                                                mandatory=mandatory, table_body=table_body,
-                                                sub_run=True, parent=sub_parent)
+                    #no recursions
+                    if name != element_name:
+                        print("Name: %s, Element-Name: %s" % (name, element_name))
+                        self.generate_complex_table(name, include_name=include_name,
+                                                    mandatory=mandatory, table_body=table_body,
+                                                    sub_run=True, parent=sub_parent)
                 else:
                     (sub_element, atype, doc) = sub_element
                     indent = 2 if parent is not None else 1

.doc/main.py

@@ -131,7 +131,7 @@ def main():
     parser.add_argument('--doc-type', "-dt", dest="doc", default="manual",
                         type=str, help='type of documentation to generate (manual, source)', nargs='?')
 
-    parser.add_argument('action', type=str, help='what should I do?', nargs='?')
+    parser.add_argument('action', type=str, help='action (doc, create-widget-skeleton)', nargs='?')
     options = parser.parse_args()
 
     if options.action is None:

doc/manual/de/config/widgets/page/index.rst

@@ -0,0 +1,75 @@
+.. _page:
+
+Das Page Widget
+===============
+
+Beschreibung
+------------
+
+Das Page-Widget fügt der Visualisierung eine Seite hinzu. Eine Seite kann beliebig viele Widgets (auch weitere Seiten)
+enthalten. Die Seiten dienen dazu die Widgets inhaltlich zusammenzufassen. So kann man z.B. für jeden Raum eine
+Seite hinzufügen und dort alle Widgets einfügen, die in diesem Raum vorhanden sind (z.B. alle Lampen, Steckdosen,
+Jalousien und sonstigen Informations- und Bedienungsmöglichkeiten innerhalb dieses Raumes.
+
+.. TODO::
+
+    Weitere Erklärungen zum Page-Widget, ggf. Beispiele (aus der Metal-Demo?)
+
+Einstellungen
+-------------
+
+Für eine grundsätzliche Erklärung des Aufbaus der Konfiguration und der Definition der im folgenden benutzten
+Begriffe (Elemente, Attribute) sollte zunächst dieser Abschnitt gelesen werden: :ref:`visu-config-details`.
+
+Das Verhalten und Aussehen des Page-Widgets kann durch die Verwendung von Attributen und Elementen beeinflusst werden.
+Die folgenden Tabellen zeigen die erlaubten Attribute und Elemente. In den Screenshots sieht man, wie
+beides über den :ref:`Editor <editor>` bearbeitet werden kann.
+
+Nur die mit * gekennzeichneten Attribute/Elemente müssen zwingend angegeben werden, alle anderen sind optional und können
+daher weg gelassen werden.
+
+
+Erlaubte Attribute im Page-Element
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. parameter-information:: page
+
+.. widget-example::
+    :editor: attributes
+    :scale: 75
+    :align: center
+
+        <caption>Attribute im Editor (vereinfachte Ansicht) [#f1]_</caption>
+        <page>
+          <layout colspan="4" />
+          <text>Test</text>
+        </page>
+
+
+Erlaubte Kind-Elemente und deren Attribute
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Innerhalb des Page-Widgets sind alle anderen Widgets (auch andere Page-Widgets) erlaubt.
+
+
+Erklärung zu den Menübezeichnungen
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: _static/menu_expl_page.png
+    :alt: Menübezeichnungen
+    :target: ../../../_images/menu_expl_page.png
+
+
+XML Syntax
+----------
+
+Hier der Beispielcode der die Page mit den oben gezeigten Eigenschaften einfügt:
+
+.. code-block:: xml
+
+        <page name="Testseite" visible="true" showtopnavigation="true"
+                showfooter="true" shownavbar-top="true" shownavbar-bottom="false"
+                shownavbar-left="false" shownavbar-right="false">
+        ....
+        </page>
+