RandomTopicPlugin
Pick a selection of Random Topics
Syntax Rules
-
%RANDOMTOPIC%
- inserts a single random topic name in its place.
-
%RANDOMTOPIC{params}%
- inserts potentially more than one random topic, with user formatting. Parameters:
- topics="5" - Number of topics requested. Default is 1 topic
- include="^Web" - Perl regular expression. Only topics that match this expression will be shown. Default is set by RANDOMTOPICPLUGIN_INCLUDE (see below).
- exclude="^Web" - Perl regular expression. Any topics that match this expression will never be shown. Default is set by RANDOMTOPICPLUGIN_EXCLUDE (see below).
- format=" format string " . The format string accepts 3 quoted parameters:
-
$t
will be expanded to \t
(necessary for bullet lists)
-
$n
will be expanded to \n
(So that things appear on separate lines - again for bullet lists)
-
$topic
will be expanded to the randomly chosen name
- Default is a bullet list:
"$t* $topic$n"
Examples
-
%RANDOMTOPIC{topics="5"}%
- 5 random topics as a bullet list * %RANDOMTOPIC{topics="5" format="| *$topic* | $topic |$n"}%
-
%RANDOMTOPIC{topics="10" exclude="^Web"}%
- 10 random topics, excluding any that start with "Web".
RandomTopicPlugin Global Settings
Plugin settings are stored as preferences variables. To reference a plugin setting write
%<plugin>_<setting>%
, i.e.
%RANDOMTOPICPLUGIN_SHORTDESCRIPTION%
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Pick a selection of Random Topics
- Perl regular expression matching topics to be selected from
- Perl regular expression matching topics to be excluded
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
RandomTopicPlugin.zip
in your twiki installation directory. Content: File: | Description: |
lib/TWiki/Plugins/RandomTopicPlugin.pm | |
data/TWiki/RandomTopicPlugin.txt | |
- (Dakar) Visit
configure
in your TWiki installation, and enable the plugin in the {Plugins} section.
- Test if the installation was successful:
- If you see a table below of 5 random topics then you have successfully installed this:
%RANDOMTOPIC%
%RANDOMTOPIC%
%RANDOMTOPIC{ format="$topic" }%
%RANDOMTOPIC{ format="$topic" }%
%RANDOMTOPIC{topics="5" format="| $topic |$n"}%
%RANDOMTOPIC{topics="5" format="| $topic |$n"}%
%RANDOMTOPIC{topics="5" format="| *$topic* | $topic |$n"}%
%RANDOMTOPIC{topics="5" format="|
$topic | $topic |$n"}%
Plugin Info
Related Topics: TWikiPreferences,
TWikiPlugins