[rkward-cvs] SF.net SVN: rkward: [1830] trunk/rkward/doc/en/writing_plugins_introduction .docbook

[tfry at users.sourceforge.net]

Revision: 1830
          http://svn.sourceforge.net/rkward/?rev=1830&view=rev
Author:   tfry
Date:     2007-04-18 15:48:30 -0700 (Wed, 18 Apr 2007)

Log Message:
-----------
Clean up some references to cleanup(), and document new behavior of boolean not

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

Modified: trunk/rkward/doc/en/writing_plugins_introduction.docbook
===================================================================
--- trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-04-18 22:47:51 UTC (rev 1829)
+++ trunk/rkward/doc/en/writing_plugins_introduction.docbook	2007-04-18 22:48:30 UTC (rev 1830)
@@ -453,7 +453,7 @@
 }
 </programlisting>
 <para>
-The PHP-file is organized into four separate functions: preprocess, calculate, printout and cleanup. This is because not all code is needed at all stages. Currently the preprocess-function is not really used.
+The PHP-file is organized into three separate functions: preprocess, calculate, and printout. This is because not all code is needed at all stages. Currently the preprocess-function is not really used in many places.
 </para>
 <programlisting>
 function calculate () {
@@ -892,13 +892,8 @@
 	preprocess ();
 	calculate ();
 	doPrintout (false);
-	cleanup ();
 }
 
-function cleanup () {
-	// empty in this example
-}
-
 function doPrintout ($final) {
 	// this function takes care of generating the code for the printout() section. If $final is set to true,
 	// it generates the full code, including headers. If $final is set to false, only the essentials will
@@ -1152,7 +1147,7 @@
 	</varlistentry>
 	<varlistentry>
 	<term>"not"</term>
-	<listitem>Return the string as if the property held its opposite value (i.e. false if true, true if false)</listitem>
+	<listitem>This actually returns another Boolean property, which is the reverse of the current (i.e. false if true, true if false)</listitem>
 	</varlistentry>
 	<varlistentry>
 	<term>"numeric"</term>
@@ -1192,7 +1187,7 @@
 	<variablelist>
 	<varlistentry>
 	<term>No modifier ("")</term>
-	<listitem>Returns the full code, i.e. the sections "preprocess", "calculate", "printout", and "cleanup" (but not "preview") concatenated to one string.</listitem>
+	<listitem>Returns the full code, i.e. the sections "preprocess", "calculate", "printout", and (but not "preview") concatenated to one string.</listitem>
 	</varlistentry>
 	<varlistentry>
 	<term>"preprocess"</term>
@@ -1207,10 +1202,6 @@
 	<listitem>Returns only the printout section of the code</listitem>
 	</varlistentry>
 	<varlistentry>
-	<term>"cleanup"</term>
-	<listitem>Returns only the cleanup section of the code</listitem>
-	</varlistentry>
-	<varlistentry>
 	<term>"preview"</term>
 	<listitem>Returns the preview section of the code</listitem>
 	</varlistentry>


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