模組:Labelled list hatnote/doc

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

此模塊提供了幾個函數來實現帶有標籤的頁面列表提示,例如 {{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 項提供一些值來修復模板中的問題。