[gnue] r8045 - in trunk: gnue-appserver/doc/devguide gnue-common gnue-common/doc

[neilt]

Author: neilt
Date: 2005-10-11 10:56:19 -0500 (Tue, 11 Oct 2005)
New Revision: 8045

Added:
   trunk/gnue-appserver/doc/devguide/picture-1.pdf
   trunk/gnue-appserver/doc/devguide/picture-1.png
   trunk/gnue-appserver/doc/devguide/picture-2.pdf
   trunk/gnue-appserver/doc/devguide/picture-2.png
Modified:
   trunk/gnue-appserver/doc/devguide/02-concepts.texi
   trunk/gnue-appserver/doc/devguide/03-basicdb.texi
   trunk/gnue-appserver/doc/devguide/04-ui.texi
   trunk/gnue-common/INSTALL
   trunk/gnue-common/doc/install-mac-os-x.txt
Log:
Document updates.

Modified: trunk/gnue-appserver/doc/devguide/02-concepts.texi
===================================================================
--- trunk/gnue-appserver/doc/devguide/02-concepts.texi  2005-10-10 12:01:54 UTC 
(rev 8044)
+++ trunk/gnue-appserver/doc/devguide/02-concepts.texi  2005-10-11 15:56:19 UTC 
(rev 8045)
@@ -13,7 +13,7 @@
 
 As a result, people started to move parts of the logic into the database
 server, using sophisticated SQL databases with triggers and stored procedures.
-However, this required to write the logic in a programming language specific to
+However, this required writing the logic in a programming language specific to
 the database server, usually based on SQL, which was hard to learn and very
 limited in its possibilities.
 
@@ -33,8 +33,8 @@
 
 To distinguish between the database layer and the GNU Enterprise layer, we
 speak of @dfn{tables}, and @dfn{columns} for the database, and of
address@hidden, @dfn{properties}, and @dfn{procedures} for the stuff we do in
-GNU Enterprise.
address@hidden, @dfn{properties}, and @dfn{procedures} for the related
+information in GNU Enterprise.
 
 If you have ever dealt with object oriented programming, the word @emph{class}
 probably rings a bell for you.  But please be aware: although classes in

Modified: trunk/gnue-appserver/doc/devguide/03-basicdb.texi
===================================================================
--- trunk/gnue-appserver/doc/devguide/03-basicdb.texi   2005-10-10 12:01:54 UTC 
(rev 8044)
+++ trunk/gnue-appserver/doc/devguide/03-basicdb.texi   2005-10-11 15:56:19 UTC 
(rev 8045)
@@ -4,17 +4,18 @@
 
 Let's start with a simple address management application.
 
-For now, we will assume that gnue-appserver has been installed properly and is
-already running, that gnue-forms and gnue-reports are also installed, and that
-your connections.conf file is set up correctly to allow connections to the
-running application server with the [appserver] connection.
+For now, we will assume that gnue-appserver has been installed properly
+and is already running, that gnue-forms and gnue-reports are also
+installed, X Windows is running, and that your connections.conf file is
+set up correctly to allow connections to the running application server
+with the [appserver] connection.
 
 @c ----------------------------------------------------------------------------
 
 @section General GCD Layout
 
-To define the classes for GNU Enterprise, we use @dfn{GCD files} (GNUe class
-definition files).  These files are a specialized XML file format.  You can
+To define the classes for GNU Enterprise, 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:
@@ -34,20 +35,22 @@
 
 @section Using GCD Files
 
-After having written the above GCD file, save it as @samp{address.gcd}.  Now we
-have to make GNU Enterprise read and process our class definition.  We do this
-by typing
+After having written the above GCD file, save it as @samp{address.gcd}
+and stop gnue-appserver.  Now we have to make GNU Enterprise read and
+process our class definition.  We do this by typing
 @example
 gnue-readgcd address.gcd
 @end example
 @noindent
-at the command prompt.  This will teach GNU Enterprise about our new class and
-make the database backend create the tables necessary to hold the data of this
-class.
+at the command prompt.  This will teach GNU Enterprise about our new
+class and make the database backend create the tables necessary to hold
+the data of this class. You can re-run gnue-readgcd as often as
+necessary and the database will be inserted/updated, but elements will
+not be deleted.  Restart gnue-appserver.
 
-Please note that some databases don't allow adding new tables while there is an
-active connection to the database server, so you might have to kill the
-application server before entering the above command and restart it afterwards.
+Please note that some databases may allow adding new tables while there
+is an active connection to the database server. You may not have to stop
+gnue-appserver depending on the database selected.
 
 As an alternative, GNU Enterprise supports a configuration option called the
 @dfn{module path}. You can simply place your GCD files (and also the GLD files
@@ -64,6 +67,8 @@
 @noindent
 and enjoy your first application!
 
address@hidden
+
 Please note the syntax of the last part in the command line, consisting of the
 module name, an underscore, and the class name.  We call this the @dfn{fully
 qualified class name}.
@@ -84,9 +89,9 @@
 
 @table @code
 @item name
-unique name of the module, namespace identifier for everything defined within
-the module (max.@: 35 characters, but usually not more than 10 characters,
-required)
+unique name of the module, namespace identifier for everything defined
+within the module (max.@: 35 characters, but usually not more than 10
+characters, can not include underscore character, required)
 
 @item comment
 explanatory text, not used by the system in any way (max.@: 70 characters,
@@ -104,7 +109,7 @@
 @item name
 identifier for this class, has to be unique within the module (the length of
 this name plus the length of the module name should not exceed 30 characters,
-required)
+can not include underscore character, required)
 
 @item comment
 explanatory text, not used by the system in any way (max.@: 70 characters,

Modified: trunk/gnue-appserver/doc/devguide/04-ui.texi
===================================================================
--- trunk/gnue-appserver/doc/devguide/04-ui.texi        2005-10-10 12:01:54 UTC 
(rev 8044)
+++ trunk/gnue-appserver/doc/devguide/04-ui.texi        2005-10-11 15:56:19 UTC 
(rev 8045)
@@ -54,16 +54,39 @@
 gnue-forms appserver://appserver/form/address_person
 @end example
 
address@hidden
+
 The @code{label} tag of the class defines the form title, the @code{label} tag
 of the properties tells GNU Enterprise about the labels to use for the several
 fields in the form. Fields are ordered by the number given in the @code{pos}
 attribute of the properties. Properties with @code{pos="0"} are not shown in
 the form at all.
 
-However, maybe English isn't your native language, and you want GNU Enterprise
-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 GNU Enterprise, too.
address@hidden Multiple Languages
 
+GNU Enterprise was designed from the beginning to support multiple
+languages. If English isn't your native language, and you want GNU
+Enterprise 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 GNU Enterprise, too.
+
+For example:
+
address@hidden
+<module name="address" language="de">
+  <class name="person" label="Adressleitung">
+    <property name="name"   pos="100" label="Name" />
+    <property name="street" pos="200" label="address@hidden" />
+    <property name="zip"    pos="300" label="Postcode" />
+    <property name="city"   pos="400" label="Stadt" />
+  </class>
+</module>
address@hidden example
+
 Now, users will be presented with the interface according to their own locale
 setting.
+
+The "-de" in the file name is a convience to recongize language files. 
+GNU Enterprise uses the attribute "language" in the "module" tag to
+define the language.
\ No newline at end of file

Added: trunk/gnue-appserver/doc/devguide/picture-1.pdf
===================================================================
(Binary files differ)


Property changes on: trunk/gnue-appserver/doc/devguide/picture-1.pdf
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/gnue-appserver/doc/devguide/picture-1.png
===================================================================
(Binary files differ)


Property changes on: trunk/gnue-appserver/doc/devguide/picture-1.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/gnue-appserver/doc/devguide/picture-2.pdf
===================================================================
(Binary files differ)


Property changes on: trunk/gnue-appserver/doc/devguide/picture-2.pdf
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/gnue-appserver/doc/devguide/picture-2.png
===================================================================
(Binary files differ)


Property changes on: trunk/gnue-appserver/doc/devguide/picture-2.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Modified: trunk/gnue-common/INSTALL
===================================================================
--- trunk/gnue-common/INSTALL   2005-10-10 12:01:54 UTC (rev 8044)
+++ trunk/gnue-common/INSTALL   2005-10-11 15:56:19 UTC (rev 8045)
@@ -10,8 +10,12 @@
 General Information
 -------------------
 
-On all systems
+On Apple Mac OS X (using Fink)
+  
+  Use the document at doc/install-mac-os-x.txt
 
+On all other systems
+
   for standard system-wide install
   ./setup.py install
     (if you don't do this as root, you have to set
@@ -52,7 +56,6 @@
   Rename the sample-windows.gnue.conf to gnue.conf.  Make any optional changes
   you like to this file.
 
-
 On all systems
 
   You should also rename sample.connections.conf to connections.conf and edit

Modified: trunk/gnue-common/doc/install-mac-os-x.txt
===================================================================
--- trunk/gnue-common/doc/install-mac-os-x.txt  2005-10-10 12:01:54 UTC (rev 
8044)
+++ trunk/gnue-common/doc/install-mac-os-x.txt  2005-10-11 15:56:19 UTC (rev 
8045)
@@ -16,8 +16,19 @@
 These instructions assume you are using the command line terminal. 
 Lines starting with "#" are comments.
 
-Report any problems with these instructions to neilt<at>gnue.org
+Report any problems with these instructions to neilt<at>gnue.org.  These
+notes tested with the following:
 
+       %fink --version
+       Package manager version: 0.24.10
+       Distribution version: 0.8.0.rsync
+
+       % sw_vers
+       ProductName:    Mac OS X
+       ProductVersion: 10.4.2
+       BuildVersion:   8C46
+
+
 # Install Prerequisites
 # ===========================
 fink install xorg
@@ -151,3 +162,8 @@
 
 # you should see a form in xWindows
 # done with basic installation and testing
+
+For more information about using appserver please refer to the development
+guide located at:
+
+http://www.gnuenterprise.org/tools/appserver/docs/manual/devguide/index.html