View source for Template:Shortcut/doc

{{documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Template shortcut|Shc|Short|Shorthand}}
<!--{{High-use}}
{{Lua|Module:Shortcut}}
{{Lua sidebar}}-->
{{Commons|Template:Redirects}}

This is the documentation for {{tl|shortcut}} and its sister templates. Template {{tl|shortcut}} renders a box, informing editors which {{Wikipedia|Shortcut|shortcuts}} are available for linking to a page or a section of a page.

The ''{{Wikipedia|Shortcut|shortcut}}'' family of templates is put into context here, but they each have their own documentation pages, [[#See also|see below]]. A shortcut template is similar to the {{tl|anchor}} template, but it adds a visual ''box'' graphic to the rendered page, as well as providing an alternative name. {{Wikipedia|Help:Redirect|Creating a redirect page}} is a requirement to fulfill the shortcut mechanism.

In templates, it is put in the {{Wikipedia|Template documentation|documentation page}}.

== Usage ==
This template should not be used for articles in the main namespace, because the graphic produces an unavoidable {{Wikipedia|WP:SELF|self-reference}}.

# Insert the shortcut template. 
# Create a redirect page with the {{tl|R from shortcut}} template suffixed to the redirect. Name the page after your shortcut name.  Include the namespace name in both the shortcut name and the redirect page name. For example, substitute your own shortcut name as the title of the page, and substitute the proper namespace, then add the REDIRECT as the top-line on your redirect page, and the category to the third line of the redirect:
#:<code><nowiki>#REDIRECT [[</nowiki>''Namespace'':''Title of page with''#''Optional and possibly very long section name''<nowiki>]]</nowiki><br><br><nowiki>{{R from shortcut}}</nowiki></code>
# Verify operation.  Note that shortcut templates should display in all capitals, but operate without all capitals.

'''Notes'''
Shortcuts are used mainly on user pages and talk pages in reference to the Wikipedia, Help, and Portal namespaces. These templates inform about the shortcuts available to the page they are on. For example, [[WP:SHORT]] redirects to [[Wikipedia:Shortcut]] and therefore, Wikipedia:Shortcut renders a shortcut box listing WP:SHORT.  It is a self-reference that is normally avoided in the main article namespace.

The purpose of these templates is not to list every single redirect for a page (that's what [[Special:WhatLinksHere]] is for), but to list the most common and easily remembered redirects.

== Parameters ==
{{tl|shortcut}} takes the following parameters:
* {{code|1}}, {{code|2}}, {{code|3}}... – the shortcut links.
* {{code|float}} – if set to {{code|left}}, the box floats to the left.
* {{code|clear}} – if set to {{code|right}}, (or {{code|left}} if {{para|float|left}} is set), the box appears beneath, not beside, another floating element preceding it (infobox, thumbnail etc.).
* {{code|msg}} – an unlinked message that goes after the shortcut links.
* {{code|category}} – set to "no", "n", "false" or "0" to suppress error categories.

== Examples ==
{|
! Code
! Result
|-
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|WP:SHORT}}
| {{<!---->{{BASEPAGENAME}}|WP:SHORT}}
|-
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|WP:V|WP:VERIFY|WP:SOURCE}}
| {{<!---->{{BASEPAGENAME}}|WP:V|WP:VERIFY|WP:SOURCE}}
|-
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|WP:V|WP:VERIFY|4=msg=A message}}
| {{<!---->{{BASEPAGENAME}}|WP:V|WP:VERIFY|msg=A message}}
|}

== Anchors ==
These templates automatically add an {{Wikipedia|HTML element#Anchor|anchor}} for each shortcut name parameter. For example, if a shortcut box with the shortcut [[WP:SHORT]] is placed on the page [[Wikipedia:Shortcut]], then the link [[Wikipedia:Shortcut#WP:SHORT]] will take you to the position in the page where that shortcut box is placed.

Examples: [[#WP:SHORT]], and [[MOS:MATH#TONE]]

This makes it easier to create a shortcut for a section of a page, because you can refer to the anchor when creating the shortcut redirect itself. Like this:

:<code><nowiki>#REDIRECT [[Pagename#WP:SHORT]] {{R from shortcut}}</nowiki></code>

== Positioning ==
This template is usually placed below the section header or at the top of a page. 

Before July 26, 2010, when the anchor was inside the box, this caused the section header to scroll above the page window. Fixes for this issue included:
* Placing the shortcut above the section header; a bit confusing when editing
* Creating the redirect to the section header, not the shortcut; this would break if the section header was renamed
* Placing an {{tl|anchor}} in the section header that duplicated the shortcut

These fixes are no longer needed, but do not break the current implementation.

== TemplateData ==
<!-- The <nostrip> comments are necessary to work around bugs in [[Module:Plain text]] -->
<!--{{Format TemplateData|<templatedata>-->
{{TemplateData header}}
<syntaxhighlight lang="JSON">
{
	"description": "This template displays one or more of a template's shortcuts.",
	"format": "inline",
	"params": {
		"template": {
			"label": "Template?",
			"description": "Whether this is a list of shortcuts for a Template. <p><!--nostrip-->'''See also:''' <code><!--nostrip-->{{[[Template:Template shortcut|Template shortcut]]}}</code></p>",
			"default": "0",
			"autovalue": "1",
			"type": "boolean"
		},
		"redirect": {
			"label": "Redirect?",
			"description": "Whether to refer to the “shortcut/s” as “redirect/s” instead.",
			"default": "0",
			"autovalue": "1",
			"type": "boolean"
		},
		"target": {
			"label": "Target?",
			"description": "Whether to omit the <code><!--nostrip-->redirect=no</code><!--nostrip--> URL parameter.",
			"default": "0",
			"autovalue": "1",
			"type": "boolean"
		},
		"float": {
			"label": "Float",
			"description": "The CSS <code><!--nostrip-->float</code><!--nostrip--> property value.",
			"default": "right",
			"suggestedvalues": [
				"left",
				"right"
			],
			"type": "string"
		},
		"clear": {
			"label": "Clear",
			"description": "The CSS <code><!--nostrip-->clear</code><!--nostrip--> property value.",
			"suggestedvalues": [
				"left",
				"right",
				"both"
			],
			"type": "string"
		},
		"category": {
			"label": "Categorize",
			"description": "Whether to add pages to the error category if no alias or <code><!--nostrip-->msg</code><!--nostrip--> is specified.",
			"default": "1",
			"autovalue": "0",
			"type": "boolean"
		},
		"msg": {
			"label": "Message",
			"description": "An unlinked message that goes after the shortcut links.",
			"type": "content"
		},
		"1": {
			"label": "Shortcut 1",
			"description": "Page/section shortcut 1",
			"required": true,
			"type": "wiki-page-name"
		},
		"2": {
			"label": "Shortcut 2",
			"description": "Page/section shortcut 2",
			"type": "wiki-page-name"
		},
		"3": {
			"label": "Shortcut 3",
			"description": "Page/section shortcut 3",
			"type": "wiki-page-name"
		},
		"4": {
			"label": "Shortcut 4",
			"description": "Page/section shortcut 4",
			"type": "wiki-page-name"
		},
		"5": {
			"label": "Shortcut 5",
			"description": "Page/section shortcut 5",
			"type": "wiki-page-name"
		},
		"6": {
			"label": "Shortcut 6",
			"description": "Page/section shortcut 6",
			"type": "wiki-page-name"
		},
		"7": {
			"label": "Shortcut 7",
			"description": "Page/section shortcut 7",
			"type": "wiki-page-name"
		},
		"8": {
			"label": "Shortcut 8",
			"description": "Page/section shortcut 8",
			"type": "wiki-page-name"
		},
		"9": {
			"label": "Shortcut 9",
			"description": "Page/section shortcut 9",
			"type": "wiki-page-name"
		}
	},
	"paramOrder": [
		"template",
		"redirect",
		"target",
		"float",
		"clear",
		"category",
		"msg",
		"1",
		"2",
		"3",
		"4",
		"5",
		"6",
		"7",
		"8",
		"9"
	]
}
</syntaxhighlight>
<!--</templatedata>}}-->

== See also ==
* {{Wikipedia|Shortcut}} – The how-to guide and guideline about how and when to create shortcuts and shortcut boxes. A must-read for anyone handling shortcuts.
* {{tl|Anchor}} – a way to overcome the otherwise permanent fact that section titles are the only way to link to a section
* {{tl|R from shortcut}} – for placement on the redirect page
* {{tl|Template shortcut}} – used for shortcuts/redirects to a template page
* {{tl|Short URL box}} – for short URLs created with the [[:meta:Special:URLShortener|WMF URL shortener]]

<includeonly>{{Sandbox other||
<!--Categories below this line, please; interwikis at Wikidata-->
[[Category:Shortcut templates]]

}}</includeonly>