Template:Template shortcut

From Simple English Wikipedia, the free encyclopedia
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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[change source]

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[change source]

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[change source]

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[change source]

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[needs to be explained] 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 – 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.
  • pre1, pre2 ... – like above, but adds the prefix only to the nth shortcut.

Examples of basic code[change source]

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

{{template shortcut|uw-v1}}

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

{{template shortcut|uw-v1|uw-vand1|uw-vandal1}}

Example with the float parameter[change source]

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[change source]

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

If you use |pre=subst:, it applies to all of the shortcuts:

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

TemplateData[change source]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Template shortcut

This template displays one or more of a template's shortcuts.
ParameterDescriptionTypeStatus
Redirect?redirect
Whether to refer to the "shortcut/s" as "redirect/s" instead.
Default
False (0)
Booleanoptional
Target?target
Whether to not add the redirect=no URL parameter.
Default
False (0)
Booleanoptional
Floatfloat
The CSS float property value.
Suggested values
left right
Default
right
Stringoptional
Clearclear
The CSS clear property value.
Suggested values
left right both
Stringoptional
Categorizecategory
Whether to add pages to the error category if no alias or msg is specified.
Default
True (1)
Booleanoptional
Messagemsg
An unlinked message that goes after the shortcut links.
Contentoptional
Default prefixpre
The default prefix
Example
subst:
Stringoptional
Prefix 1pre1
Prefix for template shortcut 1
Example
subst:
Stringoptional
Shortcut 11
Template shortcut 1
Templaterequired
Prefix 2pre2
Prefix for template shortcut 2
Example
subst:
Stringoptional
Shortcut 22
Template shortcut 2
Templateoptional
Prefix 3pre3
Prefix for template shortcut 3
Example
subst:
Stringoptional
Shortcut 33
Template shortcut 3
Templateoptional
Prefix 4pre4
Prefix for template shortcut 4
Example
subst:
Stringoptional
Shortcut 44
Template shortcut 4
Templateoptional
Prefix 5pre5
Prefix for template shortcut 5
Example
subst:
Stringoptional
Shortcut 55
Template shortcut 5
Templateoptional
Prefix 6pre6
Prefix for template shortcut 6
Example
subst:
Stringoptional
Shortcut 66
Template shortcut 6
Templateoptional
Prefix 7pre7
Prefix for template shortcut 7
Example
subst:
Stringoptional
Shortcut 77
Template shortcut 7
Templateoptional
Prefix 8pre8
Prefix for template shortcut 8
Example
subst:
Stringoptional
Shortcut 88
Template shortcut 8
Templateoptional
Prefix 9pre9
Prefix for template shortcut 9
Example
subst:
Stringoptional
Shortcut 99
Template shortcut 9
Templateoptional

Format: inline

Related pages[change source]