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

[m-eik at users.sourceforge.net]

Revision: 3928
          http://rkward.svn.sourceforge.net/rkward/?rev=3928&view=rev
Author:   m-eik
Date:     2011-10-11 20:04:23 +0000 (Tue, 11 Oct 2011)
Log Message:
-----------
minor fixes to the docs

Modified Paths:
--------------
    trunk/rkward/doc/rkwardplugins/index.docbook

Modified: trunk/rkward/doc/rkwardplugins/index.docbook
===================================================================
--- trunk/rkward/doc/rkwardplugins/index.docbook	2011-10-11 19:46:31 UTC (rev 3927)
+++ trunk/rkward/doc/rkwardplugins/index.docbook	2011-10-11 20:04:23 UTC (rev 3928)
@@ -1722,7 +1722,7 @@
 	edit=TRUE,
 	show=TRUE)
 			</programlisting>
-			<para>The files will be created in a temporal directory by default. The last three options are not necessary, but very handy: <markup>load=TRUE</markup> will automatically add the new plugin to &kapp;s configuration (since it's in a temp dir and hence will cease to exist when &kapp; is closed, it will automatically be removed again by &kapp; during its next start), <markup>edit=TRUE</markup> will open all created files for editing in &kapp; editor tabs, and <markup>show=TRUE</markup> will attemt to directly launch the plugin, so you can examine what it looks like without a klick. You might consider adding <markup>overwrite=TRUE</markup> if you're about to run your script repeatedly (e.g. after changes to the code), as by default no files will be overwritten.</para>
+			<para>The files will be created in a temporal directory by default. The last three options are not necessary, but very handy: <parameter>load=</parameter><markup>TRUE</markup> will automatically add the new plugin to &kapp;s configuration (since it's in a temp dir and hence will cease to exist when &kapp; is closed, it will automatically be removed again by &kapp; during its next start), <parameter>edit=</parameter><markup>TRUE</markup> will open all created files for editing in &kapp; editor tabs, and <parameter>show=</parameter><markup>TRUE</markup> will attempt to directly launch the plugin, so you can examine what it looks like without a klick. You might consider adding <parameter>overwrite=</parameter><markup>TRUE</markup> if you're about to run your script repeatedly (e.g. after changes to the code), as by default no files will be overwritten.</para>
 			<para>The result object <quote>plugin.dir</quote> contains the path to the directory in which the plugin was created. This can be useful in combination with the function <function>rk.build.package()</function>, to build an actual R package to share your plugin with others -- e.g. by sending it to the RKWard development team to be added to our plugin repository.</para>
 		</sect2>
 		<sect2 id="rkdev_ttest_script"><title>The full script</title>

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