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

Mon Mar 26 19:58:30 UTC 2007

Revision: 1738
          http://svn.sourceforge.net/rkward/?rev=1738&view=rev
Author:   tfry
Date:     2007-03-26 12:58:30 -0700 (Mon, 26 Mar 2007)

Log Message:
-----------
Start new page on using output

Modified Paths:
--------------
    trunk/rkward/rkward/pages/Makefile.am
    trunk/rkward/rkward/pages/rkward_for_new_users.rkh
    trunk/rkward/rkward/pages/rkward_trouble_shooting.rkh

Added Paths:
-----------
    trunk/rkward/rkward/pages/rkward_output.rkh

Modified: trunk/rkward/rkward/pages/Makefile.am
===================================================================

--- trunk/rkward/rkward/pages/Makefile.am	2007-03-26 18:31:01 UTC (rev 1737)
+++ trunk/rkward/rkward/pages/Makefile.am	2007-03-26 19:58:30 UTC (rev 1738)
@@ -6,5 +6,6 @@
 	rkward_for_r_users.rkh \
 	rkward_help.css \
 	rkward_shortcuts.rkh \
-	rkward_trouble_shooting.rkh
+	rkward_trouble_shooting.rkh \
+	rkward_output.rkh
 

Modified: trunk/rkward/rkward/pages/rkward_for_new_users.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_for_new_users.rkh	2007-03-26 18:31:01 UTC (rev 1737)
+++ trunk/rkward/rkward/pages/rkward_for_new_users.rkh	2007-03-26 19:58:30 UTC (rev 1738)
@@ -40,6 +40,7 @@
 	<li><link href="rkward://page/rkward_for_r_users"/></li>
 	<li><link href="rkward://page/rkward_shortcuts"/></li>
 	<li><link href="rkward://page/rkward_trouble_shooting"/></li>
+	<li><link href="rkward://page/rkward_output"/></li>
 </ul>
 	</related>
 </document>

Added: trunk/rkward/rkward/pages/rkward_output.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_output.rkh	                        (rev 0)
+++ trunk/rkward/rkward/pages/rkward_output.rkh	2007-03-26 19:58:30 UTC (rev 1738)
@@ -0,0 +1,17 @@
+<!DOCTYPE rkhelp>
+<document>
+	<title>RKWard Output</title>
+	<summary>
+Describe the RKWard output window, and how to make use of the generated output.
+
+TODO: This page is incomplete.
+	</summary>
+
+	<section title="Using the output in an office suite" id="integration_in_office_suite">
+One of the many goals of RKWard is to have a seamless integration with an office-suite. Future plans of RKWard include the usage of the "OASIS Open Document Format for Office Applications (ODF)". But right now there is only support for HTML output (including images as png) of your results. HTML can be read and worked on with any modern office suite.
+
+The easiest way to get output into your office suite, is to first select the relevant portions, copy them (Edit->Copy), then paste them. This works well, at least in OpenOffice. You can also drag and drop images from the output to an OpenOffice document.
+
+If you need access to the raw HTML and image files, these are stored in a hidden directory. By default this is a sub-folder called ".rkward" of your home directory (Settings->Configure RKWard->General). You'll want the files "rk_out.html" and the "graph*.png" files.
+	</section>
+</document>

Modified: trunk/rkward/rkward/pages/rkward_trouble_shooting.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_trouble_shooting.rkh	2007-03-26 18:31:01 UTC (rev 1737)
+++ trunk/rkward/rkward/pages/rkward_trouble_shooting.rkh	2007-03-26 19:58:30 UTC (rev 1738)
@@ -20,7 +20,7 @@
 		Typically you would call them from R via <link href="rkward://rhelp/update.packages">update.packages</link> and <link href="rkward://rhelp/library">library</link> to achieve this. But RKWard simplifies this for you. You'll be guided through the install procedure for the required package. Please note you need root privileges in certain situations.
 	</section>
 	<section title="RKWard claimes to take care of seamless integration with an office-suite. Why is there no option to save it as an office file?" shorttitle="RKWard integration with an office-suite" id="integration_in_office_suite">
-		One of the many goals of RKWard is to have a seamless integration with an office-suite. Future plans of RKWard include the usage of the "OASIS Open Document Format for Office Applications (ODF)". But right now there is only support for HTML output (including images as png) of you results. HTML can be read and worked on with any modern office suite. The method is known to work for OpenOffice.org but KWord seems to have some issues when importing HTML files with images. However, depending on further processing the layout but not the content of your results might change.
+		We agree that RKWard is still very lacking when it comes to office integration, and "seamless" integration is still far away. Refer to <link href="rkward://page/rkward_output"/> for information on how to accomplish the most important things right now.
 	</section>
 	<section title="RKWard is running since ages. Has it hung up?" shorttitle="RKWard seems to hang" id="hung_up_problems">
 		This depends. Some test and plots just need some time if you have huge amounts of data or sophisticated calculations. Therefore patience is sometimes needed. In any case you can check the state of R within RKWard. Just look at the little box on the right bottom corner of RKWard. Red means there is still something to calculate or plot. If it's green, R is done calculating.


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


