[rkward-cvs] SF.net SVN: rkward:[4468] trunk/rkward/doc/rkwardplugins/index.docbook

tfry at users.sourceforge.net tfry at users.sourceforge.net
Thu Nov 29 10:48:15 UTC 2012

Revision: 4468
Author:   tfry
Date:     2012-11-29 10:48:15 +0000 (Thu, 29 Nov 2012)
Log Message:
Finish reference for optionset.

Modified Paths:

Modified: trunk/rkward/doc/rkwardplugins/index.docbook
--- trunk/rkward/doc/rkwardplugins/index.docbook	2012-11-28 18:38:29 UTC (rev 4467)
+++ trunk/rkward/doc/rkwardplugins/index.docbook	2012-11-29 10:48:15 UTC (rev 4468)
@@ -2707,10 +2707,21 @@
 	<listitem><para>Declare the content / UI of the set. No attributes. All usual active, passive, and layout elements are allowed as childname elements. In addition, the following special child-elements are allowed:
-			<varlistentry><term>optiondisplay</term>
-			<listitem><para>TODO</para></listitem></varlistentry>
-			<varlistentry><term>property</term>
-			<listitem><para>TODO</para></listitem></varlistentry>
+			<varlistentry><term><optiondisplay></term>
+			<listitem><para>Creates a display for showing / selecting / adding / removing items in an optionset. Allowed only inside the contents are of an optionset, and only once. Attributes:
+			<variablelist>
+				<varlistentry><term>index</term>
+				<listitem><para>Whether to show a column with a numberic index (1...n) in the optiondisplay. (optional, boolean, defaults to "true")</para></listitem></varlistentry>
+			</variablelist>
+			</para></listitem></varlistentry>
+			<varlistentry><term><property></term>
+			<listitem><para>In the rare case that you want to connect two or more properties inside the contents region to an (external)
+			<option>, you can create an auxiliary property using this element. Attributes:
+			<variablelist>
+				<varlistentry><term>id</term>
+				<listitem><para>Id of the property (relative to "setid.contents") (required, string).</para></listitem></varlistentry>
+			</variablelist>
+			</para></listitem></varlistentry>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

More information about the rkward-tracker mailing list