User manual update

doc/manual/de/config/flavour.rst

@@ -0,0 +1,33 @@
+Flavour
+=======
+
+Einige Widgets ermöglichen eine weiterführende Konfiguration mit der
+Option "flavour"
+
+folgende Flavour-Bezeichnungen sind definiert:
+
+im Design "metal"
+-----------------
+
+.. raw:: html
+
+    <ul><li> <span style="color:#000000"> black </span></li>
+    <li> <span style="color:#ffffff"> white </span>  &lt;--- da steht white&nbsp;:)</li>
+    <li> <span style="color:#00ddff"> antimony </span></li>
+    <li> <span style="color:#00ff11"> boron </span></li>
+    <li> <span style="color:#ff0000"> lithium </span></li>
+    <li> <span style="color:#d00055"> potassium </span></li>
+    <li> <span style="color:#ff8000"> sodium </span></li></ul>
+
+im Design "pure"
+----------------
+
+.. raw:: html
+
+    <ul><li> <span style="color:#000000"> black </span></li>
+    <li> <span style="color:#ffffff"> white </span>  &lt;--- da steht white&nbsp;:)</li>
+    <li> <span style="color:#00ddff"> antimony </span></li>
+    <li> <span style="color:#00ff11"> boron </span></li>
+    <li> <span style="color:#ff0000"> lithium </span></li>
+    <li> <span style="color:#d00055"> potassium </span></li>
+    <li> <span style="color:#ff8000"> sodium </span></li></ul>

doc/manual/de/config/format.rst

@@ -0,0 +1,39 @@
+Format
+======
+
+Über das Format-Attribut kann die Formatierung der Anzeige von Werten
+beeinflusst werden. Dazu wird die Syntax des vom "printf" bekannten
+Formats benutzt. **Man beachte dabei den Punkt zwischen dem % und der
+Kommastelle!**
+
++----------+--------------------------------------+------------+
+| Format   | Ausgabe                              | Beispiel   |
++----------+--------------------------------------+------------+
+| %.0f     | Ein Wert ohne Nachkommastellen       | 31         |
++----------+--------------------------------------+------------+
+| %.1f     | Ein Wert mit einer Nachkommastelle   | 31.0       |
++----------+--------------------------------------+------------+
+| %.2f     | Ein Wert mit 2 Nachkommastellen      | 31.00      |
++----------+--------------------------------------+------------+
+| %.3f     | Ein Wert mit 3 Nachkommastellen      | 31.000     |
++----------+--------------------------------------+------------+
+| %.4f     | Ein Wert mit 4 Nachkommastellen      | 31.0000    |
++----------+--------------------------------------+------------+
+
+Unter Format kann auch eine Einheit eingetragen werden. Diese wird
+einfach hinter den Dezimaltrenner gesetzt. Beispielsweise:
+
++-------------------+---------------------------------------------------------+--------------------+
+| Format            | Ausgabe                                                 | Beispiel           |
++-------------------+---------------------------------------------------------+--------------------+
+| %.0f %%           | Ein Wert ohne Nachkommastellen mit % als Einheit        | 31 %               |
++-------------------+---------------------------------------------------------+--------------------+
+| %.1f °C           | Ein Wert mit einer Nachkommastelle und °C als Einheit   | 31.0 °C            |
++-------------------+---------------------------------------------------------+--------------------+
+| %.2f km/h         | Ein Wert mit 2 Nachkommastellen und km/h als Einheit    | 31.00 km/h         |
++-------------------+---------------------------------------------------------+--------------------+
+
+.. HINT::
+    Wenn man ein % Zeichen verwenden möchte muss man %% nutzen (sonst gibt
+    es je nach verwendetem Browser Fehlermeldungen, da das einzelne % dann
+    evt. als Steuerzeichen interpretiert wird)

doc/manual/de/config/index.rst

@@ -0,0 +1,92 @@
+Konfiguration der CometVisu
+===========================
+
+Die CometVisu Konfigurationsdatei ist eine XML Datei, die im
+Unterverzeichnis "config" der CometVisu-Installation (normal also unter
+/var/www/visu/config) liegt.
+
+Der Editor bearbeitet direkt diese Konfigurationsdatei. Hierfür muss die
+Konfigurationsdatei für den Webserver Prozess (oder alle Prozesse)
+beschreibar sein.
+
+Die Konfiguration ist XML formatiert und kann von fortgeschrittenen
+Anwendern auch direkt bearbeitet werden. (Man sollte dafür dann einen
+Editor nutzen, der mit XML umgehen kann und/oder die Syntax einfärbt
+(z.B. Textwrangler auf MacOSX, WordPad++ oder MS XML Editor 2007 unter
+Windows und unter Linux z.B. vi mit ":syntax on").
+
+Allgemeine Informationen über das CometVisu XML Format findet man
+`hier <CometVisu/XML-Elemente>`__, Informationen zu den einzelnen
+Widgets in den jeweiligen Unterseiten.
+
+Nach dem Speichern ist keinerlei Neustart von Prozessen nötig, jedoch
+sollte man die Seite neu laden und den Browser-Cache löschen.
+
+Wenn die XML Datei ungültig ist wird beim Laden der Visu im Webbrowser
+eine Fehlermeldung angezeigt. Diese gibt im Normalfall schon genaue
+Hinweise wo in der Datei der Fehler liegt. Man kann die Überprüfung (und
+Darstellung) auch mit dem Link "Check Config" in der Fusszeile oder
+durch Anhängen von check\_config.php an den URL erzwingen.
+
+Seiten und Struktur der CometVisu
+---------------------------------
+
+.. TODO::
+
+    Beschreibung
+
+Navigationselemente in der CometVisu
+------------------------------------
+
+.. TODO::
+
+    Beschreibung
+
+Elemente für Konvertierung und Formatierung in der CometVisu
+------------------------------------------------------------
+
+In der CometVisu können Werte auf verschiedenste Art und Weisen
+dargestellt werden. Hierfür können genutzt werden:
+
+.. toctree::
+    :hidden:
+    :glob:
+
+    *
+
+-  :doc:`Format <format>` von Werten z.B. auf Anzahl der
+   Nachkommastellen, Einheiten etc.
+-  :doc:`Mapping <mapping>` erlaubt das Ersetzen von
+   Zahlenwerten durch Texte (z.B. An/Aus statt 1/0) und Icons. (z.B. für
+   Fensterkontakte)
+-  :doc:`Styling <styling>` erlaubt das wertabhängige
+   Färben von Werten (z.B. An in rot und Aus in Grün)
+-  :doc:`Flavour <flavour>` ermöglich in einigen Designs
+   für einige Widgets noch zusätzliche Optionen.
+
+Widgets in der CometVisu
+------------------------
+
+Widgets sind die einzelnen Elemente aus denen eine CometVisu-Site
+zusammengebaut wird. Diese können entweder fest in der CometVisu
+eingebaut sein oder per Plugin-Schnittstelle intergriert.
+
+Die Beschreibung der Widgets kann man hier nachlesen:
+
+.. toctree::
+
+    widgets/index
+
+CometVisu - Beispiele
+---------------------
+
+.. TODO::
+
+    Hinzufügen
+
+sonstiges
+---------
+
+.. TODO::
+
+    Hinzufügen der alten Inhalte (RRD-Beispiele, Animierter Hydraulikplan)