Modulo:Hatnote

Dokumentasion ti modulo

[kitaen] [urnosen] [pakasaritaan] [purgaen]

Inus-usar daytoy a modulo kadagiti adu a panid, no baliwam adunto ti makadlaw. Pangngaasi nga umuna a subokan kadagiti subpanid ti /pagipadasan wenno /pangsubok, wenno iti bukodmo a subpanid, ken usigen a pagtungtungan dagiti binaliwan iti panid ti tungtungan sakbay nga isayangkat.

Agus-usar daytoy a modulo iti TemplateStyles:

Modulo:Hatnote/styles.css

Daytoy ket meta-modulo a mangited kadagiti nadumaduma nga annong para iti panagaramid kadagiti hatnote. Daytoy ket isayangkatna ti plantilia ti {{hatnote}}, para iti panagusar kadagiti hatnote iti ngato dagiti panid, ken ti plantilia ti {{pormaten ti silpo}}, a maus-usar a mangpormat ti silpo ti wiki para iti panagusar kadagiti hatnote. Daytoy ket aglaon pay kadagiti nadumaduma nga annong para iti panagusar kadagiti sabali a hatnote a modulo ti Lua.

Panagusar manipud iti wikitext

Dagiti annong iti daytoy a modulo ket saan a dagus a mabalin a mausar manipud iti #invoke, ken imbes ket a nasken a mausar babaen kadagiti plantilia. Pangngaasi a kitaen ti Plantilia:Hatnote ken Plantilia:Pormaten ti silpo para iti dokumentasion.

Panagusar manipud kadagiti sabali a modulo ti Lua

Ti mangikarga daytoy a modulo manipud iti sabali a modulo ti Lua, usaren ti sumaganad a kodigo.

local mHatnote = require('Modulo:Hatnote')

Kalpasanna mabalinton nga usaren dagiti annong a kas ti nadokumentuan dita baba.

Hatnote

mHatnote._hatnote(s, options)

Pormatenna ti kuerdas ti s a kas hatnote. Daytoy ket rikpanna ti s kadagiti etiketa ti <div class="hatnote">...</div>. Dagiti pagpilian ket naited iti tabla ti options . Dagiti pagpilian ket mairaman ti:

options.extraclasses – ti kuerdas dagiti nayon a klase a maited
options.selfref – no daytoy ket saan a nil wenno false, manginayon daytoy ti klase ti "selfref", inus-usar daytoy a mangibaga kadagiti bukod a reperensia iti Wikipedia (kitaen ti Plantilia:Selfref))

Ti CSS ti klase ti hatnote ket naipalawag idiay Module:Hatnote/styles.css.

Kas pagarigan 1

mHatnote._hatnote('Daytoy ket hatnote.')

Maited: <div class="hatnote">Daytoy ket hatnote.</div>

Maiparang a kas:

Kas pagarigan 2

mHatnote._hatnote('Daytoy ket hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})

Maited: <div class="hatnote boilerplate seealso selfref">Daytoy ket hatnote.</div>

Maiparang a kas:

Biruken ti ID ti nagan ti espasio

mHatnote.findNamespaceId(link, removeColon)

Birukenna ti id ti nagan ti espasio iti kuerdas ti link, a nasken koma nga umiso a nagan ti panid, nga addaan iti wenno awan iti nagan ti paset. Daytoy nga annong ket saan a mabalin no ti nagan ti panid ket narikpan kadagiti kuadrado a pangrikep. No agpadpadas a mangiwaswas ti nagan ti nagan ti espasio, maikkat dagiti dua-tuldek manipud iti rugi ti silpo babaen ti kasisigud. Daytoy ket naserbi no dagiti agar-aramat ket innagananda dagiti dua-tuldek no saan dagitoy a nainget a nasken. No masapul a kitaen para kadagiti umuna a kolon, isaad ti removeColon iti false.

Kas pagarigan: mHatnote.findNamespaceId('Leon') → 0; mHatnote.findNamespaceId('Kategoria:Dagiti leon') → 14; mHatnote.findNamespaceId(':Kategoria:Dagiti leon') → 14; mHatnote.findNamespaceId(':Kategoria:Dagiti leon', false) → 0 (ti nagan ti espasio ket maduktalan a kas ti ":Kategoria", imbes a kas ti "Kategoria")

Agaramid ti biddut iti wikitext

mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)

Pormatenna ti kuerdas ti msg a kas nalabbasit a mensahe ti biddut iti wikitext, nga addaan iti pagpilian a silpo iti panid ti tulong helpLink. Kadawyan a daytoy nga annong ket manginayon pay ti Kategoria:Dagiti plantilia ti hatnote nga agraman kadagiti biddut (0); nupay kasta, no ti addTrackingCategory ket saan a false kalpasan a maipasa babaen ti Modulo:Wensaan, ti kategoria ket mapasardengto. Ti kayatna a sawen daytoy ket ti kategoria ket mabalin a mapasardeng babaen kadagiti pateg ti addTrackingCategory a mairaman ti "no", "n", 0, "false", "saan", "s" ken false.

Kas pagarigan:

mHatnote.makeWikitextError('adda rimsua a biddut') → Biddut: adda rimsua a biddut.

mHatnote.makeWikitextError('adda rimsua a biddut', 'Plantilia:Kaspagarigan#Dagiti biddut') → Biddut: adda rimsua a biddut (tulong).

--------------------------------------------------------------------------------
--                              Module:Hatnote                                --
--                                                                            --
-- This module produces hatnote links and links to related articles. It       --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- helper functions for other Lua hatnote modules.                            --
--------------------------------------------------------------------------------

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Modulo:Dagiti argumento]]
local yesno -- lazily initialise [[Modulo:Wensaan]]

local p = {}

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getArgs(frame)
	-- Fetches the arguments from the parent frame. Whitespace is trimmed and
	-- blanks are removed.
	mArguments = require('Modulo:Dagiti argumento')
	return mArguments.getArgs(frame, {parentOnly = true})
end

local function removeInitialColon(s)
	-- Removes the initial colon from a string, if present.
	return s:match('^:?(.*)')
end

function p.findNamespaceId(link, removeColon)
	-- Finds the namespace id (namespace number) of a link or a pagename. This
	-- function will not work if the link is enclosed in double brackets. Colons
	-- are trimmed from the start of the link by default. To skip colon
	-- trimming, set the removeColon parameter to false.
	checkType('findNamespaceId', 1, link, 'string')
	checkType('findNamespaceId', 2, removeColon, 'boolean', true)
	if removeColon ~= false then
		link = removeInitialColon(link)
	end
	local namespace = link:match('^(.-):')
	if namespace then
		local nsTable = mw.site.namespaces[namespace]
		if nsTable then
			return nsTable.id
		end
	end
	return 0
end

function p.formatPages(...)
	-- Formats a list of pages using formatLink and returns it as an array. Nil
	-- values are not allowed.
	local pages = {...}
	local ret = {}
	for i, page in ipairs(pages) do
		ret[i] = p._formatLink{link = page}
	end
	return ret
end

function p.formatPageTables(...)
	-- Takes a list of page/display tables and returns it as a list of
	-- formatted links. Nil values are not allowed.
	local pages = {...}
	local links = {}
	for i, t in ipairs(pages) do
		checkType('formatPageTables', i, t, 'table')
		local link = t[1]
		local display = t[2]
		links[i] = p._formatLink{link = link, display = display}
	end
	return links
end

function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
	-- Formats an error message to be returned to wikitext. If
	-- addTrackingCategory is not false after being returned from
	-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
	-- is added.
	checkType('makeWikitextError', 1, msg, 'string')
	checkType('makeWikitextError', 2, helpLink, 'string', true)
	yesno = require('Modulo:Wensaan')
	title = title or mw.title.getCurrentTitle()
	-- Make the help link text.
	local helpText
	if helpLink then
		helpText = ' ([[' .. helpLink .. '|tulong]])'
	else
		helpText = ''
	end
	-- Make the category text.
	local category
	if not title.isTalkPage -- Don't categorise talk pages
		and title.namespace ~= 2 -- Don't categorise userspace
		and yesno(addTrackingCategory) ~= false -- Allow opting out
	then
		category = 'Dagiti plantilia ti hatnote nga addaan kadagiti biddut'
		category = string.format(
			'[[%s:%s]]',
			mw.site.namespaces[14].name,
			category
		)
	else
		category = ''
	end
	return string.format(
		'<strong class="error">Biddut: %s%s.</strong>%s',
		msg,
		helpText,
		category
	)
end

function p.disambiguate(page, disambiguator)
	-- Formats a page title with a disambiguation parenthetical,
	-- i.e. "Example" → "Example (disambiguation)".
	checkType('disambiguate', 1, page, 'string')
	checkType('disambiguate', 2, disambiguator, 'string', true)
	disambiguator = disambiguator or 'panangilawlawag'
	return string.format('%s (%s)', page, disambiguator)
end

--------------------------------------------------------------------------------
-- Format link
--
-- Makes a wikilink from the given link and display values. Links are escaped
-- with colons if necessary, and links to sections are detected and displayed
-- with " § " as a separator rather than the standard MediaWiki "#". Used in
-- the {{format link}} template.
--------------------------------------------------------------------------------

function p.formatLink(frame)
	-- The formatLink export function, for use in templates.
	yesno = require('Modulo:Wensaan')
	local args = getArgs(frame)
	local link = args[1]
	if not link then
		return p.makeWikitextError(
			'awan ti nainaganan a silpo',
			'Plantilia:Pormaten ti silpo#Dagiti biddut',
			args.category
		)
	end
	return p._formatLink{
		link = link,
		display = args[2],
		italicizePage = yesno(args.italicizepage),
		italicizeSection = yesno(args.italicizesection),
	}
end

local function italicize(s)
	-- Italicize a string.
	return '<i>' .. s .. '</i>'
end

local function maybeItalicize(s, shouldItalicize)
	-- italicize s if s is a string and the shouldItalicize parameter is true.
	if s and shouldItalicize then
		return italicize(s)
	else
		return s
	end
end

local function parseLink(link)
	-- Parse a link and return a table with the link's components.
	-- These components are:
	-- - link: the link, stripped of any initial colon (always present)
	-- - page: the page name (always present)
	-- - section: the page name (may be nil)
	-- - display: the display text, if manually entered after a pipe (may be nil)
	link = removeInitialColon(link)

	-- Find whether a faux display value has been added with the {{!}} magic
	-- word.
	local prePipe, display = link:match('^(.-)|(.*)$')
	link = prePipe or link

	-- Find the page, if it exists.
	-- For links like [[#Bar]], the page will be nil.
	local preHash, postHash = link:match('^(.-)#(.*)$')
	local page
	if not preHash then
		-- We have a link like [[Foo]].
		page = link
	elseif preHash ~= '' then
		-- We have a link like [[Foo#Bar]].
		page = preHash
	end

	-- Find the section, if it exists.
	local section
	if postHash and postHash ~= '' then
		section = postHash
	end
	
	return {
		link = link,
		page = page,
		section = section,
		display = display,
	}
end

function p._formatLink(options)
	-- The formatLink export function, for use in modules.
	checkType('_formatLink', 1, options, 'table')
	checkTypeForNamedArg('_formatLink', 'link', options.link, 'string', false)
	checkTypeForNamedArg(
		'_formatLink',
		'display',
		options.display,
		'string',
		true
	)
	checkTypeForNamedArg(
		'_formatLink',
		'italicizePage',
		options.italicizePage,
		'boolean',
		true
	)
	checkTypeForNamedArg(
		'_formatLink',
		'italicizeSection',
		options.italicizeSection,
		'boolean',
		true
	)

	local parsed = parseLink(options.link)
	local display = options.display or parsed.display
	
	-- Deal with the case where we don't have to pipe the link
	if not display and not parsed.section and not options.italicizePage then
		return string.format('[[:%s]]', parsed.link)
	end
	
	-- Find the display text for piped links
	if not display then
		local page = maybeItalicize(parsed.page, options.italicizePage)
		local section = maybeItalicize(parsed.section, options.italicizeSection)
		if not page then
			display = string.format('§&nbsp;%s', section)
		elseif section then
			display = string.format('%s §&nbsp;%s', page, section)
		else
			display = page
		end
	end
	
	return string.format('[[:%s|%s]]', parsed.link, display)
end

--------------------------------------------------------------------------------
-- Hatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------

function p.hatnote(frame)
	local args = getArgs(frame)
	local s = args[1]
	local options = {}
	if not s then
		return p.makeWikitextError(
			'awan ti nainaganan a teksto',
			'Plantilia:Hatnote#Dagiti biddut',
			args.category
		)
	end
	options.extraclasses = args.extraclasses
	options.selfref = args.selfref
	return p._hatnote(s, options)
end

function p._hatnote(s, options)
	checkType('_hatnote', 1, s, 'string')
	checkType('_hatnote', 2, options, 'table', true)
	options = options or {}
	local classes = {'hatnote', 'navigation-not-searchable'}
	local extraclasses = options.extraclasses
	local selfref = options.selfref
	if type(extraclasses) == 'string' then
		classes[#classes + 1] = extraclasses
	end
	if selfref then
		classes[#classes + 1] = 'selfref'
	end
	return string.format(
		'<div role="note" class="%s">%s</div>',
		table.concat(classes, ' '),
		s
	)
end

return p