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

tfry at users.sourceforge.net tfry at users.sourceforge.net
Mon Jan 8 17:04:41 UTC 2007

Revision: 1100
Author:   tfry
Date:     2007-01-08 09:04:41 -0800 (Mon, 08 Jan 2007)

Log Message:
ChangeLog, TODO

Modified Paths:

Modified: trunk/rkward/ChangeLog
--- trunk/rkward/ChangeLog	2007-01-08 16:41:50 UTC (rev 1099)
+++ trunk/rkward/ChangeLog	2007-01-08 17:04:41 UTC (rev 1100)
@@ -1,5 +1,6 @@
 - TODO: test auto-detection of pluginmap path!
+- added a basic help system, and some introductory help pages
 - plug-in for skewness and kurtosis added
 - plug-ins for distribution analysis added
 - plug-ins for new plots (stripchart & density plot)

Modified: trunk/rkward/TODO
--- trunk/rkward/TODO	2007-01-08 16:41:50 UTC (rev 1099)
+++ trunk/rkward/TODO	2007-01-08 17:04:41 UTC (rev 1100)
@@ -105,6 +105,9 @@
 		- par (no.readonly=TRUE) and par () to fetch available parameters and determine read-only state
 		- device list would only be fetched when opening the window, not kept up to date?
 		- access to graphics device plugins
+	- Help system
+		- find a good way to open R help pages in the same window
+		- open link in new tab, etc.
 Internal stuff:
 	- Look at package odfWeave, and find out, how to use this
@@ -188,15 +191,6 @@
 		- whenever the value changes (user entered text, or clicked up/down), the value will be translated into an integer number, and an integer exponent (in mapTextToValue(), and mapValueToText ()?)
 		- step size will be auto-adjusted logarithmically (e.g. always third most significant digit)
 	- create a drop down list in addition to a radio box
-	- add a help system
-		- some thoughts:
-			- this should use XML files, which contain mostly html, but also tags like <related component_id="..." component_namespace="..."/> (for related plugins / components), and <rhelp topic="..."/> (for linking to R help on functions / constants / topics). Potentially more tags for a consistent way of marking up option names, headers, etc. (but first check what's needed). Potentially a special link type for links to the rkward user manual
-			- overview pages would be a component not added to any menus (and without any GUI, just containing a <help file="..."/> tag
-			- the XML files would be read in, the mentioned tags replaced by HTML-code, header/footer added, written to an HTML cache (if a cached file already exists, and is newer, simply use that)
-			- the links will work by having a protocol of rkward://[rhelp|component]/[namespace|library|empty]/name
-				- since we need to do all openURL () calls manually in RKHTMLWindow, anyway, we can just analyse the URL for this protocol, and translate it to a real HTML url on the fly
-		- on first startup (or until disabled), a help page giving a rough overview of the main components / features should be shown
-		- different help icons for R help, and RKWard help?
 	- add an example to show rkward-specific commands (rk.print, rk.graph)

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

More information about the rkward-tracker mailing list