模組:Hatnote list/doc

此頁面為 Module:Hatnote list 的說明文件

從維基文本中的使用

雖然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() 預處理參數。