模組:Labelled list hatnote/doc

此模块文档已被保护。此为高度可见模块文档，其已用于大量条目或被频繁替换引用。由于破坏或失误会影响诸多页面，即便细小的改动也可能导致大量服务器负载，因此已被保护，不可编辑。

此模块文档被引用於約26,000個頁面。
為了避免造成大規模的影響，所有對此模块文档的編輯應先於沙盒或測試樣例上測試。
測試後無誤的版本可以一次性地加入此模块文档中，但是修改前請務必於討論頁發起討論。

模板引用數量會自動更新。

此模块提供了几个函数来实现带有标签的页面列表提示，例如 {{hatnote|LABEL: [[A]], [[B]], and [[C]]}}。此模块实现了一个功能，用于创建带有标签的页面列表提示，类似于 "{{see also}}" 等模板的效果。它包括两个主要函数：preprocessDisplays 函数用于将显示参数预先组合成页面参数，并在处理过程中压缩稀疏数组；labelledList 函数处理模板调用，接受单数和可选的复数标签参数，并生成带标签的页面列表提示。

使用方法

labelledList

调用 labelledList() 函数足以实现大多数类似的模板： {{#invoke list hatnote|labelledList|通用标签}} 或者 {{#invoke list hatnote|labelledList|单数标签|复数标签}} 例如，用 "See also" 替代 "通用标签" 可以复制 {{see also}} 的功能，用 "Main article" 和 "Main articles" 替代 "单数标签" 和 "复数标签" 可以复制 {{main}} 的功能（在文章命名空间）。

preprocessDisplays

preprocessDisplays() 函数接受一个原始参数列表，并组合任何显示参数。例如，{{see also|1|l1=One}} 最初的参数表为 {'1', ['l1'] = 'One'}；此函数会将其组合成 {'1|One'}。它会覆盖手动的管道符（例如 {{see also|1{{!}}2|l1=One}} → {'1|One'}），并压缩稀疏数组，如果参数被跳过或留空。

示例：

 local mLabelledList = require('Module
list hatnote') local pages = mLabelledList.preprocessDisplays(args)

_labelledList

对于需要稍微修改功能但仍使用它的模块，_labelledList() 提供了一些灵活性。它接受三个参数：页面列表，最好由 preprocessDisplays 预处理和压缩标签表，第一项为单数或通用标签，第二项为复数标签或第一项的副本选项表，最好包含：

- template 字符串，包含模板的完整标题。默认为本模块的标题。 #* category 字符串（或 nil），如由 [[Module

]] 的 makeWikitextError 接受，可选择禁用错误分类 #* selfref 字符串（或 nil），如由 _hatnote 接受，可启用自引用选项

示例：

 local mLabelledList = require('Module
list hatnote') return mLabelledList._labelledList(pages, labels, options)

== 错误 == 如果模板基于此模块，并且没有提供页面名称作为模板参数，则会产生错误消息。通常情况下，这些应指回该模板的 "错误" 部分的文档。然而，如果这些模板使用了一个具有 _labelledList() 并且没有在选项表中提供 template 项的模块，那么该错误将默认指回这里。可以通过为相应模板提供至少一个有效的页面名称参数来解决错误；可以通过为 _labelledList() 的 options 表的 template 项提供一些值来修复模板中的问题。