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

[tfry at users.sourceforge.net]

Revision: 1685
          http://svn.sourceforge.net/rkward/?rev=1685&view=rev
Author:   tfry
Date:     2007-03-21 11:31:30 -0700 (Wed, 21 Mar 2007)

Log Message:
-----------
Add support for a technical details section in .rkh files

Modified Paths:
--------------
    trunk/rkward/ChangeLog
    trunk/rkward/doc/en/writing_plugins_introduction.docbook
    trunk/rkward/rkward/plugins/plots/histogram_options.rkh
    trunk/rkward/rkward/plugins/plots/plot_stepfun_options.rkh
    trunk/rkward/rkward/windows/rkhtmlwindow.cpp

Modified: trunk/rkward/ChangeLog
===================================================================
--- trunk/rkward/ChangeLog	2007-03-21 17:31:04 UTC (rev 1684)
+++ trunk/rkward/ChangeLog	2007-03-21 18:31:30 UTC (rev 1685)
@@ -1,3 +1,4 @@
+- add support for a "technical details" section in plugin help files
 - add option to enable / disable single options of a radio or dropdown control in plugins		TODO: document
 - t-test plugin now also allows to calculate a paired test
 - show current working directory in the statusbar

Modified: trunk/rkward/doc/en/writing_plugins_introduction.docbook
===================================================================
--- trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-03-21 17:31:04 UTC (rev 1684)
+++ trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-03-21 18:31:30 UTC (rev 1685)
@@ -1102,7 +1102,7 @@
 	</settings>
 
 	<related>
-The related section (always last) typically just contains some links, such as:
+The related section typically just contains some links, such as:
 
 <ul>
 	<li><link href="rkward://rhelp/mean"/></li>
@@ -1110,6 +1110,14 @@
 	<li><link href="rkward://component/related_component"/></li>
 </ul>
 	</related>
+
+	<technical>
+The technical section (optional, always last) may contain some technical details of the plugin
+implementation, which are of interest only to RKWard developers. This is particularily relevant
+for plugins that are designed to be embedded in many other plugins, and could detail, which
+options are available to customize the embedded plugin, and which code sections contain which
+R code.
+	</technical>
 </document>
 </programlisting>
 </chapter>

Modified: trunk/rkward/rkward/plugins/plots/histogram_options.rkh
===================================================================
--- trunk/rkward/rkward/plugins/plots/histogram_options.rkh	2007-03-21 17:31:04 UTC (rev 1684)
+++ trunk/rkward/rkward/plugins/plots/histogram_options.rkh	2007-03-21 18:31:30 UTC (rev 1685)
@@ -35,8 +35,10 @@
 			<li><link href="rkward://rhelp/extendrange"/></li>
 		</ul>
 	</related>
-	<section id="techdetails" title="Techinical details">General users may skip this section of help, this is primarily for developers.
-		The following external tags are provided for use in the embeding plugin.
+	<technical>
+		General users may skip this section of help, this is primarily for developers.
+
+		The following external tags are provided for use in the embedding plugin.
 		<ul>
 			<li><i>varname</i>: For linking to the variable name for which histogram is being plotted. This is used in the 'Integer numbers' option for breaks.</li>
 			<li><i>allow_freq</i>: Setting this to "true" ("false") enables (disables) the display of the 'Frequency' checkbox.</li>
@@ -49,5 +51,5 @@
 			<li><i>code.calculate</i>: This contains only the <i>breaks</i>-option.</li>
 			<li><i>code.printout</i>: This contains all the other options determining the look of the plot.</li>
 		</ul>
-	</section>
+	</technical>
 </document>

Modified: trunk/rkward/rkward/plugins/plots/plot_stepfun_options.rkh
===================================================================
--- trunk/rkward/rkward/plugins/plots/plot_stepfun_options.rkh	2007-03-21 17:31:04 UTC (rev 1684)
+++ trunk/rkward/rkward/plugins/plots/plot_stepfun_options.rkh	2007-03-21 18:31:30 UTC (rev 1685)
@@ -23,14 +23,16 @@
 			<li><link href="rkward://rhelp/ecdf"/></li>
 		</ul>
 	</related>
-	<section id="techdetails" title="Techinical details">General users may skip this section of help, this is primarily for developers.
-		The following external tags are provided for use in the embeding plugin.
+	<technical>
+		General users may skip this section of help, this is primarily for developers.
+
+		The following external tags are provided for use in the embedding plugin.
 		<ul>
 			<li><i>allow_addtoplot</i>: Setting this to "true" ("false") enables (disables) the display of the 'Add to current plot' checkbox.</li>
 			<li><i>default_dopoints</i>: Setting this to "true" ("false") toggles the state of the 'Draw points' checkbox.</li>
 			<li><i>default_verticals</i>: Setting this to "true" ("false") toggles the state of the 'Draw verticals' checkbox.</li>
 			<li><i>visible_col01line</i>: Setting this to "true" ("false") enables (disables) the display of the two frames ('For y = 0 line' and 'For y = 1 line') for <i>col.01line</i> option to ecdf.</li>
 		</ul>
-	</section>
+	</technical>
 </document>
 

Modified: trunk/rkward/rkward/windows/rkhtmlwindow.cpp
===================================================================
--- trunk/rkward/rkward/windows/rkhtmlwindow.cpp	2007-03-21 17:31:04 UTC (rev 1684)
+++ trunk/rkward/rkward/windows/rkhtmlwindow.cpp	2007-03-21 18:31:30 UTC (rev 1685)
@@ -555,6 +555,13 @@
 			khtmlpart->write (renderHelpFragment (element));
 		}
 
+		// "technical" section
+		element = help_xml->getChildElement (help_doc_element, "technical", DL_INFO);
+		if (!element.isNull ()) {
+			khtmlpart->write (startSection ("technical", i18n ("Technical details"), QString (), &anchors, &anchornames));
+			khtmlpart->write (renderHelpFragment (element));
+		}
+
 		// create a navigation bar
 		KURL url_copy = url;
 		QString navigation;


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