Difference between revisions of "Template:Shortcut/doc"

m (1 revision imported)
 
m
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
−
{{high-use|17,000+}}
+
{{Template shortcut|Sc|Short}}
−
{{Template shortcut|Shc|Short|Shorthand}}
 
 
{{Lua|Module:Shortcut}}
 
{{Lua|Module:Shortcut}}
−
{{Commons|Template:Redirects}}
 
  
 
This is the documentation for {{tl|shortcut}} and its sister templates.
 
This is the documentation for {{tl|shortcut}} and its sister templates.
−
The ''[[Wikipedia:Shortcut|shortcut]]'' family of templates is put into context here, but they each have their own documentation pages, [[#See also|see below]].
+
The ''[[GoArch: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.
 
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.
Line 19: Line 17:
 
*{{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 self-reference.
  
 
# Insert the shortcut template.  
 
# 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:
+
# Create a redirect page. 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:
−
#:<code><nowiki>#REDIRECT [[</nowiki>''Namespace'':''Title of page with''#''Optional very long section name'']]<br><br><nowiki>{{</nowiki><tt>R from shortcut</tt>}}</code>
+
#:<code><nowiki>#REDIRECT [[</nowiki>''Namespace'':''Title of page with''#''Optional very long section name'']]</code>
 
# Verify operation.  Note that shortcut templates should display in all capitals, but operate without all capitals.
 
# Verify operation.  Note that shortcut templates should display in all capitals, but operate without all capitals.
  
−
'''Notes'''
+
'''Notes'''<br />
−
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, [[GA:SHORT]] redirects to [[GoArch:Shortcut]] and therefore, GoArch:Shortcut renders a shortcut box listing GA: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|What links here]]" is for). Instead, they should list only one or two 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|What links here]]" is for). Instead, they should list only one or two common and easily remembered redirects.
Line 46: Line 44:
 
! Result
 
! Result
 
|-
 
|-
−
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|WP:SHORT}}
+
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|GA:SHORT}}
−
| {{{{BASEPAGENAME}}|WP:SHORT}}
+
| {{{{BASEPAGENAME}}|GA:SHORT}}
 
|-
 
|-
−
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|WP:V|WP:VERIFY|WP:SOURCE}}
+
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|GA:POLICY}}
−
| {{{{BASEPAGENAME}}|WP:V|WP:VERIFY|WP:SOURCE}}
+
| {{{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|GA:POLICY}}
 
|-
 
|-
−
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|WP:V|WP:VERIFY|4=msg=A message}}
+
| style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|4=msg=A message}}
−
| {{{{BASEPAGENAME}}|WP:V|WP:VERIFY|msg=A message}}
+
| {{{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|msg=A message}}
 
|}
 
|}
  
 
== 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 anchor for each shortcut name parameter. For example, if a shortcut box with the shortcut [[GA:SHORT]] is placed on the page [[GoArch:Shortcut]], then the link [[GoArch:Shortcut#GA:SHORT]] will take you to the position in the page where that shortcut box is placed.
  
−
For instance, try this link: [[#WP:SHORT]]
+
For instance, try this link: [[#GA:SHORT]]
  
 
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:
 
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>
+
:<code><nowiki>#REDIRECT [[Pagename#GA:SHORT]] </nowiki></code>
  
 
== Positioning ==
 
== Positioning ==
  
 
This template is usually placed below the section header or at the top of a page.  
 
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 ==
 
== 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.
+
* [[GoArch: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|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|Ombox/shortcut}} – for embedding into message boxes

Revision as of 07:35, 20 January 2018

Shortcuts

This is the documentation for {{shortcut}} and its sister templates. The shortcut family of templates is put into context here, but they each have their own documentation pages, see below.

A shortcut template is similar to the {{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.

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:

This template should not be used for articles in the main namespace, because the graphic produces an unavoidable self-reference.

  1. Insert the shortcut template.
  2. Create a redirect page. 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:
    #REDIRECT [[Namespace:Title of page with#Optional very long section name]]
  3. 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, GA:SHORT redirects to GoArch:Shortcut and therefore, GoArch:Shortcut renders a shortcut box listing GA: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 "What links here" is for). Instead, they should list only one or two common and easily remembered redirects.

For policy pages, one can use the {{policy shortcut}} template, which takes up to ten (10) shortcuts as parameters. Be careful not to use a policy template on a guideline or essay.

Parameters

{{shortcut}} takes the following parameters:

  • 1, 2, 3... - the shortcut links.
  • msg - an unlinked message that goes after the shortcut links.
  • category - set to "no", "n", "false" or "0" to suppress error categories.

Examples

Code Result
{{Shortcut|GA:SHORT}}
Shortcut
{{Shortcut|GA:MOS|GA:GUIDE|GA:POLICY}}
Shortcuts
{{Shortcut|GA:MOS|GA:GUIDE|msg=A message}}
Shortcuts

Anchors

These templates automatically add an HTML anchor for each shortcut name parameter. For example, if a shortcut box with the shortcut GA:SHORT is placed on the page GoArch:Shortcut, then the link GoArch:Shortcut#GA:SHORT will take you to the position in the page where that shortcut box is placed.

For instance, try this link: #GA:SHORT

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:

#REDIRECT [[Pagename#GA:SHORT]]

Positioning

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

See also

  • GoArch:Shortcut – The how-to guide and guideline about how and when to create shortcuts and shortcut boxes. A must-read for anyone handling shortcuts.
  • {{Anchor}} – a way to overcome the otherwise permanent fact that section titles are the only way to link to a section
  • {{Ombox/shortcut}} – for embedding into message boxes
  • {{Policy shortcut}} – for shortcuts to sections of policy pages
  • {{R from shortcut}} – for placement on the redirect page
  • {{Shortcut-l}} – for left aligned normal shortcuts
  • {{Template shortcut}} – used for shortcuts/redirects to a template page
Retrieved from "https://archive.guildofarchivists.org/w/index.php?title=Template:Shortcut/doc&oldid=5286"