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.

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 prevent it from nest to the left of other right-floating elements.[clarification needed] 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

دَییشدیر

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

دَییشدیر

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

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

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

TemplateData

دَییشدیر
This template displays one or more of a template's shortcuts.
پارامترتوضیحاتنوعوضعیت
Redirect?redirect
Whether to refer to the "shortcut/s" as "redirect/s" instead.
پیش‌فرض
False (0)
بولیاختیاری
Target?target
Whether to not add the redirect=no URL parameter.
پیش‌فرض
False (0)
بولیاختیاری
Floatfloat
The CSS float property value.
مقدارهای پیشنهادی
left right
پیش‌فرض
right
رشتهاختیاری
Clearclear
The CSS clear property value.
مقدارهای پیشنهادی
left right both
رشتهاختیاری
Categorizecategory
Whether to add pages to the error category if no alias or msg is specified.
پیش‌فرض
True (1)
بولیاختیاری
Messagemsg
An unlinked message that goes after the shortcut links.
محتوااختیاری
Default prefixpre
The default prefix
مثال
subst:
رشتهاختیاری
Prefix 1pre1
Prefix for template shortcut 1
مثال
subst:
رشتهاختیاری
Shortcut 11
Template shortcut 1
الگوضروری
Prefix 2pre2
Prefix for template shortcut 2
مثال
subst:
رشتهاختیاری
Shortcut 22
Template shortcut 2
الگواختیاری
Prefix 3pre3
Prefix for template shortcut 3
مثال
subst:
رشتهاختیاری
Shortcut 33
Template shortcut 3
الگواختیاری
Prefix 4pre4
Prefix for template shortcut 4
مثال
subst:
رشتهاختیاری
Shortcut 44
Template shortcut 4
الگواختیاری
Prefix 5pre5
Prefix for template shortcut 5
مثال
subst:
رشتهاختیاری
Shortcut 55
Template shortcut 5
الگواختیاری
Prefix 6pre6
Prefix for template shortcut 6
مثال
subst:
رشتهاختیاری
Shortcut 66
Template shortcut 6
الگواختیاری
Prefix 7pre7
Prefix for template shortcut 7
مثال
subst:
رشتهاختیاری
Shortcut 77
Template shortcut 7
الگواختیاری
Prefix 8pre8
Prefix for template shortcut 8
مثال
subst:
رشتهاختیاری
Shortcut 88
Template shortcut 8
الگواختیاری
Prefix 9pre9
Prefix for template shortcut 9
مثال
subst:
رشتهاختیاری
Shortcut 99
Template shortcut 9
الگواختیاری

Format: inline

Test of raw TemplateData output:

This template displays one or more of a template's shortcuts.

پارامترهای الگو

استفاده از قالب‌بندی درون‌خطی برای پارامترهای این الگو ارجح است.

پارامترتوضیحاتنوعوضعیت
Redirect?redirect

Whether to refer to the "shortcut/s" as "redirect/s" instead.

پیش‌فرض
0
بولیاختیاری
Target?target

Whether to not add the URL parameter.

پیش‌فرض
0
بولیاختیاری
Floatfloat

The CSS property value.

مقدارهای پیشنهادی
left right
پیش‌فرض
right
رشتهاختیاری
Clearclear

The CSS property value.

مقدارهای پیشنهادی
left right both
رشتهاختیاری
Categorizecategory

Whether to add pages to the error category if no alias or is specified.

پیش‌فرض
1
بولیاختیاری
Messagemsg

An unlinked message that goes after the shortcut links.

محتوااختیاری
Default prefixpre

The default prefix

مثال
subst:
رشتهاختیاری
Prefix 1pre1

Prefix for template shortcut 1

مثال
subst:
رشتهاختیاری
Shortcut 11

Template shortcut 1

الگوضروری
Prefix 2pre2

Prefix for template shortcut 2

مثال
subst:
رشتهاختیاری
Shortcut 22

Template shortcut 2

الگواختیاری
Prefix 3pre3

Prefix for template shortcut 3

مثال
subst:
رشتهاختیاری
Shortcut 33

Template shortcut 3

الگواختیاری
Prefix 4pre4

Prefix for template shortcut 4

مثال
subst:
رشتهاختیاری
Shortcut 44

Template shortcut 4

الگواختیاری
Prefix 5pre5

Prefix for template shortcut 5

مثال
subst:
رشتهاختیاری
Shortcut 55

Template shortcut 5

الگواختیاری
Prefix 6pre6

Prefix for template shortcut 6

مثال
subst:
رشتهاختیاری
Shortcut 66

Template shortcut 6

الگواختیاری
Prefix 7pre7

Prefix for template shortcut 7

مثال
subst:
رشتهاختیاری
Shortcut 77

Template shortcut 7

الگواختیاری
Prefix 8pre8

Prefix for template shortcut 8

مثال
subst:
رشتهاختیاری
Shortcut 88

Template shortcut 8

الگواختیاری
Prefix 9pre9

Prefix for template shortcut 9

مثال
subst:
رشتهاختیاری
Shortcut 99

Template shortcut 9

الگواختیاری