Module:Redirect: Difference between revisions

Module:Redirect (edit)

23 bytes removed , 11 years ago

update comment

Anonymous user

@@ Line 1: / Line 1: @@
- ---- This module 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}}.
+Given a single page name determines what page, if any, it redirects to and returns the target page name, or the
- ---- The template neither takes nor gives square brackets, so to show the result as a link use
+passed page name if not a redirect. The passed page name can be given as plain text or as a page link. The
- ---- [[{{#invoke:redirect|main|redirect-page-name}}]].  An error is produced if the redirect does not exist,
+returned page name is as plain text, or when the bracket parameter is given, as a page link. An error message
- ---- but for versatility no error is given if the file is not a redirect (returns the original text)
+is returned if page does not exist or the redirect target cannot be determined for some reason.
- ---- or if the file name is blank (returns blank).
+Thus these are roughly the same:
+  [[{{#invoke:redirect|main|redirect-page-name}}]] and {{#invoke:redirect|main|redirect-page-name|bracket=yes}}
+--]=]
 p={}