Template:Shortcut/doc

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

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.

In templates, it is put in the documentation page.

Usage
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 with the 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:
 * 3) Verify operation.  Note that shortcut templates should display in all capitals, but operate without all capitals.
 * 1) 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 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.

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

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

Examples:, and MOS:MATH

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:



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 anchor in the section header that duplicated the shortcut

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