[Equanda-svn-commit] SF.net SVN: equanda: [259] trunk/equanda-generate/src/site/wiki/templates/ t5gui.wiki

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

Revision: 259
          http://equanda.svn.sourceforge.net/equanda/?rev=259&view=rev
Author:   triathlon98
Date:     2008-01-20 07:32:01 -0800 (Sun, 20 Jan 2008)

Log Message:
-----------
extra docs

Modified Paths:
--------------
    trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki

Modified: trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki	2008-01-18 14:05:27 UTC (rev 258)
+++ trunk/equanda-generate/src/site/wiki/templates/t5gui.wiki	2008-01-20 15:32:01 UTC (rev 259)
@@ -16,5 +16,59 @@
 
 (*) ^Items marked like this were available in the old tapestry4 version and will be available again for the tapestry5 version.^
 
+h2. renderer support
 
-h2. configuring how forms are generated
\ No newline at end of file
+In the domain model, it is possible to overwrite the rendering of specific fields or groups using the "renderer" parameter on the definition.
+*TODO : documentation to be completed*
+
+h2. configuring how forms are generated
+
+The generation of forms is multi-layered to allow configuration of how specific elements will be generated. This makes the user interface highly customizeable, it assures consistency and assures the user interface can be updated based on the domain model.
+At field or group level, the rendering can be overwritten using the "renderer" parameter in the domain model. However, some generic changes can also be handled as generation parameters.
+
+In the configuration file "dm.ini" you can define which files should be read to get the properties.
+
+{code}
+[t5gui]
+keyvalue1=t5gui/edit-tml/templates.properties
+keyvalue2=mytemplates/templates.properties
+{code}
+
+The first file included above is always included and contains the default mappings. You can include as many keyvalueX keys as needed, but there shoud be no gaps in the numbering.
+The references properties files are searched on the classpath. As an example the deafult (t5gui/edit-tml/templates.properties) is included below.
+When several mappings exist for the same key, the last one is applied.
+
+{code}
+pages=edit-tml/pages.tml.vm
+page=edit-tml/page.tml.vm
+group=edit-tml/group.tml.vm
+field=edit-tml/field.tml.vm
+
+type.string=edit-tml/string.tml.vm
+type.clob=edit-tml/string.tml.vm
+type.double=edit-tml/double.tml.vm
+type.int=edit-tml/int.tml.vm
+type.date=edit-tml/date.tml.vm
+type.timestamp=edit-tml/timestamp.tml.vm
+type.boolean=edit-tml/boolean.tml.vm
+type.link.one=edit-tml/linkone.tml.vm
+type.link.list=edit-tml/linklist.tml.vm
+
+field.EquandaUser.Password=edit-tml/password.tml.vm
+field.EquandaType=edit-tml/type.tml.vm
+{code}
+
+You can define the templates (and thus tapestry objects) which are used for the display based on the structure.
+- pages : defines how the sequence of pages are handled, implemented using the Tabs component which creates tab pages. There is some special handling for the "ALL" and "metadata" pages.
+- page : handle the contents of one page, rendering the fields (which are not part of a group) and groups.
+- group : handling of a group, put the contents in a fieldset.
+- field : default rendering of individual fields.
+
+The default field handling uses the keyvalue settings again to read the velocity templates used to build the .tml tapestry template.
+Below are the possible configurations which are used, in order. Of course only the types which are possible according to the field type apply.
+
+- type.TableName.FieldName : specific templates for a field in a table.
+- type.FieldName : specific tamplates for fields of that name in all tables.
+- type.link.TableName.one, type.link.TableName.list : templates to use for instances links to the table of the name as included in the key.
+- type.link.one, type.link.list : generic handling for link fields.
+- type.string, type.boolean, type.date, type.timestamp, type.int, type.double, type.blob, type.clob : templates for generic handling of fields of a certain type.


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