Template:Shortcut/doc

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:
 * shortcut – right-aligned box
 * shortcut-l – left aligned box
 * policy shortcut – shortcut that also says "policy"
 * Ombox/shortcut – shortcut that embeds into message boxes

This template is not normally used for articles in the main namespace, because the graphic produces an avoidable 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 following as the top-line on your redirect page:
 * #REDIRECT Namespace:Title of page with
 * 1) Verify operation.  Note that shortcut templates should display in all capitals, but operate without all capitals.

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

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.

The shortcut template can take up to five (5) shortcuts as parameters.

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.

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

For instance, try this link:

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.