Actions

Template

Redirectstohere/doc

From Joomla! Documentation

< Template:Redirectstohere
Revision as of 06:15, 16 May 2008 by CirTap (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a documentation subpage for Template:Redirectstohere.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Redirectstohere.

Contents

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

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


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

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


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


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

Stylesheet

div.dablink
.redirectstohere