มอดูล:Labelled list hatnote

คู่มือการใช้งานมอดูล[ดู] [แก้] [ประวัติ] [ล้างแคช]

มอดูลนี้มีฟังก์ชันจำนวนหนึ่งที่ช่วยสร้างแฮตโน้ตให้อยู่ในรูปแบบที่มีป้ายกำกับวางอยู่ตรงตำแหน่งด้านหน้าของรายการของหน้า ในลักษณะนี้

ป้ายกำกับ: ก, ข, และ ค

การใช้งาน

labelledList

การเรียกใช้ (invoke) ฟังก์ชัน labelledList() ก็เพียงพอต่อใช้งานแม่แบบส่วนใหญ่ได้ ดังนี้

{{#invoke:Labelled list hatnote|labelledList|ป้ายที่ใช้ได้ทั่วไป}}

ตัวอย่างเช่น ถ้าระบุตรง "ป้ายที่ใช้ได้ทั่วไป" เป็น "ดูเพิ่มที่" จะให้ผลลัพธ์แบบแม่แบบ {{ดูเพิ่ม}}

หรือ

{{#invoke:Labelled list hatnote|labelledList|ป้ายกำกับเอกพจน์|ป้ายกำกับพหูพจน์}}

เนื่องด้วยสคริปต์ลูอามอดูลนี้ได้รับการคัดลอกมาจากวิกิพีเดียภาษาอังกฤษ จึงจำเป็นต้องระบุพารามิเตอร์ด้วยข้อความที่เหมือนกันสองครั้ง ตัวอย่างการนำไปใช้งาน เช่น ถ้าระบุตรง "ป้ายกำกับเอกพจน์" กับ "ป้ายกำกับพหูพจน์" เป็น "บทความหลัก" กับ "บทความหลัก" จะให้ผลลัพธ์ในลักษณะเดียวกับแม่แบบ {{หลัก}} (เฉพาะส่วนของการทำงานในเนมสเปซหลัก)

ส่วนการระบุป้ายที่ 3 และ 4 จะใช้ในกรณีที่มีหน้าเป้าหมายที่อยู่นอกเนมสเปซบทความ ดังเช่นในแม่แบบ {{หลัก}} ดังนี้

{{#invoke:Labelled list hatnote|labelledList|บทความหลัก|บทความหลัก|หน้าหลัก|หน้าหลัก}}

preprocessDisplays

The preprocessDisplays() function takes a raw list of arguments and combines in any display arguments. For example, {{see also|1|l1=One}} initially has the arguments table {'1', ['l1'] = 'One'}; this table would combine those into the table {'1|One'}. It overrides manual piping (e.g. {{see also|1{{!}}2|l1=One}} → {'1|One'}) and compresses sparse arrays if a parameter is skipped or left empty.

ตัวอย่าง:

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

_labelledList

For modules that need to modify the functionality slightly while still using it, _labelledList() provides some flexibility. It takes three parameters:

1. A pages list, preferably preprocessed and compressed by preprocessDisplays
2. A labels table, where the first item is the singular or universal label, and the second either a plural label or a copy of the first.
3. An options table, preferably containing:
   • a template string with the full title of the template. Defaults to the title of this module.
   • a category string (or nil) as taken by makeWikitextError from Module:Hatnote, to optionally disable error categories
   • a selfref string (or nil) as taken by _hatnote to enable the selfref option

Example:

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

ข้อผิดพลาด

หากไม่มีการระบุชื่อหน้าลงในพารามิเตอร์ในแม่แบบที่นำมอดูลนี้ไปใช้ มอดูลนี้จะส่งผลให้แม่แบบสร้างข้อความแสดงข้อผิดพลาด และโดยปกติแล้ว ข้อความแสดงข้อผิดพลาดนี้จะสร้างลิงก์เพื่อนำผู้ใช้ไปยังส่วน "ข้อผิดพลาด" ในเอกสารประกอบแม่แบบนั้น ๆ ด้วย อย่างไรก็ตาม ถ้าปัญหาอยู่ที่ตัวแม่แบบเอง กล่าวคือ ตัวแม่แบบที่นำมอดูลไปใช้โดยใช้ฟังก์ชัน _labelledList() แต่ไม่ได้กำหนดในส่วนของ template ในตารางตัวเลือก (options table) ลิงก์จะนำผู้ใช้กลับมายังที่นี่โดยตรง ข้อผิดพลาดข้างต้นสามารถแก้ไขได้โดยระบุชื่อของหน้าให้กับพารามิเตอร์ให้ถูกต้องอย่างน้อยหนึ่งรายการให้กับแม่แบบที่เป็นปัญหา ส่วนถ้าเป็นปัญหาที่เกิดจากในตัวแม่แบบ ก็สามารถแก้ไขได้โดยการกำหนดค่าบางอย่างแก่ template ของตาราง options ของฟังก์ชัน _labelledList()

--------------------------------------------------------------------------------
--                               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('มอดูล:Hatnote')
local mHatlist = require('มอดูล:Hatnote list')
local mArguments --initialize lazily
local yesno --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 = 'มอดูล:Labelled list hatnote'
}

-- Localizable message strings
local msg = {
	errorSuffix = '#ข้อผิดพลาด',
	noInputWarning = 'ไม่ได้ระบุชื่อหน้า',
	noOutputWarning =
		"'''[[%s]] — ไม่มีข้อมูลส่งออก: หน้าเป้าหมายไม่มีอยู่'''"
}

-- 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 indices = {}
	local sparsePages = {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			indices[#indices + 1] = k
			local display
			for i = 1, #prefixes do
				display = args[prefixes[i] .. k]
				if display then break end
			end
			sparsePages[k] = display and
				string.format('%s|%s', string.gsub(v, '|.*$', ''), display) or v
		end
	end
	table.sort(indices)
	local pages = {}
	for k, v in ipairs(indices) do pages[#pages + 1] = sparsePages[v] end
	return pages
end

--Helper function to get a page target from a processed page string
--e.g. "Page|Label" → "Page" or "Target" → "Target"
local function getTarget(pagename)
 	local pipe = string.find(pagename, '|')
	return string.sub(pagename, 0, pipe and pipe - 1 or nil)
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('มอดูล:Arguments')
	yesno = require('มอดูล:Yesno')
	local labels = {frame.args[1] or defaults.label}
	labels[2] = frame.args[2] or labels[1]
	labels[3] = frame.args[3] --no defaulting
	labels[4] = frame.args[4] --no defaulting
	local template = frame:getParent():getTitle()
	local args = mArguments.getArgs(frame, {parentOnly = true})
	local pages = p.preprocessDisplays(args)
	local options = {
		category = yesno(args.category),
		extraclasses = frame.args.extraclasses,
		ifexists = yesno(frame.args.ifexists),
		namespace = frame.args.namespace or args.namespace,
		selfref = yesno(frame.args.selfref or args.selfref),
		template = template
	}
	return p._labelledList(pages, labels, options)
end

function p._labelledList (pages, labels, options)
	if options.ifexists then
		for k = #pages, 1, -1 do --iterate backwards to allow smooth removals
			local v = pages[k]
			local title = mw.title.new(getTarget(v), namespace)
			if (v == '') or title == nil or not title.exists then
				table.remove(pages, k)
			end
		end
	end
	labels = labels or {}
	label = (#pages == 1 and labels[1] or labels[2]) or defaults.label
	for k, v in pairs(pages) do 
		if mHatnote.findNamespaceId(v) ~= 0 then
			label =
				(
					#pages == 1 and
					(labels[3] or labels[1] or defaults.label) or
					(labels[4] or labels[2] or defaults.label)
				) or defaults.label
		end
	end
	if #pages == 0 then
		if options.ifexists then
			mw.addWarning(
				string.format(
					msg.noOutputWarning, options.template or defaults.template
				)
			)
			return ''
		else
			return mHatnote.makeWikitextError(
				msg.noInputWarning,
				(options.template or defaults.template) .. msg.errorSuffix,
				options.category
			)
		end
	end
	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