Mòdul:Redirect

Documentació del mòdul [ mostra ] [ modifica el codi ] [ mostra l'historial ] [ refresca ]

A continuació es mostra la documentació transclosa de la subpàgina /ús. [salta a la caixa de codi]

---

Aquest mòdul conté funcions per trobar el destí d'una pàgina redirigida.

Main

La funció main accepta el nom d'una sola pàgina. Determina si la pàgina és una redirecció; si és així, cerca la pàgina, extreu el destí de la redirecció i retorna el nom del destí com a text. El seu ús és {{#invoke:redirect|main|nom-pàgina}}. Si nom de la pàgina no existeix o no és una redirecció, es retorna el nom de la pàgina. Si nom de la pàgina està en blanc, es retornarà en blanc.

La funció normalment no pren ni dóna claudàtors, de manera que per mostrar el resultat com a enllaç utilitzeu [[{{#invoke:redirect|main|nom-pàgina}}]].

Si al paràmetre bracket se li dóna un valor no en blanc, els claudàtors es passaran si hi ha l'objectiu de la redirecció.

Exemples

• {{#invoke:redirect|main|VP:EP/P}} → Viquipèdia:Esborrar pàgines/Propostes
• {{#invoke:redirect|main|[[VP:APR]]|bracket=yes}} → VP:APR
• {{#invoke:redirect|main|Viquipèdia:Esborrar pàgines/Propostes}} → Viquipèdia:Esborrar pàgines/Propostes
• {{#invoke:redirect|main|Viquipèdia:Articles per pensar}} → Viquipèdia:Articles per rumiar

Nota: VP:EP/P i VP:APR són redireccions, però Viquipèdia:Esborrar pàgines/Propostes existeix, i Viquipèdia:Articles per rumiar no existeix.

LuaMain

Si voleu utilitzar la funció main d'un altre mòdul Lua, potser voldreu utilitzar la funció luaMain. Això proporciona la mateixa funcionalitat que la funció principal, però no requereix que un objecte marc estigui disponible.

Per utilitzar-ho, primer carregueu el mòdul.

local mRedirect = require('Module:Redirect')

A continuació, utilitzeu la funció amb la sintaxi següent:

mRedirect.luaMain(rnom, bracket)

rnom és el nom de la pàgina de redirecció, i si bracket no és fals o nul, el mòdul produirà un enllaç en lloc d'un nom de pàgina.

IsRedirect

La funció isRedirect s'utilitza des de les pàgines wiki per esbrinar si una pàgina determinada és una redirecció o no. Si la pàgina és una redirecció, la funció retorna "yes", i si no, la sortida està en blanc. El seu ús és {{#invoke:redirect|isRedirect|nom-pàgina}}.

Examples

• {{#invoke:redirect|isRedirect|VP:EP/P}} → yes
• {{#invoke:redirect|isRedirect|Viquipèdia:Esborrar pàgines/Propostes}} →
• {{#invoke:redirect|isRedirect|Viquipèdia:Articles per pensar}} →

LuaIsRedirect

Es pot accedir a l'isRedirect des d'altres mòduls Lua de la mateixa manera que la funció main:

local mRedirect = require('Module:Redirect')
mRedirect.luaIsRedirect(rname)

GetTarget

La funció getTarget recupera el nom de la pàgina de destinació d'una pàgina de redirecció i només es pot utilitzar des de Lua. Si la pàgina especificada és una redirecció, es retorna el destí; en cas contrari, la funció retorna nil.

Per utilitzar-lo, primer carregueu el mòdul.

local mRedirect = require('Module:Redirect')

Then use the function with the following syntax:

mRedirect.getTarget(page)

page can be either the name of the redirect page as a string, or a mw.title object.

Vegeu també

• phab:T68974 - Provide a standard way to get the target of a redirect page
• mw:Extension:Scribunto/Lua reference manual#Title objects, the Scribunto interface for determining a page's redirect status
• Template:Get QID, which uses this module
• Template:Submit an edit request, which uses this module

-- This module provides functions for getting the target of a redirect page.

local p = {}

-- Gets a mw.title object, using pcall to avoid generating script errors if we
-- are over the expensive function count limit (among other possible causes).
local function getTitle(...)
	local success, titleObj = pcall(mw.title.new, ...)
	if success then
		return titleObj
	else
		return nil
	end
end

-- Gets the name of a page that a redirect leads to, or nil if it isn't a
-- redirect.
function p.getTargetFromText(text)
	local target = string.match(
		text,
		"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)%]%]"
	) or string.match(
		text,
		"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)|[^%[%]]-%]%]"
	)
	return target and mw.uri.decode(target, 'PATH')
end

-- Gets the target of a redirect. If the page specified is not a redirect,
-- returns nil.
function p.getTarget(page, fulltext)
	-- Get the title object. Both page names and title objects are allowed
	-- as input.
	local titleObj
	if type(page) == 'string' or type(page) == 'number' then
		titleObj = getTitle(page)
	elseif type(page) == 'table' and type(page.getContent) == 'function' then
		titleObj = page
	else
		error(string.format(
			"argument erroni #1 per 'getTarget'"
				.. " (s'esperava string, number, o object de títol, tornat %s)",
			type(page)
		), 2)
	end
	if not titleObj then
		return nil
	end
	local targetTitle = titleObj.redirectTarget
	if targetTitle then
		if fulltext then
			return targetTitle.fullText
		else
			return targetTitle.prefixedText
		end
	else
		return nil
	end
end

--[[
-- Given a single page name determines what page it redirects to and returns the
-- target page name, or the passed page name when not a redirect. The passed
-- page name can be given as plain text or as a page link.
--
-- Returns page name as plain text, or when the bracket parameter is given, as a
-- page link. Returns an error message when page does not exist or the redirect
-- target cannot be determined for some reason.
--]]
function p.luaMain(rname, bracket, fulltext)
	if type(rname) ~= "string" or not rname:find("%S") then
		return nil
	end
	bracket = bracket and "[[%s]]" or "%s"
	rname = rname:match("%[%[(.+)%]%]") or rname
	local target = p.getTarget(rname, fulltext)
	local ret = target or rname
	ret = getTitle(ret)
	if ret then
		if fulltext then
			ret = ret.fullText
		else
			ret = ret.prefixedText
		end
		return bracket:format(ret)
	else
		return nil
	end
end

-- Provides access to the luaMain function from wikitext.
function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame, {frameOnly = true})
	return p.luaMain(args[1], args.bracket, args.fulltext) or ''
end

-- Returns true if the specified page is a redirect, and false otherwise.
function p.luaIsRedirect(page)
	local titleObj = getTitle(page)
	if not titleObj then
		return false
	end
	if titleObj.isRedirect then
		return true
	else
		return false
	end
end

-- Provides access to the luaIsRedirect function from wikitext, returning 'yes'
-- if the specified page is a redirect, and the blank string otherwise.
function p.isRedirect(frame)
	local args = require('Module:Arguments').getArgs(frame, {frameOnly = true})
	if p.luaIsRedirect(args[1]) then
		return 'yes'
	else
		return ''
	end
end

return p