Template:Template shortcut/doc

This is a documentation subpage for Template:Template shortcut (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

This template is used on many pages. To avoid any disruptions and to save server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. As a courtesy to other users, please discuss any changes at the talk page before implementing them.

This template displays one or more of a template's shortcuts (that is, redirects, also known as aliases, as in the box appearing at the right. {{Tsh}} is a shortcut to this template, {{template shortcut}}, and can be used in its place, as it is in this documentation's source wikitext.

Usage

Place this template and its list of few to one, carefully selected shortcut(s) at the top of the template documentation page's wikitext, right underneath {{Documentation subpage}}. In the saved, rendered text, those shortcuts will appear in this template's Shortcut(s) box, whose title will reflect the number of list items by automatically being singular or plural in form.

Which ones to display here

Although the template can show up to ten shortcuts, you are encouraged to choose well which ones to display in this template's box. Even if many redirects exist, two or three at the most is almost always enough. By keeping the number of redirects presented in the Shortcut box small, it makes it easier to remember them, and the documentation is kept well organized.

Where to list any others

List others in the Redirects section of the template documentation. Again, not all of them need to be listed; some shortcuts are there just for historical reasons, and others differ only in minor points such as white spaces or capitalization. Such shortcut-name variations are unnecessary to list at all—just list the standard, most common version of such a variation.

Optional parameters

This template has several optional parameters:

• float – if set to "left", then the box will float to the left of the page, instead of the default float "right".
• clear – if set to "right" (when float also is set to "right"), the box will be pushed to the right margin of the page, and Template:Clarify Similarly, if set to "left" (when float also is set to "left"), the box will be pushed to the left margin of the page.
• pre, pre2, pre3 ... up to pre10 – can be used to show some text before the shortcut links, but within the braces. This is mostly used to add the text "subst:". This shows the proper syntax for using the template with substitution.

As with the other shortcuts in the saved, rendered version of this template, this shortcut code can be copied from its line in the box on the documentation page, as it is, and pasted in the wikitext of another page where you wish its rendered version to appear.

• top – to change the padding above the box (e.g. |top=0 for no padding, |top=0.2em, |top=4 / |top=4px).

Examples of basic code

To display one template shortcut named {{uw-v1}}:

To display three template shortcuts for {{uw-vandalism1}} named {{uw-v1}}, {{uw-vand1}}, and {{uw-vandal1}}:

Example with the float parameter

Using |float=left makes this template flow to the left of the page:

{{template shortcut|float=left|uw-v1}}

Example with text ("subst:") within the braces

This is mostly used to add text to show how the template could be used with substitution.

Use |pre2=subst: and |pre3=subst: to show "subst:" before the shortcut links, but within the braces:

{{template shortcut|uw-v1|pre2=subst:|uw-vand1|pre3=subst:|uw-vandal1}}

See also

• {{shortcut}}, the standard shortcut notice.
  • {{shortcut-l}} for a left-aligned standard shortcut notice.
• {{policy shortcut}} for shortcuts to sections of policy pages.