モジュール:Random/doc

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.

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 (anchor=Number)-  → number-  → 100-  → -50-  → same=yes-  → same=yes
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.
- 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 (anchor=Date)-  → date-  → format=F j-  → 31 Dec 1999-  → format=g:i a, l d M Y-  → 1970/06/01-  → same=yes-  → same=yes

**Item**
The item function outputs a random item from a list.

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 (anchor=Item)-  → spam-  → same=yes-  → same=yes

**List**
The list function outputs a list in a random order.

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.
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 &#32; to represent a normal space, and &nbsp; to represent a non-breaking space.
Examples (anchor=List)-  → spam-  → sep=dot-  → sep=space-  → sep=; -  → sep=foo-  → limit=3-  → same=yes-  → same=yes

**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.

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 (anchor=Text list)-  → spam-  → sep=; -  → conj= or -  → limit=3-  → same=yes-  → same=yes

**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.
 Basic usage

 All parameters
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.