Редактирование: Модуль:Random/doc

Этот модуль содержит ряд функций, использующих случайные числа. Он может вернуть случайное число, выбрать случайный элемент списка или перемешать список случайным образом. Перемешанные списки могут быть выведены в строчку или в виде нумерованных или ненумерованных списков различных видов. Доступные функции описаны более подробно ниже.

== Number ==
Функция <code>number</code> возвращает случайное число.

 &#123;{#invoke:random|number|''m''|''n''|same=''yes''}}

Аргументы <code>m</code> и <code>n</code> могут быть опущены, однако в случае, если они заданы, они должны быть приводимы к целым числам.
* При вызове без параметров возвращает вещественное число в полуинтервале <math>[0,1)</math>.
* При вызове с одним параметром возвращает целое число из интервала <math>[1,m]</math>. <code>''m''</code> должно быть положительным.
* При вызове с двумя параметрами возвращает целое число из интервала <math>[m,n]</math>. <code>''m''</code> и <code>''n''</code> могут быть как положительными, так и отрицательными. Если <code>''m''</code> больше <code>''n''</code>, возвращает целое число из интервала <math>[n,m]</math>.
* Если параметру {{para|same}} присвоено одно из значений «yes», «y», «true» или «1», одно и то же случайное число возвращается для каждого вызова модуля на данной странице.

'''Примеры''' <small>({{purge|обновить|anchor=Number}})</small>
{{очищать кэш|ежедневно}}
* <code><nowiki>{{#invoke:random|number}}</nowiki></code> &rarr; {{#invoke:random|number}}
* <code><nowiki>{{#invoke:random|number|100}}</nowiki></code> &rarr; {{#invoke:random|number|100}}
* <code><nowiki>{{#invoke:random|number|-100|-50}}</nowiki></code> &rarr; {{#invoke:random|number|-100|-50}}
* <code><nowiki>{{#invoke:random|number|100|same=yes}}</nowiki></code> &rarr; {{#invoke:random|number|100|same=yes}}
* <code><nowiki>{{#invoke:random|number|100|same=yes}}</nowiki></code> &rarr; {{#invoke:random|number|100|same=yes}}

<small>Документация этой функции частично скопирована из [[mw:Extension:Scribunto/Lua reference manual#math.random|справки по Scribunto Lua]], в свою очередь основанной на [http://www.lua.org/manual/5.1/index.html справке по Lua 5.1], доступной под [[Лицензия MIT|лицензией MIT]].</small>

== Date ==
Функция <code>date</code> возвращает случайную дату.

 &#123;{#invoke:random|date|''метка1''|''метка2''|format=''формат даты''|same=''yes''}}

* Если ни одна из временных меток не задана, модуль возвращает случайную дату текущего года.
* Если заданы параметры <code>''метка1''</code> и <code>''метка2''</code>, модуль возвращает случайную дату между данными двумя временными метками. <code>''метка1''</code> должна быть раньше <code>''метка2''</code>.
* Если задан только параметр <code>''метка1''</code>, модуль возвращает случайную дату между «[[Unix-время|эрой Unix]]» (1 января 1970) и временной меткой. Метка <code>''метка1''</code> не должна быть раньше 1 января 1970.
* Форматирование может быть задано параметром {{para|format}}. Форматирование по умолчанию — «hh:mm, DD Month YYYY (UTC)» (аналогично форматированию по умолчанию временных меток Википедии).
* Временные метки и параметр {{para|format}} поддерживают значения, совместимые с [[mw:Help:Extension:ParserFunctions##time|функцией парсера #time]]. Обратитесь к документации #time для получения полного списка возможных входных значений и опций форматирования.
* Если параметру {{para|same}} присвоено одно из значений «yes», «y», «true» или «1», одна и та же дата возвращается для каждого вызова модуля на данной странице.

'''Примеры''' <small>({{purge|обновить|anchor=Date}})</small>

* <code><nowiki>{{#invoke:random|date}}</nowiki></code> &rarr; {{#invoke:random|date}}
* <code><nowiki>{{#invoke:random|date|format=F j}}</nowiki></code> &rarr; {{#invoke:random|date|format=F j}}
* <code><nowiki>{{#invoke:random|date|1 Jan 1980|31 Dec 1999}}</nowiki></code> &rarr; {{#invoke:random|date|1 Jan 1980|31 Dec 1999}}
* <code><nowiki>{{#invoke:random|date|1st January 1500|1st January 3000|format=g:i a, l d M Y}}</nowiki></code> &rarr; {{#invoke:random|date|1st January 1500|1st January 3000|format=g:i a, l d M Y}}
* <code><nowiki>{{#invoke:random|date|1970/06/01}}</nowiki></code> &rarr; {{#invoke:random|date|1970/06/01}}
* <code><nowiki>{{#invoke:random|date|same=yes}}</nowiki></code> &rarr; {{#invoke:random|date|same=yes}}
* <code><nowiki>{{#invoke:random|date|same=yes}}</nowiki></code> &rarr; {{#invoke:random|date|same=yes}}

== Item ==
Функция <code>item</code> возвращает случайный элемент списка.

 &#123;{#invoke:random|item|''элемент списка 1''|''элемент списка 2''|''элемент списка 3''|...|same=''yes''}}

Если параметру {{para|same}} присвоено одно из значений «yes», «y», «true» или «1», один и тот же элемент возвращается для каждого вызова модуля на данной странице.

'''Пример''' <small>({{purge|обновить|anchor=Item}})</small>

* <code><nowiki>{{#invoke:random|item|egg|beans|sausage|bacon|spam}}</nowiki></code> &rarr; {{#invoke:random|item|egg|beans|sausage|bacon|spam}}
* <code><nowiki>{{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}}</nowiki></code> &rarr; {{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}}
* <code><nowiki>{{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}}</nowiki></code> &rarr; {{#invoke:random|item|egg|beans|sausage|bacon|spam|same=yes}}

== List ==
Функция <code>list</code> возвращает список в случайном порядке.

 &#123;{#invoke:random|list|''элемент списка 1''|''элемент списка 2''|''элемент списка 3''|...|sep=''разделитель''|limit=''сколько элементов отображать''|same=''yes''}}

'''Именованные параметры'''
* {{para|sep}} или {{para|separator}} — опциональный разделитель списка элементов. Некоторые значения зарезервированы, см. таблицу ниже.
* {{para|limit}} — максимальное число отображаемых элементов списка. Наименьшее возможное значение — 0, наибольшее — число элементов в списке.
* Если параметру {{para|same}} присвоено одно из значений «yes», «y», «true» или «1», один и тот же список возвращается для каждого вызова модуля на данной странице.

{| class="wikitable"
|+ Возможные значения разделителя
|-
! Код !! Вывод
|-
| <code>dot</code> || {{int:dot-separator}}
|-
| <code>pipe</code> 
|| {{int:pipe-separator}}
|-
| <code>comma</code> || {{int:comma-separator}}
|-
| <code>tpt-languages</code> || {{int:tpt-languages-separator}}
|-
| <code>space</code> || ''пробел''
|-
| <code>newline</code> || ''символ перевода строки''
|-
| ''любое другое значение'' || ''остальные значения используются без изменения''
|}

Передать пробелы в параметр {{para|sep}} невозможно из-за ограничений, накладываемых синтаксисом шаблонов в MediaWiki. Однако их можно обойти, используя [[Кодировки_символов_в_HTML#Мнемоники_HTML_и_коды_Unicode|мнемоники HTML]]. Используйте <code>&amp;#32;</code> для представления обычного пробела и <code>&amp;nbsp;</code> для представления [[Неразрывный пробел|неразрывного пробела]].

'''Примеры''' <small>({{purge|обновить|anchor=List}})</small>

* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam}}
* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=dot}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=dot}}
* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=space}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=space}}
* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=;&amp;#32;}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=;&#32;}}
* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=foo}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam|sep=foo}}
* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam|limit=3}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam|limit=3}}
* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}}
* <code><nowiki>{{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}}</nowiki></code> &rarr; {{#invoke:random|list|egg|beans|sausage|bacon|spam|same=yes}}

== Text list ==

Функция <code>text_list</code> возвращает список в случайном порядке в виде связанного текста. Другими словами, эта функция работает так же, как функция <code>list</code>, но использует другой разделитель перед последним элементом.

 &#123;{#invoke:random|text_list|''элемент списка 1''|''элемент списка 2''|''элемент списка 3''|...|sep=''разделитель''|conj=''союз''|limit=''сколько элементов отображать''|same=''yes''}}

Разделитель может быть задан параметрами {{para|sep}} или {{para|separator}}; значение по умолчанию — «{{int:comma-separator}}». Союз может быть задан параметрами {{para|conj}} или {{para|conjunction}}; значение по умолчанию — « и ». В параметры разделителя и союза могут быть переданы те же значения, что и в параметр разделителя в [[#List|функции list]].

Максимальное число отображаемых элементов списка может быть задано параметром {{para|limit}}. Наименьшее возможное значение — 0, наибольшее — число элементов в списке.

Если параметру {{para|same}} присвоено одно из значений «yes», «y», «true» или «1», один и тот же список возвращается для каждого вызова модуля на данной странице.

'''Примеры''' <small>({{purge|обновить|anchor=Text list}})</small>

* <code><nowiki>{{#invoke:random|text_list|egg|beans|sausage|bacon|spam}}</nowiki></code> &rarr; {{#invoke:random|text_list|egg|beans|sausage|bacon|spam}}
* <code><nowiki>{{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=;&amp;#32;}}</nowiki></code> &rarr; {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=;&#32;}}
* <code><nowiki>{{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=;&amp;#32;|conj=&amp;#32;или&amp;#32;}}</nowiki></code> &rarr; {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|sep=;&#32;|conj=&#32;или&#32;}}
* <code><nowiki>{{#invoke:random|text_list|egg|beans|sausage|bacon|spam|limit=3}}</nowiki></code> &rarr; {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|limit=3}}
* <code><nowiki>{{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}}</nowiki></code> &rarr; {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}}
* <code><nowiki>{{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}}</nowiki></code> &rarr; {{#invoke:random|text_list|egg|beans|sausage|bacon|spam|same=yes}}

== HTML-списки ==
Если вы хотите вывести HTML-список в случайном порядке, вы можете выбрать одну из пяти функций: <code>bulleted_list</code>, <code>unbulleted_list</code>, <code>horizontal_list</code>, <code>ordered_list</code>, и <code>horizontal_ordered_list</code>. Все эти функции используют [[Модуль:List]].

{| class="wikitable"
|-
! Название функции
! Создаёт
! Код примера
! Вывод примера <small>({{purge|обновить|anchor=HTML lists}})</small>
|-
| <code>bulleted_list</code>
| Маркированный список
| <code><nowiki>{{#invoke:random|bulleted_list|egg|sausage|spam}}</nowiki></code>
| {{#invoke:random|bulleted_list|egg|sausage|spam}}
|-
| <code>unbulleted_list</code>
| Немаркированный список
| <code><nowiki>{{#invoke:random|unbulleted_list|egg|sausage|spam}}</nowiki></code>
| {{#invoke:random|unbulleted_list|egg|sausage|spam}}
|-
| <code>horizontal_list</code>
| Горизонтальный маркированный список
| <code><nowiki>{{#invoke:random|horizontal_list|egg|sausage|spam}}</nowiki></code>
| {{#invoke:random|horizontal_list|egg|sausage|spam}}
|-
| <code>ordered_list</code>
| Упорядоченный список (нумерованные и алфавитные списки)
| <code><nowiki>{{#invoke:random|ordered_list|egg|sausage|spam}}</nowiki></code>
| {{#invoke:random|ordered_list|egg|sausage|spam}}
|-
| <code>horizontal_ordered_list</code>
| Горизонтальный упорядоченный список
| <code><nowiki>{{#invoke:random|horizontal_ordered_list|egg|sausage|spam}}</nowiki></code>
| {{#invoke:random|horizontal_ordered_list|egg|sausage|spam}}
|}

; Базовое использование

 &#123;{#invoke:random|''функция''|''элемент списка 1''|''элемент списка 2''|''элемент списка 3''|...|limit=''сколько элементов отображать''|same=''yes''}}

; Все параметры

{{pre|
<nowiki>{{</nowiki>#invoke:random<nowiki>|</nowiki>''функция''
<nowiki>|</nowiki>''первый элемент''<nowiki>|</nowiki>''второй элемент''<nowiki>|</nowiki>''третий элемент''<nowiki>|</nowiki>...
<nowiki>|start           = </nowiki>''начальное число для упорядоченного списка''
<nowiki>|type            = </nowiki>''тип маркера для упорядоченного списка''
<nowiki>|list_style_type = </nowiki>''тип маркера для упорядоченного списка (использует CSS)''
<nowiki>|class           = </nowiki>''класс''
<nowiki>|style           = </nowiki>''стиль''
<nowiki>|list_style      = </nowiki>''стиль списка''
<nowiki>|item_style      = </nowiki>''стиль всех элементов списка''
<nowiki>|item_style1     = </nowiki>''стиль первого элемента списка''<nowiki> |item_style2 = </nowiki>''стиль второго элемента списка''<nowiki> |</nowiki>...
<nowiki>|indent          = </nowiki>''отступ для горизонтальных списков''
<nowiki>}}</nowiki>
}}

Максимальное число отображаемых элементов списка может быть задано параметром {{para|limit}}. Наименьшее возможное значение — 0, наибольшее — число элементов в списке.

Если параметру {{para|same}} присвоено одно из значений «yes», «y», «true» или «1», один и тот же список возвращается для каждого вызова модуля на данной странице.

Посетите документацию [[Модуль:List|Модуля:<nowiki/>List]] для получения полной информации по остальным параметрам.

== См. также ==
* {{tl|очищать кэш}} — для периодической пересборки страницы

<includeonly>
[[Категория:Тептар:Модули]]
</includeonly><noinclude>
[[Категория:Модули:Документация]]
</noinclude>