[Equanda-svn-commit] SF.net SVN: equanda: [210] trunk

[<tri...@us...>]

Revision: 210
          http://equanda.svn.sourceforge.net/equanda/?rev=210&view=rev
Author:   triathlon98
Date:     2007-12-19 02:04:08 -0800 (Wed, 19 Dec 2007)

Log Message:
-----------
doc improvements

Modified Paths:
--------------
    trunk/src/site/wiki/index.wiki

Added Paths:
-----------
    trunk/equanda-generate/src/site/wiki/templates/
    trunk/equanda-generate/src/site/wiki/templates/ddltool.wiki
    trunk/equanda-generate/src/site/wiki/templates/docs.wiki
    trunk/equanda-generate/src/site/wiki/templates/ejb3.wiki
    trunk/equanda-generate/src/site/wiki/templates/gui-descriptors.wiki
    trunk/equanda-generate/src/site/wiki/templates/import.wiki
    trunk/equanda-generate/src/site/wiki/templates/login.wiki
    trunk/equanda-generate/src/site/wiki/templates/reports.wiki
    trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki

Added: trunk/equanda-generate/src/site/wiki/templates/ddltool.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/ddltool.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/ddltool.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1 @@
+h1. dlltool templates
\ No newline at end of file

Added: trunk/equanda-generate/src/site/wiki/templates/docs.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/docs.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/docs.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1 @@
+h1. docs templates
\ No newline at end of file

Added: trunk/equanda-generate/src/site/wiki/templates/ejb3.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/ejb3.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/ejb3.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1 @@
+h1. ejb3 templates

Added: trunk/equanda-generate/src/site/wiki/templates/gui-descriptors.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/gui-descriptors.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/gui-descriptors.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1,4 @@
+h1. gui-descriptors templates
+
+This template generates xml user interface descriptions which are used by the tapestry4 gui rendering code to build a user interface for the object model.
+This is no longer supported as the power and configurability (not to mention developer friendlyness) of the newer tapestry5 user interface is much higher.
\ No newline at end of file

Added: trunk/equanda-generate/src/site/wiki/templates/import.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/import.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/import.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1 @@
+h1. import templates

Added: trunk/equanda-generate/src/site/wiki/templates/login.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/login.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/login.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1 @@
+h1. login templates
\ No newline at end of file

Added: trunk/equanda-generate/src/site/wiki/templates/reports.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/reports.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/reports.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1 @@
+h1. reports templates
\ No newline at end of file

Added: trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki	                        (rev 0)
+++ trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -0,0 +1 @@
+h1. t5gui templates

Modified: trunk/src/site/wiki/index.wiki
===================================================================
--- trunk/src/site/wiki/index.wiki	2007-12-18 22:42:41 UTC (rev 209)
+++ trunk/src/site/wiki/index.wiki	2007-12-19 10:04:08 UTC (rev 210)
@@ -9,12 +9,45 @@
 
 This is done by generating as much as possible directly from an XML description of the the data and interactions (the _[object model|om.html]_ "om"). Some more thoughts about the concept (generation) can be found [here|http://blog.progs.be/?p=29].
 
-There are many ways to enhance/improve the generated application, but this is always done in such a way that most changes in the object model don't cause any problems. You just recompile (which re-generates al lthe files which needs modifying) and all the manual changes are preserved.
+There are many ways to enhance/improve the generated application, but this is always done in such a way that most changes in the object model don't cause any problems. You just recompile (which re-generates all the files which needs modifying) and all the manual changes are preserved.
 
 The idea is that application development should be focussed on doing the important stuff (the unique features of the application), and that common aspects should only be done once (even more so because this improves consistency). The goal is to work towards a [vision|vision.html] of how application development should be (original thoughts in this [blog|http://blog.progs.be/?p=21]).
 
-h2. Features
 
+h2. Model based programming
+
+In equanda, the definition of the domain or object model is very important. This is a (xml) description which contains your data structure enriched with possible declarative constraints on your data, hints for the user interface, information about user rights etc.
+
+From this model various aspects of your application can be built. This is done using code generation based on [Velocity|http://jakarta.apache.org/velocity/] templates. The templates are written in such a way to allow programmatic customizations and extensions without affacteing the generation proces. So when your object model changes, you can just re-generate your application. The changes in the model will be propagated and your customizations will still be in place. No cut and paste or other manual labour is needed.
+
+equanda is built to have many aspects where flexibility is offered, to allow you to choose what kind of application is built.
+
+Some examples :
+- the persistence layer is built to use EJB3, but you could replace this to use web services to query the data (though currently only EJB3 templates exist).
+- user interface widgets can be replaced globally (by type or fieldname), on a per-field basis or in specific locations.
+- the user interface could be built using the interface of your choice (provided the templates exist).
+- the domain model has been used in projects to generate custom (non-soap) web services.
+- the domain model has been used in projects to generate data schema, data lists,...
+
+
+h2. Generated application features and options
+
+h3. General features
+
+equanda is intended to help you build enterprise grade (business) applications with minimal effort.
+
+The application can run in a client server environment and can be deployed on several tiers.
+Specifically, you could deploy the web server, the business tier and the database on different machines. Moreover, while the business tier needs to have access to the database tier, the (web) client tier only needs access to the business tier. This way it is possible to secure that all access to the database is forced through the business tier and to ensure that all the constraints which are enforced by the business tier cannot be evaded.
+
+Internationalization is built into the system. All the information in the system can be translated, both the messages on the user interface and the error messages. There is specific support and tools to manage the translations. This to allow seperate people (non-programmers) to manage the translations without the properties hell (where you have translation in tens or hundreds of properties files).
+
+The generation has some extra support for useability. There are efforts to make the templates as readable as possible, but to aid you the generated (java) files can be source formatted, the generated xml files can be formatted and/or validated. However, in both cases this can be disabled as well (to make generation faster).
+
+
+The following aspects of the application can be generated.
+
+h3. EJB3 persistence layer
+
 - The data model supports the following features
 -- (multiple) inheritance
 -- declarative constraints
@@ -27,6 +60,8 @@
 -- for removing records [cascade] can be used
 -- field templates can be used
 
+h3. tapestry5 user interface
+
 - The user interface, out of the box, contains the following features
 -- thin client, all browsers
 -- no need for ActiveX activation of client side java
@@ -43,6 +78,18 @@
 -- generated components can be used to build custom pages
 -- layout can be modified using css.
 
+h3. user management support
+
+h3. import data
+
+h3. import/export tool
+
+h3. object model (domain model) documentation
+
+{private}
+h3. tapestry4 user interface
+{private}
+
 - Powerful support for import and export of data using text files.
 
 - [lazy] collections used to fetch selectors results


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.