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

[tfry at users.sourceforge.net]

Revision: 2579
          http://rkward.svn.sourceforge.net/rkward/?rev=2579&view=rev
Author:   tfry
Date:     2009-07-28 11:02:37 +0000 (Tue, 28 Jul 2009)

Log Message:
-----------
Cleanups in preparation for release

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

Modified: trunk/rkward/ChangeLog
===================================================================
--- trunk/rkward/ChangeLog	2009-07-27 15:17:25 UTC (rev 2578)
+++ trunk/rkward/ChangeLog	2009-07-28 11:02:37 UTC (rev 2579)
@@ -1,6 +1,6 @@
-TODO: add notice on differing licences/copyrights in subdirs
+--- Version 0.5.1 - ???-??-2009
 - New command line option "--evaluate <Rcode>" mostly for the purpose of automated testing
-- Remove support for R 2.6.x and earlier		TODO: clean up more (RData?), adjust debian control
+- Remove support for R 2.6.x and earlier
 - Add basic checks for a correct installation of the RKWard resource files
 - Remove "What to expect" dialog at startup
 - Make keyboard shorcuts configurable
@@ -9,8 +9,8 @@
 - Fixed: No warning was shown, when an open script file was changed on disk, externally
 - Fixed: Opening most file types (e.g. PDF) from the help browser was broken
 - Fixed: Make built-in editor work again for file.edit ()
-- (Almost) all plugins now write a header to the output window		TODO: work in progress; which ones should not?
-- Add convenience function "makeHeaderCode()" for use inside plugins	TODO: document, adjust for tests (->rk.describe.alternative())
+- More plugins now write a header to the output window
+- Add convenience function "makeHeaderCode()" for use inside plugins
 - Adjust some icons
 - Plugins can be invoked from R code (mostly for internal purposes)
 - Add "Run again" link for plugin generated output

Modified: trunk/rkward/doc/rkward/writing_plugins_introduction.docbook
===================================================================
--- trunk/rkward/doc/rkward/writing_plugins_introduction.docbook	2009-07-27 15:17:25 UTC (rev 2578)
+++ trunk/rkward/doc/rkward/writing_plugins_introduction.docbook	2009-07-28 11:02:37 UTC (rev 2579)
@@ -486,7 +486,8 @@
 </para>
 <programlisting>
 function printout () {
-?>rk.header ("Independent samples t test", parameters=list ("Assume equal variances", <? getRK ("varequal"); ?>, "Confidence level", <? getRK ("conflevel"); ?>))
+	makeHeaderCode ("Independent samples t test", array ("Assume equal variances" => getRK_val ("varequal"), "Confidence level", => getRK_val ("conflevel")))
+?>
 rk.print (res)
 <?
 }
@@ -495,7 +496,7 @@
 The list of parameters is given as pairs of "Description", "Value". This will also be printed in a standard way.
 </para>
 <para>
-rk.print () utilizes the R2HTML package to provide HTML formatted output. Another helpful function is rk.results (), which can also output different kinds of result tables. If in doubt, however, just use rk.print (), and be done with.
+rk.print () utilizes the R2HTML package to provide HTML formatted output. Another helpful function is rk.results (), which can also output different kinds of result tables. If in doubt, however, just use rk.print (), and be done with. makeHeaderCode () is a PHP-level helper function to create a call to rk.header () (just take a look at the generated code). In some cases you may want to call rk.header () directly to print a header for your output.
 </para>
 <para>
 Note that internally, the output is just a plain HTML document at this point of time. Therefore you might be tempted to add custom HTML using cat (). While this will work, please don't do this. The output format may change (e.g. to ODF) in the future, so it's best not to introduce HTML specific code. Rather keep things simple with rk.header (), rk.print (), and rk.results (). If those don't seem to satisfy your formatting needs, contact us on the mailing list for help.


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