Difference between revisions of "Module:Redirect"

From blackwiki
Jump to navigation Jump to search
test>Mr. Stradivarius
(extend the pattern to match a colon after the "REDIRECT" text)
test>Mark Arsten
m (Changed protection level of Template:Redirect: Allowing Protected Template editors ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite)))
Line 1: Line 1:
-- Given a single page name determines what page it redirects to and returns the target page name, or the
+
{{Hatnote|<!--
-- passed page name when not a redirect. The passed page name can be given as plain text or as a page link.
+
-->"{{{1}}}" redirects here. For {{#if:{{{2|}}}|{{{2}}}|other uses}}, see {{#if:{{{3|}}}|[[:{{{3}}}]]{{#ifeq:{{{4|}}}|and|&#32;and {{#if:{{{5|}}}|[[:{{{5}}}]]|[[{{{1}}} (disambiguation)]]}}}}|[[{{{1}}} (disambiguation)]]}}.<!--
-- Returns page name as plain text, or when the bracket parameter is given, as a page link. Returns an
+
-->{{#if:{{{2|}}}|{{#if:{{{4|}}}|<!--
-- error message when page does not exist or the redirect target cannot be determined for some reason.
+
  -->{{#ifeq:{{{4|}}}|and||<!-- "and" is a special word, don't output "For and, ..."
 +
    -->&#32;&#32;For {{#ifeq:{{{4}}}|1|other uses|{{{4}}}}}, see {{#if:{{{5|}}}|[[:{{{5}}}]]{{#ifeq:{{{6|}}}|and|&#32;and {{#if:{{{7|}}}|[[:{{{7}}}]]|[[{{{4}}} (disambiguation)]]}}}}|[[{{{4}}} (disambiguation)]]}}.}}<!--
 +
  -->{{#if:{{{6|}}}|<!--
 +
    -->{{#ifeq:{{{6|}}}|and||<!--
 +
      -->&#32;&#32;For {{#ifeq:{{{6}}}|1|other uses|{{{6}}}}}, see {{#if:{{{7|}}}|[[:{{{7}}}]]{{#ifeq:{{{8|}}}|and|&#32;and {{#if:{{{9|}}}|[[:{{{9}}}]]|[[{{{6}}} (disambiguation)]]}}}}|[[{{{6}}} (disambiguation)]]}}.}}<!--
 +
    -->{{#if:{{{8|}}}|<!--
 +
      -->{{#ifeq:{{{8|}}}|and||<!--
 +
        -->&#32;&#32;For {{#ifeq:{{{8}}}|1|other uses|{{{8}}}}}, see {{#if:{{{9|}}}|[[:{{{9}}}]]|[[{{{8}}} (disambiguation)]]}}.}}<!--
 +
    -->}}<!--
 +
  -->}}<!--
 +
-->}}}}}}{{#switch:{{{1<noinclude>|REDIRECT</noinclude>}}}|REDIRECT|REDIRECT1|REDIRECT2|REDIRECT3|TERM = | #default = {{#ifexist:{{{1}}}||{{main other|[[Category:Missing redirects]]}}}}}}<noinclude>
  
-- Thus these are roughly the same:
+
{{Documentation}}
-- [[{{#invoke:redirect|main|redirect-page-name}}]] and {{#invoke:redirect|main|redirect-page-name|bracket=yes}}
 
  
local p = {}
+
</noinclude>
 
 
function p.main(frame)
 
    -- If called via #invoke, use the args passed into the invoking
 
    -- template, or the args passed to #invoke if any exist. Otherwise
 
    -- assume args are being passed directly in from the debug console
 
    -- or from another Lua module.
 
    local origArgs
 
    if frame == mw.getCurrentFrame() then
 
        origArgs = frame:getParent().args
 
        for k, v in pairs( frame.args ) do
 
            origArgs = frame.args
 
            break
 
        end
 
    else
 
        origArgs = frame
 
    end
 
    -- Trim whitespace and remove blank arguments.
 
    local args = {}
 
    for k, v in pairs( origArgs ) do
 
        v = mw.text.trim( v )
 
        if v ~= '' then
 
            args[k] = v
 
        end
 
    end
 
    local rname, bracket = args[1], args.bracket
 
   
 
    if type(rname) ~= "string" or not mw.ustring.match(rname, "%S") then return end
 
    bracket = bracket and "[[%s]]" or "%s"
 
    rname = mw.ustring.match(rname, "%[%[(.+)%]%]") or rname
 
   
 
    -- Get the title object, passing the function through pcall
 
    -- in case we are over the expensive function count limit.
 
    local noError, rpage = pcall(mw.title.new, rname)
 
    if not noError or noError and not rpage or not rpage.isRedirect then
 
        -- mw.title.new failed, or the page is not a redirect, so use the passed page name.
 
        return mw.ustring.format(bracket, rname)
 
    end
 
 
 
    local redirect = mw.ustring.match(rpage:getContent() or "", "^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]]-)%]%]" )
 
    if redirect then
 
        -- Decode html entities and percent encodings.
 
        redirect = mw.text.decode(redirect, true)
 
        redirect = mw.uri.decode(redirect, 'WIKI')
 
        return mw.ustring.format(bracket, redirect)
 
    else
 
        return mw.ustring.format('<span class="error">[[Module:redirect]] error: could not parse redirect - [[%s]]</span>', rname)
 
    end
 
end
 
 
 
return p
 

Revision as of 22:24, 29 January 2014

50px Module documentation[view] [edit] [history] [purge]

This module contains functions to find the target of a redirect page.

Main

The main function accepts the name of a single page. It determines if the page is a redirect; if so it looks up the page, extracts the target, and returns the target name as text. Its usage is {{#invoke:redirect|main|redirect-page-name}}.

The template normally neither takes nor gives square brackets, so to show the result as a link use [[{{#invoke:redirect|main|redirect-page-name}}]]. An error is produced if the redirect does not exist, but for versatility no error is given if the file is not a redirect (returns the original text) or if the file name is blank (returns blank).

However, if the parameter bracket is given a nonblank value, brackets will be passed on if present.

Examples

  • {{#invoke:redirect|main|WP:AFC}}Lua error at line 1: unexpected symbol near '{'.
  • {{#invoke:redirect|main|[[WP:AFD]]|bracket=yes}}Lua error at line 1: unexpected symbol near '{'.
  • {{#invoke:redirect|main|Wikipedia:Articles for deletion}}Lua error at line 1: unexpected symbol near '{'.

Note: WP:AFC and WP:AFD are both redirects, but Wikipedia:Articles for deletion is not.

LuaMain

If you want to use the main function from another Lua module, you may want to use the luaMain function. This provides the same functionality as the main function, but doesn't require that a frame object be available.

To use this, first load the module.

local mRedirect = require('Module:Redirect')

Then use the function with the following syntax:

mRedirect.luaMain(rname, bracket)

rname is the name of the redirect page, and if bracket is anything but false or nil, the module will produce a link rather than just a page name.

IsRedirect

The isRedirect function is used from wiki pages to find out if a given page is a redirect or not. If the page is a redirect, the function returns "yes", and if not the output is blank. Its usage is {{#invoke:redirect|isRedirect|redirect-page-name}}.

Examples

  • {{#invoke:redirect|isRedirect|WP:AFC}}Lua error at line 1: unexpected symbol near '{'.
  • {{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}}Lua error at line 1: unexpected symbol near '{'.

LuaIsRedirect

The isRedirect can be accessed from other Lua modules in the same way as the main function:

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

GetTarget

The getTarget function fetches the target page name of a redirect page, and is only usable from Lua. If the page specified is a redirect, then the target is returned; otherwise the function returns nil.

To use it, first load the module.

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.

See also