Template:Shortcut/doc
From MeritBadgeDotOrg
(testing) |
({documentation subpage}}) |
||
| Line 1: | Line 1: | ||
| - | < | + | <noinclude>{{template doc page viewed directly}}</noinclude> |
| + | {{documentation subpage}} | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
| + | This template is used to display a short ''alias'' for the given page. This template does NOT create the shortcut; it displays the shortcut in a standardized format on the destination page. The optional parameter is typically a link to the shortcut. | ||
==Usage== | ==Usage== | ||
This template is primarily used on MeritBadgeDotOrg guideline and policy pages to show the shortest alias of a given page. For example, [[MB:SHORT]] redirects to [[MeritBadgeDotOrg:Shortcut]]. The point of this template is not to list every single redirect (indeed, that's what [[Special:Whatlinkshere]] is for); for any given page, it should list only one or two common and easily-remembered redirects. | This template is primarily used on MeritBadgeDotOrg guideline and policy pages to show the shortest alias of a given page. For example, [[MB:SHORT]] redirects to [[MeritBadgeDotOrg:Shortcut]]. The point of this template is not to list every single redirect (indeed, that's what [[Special:Whatlinkshere]] is for); for any given page, it should list only one or two common and easily-remembered redirects. | ||
Revision as of 14:41, November 7, 2008
| This is the documentation page for Template:Shortcut/doc. When viewed directly, links using variables may appear broken; do not replace these with hard-coded page names or URLs.
|
- This documentation is transcluded from Template:Shortcut/doc/doc.
This template may have a sandbox (edit) and testcases for editors to experiment.
This template is used to display a short alias for the given page. This template does NOT create the shortcut; it displays the shortcut in a standardized format on the destination page. The optional parameter is typically a link to the shortcut.
Usage
This template is primarily used on MeritBadgeDotOrg guideline and policy pages to show the shortest alias of a given page. For example, MB:SHORT redirects to MeritBadgeDotOrg:Shortcut. The point of this template is not to list every single redirect (indeed, that's what Special:Whatlinkshere is for); for any given page, it should list only one or two common and easily-remembered redirects.
Don't use this template on other templates, e.g. to state that the shortcut to Template:Foo is in fact {{Foo}}. There's no need to state the obvious like that, by default every template uses its own name as a shortcut.
Template usage
Please use {{template shortcut}} to indicate convenient template redirects, which is specifically intended for that purpose.
