Changes between Version 8 and Version 9 of S3/S3REST/s3_rest_controller

Timestamp:

10/22/10 12:26:42 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/s3_rest_controller

@@ -23 +23 @@
   - '''prefix''' is the application prefix of the resource
   - '''resourcename''' is the name of the resource (without prefix)
-  - '''**attr''' are any additional view components
+  - '''**attr''' are any additional view variables
 
   - '''output''' contains the result of the request and can be returned from the controller as-is
-    - in interactive view formats, this is a {{{dict}}} of variables for the view
+    - in interactive view formats, this is a {{{dict}}} view variables
 
-=== Additional View Components ===
+=== Additional View Variables ===
 
-Additional named arguments in the {{{s3_rest_controller}}} call control the {{{output dict}}} ''after'' the request has been executed:
+In interactive view formats, any additional named arguments in the {{{s3_rest_controller}}} argument list will be added to the view variables:
 
-  - any callable argument will be invoked with the {{{S3Request}}} as first and only argument, and its return value will be added to the {{{output dict}}} instead
-  - any non-callable argument which is not {{{None}}} will be added to the {{{output dict}}} as-is
-  - any argument that gives {{{None}}} will remove this key from the {{{output dict}}}
+  - any callable argument will be invoked with the {{{S3Request}}} as first and only argument, and its return value will be added to the view variables
+  - any non-callable argument will be added to the view variables as-is
+  - any argument that gives {{{None}}} will remove this key from the view variables
 
 A typical use-case is '''rheader''':
@@ -49 +49 @@
 }}}
 
-In this case, the {{{rheader}}} variable is only added to the output when {{{my_rheader(r)}}} returns something else than {{{None}}}.
+If {{{my_rheader(r)}}} gives something else than {{{None}}}, then this value is added as {{{rheader}}} to the view variables.
 
 ----