[Mpuls-commits] r1681 - in wasko/branches/2.0: . mpulsweb/lib

[scm-commit@wald.intevation.org]

Author: bh
Date: 2010-02-22 20:12:47 +0100 (Mon, 22 Feb 2010)
New Revision: 1681

Modified:
   wasko/branches/2.0/ChangeLog
   wasko/branches/2.0/mpulsweb/lib/config.py
Log:
* mpulsweb/lib/config.py (MpulsConfig.build_defaults): Add comment
for the fields setting.


Modified: wasko/branches/2.0/ChangeLog
===================================================================
--- wasko/branches/2.0/ChangeLog	2010-02-22 17:38:25 UTC (rev 1680)
+++ wasko/branches/2.0/ChangeLog	2010-02-22 19:12:47 UTC (rev 1681)
@@ -1,5 +1,10 @@
 2010-02-22  Bernhard Herzog  <bh at intevation.de>
 
+	* mpulsweb/lib/config.py (MpulsConfig.build_defaults): Add comment
+	for the fields setting.
+
+2010-02-22  Bernhard Herzog  <bh at intevation.de>
+
 	* waskaweb/controllers/case.py (CaseController.newAction):
 	Sanitize the form_result with convert2dic when passing it to
 	createNew.

Modified: wasko/branches/2.0/mpulsweb/lib/config.py
===================================================================
--- wasko/branches/2.0/mpulsweb/lib/config.py	2010-02-22 17:38:25 UTC (rev 1680)
+++ wasko/branches/2.0/mpulsweb/lib/config.py	2010-02-22 19:12:47 UTC (rev 1681)
@@ -96,6 +96,44 @@
         set('case-module', 'reminders', '1')
 
         # CASE FIELDS
+        #
+        # This defines which of the fields of a case need to be handled
+        # specially in some way.  There's one dict for each such field.
+        # The meaning of the settings for each field is described in the
+        # doc-string of the Field class in mpulsweb/model/case.py.
+        #
+        # Some points are not described there, though, because they
+        # apply to the list as a whole or specific fields with a special
+        # meaning in mpulsweb:
+        #
+        #  - the order of the descriptions is relevant for the default
+        #    case digest template which shows the fields in the order
+        #    listed here.
+        #
+        #  - some fields are accessed via english alias names in the
+        #    code.  These and the corresponding formed name in wasko
+        #    are:
+        #
+        #       formed name        alias
+        #      ----------------------------------
+        #       name               last_name
+        #       vorname            first_name
+        #       fn                 knr
+        #       erstgespraech      first_meeting
+        #       datum_cm_ende      cm_end
+        #       bearbeiter_id      editor
+        #
+        #  - Some fields are not actually fields in the formed
+        #    description and need to be defined here or in the .json
+        #    file with "preload":True and "search_retrieve":True :
+        #
+        #      bearbeiter_id
+        #
+        #  - alias_force_string should be set to False for all fields
+        #    that have an alias and which are not strings, such as
+        #    erstgespraech, datum_cm_ende which are dates, or
+        #    bearbeiter_id which is an int.
+        #
         set('case', 'fields', [
             {"name":"name", "digest":True,
              "search_retrieve":True, "search_match":True,