Extension:RandomSelection

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
RandomSelection

Release status:Extension status stable

ImplementationTemplate:Extension#type Tag, Parser function
DescriptionTemplate:Extension#description Displays a random option from the given set.
Author(s)Template:Extension#username
Latest versionTemplate:Extension#version 2.2.2 (2017-07-25)
MediaWikiTemplate:Extension#mediawiki 1.25+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
ExampleTemplate:Extension#example
TagsTemplate:Extension#tags
  • <choose>
  • <option>
  • <choicetemplate>
Hooks usedTemplate:Extension#hook
ParserFirstCallInitManual:Hooks/ParserFirstCallInit

Translate the RandomSelection extension if it is available at translatewiki.net

Check usage and version matrix.

The RandomSelection extension allows for randomly-generated content inside your wiki; e.g. rotating images, random greetings, etc.

Installation[edit]

  • Download and place the file(s) in a directory called RandomSelection in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'RandomSelection' );
    
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage[edit]

Tags[edit]

To choose between one or more options, simply place each option inside an <option> tag which are themselves placed inside <choose> tags, like so:

<choose>
<option>This is the first choice.</option>
<option>This is the second choice.</option>
<option>And so on...</option>
</choose>

From each set of <choose> tags, precisely one <option> tag will be selected at random, and its contents shown. Anything can be placed inside of option tags: links, images, even templates. Note, however, that template arguments will not be expanded due to task T4257.

You can also have what is placed inside the option tags be sent as an argument to a template with the <choicetemplate> tag, e.g.:

<choose>
<option>Template:Featured article/Elephant</option>
<option>Template:Featured article/Giraffe</option>
<option>Template:Featured article/Rhinoceros</option>
<choicetemplate>PageWithEditButton</choicetemplate>
</choose>

You could then create a [[Template:PageWithEditButton]] with these contents:

[{{canonicalurl:{{{1}}}|action=edit}} Edit] {{{{{1}}}}}

This is useful if you want to set up randomly rotating featured articles and have an edit button to allow the user to edit the featured article blurbs.

Parameters to <choose>[edit]

Parameter Description
uncached Disable caching for the chosen option
before Put this text before the chosen option
after Put this text after the chosen option
Since version 2.2.2 caching in the <choose> tag is disabled only if the user specifies <choose uncached>. Previously caching was disabled by default.

If you wanted to disable caching for the options, you should add the uncached parameter.

<choose uncached>
<option>This is the first choice.</option>
<option>This is the second choice.</option>
<option>And so on...</option>
</choose>

If you wanted to display one of three YouTube videos, you could try this (Extension:Widgets and Widget:YouTube required):

<choose before="{{#widget: YouTube|id=" after="}}">
<option>eR7-AUmiNcA</option><!--King of Anything-->
<option>cSCi7kCXKDA</option><!--Slipping Through My Fingers-->
<option>7n2d9XPsmmE</option><!--When Death Note Music Plays in My Car-->
</choose>

Parameters to <option>[edit]

Parameter Description
weight Weight of the option

If you'd like some options to be shown more often than others, you can add weight to the option tags, like so:

<choose>
<option weight="2">This option will be shown twice as often as a normal option.</option>
<option>By default, options have a weight of 1.</option>
<option weight="1.5">This option also has a weight of 1.  Fractional portions are ignored.</option>
</choose>

Parser function[edit]

To choose between one or more options, simply place each option inside the #choose: parser function, like so:

{{#choose:
 |This is the first choice.
 |This is the second choice.
 |And so on...
}}

From each choice divided by a pipe, precisely one choice will be selected at random, and its contents shown. Anything can be placed inside: links, images, even templates.

See also[edit]