Template:Shortcut

From Wikibooks, open books for an open world
Jump to: navigation, search
Template documentation[edit] [history] [purge]

This is the documentation for {{shortcut}}.

Usage

  1. Insert the shortcut. If it is to a section, put it on the line above the section title.
  2. Create a redirect page with the name of the page based on your shortcut name. Include the namespace name in both the shortcut name and the redirect page name. For example, substituting your own shortcut name as the title of the page, and substituting the proper namespace, add the following 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.

These templates are mainly used on user pages and talk pages in reference to Wikibooks, Help, and Category namespaces. These templates inform about the shortcuts available to the page they are on. For example, WB:RFD redirects to Wikibooks:Requests for deletion and therefore Wikibooks:Requests for deletion renders a shortcut box listing WB:RFD.

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 shortcuts as parameters.

Examples

Code Result
{{shortcut|WB:AA}}
{{shortcut|WB:CHAT|WB:RR/G}}

Anchors

These templates automatically add anchors. If a shortcut box with the shortcut WB:RFD is placed on the page Wikibooks:Requests for deletion then the link Wikibooks:Requests for deletion#WB:RFD will take you to the position in the page where that shortcut box is placed.

For instance, try this link: #WB:AA

Thus if you make a shortcut for a section of a page then you can use the anchor in the shortcut redirect itself. Like this:

#REDIRECT [[Pagename#WB:RFD]]

See also

  • Help:Shortcuts – 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
  • {{template shortcut}} – Use this one to show the names of shortcuts/redirects to a template.