Changeset 3457

Timestamp:

04/16/09 10:30:34 (3 years ago)

Author:

CrawfordCurrie

Message:

Item1383: removed support for settings in the plugin topic

Location:

trunk/TablePlugin

Files:

• data/System/TablePlugin.txt (modified) (3 diffs)
• lib/Foswiki/Plugins/TablePlugin.pm (modified) (2 diffs)
• lib/Foswiki/Plugins/TablePlugin/Core.pm (modified) (2 diffs)

trunk/TablePlugin/data/System/TablePlugin.txt

@@ -41 +41 @@
 ---++ <nop>%TOPIC% Global Settings
 
-Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference
-a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==
+You can override the default settings for the plugin by defining the following [[%SYSTEMWEB%.PreferenceSettings][preferences]].
 
-   * One line description, shown in the %SYSTEMWEB%.TextFormattingRules topic:
+<!--
       * Set SHORTDESCRIPTION = Control attributes of tables and sorting of table columns
-
-   * Set DEBUG to 1 to get debug messages in =data/debug.txt=.  Default: =0=
-      * Set DEBUG = 0
-
-   * Make all tables in a topic sortable. If this is set to =all=, all tables that have a header row (including those that do not have %TABLE before them) will be made sortable. If set to =none=, only tables with %TABLE will be sortable. Topic rendering is faster if this is set to =none=.
-      * #Set SORT = none
-      * Set SORT = all
-
-   * Default table attributes:
-      * Set TABLEATTRIBUTES = tableborder="1" cellpadding="0" cellspacing="0" valign="top" headercolor="#ffffff" headerbg="#687684" headerbgsorted="#334455" databg="#ffffff,#edf4f9" databgsorted="#f1f7fc,#ddebf6" tablerules="rows"
+-->
+| *Preference* | *Meaning* | *Default* |
+| TABLEPLUGIN_SORT | Make all tables in a topic sortable. If this is set to =all=, all tables that have a header row (including those that do not have %TABLE before them) will be made sortable. If set to =none=, only tables with %TABLE will be sortable. Topic rendering is faster if this is set to =none=. | all |
+| TABLEPLUGIN_TABLEATTRIBUTES | Default table attributes | tableborder="1" cellpadding="0" cellspacing="0" valign="top" headercolor="#ffffff" headerbg="#687684" headerbgsorted="#334455" databg="#ffffff,#edf4f9" databgsorted="#f1f7fc,#ddebf6" tablerules="rows" |
 
 ---++ Table Attributes
 
-Attributes are defined as a =TABLEATTRIBUTES= Plugin setting in this topic, a =TABLEATTRIBUTES= preferences setting, or on line before the table using =%<nop>TABLE{...}%=:
+Attributes are defined as a =TABLEATTRIBUTES= [[%SYSTEMWEB%.PreferenceSettings][preference]], or on the line before the table using =%<nop>TABLE{...}%=:
 %INCLUDE{"%SYSTEMWEB%.VarTABLE" section="table_attributes"}%
 
@@ -112 +105 @@
 
 ---++ Plugin Installation Instructions
-This plugin is pre-installed with your Foswiki release. You should not have to install it other than to do an upgrade.
-
-   * Download the ZIP file from the Plugin web (see below)
-   * Unzip ==%TOPIC%.zip== in your Foswiki installation directory. Content:
-     | *File:* | *Description:* |
-     | ==data/System/%TOPIC%.txt== | Plugin topic |
-     | ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
-     | ==lib/Foswiki/Plugins/%TOPIC%/Core.pm== | Plugin Perl module |
-   * Visit =configure= in your Foswiki installation, and enable the plugin in the {Plugins} section.
+%$INSTALL_INSTRUCTIONS%
    * Test if the plugin is correctly installed:
       * Check above example if the table renders as expected
@@ -168 +153 @@
 |  16 Nov 2001 | PTh: Added table border, cell spacing, cell padding, gif files |
 |  07 Oct 2001 | JT: Initial version |
-|  CPAN Dependencies: | none |
-|  Other Dependencies: | none |
-|  Perl Version: | 5.008 |
 |  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% |
 |  Support: | http://foswiki.org/Support/%TOPIC% |

trunk/TablePlugin/lib/Foswiki/Plugins/TablePlugin.pm

@@ -27 +27 @@
 package Foswiki::Plugins::TablePlugin;
 
-require Foswiki::Func;    # The plugins API
-require Foswiki::Plugins; # For the API version
+use Foswiki::Func ();    # The plugins API
+use Foswiki::Plugins (); # For the API version
 
-use vars qw( $topic $installWeb $VERSION $RELEASE $initialised );
+use vars qw( $topic $installWeb $initialised );
 
-# 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.038';
+our $VERSION = '$Rev$';
+our $RELEASE = '1.038';
+our $SHORTDESCRIPTION = 'Control attributes of tables and sorting of table columns';
+our $NO_PREFS_IN_TOPIC = 1;
 
 sub initPlugin {
@@ -63 +58 @@
     ### my ( $text, $removed ) = @_;
 
-    my $sort = Foswiki::Func::getPreferencesValue( 'TABLEPLUGIN_SORT' );
+    my $sort = Foswiki::Func::getPreferencesValue( 'TABLEPLUGIN_SORT' )
+      || 'all';
     return unless ($sort && $sort =~ /^(all|attachments)$/) ||
       $_[0] =~ /%TABLE{.*?}%/;

trunk/TablePlugin/lib/Foswiki/Plugins/TablePlugin/Core.pm

@@ -1714 +1714 @@
         $sortTablesInText = 0;
         $sortAttachments  = 0;
-        my $tmp = Foswiki::Func::getPreferencesValue('TABLEPLUGIN_SORT');
+        my $tmp = Foswiki::Func::getPreferencesValue('TABLEPLUGIN_SORT')
+          || 'all';
         if ( !$tmp || $tmp =~ /^all$/oi ) {
             $sortTablesInText = 1;
@@ -1724 +1725 @@
 
         $pluginAttrs =
-          Foswiki::Func::getPreferencesValue('TABLEPLUGIN_TABLEATTRIBUTES');
+          Foswiki::Func::getPreferencesValue('TABLEPLUGIN_TABLEATTRIBUTES')
+              || 'tableborder="1" cellpadding="0" cellspacing="0" valign="top" headercolor="#ffffff" headerbg="#687684" headerbgsorted="#334455" databg="#ffffff,#edf4f9" databgsorted="#f1f7fc,#ddebf6" tablerules="rows"';
         $prefsAttrs = Foswiki::Func::getPreferencesValue('TABLEATTRIBUTES');
         _setDefaults();