Module:Random/doc

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search

This is the documentation page for Module:Random

Take a look at en:wiki:Module:Random to make sure this is the most up-to-date version.

This module contains a number of functions that use random numbers. It can output random numbers, select a random item from a list, and reorder lists randomly. The randomly reordered lists can be output inline, or as various types of ordered and unordered lists. The available functions are outlined in more detail below.

Number[edit]

The number function outputs a random number.

{{#invoke:random|number|m|n|same=yes}}

The arguments m and n may be omitted, but if specified must be convertible to integers.

  • With no arguments, returns a real number in the range .
  • With one argument, returns an integer in the range . m must be positive.
  • With two arguments, returns an integer in the range . m and n can be either positive or negative. If m is greater than n, returns an integer in the range instead.
  • If the |same= parameter is set to "yes", "y", "true", or "1", the same random number is returned for each module call on a given page.

Examples (refresh)

  • {{#invoke:random|number}} → 0.54632627523799
  • {{#invoke:random|number|100}} → 20
  • {{#invoke:random|number|-100|-50}} → -100
  • {{#invoke:random|number|100|same=yes}} → 77
  • {{#invoke:random|number|100|same=yes}} → 77

The documentation for this function is partly taken from the Scribunto Lua reference manual, which is in turn based on the Lua 5.1 Reference Manual, available under the MIT License.

Date[edit]

The date function outputs a random date.

{{#invoke:random|date|timestamp1|timestamp2|format=date format|same=yes}}
  • If no timestamp arguments are specified, the module outputs a random date in the current year.
  • If timestamp1 and timestamp2 are specified, the module outputs a random date between the two timestamps. timestamp1 must be earlier than timestamp2.
  • If only timestamp1is specified, the module outputs a random date between the Unix epoch (1 Jan 1970) and the timestamp. timestamp1 must not be earlier than 1 Jan 1970.
  • Formatting can be specified with the |format= parameter. The default formatting is "hh:mm, DD Month YYYY (UTC)" (the same as the default Wikipedia timestamp).
  • The timestamps and the |format= parameter accept values compatible with the #time parser function. Please see the #time documentation for the full range of possible input values and formatting options.
  • If the |same= parameter is set to "yes", "y", "true", or "1", the same date is returned for each module call on a given page.

Examples (refresh)

  • {{#invoke:random|date}} → 17:58, 30 April 2020 (UTC)
  • {{#invoke:random|date|format=F j}} → January 6
  • {{#invoke:random|date|1 Jan 1980|31 Dec 1999}} → 15:15, 15 December 1998 (UTC)
  • {{#invoke:random|date|1st January 1500|1st January 3000|format=g:i a, l d M Y}} → 7:56 pm, Tuesday 21 Aug 2362
  • {{#invoke:random|date|1970/06/01}} → 20:05, 25 April 1970 (UTC)
  • {{#invoke:random|date|same=yes}} → 16:32, 05 October 2020 (UTC)
  • {{#invoke:random|date|same=yes}} → 16:32, 05 October 2020 (UTC)

Item[edit]

The item function outputs a random item from a list.

{{#invoke:random|item|list item 1|list item 2|list item 3|...|same=yes}}

If the |same= parameter is set to "yes", "y", "true", or "1", the same item is returned for each module call on a given page.

Example (refresh)

  • {{#invoke:random|item|egg|beans|sausage|bacon|spam}} → egg
  • {{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}} → spam
  • {{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}} → spam

List[edit]

The list function outputs a list in a random order.

{{#invoke:random|list|list item 1|list item 2|list item 3|...|sep=separator|limit=number of items to display|same=yes}}

Named parameters

  • |sep= or |separator= - an optional separator for the list items. Some values are special; see the table below.
  • |limit= - the maximum number of list items to display. The lowest possible is 0 and the highest possible is the length of the list.
  • |same= - if this is set to "yes", "y", "true", or "1", the list order is the same for each module call on a given page.
Possible separator values
Code Output
dot  ·
pipe |
comma ,
tpt-languages  •
space a space
any other value other values are used without modification

You cannot input spaces directly to the |sep= parameter due to limitations in MediaWiki's template syntax. However, it is possible to work around this by using HTML entities. You can use   to represent a normal space, and   to represent a non-breaking space.

Examples (refresh)

  • {{#invoke:random|list|egg|beans|sausage|bacon|spam}} → beanssausagespameggbacon
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=dot}} → sausage · bacon · egg · beans · spam
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=space}} → bacon spam egg sausage beans
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=; }} → beans; egg; spam; bacon; sausage
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=foo}} → eggfoobaconfoospamfoosausagefoobeans
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|limit=3}} → spameggsausage
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}} → eggbeanssausagebaconspam
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}} → eggbeanssausagebaconspam

Text list[edit]

The text_list function outputs a list in a random order, text-style. In other words, it is like the list function, but with a different separator before the last item.

{{#invoke:random|text_list|list item 1|list item 2|list item 3|...|sep=separator|conj=conjunction|limit=number of items to display|same=yes}}

The separator can be specified with either the |sep= or |separator= parameters; its default value is ", ". The conjunction can be specified with either the |conj= or |conjunction= parameters; its default value is " and ". The separator and the conjunction can be specified with the same values as the separator in the list function.

The maximum number of list items to display can be set with the |limit= parameter. The lowest possible is 0 and the highest possible is the length of the list.

If the |same= parameter is set to "yes", "y", "true", or "1", the list order is the same for each module call on a given page.

Examples (refresh)

  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam}} → bacon, beans, egg, spam and sausage
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=; }} → bacon; egg; sausage; spam and beans
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=; |conj= or }} → sausage; beans; egg; spam or bacon
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|limit=3}} → beans, sausage and egg
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}} → egg, beans, sausage, bacon and spam
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}} → egg, beans, sausage, bacon and spam

HTML lists[edit]

If you wish to output an HTML list in a random order, you can choose between five different functions: bulleted_list, unbulleted_list, horizontal_list, ordered_list, and horizontal_ordered_list. These functions all use Module:List.

Function name Produces Example code Example output (refresh)
bulleted_list Bulleted lists {{#invoke:random|bulleted_list|egg|sausage|spam}}
  • egg
  • sausage
  • spam
unbulleted_list Unbulleted lists {{#invoke:random|unbulleted_list|egg|sausage|spam}}
  • sausage
  • egg
  • spam
horizontal_list Horizontal bulleted lists {{#invoke:random|horizontal_list|egg|sausage|spam}}
  • sausage
  • egg
  • spam
ordered_list Ordered lists (numbered lists and alphabetical lists) {{#invoke:random|ordered_list|egg|sausage|spam}}
  1. spam
  2. sausage
  3. egg
horizontal_ordered_list Horizontal ordered lists {{#invoke:random|horizontal_ordered_list|egg|sausage|spam}}
  1. spam
  2. sausage
  3. egg
Basic usage
{{#invoke:random|function|list item 1|list item 2|list item 3|...|limit=number of items to display|same=yes}}
All parameters
{{#switch:{{{2}}}|nowiki|nw={{#tag:nowiki|{{{3}}}}}|{{{2}}}}}|white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;{{{style|}}}">{{#switch:{{{1}}}|nowiki|nw={{#tag:nowiki|{{{2}}}}}|{{{1}}}}} }}

The maximum number of list items to display can be set with the |limit= parameter. The lowest possible is 0 and the highest possible is the length of the list.

If the |same= parameter is set to "yes", "y", "true", or "1", the list order is the same for each module call on a given page.

Please see Module:List for a full explanation of the other parameters.