模组:Random list/doc

此页面是Module:Random list的模块文档。
此页面可能包含了模板的使用说明、分类和其他内容。

本模组可以从一个列表中随机抽取指定数量的项目，以点列（*）的形式展示。

如果您只需要从列表中选取一个项目，请使用Module:Rand（本模板亦是受到该模组启发而建）。

建议直接使用呼叫本模组的模板{{Random list}}。

使用方式

{{#invoke:Random list|randitems|...}}

参数：

1：必填。包含所有候选项目的原始文本。
count：选填。要回传的项目数量。预设为 1。
- 如果输入负数（如-1）或大于总项数，则回传所有项目。
2：选填。自定义分隔符（Lua pattern）。
- 指定后，模组会以 mw.text.split(text, sep) 分割第 1 参数。
- 未指定时，模组不使用pattern分割，而是逐行解析wiki列表（以换行切分，并移除行首的*）。

随机从ABCD中抽取2个项目展示：

{{#invoke:Random list|randitems|count=2|
*選項A
*選項B
*選項C
*選項D
}}

效果：

与Module:Rand一样，您也可以建立单独的页面，并嵌入到参数1：

例如，若您使用

{{#invoke:Random list|randitems|count=2|{{User:Example/subpage}}}}

并在User:Example/subpage建立以下内容：

*選項A
*選項B
*選項C
*選項D

实现的效果是完全一致的。