changeset 157:84cd497e50ff

Fix typos, some better wording
author florob@babelmonkeys.de
date Sat, 16 Oct 2010 19:04:27 +0000
parents 15b9d9ce4ce3
children 126d61a2287a
files mod_adhoc.wiki
diffstat 1 files changed, 8 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/mod_adhoc.wiki	Sat Oct 16 18:54:38 2010 +0000
+++ b/mod_adhoc.wiki	Sat Oct 16 19:04:27 2010 +0000
@@ -35,20 +35,20 @@
 ||to||The to attribute of the stanza to be handled||
 ||from||The from attribute of the stanza to be handled||
 ||action||The action to be performed as specified in the stanza to be handled||
-||form||If the to be handled stanza contains a form this will contains the form element||
+||form||If the to be handled stanza contains a form this will contain the form element||
 
-The handler should return to items. A data table and a state.
-The state will be saved and passed to the handler on any adhoc stanza with the same sessionid.
+The handler should return two items. A data table and a state.
+The state will be saved and passed to the handler on invocation for any adhoc stanza with the same sessionid. If a session has ended the state returned should be nil.
 
 The returned table can have the following fields:
 ||*Name*||*Explanation*||*Required?*||
-||status||Status of the command (One of: completed, canceled, error)||yes||
-||error||A table with the fields "type", "condition" and "message"||if status is "error"||
-||info||Informational info for the user||no||
+||status||Status of the command (One of: "completed", "canceled", "error")||yes||
+||error||A table with the fields "type", "condition" and "message"||when status is "error"||
+||info||Informational text for display to the user||no||
 ||warn||A warning for the user||no||
 ||actions||The actions avaiable to the client||no||
-||form||A form to be filled out by the user||no||
-||result||A form of type result to be presented to the user||no||
+||form||A dataform to be filled out by the user||no||
+||result||A dataform of type result to be presented to the user||no||
 ||other||Any other XML to be included in the response to the user||no||
 
 For a simple module and details have a look at mod_adhoc_cmd_ping.