[Formed-commits] r291 - in trunk: . doc

[scm-commit@wald.intevation.org]

Author: teichmann
Date: 2008-09-04 12:37:32 +0200 (Thu, 04 Sep 2008)
New Revision: 291

Added:
   trunk/doc/
   trunk/doc/beschreibung.txt
Modified:
   trunk/ChangeLog
Log:
Added initial description.


Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2008-08-22 09:36:11 UTC (rev 290)
+++ trunk/ChangeLog	2008-09-04 10:37:32 UTC (rev 291)
@@ -1,3 +1,7 @@
+2008-09-04	Sascha L. Teichmann <teichmann at intevation.de>
+
+	* doc/beschreibung.txt: New. Initial description of FormEd (german).
+
 2008-08-22	Sascha L. Teichmann <teichmann at intevation.de>
 
 	* formed/formed/model/nodecomponents.py: Added attribute 'flags'.

Added: trunk/doc/beschreibung.txt
===================================================================
--- trunk/doc/beschreibung.txt	2008-08-22 09:36:11 UTC (rev 290)
+++ trunk/doc/beschreibung.txt	2008-09-04 10:37:32 UTC (rev 291)
@@ -0,0 +1,102 @@
+FormEd
+
+Ein einfaches Werkzeug zur Beschreibung von Dokument-Strukturen.
+
+Knoten-Typen:
+
+    Ein FormEd-Dokument besteht aus Knoten und Blättern
+
+    Knoten:
+
+    * 'page'  : Seite im Dokument
+    * 'group' : Gruppe innerhalb einer Seite
+    * 'choice': Auswahlliste von Punkten, kann 'bool'- und 'external-choice'
+                Blätter enthalten.
+    * 'radio' : Exklusive Auswahlliste, Inhalt wie 'choice'
+
+    Blätter:
+
+    * bool           : Ein Wahr/Falsch-Wert
+    * int            : Ein Ganzzahlwert
+    * info           : Eine statische Beschriftung. Nicht editierbar.
+    * text           : Ein einzeiliges Textfeld.
+    * external-choice: Externe Referenzliste von Werten für 'choice' und 'radio'
+    * date           : Ein Datumsfeld
+    * textarea       : Ein mehrzeiliges Textfeld.
+    * rule           : Regel zur Einhaltung der internen Integrität des Dokumentes
+
+Editor:
+
+    Der Editor besteht zwei Bereichen.
+    Auf der linken Seite wird die Baumstruktur des Baumes dargestellt und
+    modifiziert. Auf der rechten Seite können die Attribute der Knoten und 
+    Blätter des Baumes editiert werden.
+
+
+Plug-Ins:
+
+    Neben dem Editor bietet FormEd die Möglichkeit, Plug-Ins zu integrieren.
+    Es gibt zwei Arten von Plug-Ins:
+
+    * Plug-In: 
+      Wird beim Programmstart von FormEd geladen und hat unabhängig vom Editor
+      ständigen Zugriff auf das aktuell bearbeitete Dokument. FormEd liefert
+      von Haus aus eine Web-Visualierung des aktuellen Dokumentes als Plug-In
+      aus.
+
+    * Filter:
+      Dienen primär dem Im- und Export von Daten, können aber auch zur Konsolidierung
+      der Dokumentstruktur eingesetzt werden. Sie werden beim Programmstart in das
+      Menü des FormEd eingebunden und haben bis zu ihrer Ausführung keinen Zugriff
+      auf das Dokument.
+
+      Von Haus liefert FormEd ein Reihe von Filtern:
+
+      * Namen eindeutig machen: Macht die Namen-Attribute eindeutig, wichtig für
+        das spätere Exportieren eines Datenbank-Schemas.
+
+      * aus Formulardaten umbenennen: Generiert Namen aus den Formular-Bezeichnungen.
+
+      * Als LaTeX-Tabelle exportieren: Generiert Dokumentation im LaTex-Format
+
+      * Als HTML exportieren (in zwei Varianten): Schematische Übersicht des Dokumentes
+        als HTML.
+
+      * ExportDiffAsHTMLFilter
+      * ExportAsTypeDict
+      * ExportAsSQLFilter
+      * ExportAsXMLSchema
+      * ExportKeyValueTableAsXLS
+      * DataImportFilter
+      * DataExportFilter
+
+Attribute von Knoten:
+
+    Gemeinsame aller Knoten/Blätter:
+
+    'name'        : Interne (eindeutige) ID des Feldes
+    'description' : Menschenlebare Beschreibung
+    'formularname': Zur Abbildung von PDF-XFA-Bezeichnungen
+    'modes'       : Sichtbarkeit in verschiedene Modi (siehe Modi)
+    'annotation'  : Allgemeine Anmerkungen (siehe Layout)
+    'target'      : Ziel von Layout-Operationen
+    'alternative' : Alternative Beschreibungen
+    'function'    : Definierbare Funktion (wird z.B. für die Anonymisierung benötigt)
+    'flags'       : Flaggen für Phasen-Wechsel
+
+    Knoten:
+
+    'containers': Container für das Lyout (siehe Layout)
+
+
+Modi:
+
+    FormEd kann Dokumente in verschiedenen Modi betrachten. Die kann z.B. dazu benutzt werden,
+    um verschieden Versionen eines Dokumentes abzubilden. Beispielsweise kann in
+    einer Version 'a' eine Auswahl als Radio-Gruppen und in der Version 'b' als Choice
+    dargestellt werden. Über die Modus-Auswahl im Menü wird der aktuelle Modus
+    gewählt.
+
+Layout:
+
+