模組:Hatnote list/doc
外觀
此頁面為 Module:Hatnote list 的說明文件
此模組文件被引用於約89,000個頁面。 為了避免造成大規模的影響,所有對此模組文件的編輯應先於沙盒或測試樣例上測試。 測試後無誤的版本可以一次性地加入此模組文件中,但是修改前請務必於討論頁發起討論。 模板引用數量會自動更新。 |
此模組使用Lua語言: |
從維基文本中的使用
[編輯]雖然forSee
接受一個初始的frame
參數,並且可能可以從維基文本中使用,但這個模塊並不是直接設計用於維基文本的,例如:
{{hatnote|PREFIX {{#invoke:Hatnote list|forSee|{{tl|For}}|Module:For|{{tl|About}}|Module:About}} POSTFIX}}
→
從 Lua 中的使用
[編輯]要調用該模塊,請使用
local mHatList = require('Module:Hatnote list')
或類似的方式,然後通過 mHatList
變量(或其他使用的變量)訪問其方法。
andList(和列表)
[編輯]andList
接受一個表格形式的列表,返回一個字符串,其中列表以「和」以及適當的逗號分隔。
orList(或列表)
[編輯]orList
接受一個表格形式的列表,返回一個字符串,其中列表以「或」以及適當的逗號分隔。
forSee(參見)
[編輯]_forSee
接受三個參數:一個修剪過且去除空白的參數表,一個從哪個索引開始的「from」數字,以及一個選項表,並返回一個字符串,其中包含一系列 "For X, see [[Y]]
" 句子。鏈接使用 Module:Hatnote 中的方法格式化。
為方便起見,forSee
方法(去掉前面的底線)接受相同的參數,除了使用框架而不是參數表,使用 Module:Arguments 中的 getArgs()
預處理參數。