Модуль:Redirect/документація

Модуль містить функції для визначення цільової сторінки на яку веде сторінка перенаправлення. This module contains functions to find the target of a redirect page.

Функція «Main»

Отримує в аргументі назву сторінки. Визначає чи є сторінка перенаправленням, якщо так повертає назву сторінки, на яку перенаправляє перенаправлення, як текстовий рядок. Виклик: {{#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.

Приклади

• {{#invoke:redirect|main|ВП:Кнайпа}} → Вікіпедія:Кнайпа
• {{#invoke:redirect|main|[[WP:AFD]]|bracket=yes}} → Вікіпедія:AFD
• {{#invoke:redirect|main|Wikipedia:Articles for deletion}} → Вікіпедія:Articles for deletion

Note: ВП:Кнайпа 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}}.

Приклади

• {{#invoke:redirect|isRedirect|WP:AFC}} →
• {{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}} →

Функція «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 може бути як назва сторінки перенаправлення, як текстовий рядок), так і mw.title object.