Template:Shortcut/doc - Revision history

Caleb Cooper: Text replacement - "[[HTML" to "[[Wikipedia:HTML"

2020-10-21T16:22:13Z

Text replacement - "[[HTML" to "[[Wikipedia:HTML"

← Older revision		Revision as of 16:22, 21 October 2020
Line 61:		Line 61:
	== Anchors ==		== Anchors ==

	These templates automatically add an [[HTML element#Anchor\|anchor]] for each shortcut name parameter. For example, if a shortcut box with the shortcut [[Wikipedia: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.		These templates automatically add an [[Wikipedia:HTML element#Anchor\|anchor]] for each shortcut name parameter. For example, if a shortcut box with the shortcut [[Wikipedia: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]]		Examples: [[#WP:SHORT]], and [[MOS:MATH#TONE]]

Caleb Cooper: Text replacement - "[[WP:" to "[[Wikipedia:WP:"

2020-10-21T08:13:12Z

Text replacement - "[[WP:" to "[[Wikipedia:WP:"

← Older revision		Revision as of 08:13, 21 October 2020
Line 22:		Line 22:
	*{{tl\|Ombox/shortcut}} – ''shortcut'' that embeds into message boxes		*{{tl\|Ombox/shortcut}} – ''shortcut'' that embeds into message boxes

	This template should not be used for articles in the main namespace, because the graphic produces an unavoidable [[WP:SELF\|self-reference]].		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.		# Insert the shortcut template.
Line 30:		Line 30:

	'''Notes'''		'''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.		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, [[Wikipedia: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 point of these templates is not to list every single redirect for a page (indeed, that's what [[Special:WhatLinksHere]] is for). Instead, they should list the most common and easily remembered redirects.		The point of these templates is not to list every single redirect for a page (indeed, that's what [[Special:WhatLinksHere]] is for). Instead, they should list the most common and easily remembered redirects.
Line 61:		Line 61:
	== Anchors ==		== Anchors ==

	These templates automatically add an [[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.		These templates automatically add an [[HTML element#Anchor\|anchor]] for each shortcut name parameter. For example, if a shortcut box with the shortcut [[Wikipedia: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]]		Examples: [[#WP:SHORT]], and [[MOS:MATH#TONE]]

Caleb Cooper: Created page with "{{documentation subpage}} {{Template shortcut|Shc|Short|Shorthand}} {{High-use}} {{Lua|Module:Shortcut..."

2020-10-16T19:11:26Z

Created page with "{{documentation subpage}}  {{Template shortcut|Shc|Short|Shorthand}} {{High-use}} {{Lua|Module:Shortcut..."

New page

{{documentation subpage}}

{{Template shortcut|Shc|Short|Shorthand}}
{{High-use}}
{{Lua|Module:Shortcut}}
{{Uses TemplateStyles|Template:Shortcut/styles.css}}
{{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. 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 ==

The characteristics of the ''box'' graphic are determined by which of the family of shortcut templates are chosen. For example, the ''policy shortcut'' box has the word ''policy'' on it for use on policy pages. The graphic alignment of the box depends on the whether it's a ''shortcut'' or a ''shortcut-l'':
*{{tl|shortcut}} – right-aligned box
*{{tl|shortcut-l}} – left aligned box
*{{tl|policy shortcut}} – ''shortcut'' that also says "policy"
*{{tl|Ombox/shortcut}} – ''shortcut'' that embeds into message boxes

This template should not be used for articles in the main namespace, because the graphic produces an unavoidable [[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 point of these templates is not to list every single redirect for a page (indeed, that's what [[Special:WhatLinksHere]] is for). Instead, they should list the most common and easily remembered redirects.

For policy pages, one can use the {{tl|policy shortcut}} template. Be careful not to use a ''policy template'' on a guideline or essay.

== Parameters ==

{{tl|shortcut}} takes the following parameters:
* {{code|1}}, {{code|2}}, {{code|3}}... – the shortcut links.
* {{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 ==

{| class="wikitable"
! 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 [[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.

== 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|Ombox/shortcut}} – for embedding into message boxes
* {{tl|Policy shortcut}} – for shortcuts to sections of policy pages
* {{tl|R from shortcut}} – for placement on the redirect page
* {{tl|Shortcut-l}} – for left aligned normal shortcuts
* {{tl|Template shortcut}} – used for shortcuts/redirects to a template page
* {{tl|Short URL}} – for short URLs created with the [[:meta:Special:URLShortener|WMF URL shortener]]

<includeonly>{{Sandbox other||

[[Category:Shortcut templates]]

}}</includeonly>