Template:Shortcut/doc

From MeritBadgeDotOrg

(Difference between revisions)
Jump to: navigation, search
({documentation subpage}})
Current revision (10:27, February 10, 2011) (edit) (undo)
m (Added __NOEDITSECTION__)
 
(4 intermediate revisions not shown.)
Line 2: Line 2:
{{documentation subpage}}
{{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.
+
__NOEDITSECTION__
 +
{{tl|Shortcut}} is used to display a short '''''alias''''' for the given page. Shortcuts should be created and used sparingly, lest they loose their standing. The point of this template is '''''not''''' to list all redirects. (See [[Special:Whatlinkshere]] and [[Special:Listredirects]].) Instead, shortcuts should only display one (no more than two) very short, common and easily-remembered aliases, which (internally) makes use of redirects. '''Note:''' {{tl|Shortcut}} does ''not'' create the shortcut itself; it only displays the shortcut in a standardized format on the ''destination'' page. The variable parameter is the ''alias'' link to the desired destination page.
 +
 
==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.
+
==Copy-and-paste==
 +
<pre>{{Shorcut|[[Foo]]}}</pre>
-
Don't use this template on other templates, e.g. to state that the shortcut to [[Template:Foo]] is in fact <nowiki>{{Foo}}</nowiki>. There's no need to state the obvious like that, by default every template uses its own name as a shortcut.
+
===Variable===
 +
The ''variable'' in this use of this template is the alias link you want displayed... e.g., '''<nowiki>[[Foo]]</nowiki>'''. Remember, this variable is a reference to an internal link, so... don't forget to place the internal link brackets ( '''<nowiki>[[</nowiki>''' and '''<nowiki>]]</nowiki>''' ) around the the text in order to create the link.
-
==Template usage==
+
==Examples==
-
Please use {{tl|template shortcut}} to indicate convenient template redirects, which is specifically intended for that purpose.
+
In the ''Main'' (a.k.a., ''Article'') [[namespace]]:
-
<includeonly>
+
:Frequently-accessed article pages...
-
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
:* [[Eagle]] &rarr; [[Eagle Scout rank]]
-
[[Category:MB header templates|{{PAGENAME}}]]
+
-
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
:Or, shortening long page titles...
 +
:* [[NESA]] &rarr; [[National Eagle Scout Association]]
 +
:* [[OA]] &rarr; [[Order of the Arrow]]
 +
:* [[MBID]] &rarr; [[Merit Badge Numbering System (BSA Advancement ID)]]
 +
In other [[namespaces]], specifically... ''Category'', ''Help'' and ''MeritBadgeDotOrg'' (a.k.a., ''Project''):
 +
:* [[AMB]] &rarr; [[MeritBadgeDotOrg:Article message boxes]]
 +
:* [[UBX]] &rarr; [[MeritBadgeDotOrg:WikiProject Userboxes]]
 +
:* [[Admin]] &rarr; [[MeritBadgeDotOrg:Administrators]]
 +
 +
{{Info|Unless approved an [[Administrator]], shortcuts should not be created/used in ''User'' or ''Talk'' namespaces.}}
 +
 +
==Notes==
 +
:1. ''Using'' shortcuts (in the search box) is not case-sensitive, but ''creating'' them is...
 +
::* [[TP]] &rarr; [[Tour Plan]]
 +
::* [[Tp]] &rarr; does not exist!
 +
::....so, give this due consideration when creating the shortcut.
 +
 +
:2. Do ''not'' use {{tl|Shortcut}} on other templates, e.g. the shortcut to [[Template:Foo]] is, in fact, <nowiki>{{Foo}}</nowiki>. By default, every template uses its own name as a shortcut.
 +
 +
==See also==
 +
===Related templates===
 +
* {{tl|Shortcutleft}} is identical to {{tl|Shortcut}}, but displays on the left.
 +
* {{tl|Template shortcut}} is for template redirects, which is specifically written for that purpose.
 +
 +
===Special pages===
 +
* [[Special:Listredirects]] &mdash; Lists all redirects on the entire site, whether they are ''shortcuts'', or not.
 +
* [[Special:Whatlinkshere]] &mdash; Only lists pages that link to the page you are currently viewing.
 +
<includeonly>
 +
<!-- ADD CATEGORIES BELOW THIS LINE -->
 +
[[Category:Header templates|{{PAGENAME}}]]
</includeonly>
</includeonly>

Current revision

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.


{{Shortcut}} is used to display a short alias for the given page. Shortcuts should be created and used sparingly, lest they loose their standing. The point of this template is not to list all redirects. (See Special:Whatlinkshere and Special:Listredirects.) Instead, shortcuts should only display one (no more than two) very short, common and easily-remembered aliases, which (internally) makes use of redirects. Note: {{Shortcut}} does not create the shortcut itself; it only displays the shortcut in a standardized format on the destination page. The variable parameter is the alias link to the desired destination page.

Contents

Usage

Copy-and-paste

{{Shorcut|[[Foo]]}}

Variable

The variable in this use of this template is the alias link you want displayed... e.g., [[Foo]]. Remember, this variable is a reference to an internal link, so... don't forget to place the internal link brackets ( [[ and ]] ) around the the text in order to create the link.

Examples

In the Main (a.k.a., Article) namespace:

Frequently-accessed article pages...
Or, shortening long page titles...

In other namespaces, specifically... Category, Help and MeritBadgeDotOrg (a.k.a., Project):


Unless approved an Administrator, shortcuts should not be created/used in User or Talk namespaces.

Notes

1. Using shortcuts (in the search box) is not case-sensitive, but creating them is...
....so, give this due consideration when creating the shortcut.
2. Do not use {{Shortcut}} on other templates, e.g. the shortcut to Template:Foo is, in fact, {{Foo}}. By default, every template uses its own name as a shortcut.

See also

Related templates

Special pages

Personal tools
language