Changeset 3449

Timestamp:

04/15/09 16:59:44 (3 years ago)

Author:

CrawfordCurrie

Message:

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

Location:

trunk

Files:

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

trunk/SpreadSheetPlugin/data/System/SpreadSheetPlugin.txt

@@ -740 +740 @@
 
 <!--
-   * Set SHORTDESCRIPTION = Add spreadsheet calculation like ="$SUM( $ABOVE() )"= to Foswiki tables and other topic text
+   * Set SHORTDESCRIPTION = Add spreadsheet calculations like ="$SUM( $ABOVE() )"= to Foswiki tables and other topic text
 -->
 | *Preference* | *Meaning* | *Default* |

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

@@ -34 +34 @@
 our $RELEASE = '29 Mar 2009';
 our $NO_PREFS_IN_TOPIC = 1;
+our $SHORTDESCRIPTION = 'Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text';
 
 $doInit = 0;

trunk/TwistyPlugin/data/System/TwistyPlugin.txt

@@ -569 +569 @@
 ---++ 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>TWISTYPLUGIN_SHORTDESCRIPTION%==
-
-   * Set TWISTYSHOWLINK = %MAKETEXT{"More..."}%
-      * For example: =More...=
-   * Set TWISTYHIDELINK = %MAKETEXT{"Close"}%
-      * For example: =Close=
-   * Set TWISTYMODE = 
-      * Either =div= or =span=; =span= if nothing set
-   * Set TWISTYREMEMBER = 
-      * Either =on= or =off=; default is not specified. If set to =on= all Twisty states will be stored in a FOSWIKIPREF cookie; if set to =off= the FOSWIKIPREF cookie will be cleared
-
+You can override some default settings in the plugin by setting the following [[%SYSTEMWEB%.PreferenceSettings][preferences]].
+| *Preference* | *Meaning* | *Default* |
+| =TWISTYSHOWLINK= | For example: =More...= | %MAKETEXT{"More..."}% |
+| =TWISTYHIDELINK= | For example: =Close= | %MAKETEXT{"Close"}% |
+| =TWISTYMODE= | Either =div= or =span= | =span= |
+| =TWISTYREMEMBER= | Either =on= or =off=. If set to =on= all Twisty states will be stored in a FOSWIKIPREF cookie; if set to =off= the FOSWIKIPREF cookie will be cleared | not specified |
+
+<!--
    * Set SHORTDESCRIPTION = Twisty section !JavaScript library to open/close content dynamically
-   * Set DEBUG = 0
+-->
    
 ---++ Plugin Installation Instructions
-   * Download the ZIP file from the Plugin web (see below)
-   * Unzip it in your Foswiki installation directory. Content: 
-     | *File:* | *Description:* |
-%$MANIFEST%
-
-   * Optionally, if it exists, run ==%TOPIC%_installer== to automatically check and install other Foswiki modules that this module depends on. You can also do this step manually.
-   * Alternatively, manually make sure the dependencies listed in the table below are resolved.
-%$DEPENDECIES%
-   * Visit =configure= in your Foswiki installation, and enable the plugin in the {Plugins} section.
-
+%$INSTALL_INSTRUCTIONS%
 
 ---++ Plugin Info

trunk/TwistyPlugin/lib/Foswiki/Plugins/TwistyPlugin.pm

@@ -25 +25 @@
 package Foswiki::Plugins::TwistyPlugin;
 
-use Foswiki::Func;
-use CGI::Cookie;
+use Foswiki::Func ();
+use CGI::Cookie ();
 use strict;
 
 use vars
-  qw( $VERSION $RELEASE $pluginName @modes $doneHeader $doneDefaults $twistyCount
+  qw( @modes $doneHeader $doneDefaults $twistyCount
   $prefMode $prefShowLink $prefHideLink $prefRemember);
 
-# This should always be $Rev$ 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$';
-
-# 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 = '1.5.2';
-
-$pluginName = 'TwistyPlugin';
+our $VERSION = '$Rev$';
+
+our $RELEASE = '1.5.2';
+our $SHORTDESCRIPTION = 'Twisty section Javascript library to open/close content dynamically';
+our $NO_PREFS_IN_TOPIC = 1;
+
+our $pluginName = 'TwistyPlugin';
 
 my $TWISTYPLUGIN_COOKIE_PREFIX  = "TwistyPlugin_";
@@ -86 +82 @@
          Foswiki::Func::getPreferencesValue('TWISTYSHOWLINK')
       || Foswiki::Func::getPluginPreferencesValue('TWISTYSHOWLINK')
-      || '';
+      || '%MAKETEXT{"More..."}%';
     $prefHideLink =
          Foswiki::Func::getPreferencesValue('TWISTYHIDELINK')
       || Foswiki::Func::getPluginPreferencesValue('TWISTYHIDELINK')
-      || '';
+      || '%MAKETEXT{"Close"}%';
     $prefRemember =
          Foswiki::Func::getPreferencesValue('TWISTYREMEMBER')