[KSS-checkins] r51212 - kukit/kss.base/trunk/kss/base

[jvloothuis at codespeak.net]

Author: jvloothuis
Date: Sat Feb  2 16:56:41 2008
New Revision: 51212

Modified:
   kukit/kss.base/trunk/kss/base/commands.txt
Log:

Added a test for the serialization of global actions


Modified: kukit/kss.base/trunk/kss/base/commands.txt
==============================================================================
--- kukit/kss.base/trunk/kss/base/commands.txt	(original)
+++ kukit/kss.base/trunk/kss/base/commands.txt	Sat Feb  2 16:56:41 2008
@@ -119,6 +119,25 @@
   True
 
 
+Command types
+-------------
+
+KSS supports two types of commands; global and node based
+commands. The global commands call an action with a set of arguments.
+
+  >>> commands = KSSCommands()
+  >>> commands.add('globalAction', None, value='data')
+  >>> commands.render()
+  '...<command name="globalAction"><param name="value">data</param></command>...'
+
+Now lets demonstrate the other type of command. This needs a selector.
+
+  >>> commands = KSSCommands()
+  >>> commands.add('action', None, value='data')
+  >>> commands.render()
+  '...<command name="action"><param name="value">data</param></command>...'
+
+
 String representation
 =====================