Template:Template shortcut/doc

This is a documentation subpage for 'Template:Template shortcut'.

It contains usage information, categories, and other content that is not part of the original template page.

Template:Template shortcut invokes function main in Module:Shortcut using Lua.

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. See Wikipedia:Template:Template shortcut for more details. Note that there are no optional parameter in this template.

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}}. 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.