ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:Template shortcut
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Uses 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, ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:Tlf, 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 ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ: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 – 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}}:
Script error: No such module "Template link general".
To display three template shortcuts for {{uw-vandalism1}} named {{uw-v1}}, {{uw-vand1}}, and {{uw-vandal1}}:
Script error: No such module "Template link general".
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
[ᥛᥥᥰ ᥗᥖᥴ ᥒᥝᥲ ᥒᥣᥱ]ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:Format TemplateData
ᥖᥨᥭᥰᥙᥣᥰ
[ᥛᥥᥰ ᥗᥖᥴ ᥒᥝᥲ ᥒᥣᥱ]- {{shortcut}}, the standard shortcut notice.
- {{policy shortcut}}, for shortcuts to sections of policy pages.
- {{R to redirect template}}, the rcat template for redirects to rcat templates
- {{template redirect}}, automatically sets
redirect=yes
ᥚᥪᥢᥴ ᥘᥤᥐ ᥘᥣᥭᥰ ᥓᥬᥳ ᥖᥪᥰ (documentation)ᥖᥤ ᥚᥣᥭᥱ ᥘᥫᥴ ᥘᥭᥳ ᥘᥧᥐ ᥖᥤ ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:Template shortcut/doc ᥔᥥᥴ ᥑᥣᥭᥳ ᥔᥬᥱ ᥑᥝᥲ (ᥞᥥᥖᥱ transclude ᥝᥭᥳ ᥑᥣᥲ ᥟᥩᥲ။ (ᥛᥥᥰ ᥗᥖᥴ | ᥙᥪᥢᥰ) ᥚᥧᥱ ᥓᥫᥰ ᥛᥥᥰ ᥗᥖᥴ ᥑᥝᥴ ᥓᥣᥒ ᥓᥣᥛᥰ ᥖᥨᥭᥰ ᥘᥭᥲ ᥓᥫᥰ ᥙᥥᥢ ᥘᥣᥲ ᥘᥤᥐ sandbox (ᥔᥣᥒᥲ | ᥒᥝᥰ ᥛᥫᥢᥴ) ᥘᥦᥲ testcases (ᥔᥣᥒᥲ) ᥞᥣᥒᥰ ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ ᥟᥢ ᥘᥭᥳ ᥘᥭᥲ ᥕᥧᥱ ᥑᥣᥲ။ ᥔᥬᥱ ᥙᥫᥒ ᥗᥣᥢᥲ ᥐᥣ ᥖᥤ ᥘᥣᥲ ᥘᥤᥐ ᥚᥥᥴ /doc ᥘᥦᥲ။ ᥘᥣᥲ ᥘᥤᥐ ᥚᥥᥴ ᥞᥣᥒᥰ ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ ᥟᥢ ᥘᥭᥳ။. |