join
donate

RandomQuotePlugin

Retrieve a random quote from a specially formatted TWiki topic and display on a TWiki page

Syntax Rules

The %RANDOMQUOTE{...}% variable gets expanded to a random quote selected from a RandomQuotes page.

%RANDOMQUOTE%
Parameter
Sorted ascending
Explanation Default
format Format of one item. Can include variables in the table below. "\"$saying\"--$author"
quotes_file Alternate name for the random quotes topic RandomQuotes
web Name of the web where the random quotes topic is stored. Users

Format $variables DescriptionSorted ascending
$saying Text of the random quote
$category What type of quote is this?
(could be used to match with Topic Classification)
$author Who said it?

Examples

%RANDOMQUOTE{ web="Main" quotes_file="JunkQuotes" }%

%RANDOMQUOTE{ web="Main" quotes_file="JunkQuotes" }%

%RANDOMQUOTE{ web="Main" }%

%RANDOMQUOTE{ web="Main" }%

%RANDOMQUOTE{ format="<p><cite>$saying</cite></p><p align='right'>$author</p>" }%

%RANDOMQUOTE{ format="

$saying

$author

" }%

RandomQuotePlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = display a random quote

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

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 TWiki is running.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip RandomQuotePlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/Users/RandomQuotes RandomQuotesPlugin data topic
    data/TWiki/RandomQuotePlugin.txt Plugin topic
    data/TWiki/RandomQuotePlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/RandomQuotePlugin.pm Plugin Perl module
  • Test if the installation was successful:
%RANDOMQUOTE{}%

Plugin Info

Plugin Author: JasonTromm
Plugin Version: 03 Jul 2003 (V0.001)
Change History:  
03 Jun 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home: https://wiki.trommetter.com/TWiki/RandomQuotePlugin
Feedback: https://wiki.trommetter.com/TWiki/RandomQuotePluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- JasonTromm - 03 Jul 2003


This topic: TWiki > RandomQuotePlugin
Topic revision: r4 - 2006-03-02 - 14:49:28 - SteveKostecke
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding NTP? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.RandomQuotePlugin