[rkward-cvs] SF.net SVN: rkward: [1282] trunk/rkward

Thu Feb 1 20:41:18 UTC 2007

Revision: 1282
          http://svn.sourceforge.net/rkward/?rev=1282&view=rev
Author:   tfry
Date:     2007-02-01 12:41:17 -0800 (Thu, 01 Feb 2007)

Log Message:
-----------
Documentation updates for browser, input, saveobject, spinbox tags

Modified Paths:
--------------
    trunk/rkward/ChangeLog
    trunk/rkward/doc/en/writing_plugins_introduction.docbook

Modified: trunk/rkward/ChangeLog
===================================================================

--- trunk/rkward/ChangeLog	2007-02-01 19:23:56 UTC (rev 1281)
+++ trunk/rkward/ChangeLog	2007-02-01 20:41:17 UTC (rev 1282)
@@ -1,5 +1,4 @@
 - improvements to spinbox: step size is adjusted dynamically, and no arbitrary limits in real mode
-- input elements and browser elements can be made required 				TODO: don't list this, but document!
 - fixed problem with specifying y axis limits in several plugins
 - simplified CSV import plugin
 - new plugin: import SPSS files								TODO: document
@@ -7,7 +6,7 @@
 - improvements to distribution plot plugins
 - new plugins: distribution plots 							TODO: list them
 - fixed: installing packages as root would not work, when $R_HOME is not defined
-- new plugin element to select name of an R object to save to				TODO: document
+- new plugin element to select name of an R object to save to
 - analysis folder for analysis plugins (Wilcoxon and Ansari-Bradley tests moved to analysis)
 - new plugin: Ansari-Bradley two-sample test						TODO: document, make it stable
 - place internal objects .rk.rkreply and .rk.available.packages.cache into rkward package environment

Modified: trunk/rkward/doc/en/writing_plugins_introduction.docbook
===================================================================
--- trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-02-01 19:23:56 UTC (rev 1281)
+++ trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-02-01 20:41:17 UTC (rev 1282)
@@ -1274,9 +1274,57 @@
 	<term><size></term>
 	<listitem>One of "small", "medium", or "large". "large" defines a multi-line input field, "small", and "medium" are single line fields (optional, defaults to "medium")</listitem>
 	</varlistentry>
+	<varlistentry>
+	<term><required></term>
+	<listitem>Whether - for submitting the code - it is required that this input is not empty. See <link linkend="elementproperties">required-property</link> (optional, defaults to false)</listitem>
+	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
+<term><browser></term>
+<listitem>An element designed to select a single filename (or directory name). Note that this field will take any string, even though it is meant to be used for files, only:
+	<variablelist>
+	<varlistentry>
+	<term><label></term>
+	<listitem>Label for the browser (optinal, defaults to "Enter filename")</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term><initial></term>
+	<listitem>Initial text of the browser (optional, defaults to "", i.e. an empty string)</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term><type></term>
+	<listitem>One of "file", "dir", or "savefile". To select an existing file, existing directory, or non-existing file, respectively (optional, defaults to "file")</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term><filter></term>
+	<listitem>File type filter, e.g. ("*.txt *.csv" for .txt and .csv files. Try not to induce limits unless absolutely needed, though) (optional, defaults to "", i.e. all files)</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term><required></term>
+	<listitem>Whether - for submitting the code - it is required that the field is not empty. Note that this does not necessarily mean, the selected filename is valid! See <link linkend="elementproperties">required-property</link> (optional, defaults to true)</listitem>
+	</varlistentry>
+	</variablelist></listitem>
+</varlistentry>
+<varlistentry>
+<term><saveobject></term>
+<listitem>An element designed to select the name of an R object to save to (i.e. generally not already existing, in contrast to a varslot):
+	<variablelist>
+	<varlistentry>
+	<term><label></term>
+	<listitem>Label for the input (optinal, defaults to "Save to:")</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term><initial></term>
+	<listitem>Initial text of the input (optional, defaults to "my.data")</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term><required></term>
+	<listitem>Whether - for submitting the code - it is required that the field holds a permissible object name. See <link linkend="elementproperties">required-property</link> (optional, defaults to true)</listitem>
+	</varlistentry>
+	</variablelist></listitem>
+</varlistentry>
+<varlistentry>
 <term><spinbox></term>
 <listitem>A spinbox in which the user can select a numeric value, using either direct keyboard input or small up/down arrows. Attributes:
 	<variablelist>
@@ -1306,7 +1354,7 @@
 	</varlistentry>
 	<varlistentry>
 	<term><max_precision></term>
-	<listitem>Unfortunately, spinboxes do not yet accept true floating point numbers, but only numbers of a fixed precision. This specifies, how many decimal places will be available as a maximum (optional, defaults to "4")</listitem>
+	<listitem>The maximum number of digits that can be meaningfully represented (optional, defaults to "6")</listitem>
 	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
@@ -1552,6 +1600,26 @@
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
+<term><browser></term>
+<listitem>Default property is "selection"
+	<variablelist>
+	<varlistentry>
+	<term>selection</term>
+	<listitem>Current text (selected file name) in the browser (string)</listitem>
+	</varlistentry>
+	</variablelist></listitem>
+</varlistentry>
+<varlistentry>
+<term><saveobject></term>
+<listitem>Default property is "selection"
+	<variablelist>
+	<varlistentry>
+	<term>selection</term>
+	<listitem>Current text (selected object name) (string)</listitem>
+	</varlistentry>
+	</variablelist></listitem>
+</varlistentry>
+<varlistentry>
 <term><spinbox></term>
 <listitem>Default property is either "int" or "real" depending on the spinbox's mode
 	<variablelist>


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


