模も組ぐみ: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 预处理り和わ压缩 标签表ひょう，第だい一项为单数或通用标签，第だい二项为复数标签或第一项的副本 选项表ひょう，最さい好こう包含ほうがん：

1. • 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 项提供ていきょう一些值来修复模板中的问题。

--------------------------------------------------------------------------------
--                               Labelled list                                --
--                                                                            --
-- This module does the core work of creating a hatnote composed of a list    --
-- prefixed by a colon-terminated label, i.e. "LABEL: [andList of pages]",    --
-- for {{see also}} and similar templates.                                    --
--------------------------------------------------------------------------------

local mHatnote = require('Module:Hatnote')
local mHatlist = require('Module:Hatnote list')
local mArguments --initialize lazily
local p = {}

-- Defaults global to this module
-- 本地ほんじ化か注意ちゅうい
local defaults = {
	label = '参まいり见', --Final fallback for label argument
	labelForm = '%s：%s',
	prefixes = {'label', 'label ', 'l'},
	template = 'Module:Labelled list hatnote'
}

-- Helper function that pre-combines display parameters into page arguments.
-- Also compresses sparse arrays, as a desirable side-effect.
function p.preprocessDisplays (args, prefixes)
	-- Prefixes specify which parameters, in order, to check for display options
	-- They each have numbers auto-appended, e.g. 'label1', 'label 1', & 'l1'
	prefixes = prefixes or defaults.prefixes
	local pages = {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			local display
			for i = 1, #prefixes do
				display = args[prefixes[i] .. k]
				if display then break end
			end
			local page = display and
				string.format('%s|%s', string.gsub(v, '|.*$', ''), display) or v
			pages[#pages + 1] = page
		end
	end
	return pages
end

-- Produces a labelled pages-list hatnote.
-- The main frame (template definition) takes 1 or 2 arguments, for a singular
-- and (optionally) plural label respectively:
-- * {{#invoke:Labelled list hatnote|labelledList|Singular label|Plural label}}
-- The resulting template takes pagename & label parameters normally.
function p.labelledList (frame)
	mArguments = require('Module:Arguments')
	local labels = {frame.args[1] or defaults.label}
	labels[2] = frame.args[2] or labels[1]
	local template = frame:getParent():getTitle()
	local args = mArguments.getArgs(frame, {parentOnly = true})
	local pages = p.preprocessDisplays(args)
	local options = {
		extraclasses = frame.args.extraclasses,
		category = args.category,
		selfref = frame.args.selfref or args.selfref,
		template = template
	}
	return p._labelledList(pages, labels, options)
end

function p._labelledList (pages, labels, options)
	labels = labels or {}
	if #pages == 0 then
		-- 本地ほんじ化か注意ちゅうい
		return mHatnote.makeWikitextError(
			'未み指定してい页面名称めいしょう',
			(options.template or defaults.template) .. '#错误',
			options.category
		)
	end
	label = (#pages == 1 and labels[1] or labels[2]) or defaults.label
	local text = string.format(
		options.labelForm or defaults.labelForm,
		label,
		mHatlist.andList(pages, true)
	)
	local hnOptions = {
		extraclasses = options.extraclasses,
		selfref = options.selfref
	}
	return mHatnote._hatnote(text, hnOptions)
end

return p