trunk/doc/beschreibung.txt

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:

    
1	FormEd
2
3	Ein einfaches Werkzeug zur Beschreibung von Dokument-Strukturen.
4
5	Knoten-Typen:
6
7	Ein FormEd-Dokument besteht aus Knoten und Blättern
8
9	Knoten:
10
11	* 'page' : Seite im Dokument
12	* 'group' : Gruppe innerhalb einer Seite
13	* 'choice': Auswahlliste von Punkten, kann 'bool'- und 'external-choice'
14	Blätter enthalten.
15	* 'radio' : Exklusive Auswahlliste, Inhalt wie 'choice'
16
17	Blätter:
18
19	* bool : Ein Wahr/Falsch-Wert
20	* int : Ein Ganzzahlwert
21	* info : Eine statische Beschriftung. Nicht editierbar.
22	* text : Ein einzeiliges Textfeld.
23	* external-choice: Externe Referenzliste von Werten für 'choice' und 'radio'
24	* date : Ein Datumsfeld
25	* textarea : Ein mehrzeiliges Textfeld.
26	* rule : Regel zur Einhaltung der internen Integrität des Dokumentes
27
28	Editor:
29
30	Der Editor besteht zwei Bereichen.
31	Auf der linken Seite wird die Baumstruktur des Baumes dargestellt und
32	modifiziert. Auf der rechten Seite können die Attribute der Knoten und
33	Blätter des Baumes editiert werden.
34
35
36	Plug-Ins:
37
38	Neben dem Editor bietet FormEd die Möglichkeit, Plug-Ins zu integrieren.
39	Es gibt zwei Arten von Plug-Ins:
40
41	* Plug-In:
42	Wird beim Programmstart von FormEd geladen und hat unabhängig vom Editor
43	ständigen Zugriff auf das aktuell bearbeitete Dokument. FormEd liefert
44	von Haus aus eine Web-Visualierung des aktuellen Dokumentes als Plug-In
45	aus.
46
47	* Filter:
48	Dienen primär dem Im- und Export von Daten, können aber auch zur Konsolidierung
49	der Dokumentstruktur eingesetzt werden. Sie werden beim Programmstart in das
50	Menü des FormEd eingebunden und haben bis zu ihrer Ausführung keinen Zugriff
51	auf das Dokument.
52
53	Von Haus liefert FormEd ein Reihe von Filtern:
54
55	* Namen eindeutig machen: Macht die Namen-Attribute eindeutig, wichtig für
56	das spätere Exportieren eines Datenbank-Schemas.
57
58	* aus Formulardaten umbenennen: Generiert Namen aus den Formular-Bezeichnungen.
59
60	* Als LaTeX-Tabelle exportieren: Generiert Dokumentation im LaTex-Format
61
62	* Als HTML exportieren (in zwei Varianten): Schematische Übersicht des Dokumentes
63	als HTML.
64
65	* ExportDiffAsHTMLFilter
66	* ExportAsTypeDict
67	* ExportAsSQLFilter
68	* ExportAsXMLSchema
69	* ExportKeyValueTableAsXLS
70	* DataImportFilter
71	* DataExportFilter
72
73	Attribute von Knoten:
74
75	Gemeinsame aller Knoten/Blätter:
76
77	'name' : Interne (eindeutige) ID des Feldes
78	'description' : Menschenlebare Beschreibung
79	'formularname': Zur Abbildung von PDF-XFA-Bezeichnungen
80	'modes' : Sichtbarkeit in verschiedene Modi (siehe Modi)
81	'annotation' : Allgemeine Anmerkungen (siehe Layout)
82	'target' : Ziel von Layout-Operationen
83	'alternative' : Alternative Beschreibungen
84	'function' : Definierbare Funktion (wird z.B. für die Anonymisierung benötigt)
85	'flags' : Flaggen für Phasen-Wechsel
86
87	Knoten:
88
89	'containers': Container für das Lyout (siehe Layout)
90
91
92	Modi:
93
94	FormEd kann Dokumente in verschiedenen Modi betrachten. Die kann z.B. dazu benutzt werden,
95	um verschieden Versionen eines Dokumentes abzubilden. Beispielsweise kann in
96	einer Version 'a' eine Auswahl als Radio-Gruppen und in der Version 'b' als Choice
97	dargestellt werden. Über die Modus-Auswahl im Menü wird der aktuelle Modus
98	gewählt.
99
100	Layout:
101
102