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

[tfry at users.sourceforge.net]

Revision: 4004
          http://rkward.svn.sourceforge.net/rkward/?rev=4004&view=rev
Author:   tfry
Date:     2011-10-27 08:21:54 +0000 (Thu, 27 Oct 2011)
Log Message:
-----------
Add a help page for 'Sort Data'

Modified Paths:
--------------
    trunk/rkward/ChangeLog
    trunk/rkward/rkward/plugins/data/sort.xml

Added Paths:
-----------
    trunk/rkward/rkward/plugins/data/sort.rkh

Modified: trunk/rkward/ChangeLog
===================================================================
--- trunk/rkward/ChangeLog	2011-10-27 07:58:42 UTC (rev 4003)
+++ trunk/rkward/ChangeLog	2011-10-27 08:21:54 UTC (rev 4004)
@@ -1,3 +1,4 @@
+- Simplified the "Sort Data" plugin, and added a help page
 - Fixed: On Windows, detached windows would sometimes be positioned with the menubar outside the upper screen edge
 - Add GUI support for inspecting the call stack during debugging
 - The backend executable is no longer linked against KDE libraries

Added: trunk/rkward/rkward/plugins/data/sort.rkh
===================================================================
--- trunk/rkward/rkward/plugins/data/sort.rkh	                        (rev 0)
+++ trunk/rkward/rkward/plugins/data/sort.rkh	2011-10-27 08:21:54 UTC (rev 4004)
@@ -0,0 +1,24 @@
+<!DOCTYPE rkhelp >
+<document>
+	<summary>
+Sort data. Currently data.frames, or individual vectors can be sorted.
+	</summary>
+	<usage>
+Select the object to be sorted. For data.frames, also specify the column to sort by. By default the object to be sorted is replaced with the sorted variant, but you can also specify to
+save to a separate object.
+	</usage>
+	<settings>
+		<setting id="object">The object to sort. If a data.frame editor window is currently active, the corresponding object name will be filled in as a default.</setting>
+		<setting id="sortby">Only for data.frame objects. Select the column to sort by.</setting>
+		<setting id="order">Sort in ascending or descending order.</setting>
+		<setting id="saveto_select">Chose "Same object" (the default) to replace the object to be sorted with the sorted variant. If, instead, you want to keep the unsorted object, chose "Another object" to save the sorted object, separately.</setting>
+		<setting id="saveto">Only, if you selected "Another object", above: Specify the object to save to.</setting>
+	</settings>
+	<related>
+		<ul>
+			<li>
+				<link href="rkward://rhelp/order" />
+			</li>
+		</ul>
+	</related>
+</document>

Modified: trunk/rkward/rkward/plugins/data/sort.xml
===================================================================
--- trunk/rkward/rkward/plugins/data/sort.xml	2011-10-27 07:58:42 UTC (rev 4003)
+++ trunk/rkward/rkward/plugins/data/sort.xml	2011-10-27 08:21:54 UTC (rev 4004)
@@ -1,6 +1,7 @@
 <!DOCTYPE rkplugin>
 <document>
 	<code file="sort.js"/>
+	<help file="sort.rkh"/>
 	<logic>
 		<set id="vectormode" to="0"/>
 		<connect governor="current_dataframe" client="object.available"/>

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