[rkward-cvs] SF.net SVN: rkward: [1699] trunk/rkward/rkward/plugins/plots

[kapatp at users.sourceforge.net]

Revision: 1699
          http://svn.sourceforge.net/rkward/?rev=1699&view=rev
Author:   kapatp
Date:     2007-03-22 03:28:14 -0700 (Thu, 22 Mar 2007)

Log Message:
-----------
Some help file updates.

Modified Paths:
--------------
    trunk/rkward/rkward/plugins/plots/color_chooser.rkh
    trunk/rkward/rkward/plugins/plots/plot_options.rkh

Modified: trunk/rkward/rkward/plugins/plots/color_chooser.rkh
===================================================================
--- trunk/rkward/rkward/plugins/plots/color_chooser.rkh	2007-03-22 08:42:06 UTC (rev 1698)
+++ trunk/rkward/rkward/plugins/plots/color_chooser.rkh	2007-03-22 10:28:14 UTC (rev 1699)
@@ -11,7 +11,6 @@
 	</usage>
 
 	<settings>
-		<caption id="aspectratio"/>
 		<setting id="color">The color to use.</setting>
 	</settings>
 

Modified: trunk/rkward/rkward/plugins/plots/plot_options.rkh
===================================================================
--- trunk/rkward/rkward/plugins/plots/plot_options.rkh	2007-03-22 08:42:06 UTC (rev 1698)
+++ trunk/rkward/rkward/plugins/plots/plot_options.rkh	2007-03-22 10:28:14 UTC (rev 1699)
@@ -31,6 +31,9 @@
 
 		<caption id="aspectratio"/>
 		<setting id="asp">This is the <i>asp</i> argument to <b>plot.default</b>.</setting>
+
+		<caption id="tab_grid"/>
+		<setting id="add_grid">Check this box to add a grid to the current plot. For various grid options see <link href="rkward://component/x11grid"/>. Note that these options are not for <b>plot.default</b> but rather for the function <b>grid</b>. For this to be functional the embedding plugin should implement it internally.</setting>
 	</settings>
 
 	<related>
@@ -38,6 +41,38 @@
 			<li><link href="rkward://rhelp/plot"/></li>
 			<li><link href="rkward://rhelp/plot.default"/></li>
 			<li><link href="rkward://rhelp/par"/></li>
+			<li><link href="rkward://component/x11grid"/></li>
 		</ul>
 	</related>
+
+	<technical>
+		General users may skip this section of help, this is primarily for developers.
+
+		The following external tags are provided for use in the embedding plugin.
+		<ul>
+			<li><i>xvar</i>: The variable to be used for the x-coordinates.</li>
+			<li><i>yvar</i>: The variable to be used for the y-coordinates.</li>
+			<li><i>default_pointtype</i>: A string that provides the default point type when the user chooses 'Default' for 'Type of points/lines'. The possibilities are p,l,b,o,h,s and S; the options for the <i>type</i> argument.</li>
+			<li><i>default_pointcolor</i>: A string that provides the default point color when the user chooses 'Default' for 'Color'. For various possibilities see the code color_chooser.xml; the options for the <i>col</i> argument.</li>
+			<li><i>default_main</i>: A string specifying the <i>main</i> argument to <b>plot.default</b>. By default this is "" which means that the main title generated by the plotting function is used.</li>
+			<li><i>default_sub</i>: Similar to <i>main</i> above but for the subtitle argument <i>sub</i>.</li>
+			<li><i>default_xlab</i>: Similar to <i>main</i> above but for the X-label argument <i>xlab</i>.</li>
+			<li><i>default_ylab</i>: Similar to <i>main</i> above but for the Y-label argument <i>ylab</i>.</li>
+			<li><i>allow_log</i>: Setting this to "true" ("false") enables (disables) the display of 'X axis logarithmic' and 'Y axis logarithmic' checkboxes.</li>
+			<li><i>allow_xlim</i>: Setting this to "true" ("false") enables (disables) the display of 'Min X value' and 'Max X value' input boxes.</li>
+			<li><i>allow_ylim</i>: Setting this to "true" ("false") enables (disables) the display of 'Min Y value' and 'Max Y value' input boxes.</li>
+			<li><i>allow_type</i>: Setting this to "true" ("false") enables (disables) the display of the 'Points / Lines' tab.</li>
+			<li><i>allow_aspect</i>: Setting this to "true" ("false") enables (disables) the display of the 'Aspect ratio' tab.</li>
+			<li><i>allow_grid</i>: Setting this to "true" ("false") enables (disables) the display of the 'Grid' tab. If "true", the actual code for grid options can be extracted from code.calculate (see below) which in turn extracts it from grid_options.code.printout. Specifically, if the plot options plugin is embeded using an id="plot_options" then the following call:<br>
+				printIndented ("\t", getRK_val ("plot_options.code.calculate"));</br><br>
+			after the plotting function should do the job.</br></li>
+		</ul>
+		In order to allow flexible use, the generated options are separated into different sections:
+		<ul>
+			<li><i>code.preprocess</i>: Nothing yet, but will hopefully include some <b>par</b> options.</li>
+			<li><i>code.calculate</i>: Currently this contains only the <b>grid</b>-options.</li>
+			<li><i>code.printout</i>: This contains all the other options determining the look of the plot.</li>
+		</ul>
+	</technical>
+
 </document>


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