Changes between Version 3 and Version 4 of UserGuidelines/Alerts

Timestamp:

08/20/12 19:45:37 (13 years ago)

Author:

g0wda

Comment:

--

UserGuidelines/Alerts

@@ -59 +59 @@
 ----
 
+
 '''Example template'''
 
@@ -65 +66 @@
 [[Image(http://i.imgur.com/K98gj.png)]]
 
+== Configuring CAP Profile ==
+
+CAP profiles can be configured using the deployment settings.
+
+The following settings can be set as follows
+
+{{{
+    settings.cap.identifier_prefix = "prefix"  # string
+    settings.cap.identifier_suffix = "suffix"  # string
+    settings.cap.codes = [...]           # key-value pairs
+    settings.cap.parameters = [...]      # key-value pairs
+    settings.cap.geocodes = [...]        # key-value pairs
+    settings.cap.base64 = False          # boolean
+    settings.cap.languages = OrderedDict([
+                                 ("en-US", "English"),
+                                 ("fr", "Français")
+                                 ...])
+    settings.cap.priorities = OrderedDict([
+                                  ("<value>, "<Translated title>", <urgency>, <severity>, <certainty>, <color>),
+                                  ...
+                              ])
+
+}}}
+
+Key-value pairs above are python lists containing many dictionaries detailing the behavior and parameters for the key-value pair.
+It should take the following form
+
+{{{
+    kvpairs = [
+        dict(key="<key>", value="<value>", comment="<help text>", immutable=<immutable>, options=[("<value>", "<Value title>"), ...]),
+        ...
+    ]
+
+}}}
+
+* Here the comment and options dictionary values are optional.
+* The options argument is a list of ("<value>", "<value title>") pairs and provides a drop-down to pick the value for the key from.
+* The mutable argument is a bit-map saying whether to lock the key field or the value field or both in the key-value user interface. (by locking we mean disabling.) You can use it like so:
+{{{
+    KEY_MUTABLE = 1
+    VALUE_MUTABLE = 2
+
+    immutable = KEY_IMMUTABLE # only key is immutable
+    immutable = VALUE_IMMUTABLE # only value is immutable
+    immutable = KEY_IMMUTABLE | VALUE_MUTABLE # both immutable
+    immutable = 0 # both immutable
+}}}
+
 == Video Tour ==
 Coming soon.