Ignore:
Timestamp:
04/16/09 10:38:08 (3 years ago)
Author:
CrawfordCurrie
Message:

Item1383: removed support for settings in the plugin topic

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SlideShowPlugin/data/System/SlideShowPlugin.txt

    r3350 r3458  
    22---+!! Slide Show Plugin 
    33 
    4 Converts a topic with headings into a slideshow. 
     4%SHORTDESCRIPTION% 
    55 
    66%TOC% 
    … …  
    7979---++ <nop>%TOPIC% preferences 
    8080 
    81 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%== 
     81You can override the default settings for the plugin by defining the following [[%SYSTEMWEB%.PreferenceSettings][preferences]]. 
     82<!-- 
     83      * Set SHORTDESCRIPTION = Create web based presentations based on topics with headings. 
     84--> 
    8285 
    83    * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic: 
    84       * Set SHORTDESCRIPTION = Create web based presentations based on topics with headings. 
    85  
    86    * Debug plugin: (See output in =data/debug.txt=) 
    87       * Set DEBUG = 0 
    88  
    89    * Default template for slides: 
    90       * Set TEMPLATE = SlideShowPlugin 
    91  
    92    * Label for Comments section 
    93       * Set COMMENTS_LABEL = Comments 
    94        
    95    * Hide text starting with a =---+++ %COMMENTS_LABEL%= heading: 
    96       * Set HIDECOMMENTS =  
     86| *Preference* | *Meaning* | *Default* | 
     87| SLIDESHOWPLUGIN_TEMPLATE | Default template for slides: | SlideShowPlugin | 
     88| SLIDESHOWPLUGIN_COMMENTS_LABEL | Label for Comments section | Comments | 
     89| SLIDESHOWPLUGIN_HIDECOMMENTS | Hide text starting with a =---+++ %COMMENTS_LABEL%= heading | | 
    9790 
    9891---++ Default slide template 
    … …  
    124117 
    125118---++ Plugin installation instructions 
    126  
    127 *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.  
    128  
    129    * Download the ZIP file from the Plugin Home (see below) 
    130    * Unzip ==%TOPIC%.zip== in your Foswiki installation directory. Content: 
    131      | *File:* | *Description:* | 
    132      | ==data/System/%TOPIC%.txt== | Plugin topic | 
    133      | ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module | 
    134      | ==lib/Foswiki/Plugins/%TOPIC%/SlideShow.pm== | Plugin Perl module | 
    135      | ==pub/System/*.gif== | Various button image files | 
    136    * Run the [[%SCRIPTURL{"configure"}%][configure]] script, and enable the plugin in the ={Plugins}= section. 
     119%$INSTALL_INSTRUCTIONS% 
    137120   * Test above example if the installation was successful. 
    138121 
    … …  
    159142|  19 Nov 2002: | Added "Start presentation" and "End presentation" buttons; added =%<nop>SLIDENAVFIRST%=, =%<nop>SLIDENAVPREV%=, =%<nop>SLIDENAVNEXT%= template keywords | 
    160143|  17 Nov 2002: | Initial version | 
    161 |  CPAN Dependencies: | none | 
    162 |  Other Dependencies: | none | 
    163 |  Perl Version: | 5.008 | 
    164144|  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% | 
    165145|  Support: | http://foswiki.org/Support/%TOPIC% | 
Note: See TracChangeset for help on using the changeset viewer.