Dokumentasion ti modulo

Daytoy a modulo ket aglaon kadagiti annong tapno mabirukan ti puntaan a panid ti baw-ing.

Nangruna

Ti nangruna nga annong ket mangawat ti nagan ti maymaysa a panid. Daytoy ket ikeddengna no ti panid ket baw-ing; no baw-ing birukenna ti panid, alaenna ti tarheta, ket isublina ti nagan ti tarheta a kas teksto. Ti panagusar iti daytoy ket {{#invoke:baw-ing|main|baw-ing-panid-nagan}}.

Ti plantilia ket kadawyan a saan a mangala wenno mangited kadagiti kuadrado a pangrikep, tapno maipakita ti resulta a kas silpo usaren ti [[{{#invoke:baw-ing|main|baw-ing-panid-nagan}}]]. Mapataud ti maysa a biddut no awan ti baw-ing, ngem para iti bersatilidad awan ti biddut a maited no ti papeles ket saan a baw-ing (mangisubli ti kasisigud a teksto)wenno ti nagan ti papeles ket blanko (mangisubli ti blanko).

Nupay kasta, no ti parametro ti bracket ket maikkan ti saan a blanko a pateg, dagiti pangrikep ket maipasanto no adda.

Kas pagarigan

  • {{#invoke:baw-ing|main|WP:VEF}} → Wikipedia:VisualEditor/Feedback
  • {{#invoke:baw-ing|main|[[WP:VE]]|bracket=yes}}Wikipedia:VisualEditor
  • {{#invoke:baw-ing|main|Wikipedia:VisualEditor|}} → Wikipedia:VisualEditor

Nota: Ti WP:VE ken WP:VEF ket baw-ing, ngem ti Wikipedia:VisualEditor ket saan.

LuaMain

No kayat nga usaren ti nangruna nga annong manipud ti sabali a modulo ti Lua, usaren ti annong ti luaMain. Daytoy ket mangited ti kapada a pamay-an a kas ti nangruna nga annong, ngem saan a makasapul ti manggun-od iti kuadro ti banag.

Ti panagusar ti daytoy, umuna nga ikarga ti modulo.

local mRedirect = require('Modulo:Baw-ing')

Kalpasanna usaren ti annong iti sumaganad nga eskritu:

mRedirect.luaMain(rname, bracket)

Ti rname ket ti nagan ti baw-ing a panid, ken no ti bracket ket aniaman ngem false wenno nil, ti modulo ket agpataud ti silpo imbes a ti laeng nagan ti panid.

IsRedirect

Ti annong ti isRedirect ket inus-usar manipud kadagiti panid ti wiki tapno mabirukan no ti naited a panid ket baw-ing wenno saan. No ti panid ket baw-ing, ti annong ket mangisubli iti "yes", ken no saan ti maiparuar ket blanko. Ti panagusar daytoy ket {{#invoke:baw-ing|isRedirect|baw-ing-panid-nagan}}.

Kas pagarigan

  • {{#invoke:baw-ing|isRedirect|WP:VEF}} → yes
  • {{#invoke:baw-ing|isRedirect|Wikipedia:VisualEditor/Feedback}}

GetTarget

Ti annong ti getTarget ket alaenna ti puntaan a nagan ti panid iti baw-ing a panid, ken mabalin laeng a mausar manipud iti Lua. No ti nainaganan a panid ket baw-ing, maisublinto ti puntaan a panid; no saan ti annong ket mangisubli ti nil.

Ti panag-usar ti daytoy, umuna nga ikarga ti modulo.

local mRedirect = require('Modulo:Baw-ing')

Kalpasanna usaren ti annong iti sumaganad nga eskritu:

mRedirect.getTarget(page)

Ti page ket mabalin a ti nagan ti baw-ing a panid a kas kuerdas, wenno ti mw.title object.

Kitaen pay

-- 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(
			"madi nga argumento ti #1 iti 'getTarget'"
				.. " (kuerdas, numero, wenno banag ti titulo ti nanamnama, ti naala ket %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('Modulo:Dagiti argumento').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('Modulo:Dagiti argumento').getArgs(frame, {frameOnly = true})
	if p.luaIsRedirect(args[1]) then
		return 'yes'
	else
		return ''
	end
end

return p