r6506 - trunk/gnue-appserver/doc/devguide

[reinhard]

Author: reinhard
Date: 2004-10-18 11:08:35 -0500 (Mon, 18 Oct 2004)
New Revision: 6506

Added:
   trunk/gnue-appserver/doc/devguide/04-ui.texi
Modified:
   trunk/gnue-appserver/doc/devguide/03-basicdb.texi
   trunk/gnue-appserver/doc/devguide/devguide.texi
Log:
New chapter about basic user interface functions.


Modified: trunk/gnue-appserver/doc/devguide/03-basicdb.texi
===================================================================
--- trunk/gnue-appserver/doc/devguide/03-basicdb.texi   2004-10-18 13:30:28 UTC 
(rev 6505)
+++ trunk/gnue-appserver/doc/devguide/03-basicdb.texi   2004-10-18 16:08:35 UTC 
(rev 6506)
@@ -13,8 +13,9 @@
 
 @section General GCD Layout
 
-To define the classes for @GNUe, we use @dfn{GCD files}.  These files are a
-specialized XML file format.  You can write GCD files with any editor you want.
+To define the classes for @GNUe, we use @dfn{GCD files} (@GNUe@ class
+definition files).  These files are a specialized XML file format.  You can
+write GCD files with any editor you want.
 
 So for a start, let's look at a very simple GCD file:
 

Added: trunk/gnue-appserver/doc/devguide/04-ui.texi
===================================================================
--- trunk/gnue-appserver/doc/devguide/04-ui.texi        2004-10-18 13:30:28 UTC 
(rev 6505)
+++ trunk/gnue-appserver/doc/devguide/04-ui.texi        2004-10-18 16:08:35 UTC 
(rev 6506)
@@ -0,0 +1,55 @@
address@hidden $Date: 2004-10-18 15:30:28 +0200 (Mon, 18 Oct 2004) $
+
address@hidden Basic User Interface Features
+
+As we are now able to define our classes with all kinds of data to be held in
+them, as a next step we want to create a better interface for the user to enter
+the data.
+
address@hidden 
----------------------------------------------------------------------------
+
address@hidden General GLD Layout
+
address@hidden@ can use a lot of information from our class definition to build 
a form
+usable for entering data into that class. However, some decisions cannot be
+based on the class definition, most notably a good decision about field order
+and about labels to display.
+
+For that purpose, we have a second file type in @GNUe: @dfn{GLD files} (@GNUe@
+layout definition files). Like GCD files, they are a specialized form of XML.
+
+Let's create a GLD file matching our example:
+
address@hidden
+<module name="address">
+  <class name="person">
+    <property name="name"   pos="100" label="Name" />
+    <property name="street" pos="200" label="Street" />
+    <property name="zip"    pos="300" label="Zip-Code" />
+    <property name="city"   pos="400" label="City" />
+  </class>
+</module>
address@hidden example
+
address@hidden 
----------------------------------------------------------------------------
+
address@hidden Using GLD Files
+
+After having written the above GLD file, save it as @samp{address-C.gld}.  Like
+for GCD files, there's a command to read GLD files into @GNUe:
address@hidden
+gnue-readgld address-C.gcd
address@hidden example
+
+Now we can see how @GNUe@ displays a much nicer form:
address@hidden
+gnue-forms appserver://appserver/form/address_person
address@hidden example
+
+However, maybe English isn't your native language, and you want @GNUe@ to
+display the form with translated labels.  No problem: just create a second
+file, for example @samp{address-de.gld} for German texts, exchange all labels
+with their respective translation, and read that into @GNUe, too.
+
+Now, users will be presented with the interface according to their own locale
+setting.

Modified: trunk/gnue-appserver/doc/devguide/devguide.texi
===================================================================
--- trunk/gnue-appserver/doc/devguide/devguide.texi     2004-10-18 13:30:28 UTC 
(rev 6505)
+++ trunk/gnue-appserver/doc/devguide/devguide.texi     2004-10-18 16:08:35 UTC 
(rev 6506)
@@ -56,7 +56,7 @@
 * Introduction::
 * General Concepts::
 * Basic DB Features:: Basic Database Features
-* UI Features:: Basic User Interface Features
+* Basic UI Features:: Basic User Interface Features
 * FDL:: GNU Free Documentation License
 @end menu
 
@@ -65,12 +65,12 @@
 @include 01-intro.texi
 @node General Concepts,  Basic DB Features, Introduction,      Top
 @include 02-concepts.texi
address@hidden Basic DB Features, UI Features,       General Concepts,  Top
address@hidden Basic DB Features, Basic UI Features, General Concepts,  Top
 @include 03-basicdb.texi
address@hidden UI Features,       FDL,               Basic DB Features, Top
address@hidden Basic UI Features, FDL,               Basic DB Features, Top
 @include 04-ui.texi
 @raisesections
address@hidden FDL,               (null),            UI Features,       Top
address@hidden FDL,               (null),            Basic UI Features, Top
 @include fdl.texi
 
 @bye