Joomla! Documentation™

Note active template content hidden as need arguments to display properly.

Otherwise see only an error message.

Template documentation

This documentation is transcluded from Template:Redirectstohere/doc.

To discuss this template as a whole, please see JDOC:WTP. If you wish to discuss general wordings, rather than the wording or formatting of this specific template, don't post here, or else what you say will probably go unnoticed.

Purpose

The purpose of the redirect templates is to establish and document a section title backlink to and from a redirect page title that links to said section or page. This usage will alert and prevent a subsequent editor from altering a section title and inadvertently breaking the link and whatever articles reference same.

Placement at the top of the article is useful as well, {{redirect}} and {{redirectstohere}} are best suited at that position to inform readers of an article.

Always wrap this templates in <noinclude> tags to prevent the message from appearing in composite documents.

Usage

The templates are used after a section heading on an article page and it uses the odd numeric parameter {{{1}}}, which will be not displayed in the tagged article as the reference title of the section. The next following even number is the name of the matching redirect page.

Subsequent pages may also be listed as additional "Numbered Parameters" to provide a reference to other redirect pages which link to that page or section, but only the Even numbered parameters will display, so dummy arguments might be needed to pad out multiple references to a single section, or the title should be repeated for each even occurrence.

Parameters

For use of numeric parameters 1 - 9 see examples below.

{{{hide=yes}}}

adds a style attribute to hide the output. See notes below.

{{{border=css-class}}}

adds css-class to the class attribute (dablink) of the container div.

Examples

In the article "Tides", the section title Spring Tides and Neap tides might be declared from their matching redirects:

ex:1 -- redirect 'Neap tide' goes to [[tide#Neap tide]]
     -- Odd params are section titles.
{{redirects|Neap Tides|Neap tide}}

ex:2 -- two redirects go to the same section 
    (i.e. related material, not worthy of own topics) 
    So handled in same section: -- Odd params are section titles...
{{redirects|Neap Tides|Neap tide|Neap Tides|Spring tide}}
      so the Section title "Neap Tides" covers both!

{{redirectstohere|Neap tide|Spring tide|Tides|Storm tide}} 
   -- to page Tide top, so lists all.

{{redirect}}

{{redirect|Application}} gives

Application redirects here. For other uses, see Application (disambiguation).

{{redirect|Back-end|the user level|Administrator (User)}} gives

Back-end redirects here. For the user level, see Administrator (User).

{{redirects}}
{{redirects|Some section|PAGE}}

PAGE redirects here.

{{redirects|Some section|PAGE|Some other section|PAGE2}}

PAGE and PAGE2 redirects here.

{{redirectstohere}} accepts a maximum of nine pages.

1. Plugins redirects here.
2. Plugins and Modules both redirect to here.
3. Plugins, Modules and Templates all redirect to here.
4. Plugins, Modules, Templates and Languages all redirect to here.
5. Plugins, Modules, Templates, Languages and Components all redirect to here.
6. Plugins, Modules, Templates, Languages,Components and Extensions all redirect to here.
7. Plugins, Modules, Templates, Languages,Components, Extensions and Mambots all redirect to here.
8. Plugins, Modules, Templates, Languages,Components, Extensions,Mambots and Scripts all redirect to here.
9. Plugins, Modules, Templates, Languages,Components, Extensions,Mambots, Scripts and Foo Bar all redirect to here.

Notes

The hide parameter should only be used if the template is added to a section to prevent visual clutter. An editor will still see the template as a procaution of changing a section title and thereby breaking (possibly many) links from other pages. One may argue that adding a regular HTML comments may provide the same information, but using the template allows what links here to locate the tagged articles; an HTML comment does not.

See also

• {{redirects}} (don't confuse with {{redirect}} - no 's')
• {{redirectstohere}}
• Otheruses templates

Stylesheet

div.dablink
.redirectstohere