Changeset 3458

Timestamp:

04/16/09 10:38:08 (3 years ago)

Author:

CrawfordCurrie

Message:

Item1383: removed support for settings in the plugin topic

Location:

trunk/SlideShowPlugin

Files:

• data/System/SlideShowPlugin.txt (modified) (4 diffs)
• lib/Foswiki/Plugins/SlideShowPlugin.pm (modified) (1 diff)

trunk/SlideShowPlugin/data/System/SlideShowPlugin.txt

@@ -2 +2 @@
 ---+!! Slide Show Plugin
 
-Converts a topic with headings into a slideshow.
+%SHORTDESCRIPTION%
 
 %TOC%
@@ -79 +79 @@
 ---++ <nop>%TOPIC% preferences
 
-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>SLIDESHOWPLUGIN_SHORTDESCRIPTION%==
+You can override the default settings for the plugin by defining the following [[%SYSTEMWEB%.PreferenceSettings][preferences]].
+<!--
+      * Set SHORTDESCRIPTION = Create web based presentations based on topics with headings.
+-->
 
-   * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic:
-      * Set SHORTDESCRIPTION = Create web based presentations based on topics with headings.
-
-   * Debug plugin: (See output in =data/debug.txt=)
-      * Set DEBUG = 0
-
-   * Default template for slides:
-      * Set TEMPLATE = SlideShowPlugin
-
-   * Label for Comments section
-      * Set COMMENTS_LABEL = Comments
-      
-   * Hide text starting with a =---+++ %COMMENTS_LABEL%= heading:
-      * Set HIDECOMMENTS = 
+| *Preference* | *Meaning* | *Default* |
+| SLIDESHOWPLUGIN_TEMPLATE | Default template for slides: | SlideShowPlugin |
+| SLIDESHOWPLUGIN_COMMENTS_LABEL | Label for Comments section | Comments |
+| SLIDESHOWPLUGIN_HIDECOMMENTS | Hide text starting with a =---+++ %COMMENTS_LABEL%= heading | |
 
 ---++ Default slide template
@@ -124 +117 @@
 
 ---++ Plugin installation instructions
-
-*Note:* You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where Foswiki is running. 
-
-   * Download the ZIP file from the Plugin Home (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%/SlideShow.pm== | Plugin Perl module |
-     | ==pub/System/*.gif== | Various button image files |
-   * Run the [[%SCRIPTURL{"configure"}%][configure]] script, and enable the plugin in the ={Plugins}= section.
+%$INSTALL_INSTRUCTIONS%
    * Test above example if the installation was successful.
 
@@ -159 +142 @@
 |  19 Nov 2002: | Added "Start presentation" and "End presentation" buttons; added =%<nop>SLIDENAVFIRST%=, =%<nop>SLIDENAVPREV%=, =%<nop>SLIDENAVNEXT%= template keywords |
 |  17 Nov 2002: | 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/SlideShowPlugin/lib/Foswiki/Plugins/SlideShowPlugin.pm

@@ -22 +22 @@
 
 use vars qw(
-  $web $topic $user $installWeb $VERSION $RELEASE $debug $addedHead
+  $web $topic $user $installWeb $debug $addedHead
 );
 
-
-# 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 = '31 Mar 2009';
+our $VERSION = '$Rev$';
+our $RELEASE = '31 Mar 2009';
+our $SHORTDESCRIPTION = 'Create web based presentations based on topics with headings';
+our $NO_PREFS_IN_TOPIC = 1;
 
 sub initPlugin {