Modulo:Hatnote/pagipadasan

Dokumentasion ti modulo

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

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:

Daytoy ket hatnote.

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:

Daytoy ket hatnote.

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') →

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

Ti dokumentasion dita ngato ket nailak-am manipud iti Modulo:Hatnote/dok. (urnosen | pakasaritaan)
Mabalin dagiti editor ti agipadas kadagiti panid ti pagipadasan (urnosen | dip) ken pangsubok a kaskaso (urnosen | patarayen) iti daytoy a modulo.
Pangngaasi nga ikabil dagiti kategoria iti subpanid ti /dok. Dagiti subpanid daytoy a modulo.

--------------------------------------------------------------------------------
--                              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 formatLink -- lazily initialise [[Modulo:Pormaten ti silpo]] ._formatLink

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.defaultClasses(inline)
	-- Provides the default hatnote classes as a space-separated string; useful
	-- for hatnote-manipulation modules like [[Module:Hatnote group]].
	return
		(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
		'navigation-not-searchable'
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 mw.ustring.format('%s (%s)', page, disambiguator)
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.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 agraman kadagiti biddut'
		category = mw.ustring.format(
			'[[%s:%s]]',
			mw.site.namespaces[14].name,
			category
		)
	else
		category = ''
	end
	return mw.ustring.format(
		'<strong class="error">Biddut: %s%s.</strong>%s',
		msg,
		helpText,
		category
	)
end

local curNs = mw.title.getCurrentTitle().namespace
p.missingTargetCat =
	--Default missing target category, exported for use in related modules
	((curNs ==  0) or (curNs == 14)) and
	'Dagiti artikulo nga agraman kadagiti plantilia ti hatnote a mangpunta kadagiti awan a panid' or nil

function p.quote(title)
	--Wraps titles in quotation marks. If the title starts/ends with a quotation
	--mark, kerns that side as with {{-'}}
	local quotationMarks = {
		["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
	}
	local quoteLeft, quoteRight = -- Test if start/end are quotation marks
		quotationMarks[string.sub(title,  1,  1)],
		quotationMarks[string.sub(title, -1, -1)]
	if quoteLeft or quoteRight then
		title = mw.html.create("span"):wikitext(title)
	end
	if quoteLeft  then title:css("padding-left",  "0.15em") end
	if quoteRight then title:css("padding-right", "0.15em") end
	return '"' .. tostring(title) .. '"'
end

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

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

function p._hatnote(s, options)
	checkType('_hatnote', 1, s, 'string')
	checkType('_hatnote', 2, options, 'table', true)
	options = options or {}
	local inline = options.inline
	local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
	local extraclasses
	if type(options.extraclasses) == 'string' then
		extraclasses = options.extraclasses
	end

	hatnote
		:attr('role', 'note')
		:addClass(p.defaultClasses(inline))
		:addClass(extraclasses)
		:addClass(options.selfref and 'selfref' or nil)
		:wikitext(s)

	return mw.getCurrentFrame():extensionTag{
		name = 'templatestyles', args = { src = 'Modulo:Hatnote/styles.css' }
	} .. tostring(hatnote)
end

return p