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

[kapatp at users.sourceforge.net]

Revision: 3080
          http://rkward.svn.sourceforge.net/rkward/?rev=3080&view=rev
Author:   kapatp
Date:     2010-09-27 03:22:56 +0000 (Mon, 27 Sep 2010)

Log Message:
-----------
Add a rkward for devs page and relocate some of the links from the users page

Modified Paths:
--------------
    trunk/rkward/rkward/pages/rkward_public_functions.rkh
    trunk/rkward/rkward/pages/rkward_welcome.rkh

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

Added: trunk/rkward/rkward/pages/rkward_for_rkward_devs.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_for_rkward_devs.rkh	                        (rev 0)
+++ trunk/rkward/rkward/pages/rkward_for_rkward_devs.rkh	2010-09-27 03:22:56 UTC (rev 3080)
@@ -0,0 +1,29 @@
+<!DOCTYPE rkhelp>
+<document>
+	<title>For RKWard Developers</title>
+	<summary>
+	List of various "internal" functions which are generally not of interest to regular users but may be to those who are interested in writing (or extending) plugins or contributing to other areas of RKWard. Make sure to read the warnings and special comments wherever noted.
+	</summary>
+
+	<section title="Plugins" id="plugins">
+	<ul>
+		<li>Call or list available plugins: For automated testing of plugins see <link href="rkward://rhelp/rk.call.plugin"/>.</li>
+	</ul>
+	</section>
+
+	<section title="Objects" id="objects">
+	<ul>
+		<li>Various labels and names related functions are documented here: <link href="rkward://rhelp/rk.get.label"/>.</li>
+		<li>Sync: these functions are useful in automated testing: <link href="rkward://rhelp/rk.sync"/></li>
+	</ul>
+	</section>
+	
+	<related>
+<ul>
+	<li>For more functions of interest see: <link href="rkward://page/rkward_public_functions"/></li>
+	<li>Do read the the online <link href="http://sourceforge.net/apps/mediawiki/rkward/index.php?title=Developer_Information">wiki</link> as well.</li>
+</ul>
+	</related>
+
+TODO: Make this more developer centric with as many links as possible (doc writing, plugin pages, etc)
+</document>

Modified: trunk/rkward/rkward/pages/rkward_public_functions.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_public_functions.rkh	2010-09-26 07:40:24 UTC (rev 3079)
+++ trunk/rkward/rkward/pages/rkward_public_functions.rkh	2010-09-27 03:22:56 UTC (rev 3080)
@@ -16,13 +16,11 @@
 
 	<section title="Other functions" id="public_fns">
 	<ul>
-		<li>Call or list plugins: <link href="rkward://rhelp/rk.call.plugin"/>.</li>
 		<li>Various editing (object and files) related functions are documented here: <link href="rkward://rhelp/rk.edit"/>.</li>
 		<li>Various output and results related functions are documented here: <link href="rkward://rhelp/rk.results"/>.</li>
-		<li>Various labels and names related functions are documented here: <link href="rkward://rhelp/rk.get.label"/>.</li>
 		<li>Various file name related functions are documented here: <link href="rkward://rhelp/rk.get.tempfile.name"/>.</li>
 		<li>Message boxes and selection lists: see <link href="rkward://rhelp/rk.show.message"/>.</li>
-		<li>Misc functions: <link href="rkward://rhelp/rk.misc"/> and <link href="rkward://rhelp/rk.sync"/>.</li>
+		<li>Misc functions: <link href="rkward://rhelp/rk.misc"/>.</li>
 	</ul>
 	</section>
 

Modified: trunk/rkward/rkward/pages/rkward_welcome.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_welcome.rkh	2010-09-26 07:40:24 UTC (rev 3079)
+++ trunk/rkward/rkward/pages/rkward_welcome.rkh	2010-09-27 03:22:56 UTC (rev 3080)
@@ -21,6 +21,11 @@
 	<section title="General Information" id="further_info">
 	For more general information on RKWard, who writes it, how to help, further questions, etc. refer to <link href="http://rkward.sourceforge.net/">the project homepage</link>.
 	</section>
+
+	<section title="For Developers" id="rkward_devs">
+	For more information on RKWard, mainly of interest to developers see <link href="rkward://page/rkward_for_rkward_devs">page for developers</link>.
+	</section>
+
 	<section title="Trouble Shooting" id="Trouble Shooting">
 	If you encounter problems please feel free to search in <link href="rkward://page/rkward_trouble_shooting">Trouble Shooting</link> first.
 	</section>


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