Module:Random/doc

From Bogleheads
Jump to: navigation, search

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

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 [0,1].
  • With one argument, returns an integer in the range [1,m]. m must be positive.
  • With two arguments, returns an integer in the range [m,n]. m and n can be either positive or negative. If m is greater than n, returns an integer in the range [n,m] 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.22599756169412
  • {{#invoke:random|number|100}} → 6
  • {{#invoke:random|number|-100|-50}} → -86
  • {{#invoke:random|number|100|same=yes}} → 95
  • {{#invoke:random|number|100|same=yes}} → 95

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

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}} → 21:15, 11 April 2020 (UTC)
  • {{#invoke:random|date|format=F j}} → January 3
  • {{#invoke:random|date|1 Jan 1980|31 Dec 1999}} → 08:42, 24 February 1980 (UTC)
  • {{#invoke:random|date|1st January 1500|1st January 3000|format=g:i a, l d M Y}} → 5:10 pm, Monday 10 Mar 1738
  • {{#invoke:random|date|1970/06/01}} → 23:27, 24 January 1970 (UTC)
  • {{#invoke:random|date|same=yes}} → 14:23, 10 December 2020 (UTC)
  • {{#invoke:random|date|same=yes}} → 14:23, 10 December 2020 (UTC)

Item

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}} → bacon
  • {{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}} → bacon
  • {{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}} → bacon

List

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 ⧼dot-separator⧽
pipe |
comma ,
tpt-languages ⧼tpt-languages-separator⧽
space a space
newline a newline character
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}} → baconsausageeggbeansspam
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=dot}} → bacon⧼dot-separator⧽sausage⧼dot-separator⧽egg⧼dot-separator⧽beans⧼dot-separator⧽spam
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=space}} → bacon egg beans spam sausage
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=; }} → bacon; egg; beans; spam; sausage
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=foo}} → baconfoospamfoosausagefoobeansfooegg
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|limit=3}} → baconspamsausage
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}} → eggsausagebeansspambacon
  • {{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}} → eggsausagebeansspambacon

Text list

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, spam, sausage, egg and beans
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=; }} → bacon; spam; sausage; egg and beans
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=; |conj= or }} → bacon; spam; sausage; egg or beans
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|limit=3}} → bacon, sausage and egg
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}} → egg, sausage, beans, spam and bacon
  • {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}} → egg, sausage, beans, spam and bacon

HTML lists

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
  • spam
  • sausage
unbulleted_list Unbulleted lists {{#invoke:random|unbulleted_list|egg|sausage|spam}}
  • egg
  • spam
  • sausage
horizontal_list Horizontal bulleted lists {{#invoke:random|horizontal_list|egg|sausage|spam}}
  • spam
  • sausage
  • egg
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

Template:Pre2

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.