Tags:
navigation1Add my vote for this tag create new tag
, view all tags

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
    • Set INCLUDETOPICS =
  • Perl regular expression matching topics to be excluded
    • Set EXCLUDETOPICS = ^Web

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

Plugin Author: TWiki:Main/MichaelSparks
Copyright: © 2003, TWiki:Main.MichaelSparks
© 2004, TWiki:Main.CrawfordCurrie
© 2005, TWiki:Main.WillNorris
© 2006-2010 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2010-11-10 - 19824 (2010-11-10)
Change History:  
2010-11-10: TWikibug:Item6530: Doc improvements
27 Dec 2005 1.201 TWiki:Main.WillNorris - changed INCLUDE and EXCLUDE preferences (to INCLUDETOPICS and EXCLUDETOPICS) for Dakar compatability
15 Nov 2004 1.200 Crawford Currie - removed non-functional persist option, added exclude and include parameters, ported to Cairo & BuildContrib build system, add to CVS.
10 Jul 2003 1.010 Initial version
Dependencies: None
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/RandomTopicPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/RandomTopicPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 RandomTopicPlugin.md5 r3 r2 r1 manage 0.2 K 2010-11-11 - 05:12 PeterThoeny  
Compressed Zip archivetgz RandomTopicPlugin.tgz r3 r2 r1 manage 4.3 K 2010-11-11 - 05:12 PeterThoeny  
Compressed Zip archivezip RandomTopicPlugin.zip r5 r4 r3 r2 r1 manage 5.9 K 2010-11-11 - 05:12 PeterThoeny  
Unknown file formatEXT RandomTopicPlugin_installer r3 r2 r1 manage 3.4 K 2010-11-11 - 05:12 PeterThoeny  
Edit | Attach | Watch | Print version | History: r13 < r12 < r11 < r10 < r9 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r13 - 2013-10-16 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2016 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.