Changeset 3448

Timestamp:

04/15/09 16:48:29 (3 years ago)

Author:

CrawfordCurrie

Message:

Item1383: make plugin get its preferences from global preferences, instead of from the plugin topic

Location:

trunk/SpreadSheetPlugin

Files:

• data/System/SpreadSheetPlugin.txt (modified) (2 diffs)
• lib/Foswiki/Plugins/SpreadSheetPlugin.pm (modified) (2 diffs)
• lib/Foswiki/Plugins/SpreadSheetPlugin/Calc.pm (modified) (1 diff)

trunk/SpreadSheetPlugin/data/System/SpreadSheetPlugin.txt

@@ -737 +737 @@
 ---++ Plugin Settings
 
-Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference
-a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>SPREADSHEETPLUGIN_SHORTDESCRIPTION%==
-
-   * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic:
-      * Set SHORTDESCRIPTION = Add spreadsheet calculation like ="$SUM( $ABOVE() )"= to Foswiki tables and other topic text
-
-   * Debug plugin: (See output in =data/debug.txt=)
-      * Set DEBUG = 0
-
-   * Do not handle =%<nop>CALC{}%= variable in included topic while including topic: (default: 1)
-      * Set SKIPINCLUDE = 1
-
-<noautolink>
-   * [[%SYSTEMWEB%.WikiWord][WikiWords]] to exclude from being spaced out by the ==$PROPERSPACE(text)== function. This comma delimited list can be overloaded by a DONTSPACE [[%SYSTEMWEB%.PreferenceSettings][preference setting]]:
-      * Set DONTSPACE = CodeWarrior, MacDonald, McIntosh, RedHat, SuSE
-</noautolink>
-
+You can override some default settings in the plugin by setting the following [[%SYSTEMWEB%.PreferenceSettings][preferences]].
+
+<!--
+   * Set SHORTDESCRIPTION = Add spreadsheet calculation like ="$SUM( $ABOVE() )"= to Foswiki tables and other topic text
+-->
+| *Preference* | *Meaning* | *Default* |
+| =SPREADSHEETPLUGIN_DEBUG= | \
+Debug plugin: (See output in =data/debug.txt=) | 0 |
+| =SPREADSHEETPLUGIN_SKIPINCLUDE= | \
+Do not handle =%<nop>CALC{}%= variable in included \
+topic while including topic | 1 |
+| =SPREADSHEETPLUGIN_DONTSPACE= | Comma-delimited list of \
+[[%SYSTEMWEB%.WikiWord][WikiWords]] to exclude from being spaced out by \
+the ==$PROPERSPACE(text)== function. | \
+<noautolink>CodeWarrior, MacDonald, McIntosh, RedHat, SuSE</noautolink> |
+
+Note that the =DONTSPACE= global preference overrides the =SPREADSHEETPLUGIN_DONTSPACE= preference for historical reasons.
 
 ---++ Plugin Installation Instructions
-
-*Note:* You do not need to install anything on the browser to use this plugin. Below installation instructions are for the administrator who needs to install this plugin on the Foswiki server. 
-
-   * Download the ZIP file from the <nop>%TOPIC% home
-   * Unzip ==SpreadSheetPlugin.zip== in your Foswiki installation directory. Content:
-     | *File:* | *Description:* |
-     | ==data/System/%TOPIC%.txt== | Plugin topic |
-     | ==data/System/%TOPIC%.txt,v== | Plugin topic repository |
-     | ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
-   * Visit =configure= in your Foswiki installation, and enable the Plugin in the {Plugins} section.
+%$INSTALL_INSTRUCTIONS%
    * Test if the "Total" in the first table in this topic is correct.
 
@@ -817 +808 @@
 |  16 Apr 2001: | Fixed div by 0 bug in $AVERAGE() |
 |  17 Mar 2001: | Initial version with $ABOVE(), $AVERAGE(), $COLUMN(), $COUNTITEMS(), $EVAL(), $INT(), $LEFT(), $LOWER(), $MAX(), $MIN(), $ROW(), $SUM(), $T(), $UPPER() |
-|  CPAN Dependencies: | none |
-|  Other Dependencies: | none |
-|  Perl Version: | 5.008 |
 |  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% |
 |  Support: | http://foswiki.org/Support/%TOPIC% |

trunk/SpreadSheetPlugin/lib/Foswiki/Plugins/SpreadSheetPlugin.pm

@@ -28 +28 @@
 # =========================
 use vars qw(
-        $web $topic $user $installWeb $VERSION $RELEASE $debug $skipInclude $doInit
+        $web $topic $user $installWeb $debug $skipInclude $doInit
     );
 
-# This should always be $Rev: 13748 $ so that Foswiki can determine the checked-in
-# status of the plugin. It is used by the build automation tools, so
-# you should leave it alone.
-$VERSION = '$Rev: 13748 $';
-
-# This is a free-form string you can use to "name" your own plugin version.
-# It is *not* used by the build automation tools, but is reported as part
-# of the version number in PLUGINDESCRIPTIONS.
-$RELEASE = '29 Mar 2009';
+our $VERSION = '$Rev: 13748 $';
+our $RELEASE = '29 Mar 2009';
+our $NO_PREFS_IN_TOPIC = 1;
 
 $doInit = 0;
@@ -55 +49 @@
 
     # Get plugin debug flag
-    $debug = Foswiki::Func::getPreferencesFlag( "SPREADSHEETPLUGIN_DEBUG" );
+    $debug = Foswiki::Func::getPreferencesFlag( "SPREADSHEETPLUGIN_DEBUG" ) || 0;
 
     # Flag to skip calc if in include
-    $skipInclude = Foswiki::Func::getPreferencesFlag( "SPREADSHEETPLUGIN_SKIPINCLUDE" );
+    $skipInclude = Foswiki::Func::getPreferencesFlag( "SPREADSHEETPLUGIN_SKIPINCLUDE" ) || 1;
 
     # Plugin correctly initialized

trunk/SpreadSheetPlugin/lib/Foswiki/Plugins/SpreadSheetPlugin/Calc.pm

@@ -1293 +1293 @@
     unless( $dontSpaceRE ) {
         $dontSpaceRE = &Foswiki::Func::getPreferencesValue( "DONTSPACE" ) ||
-                       &Foswiki::Func::getPreferencesValue( "SPREADSHEETPLUGIN_DONTSPACE" ) ||
-                       "UnlikelyGibberishWikiWord";
+                       &Foswiki::Func::getPreferencesValue( "SPREADSHEETPLUGIN_DONTSPACE" ) || "CodeWarrior, MacDonald, McIntosh, RedHat, SuSE";
         $dontSpaceRE =~ s/[^a-zA-Z0-9\,\s]//go;
         $dontSpaceRE = "(" . join( "|", split( /[\,\s]+/, $dontSpaceRE ) ) . ")";