模組:Random list/doc

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

本模組可以從一個列表中隨機抽取指定數量的項目，以點列（*）的形式展示。

如果您只需要從列表中選取一個項目，請使用Module:Rand（本模板亦是受到該模組啓發而建）。

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

使用方式

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

參數：

1：必填。包含所有候選項目的原始文本。
count：選填。要回傳的項目數量。預設為 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

實現的效果是完全一致的。