Anonymous
Not logged in
Talk
Contributions
Create account
Log in
Guild of Archivists
Search
Editing
Template:Shortcut/doc
From Guild of Archivists
Namespaces
Template
Discussion
More
More
Page actions
Read
Edit
History
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> {{Template shortcut|Sc|Short}} {{Uses TemplateStyles|Template:Shortcut/styles.css}} {{Lua|Module:Shortcut}} This is the documentation for {{tl|shortcut}} and its sister templates. 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. == 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 self-reference. # Insert the shortcut template. # 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'']]</code> # Verify operation. Note that shortcut templates should display in all capitals, but operate without all capitals. '''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, [[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. For policy pages, one can use the {{tl|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 == {{tl|shortcut}} takes the following parameters: * <code>1</code>, <code>2</code>, <code>3</code>... - the shortcut links. * <code>msg</code> - an unlinked message that goes after the shortcut links. * <code>category</code> - set to "no", "n", "false" or "0" to suppress error categories. == Examples == {| class="wikitable" ! Code ! Result |- | style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|GA:SHORT}} | {{{{BASEPAGENAME}}|GA:SHORT}} |- | style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|GA:POLICY}} | {{{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|GA:POLICY}} |- | style="vertical-align:top;" | {{tlc|{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|4=msg=A message}} | {{{{BASEPAGENAME}}|GA:MOS|GA:GUIDE|msg=A message}} |} == 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: :<code><nowiki>#REDIRECT [[Pagename#GA:SHORT]] </nowiki></code> == 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. * {{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 <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | <!--Categories below this line, please; interwikis at Wikidata--> [[Category:Archive header templates]] }}</includeonly>
Summary:
Please note that all contributions to Guild of Archivists may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
GoArch:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Templates used on this page:
Template:Bulleted list
(
edit
)
Template:Documentation subpage
(
edit
)
Template:Lua
(
edit
)
Template:Mbox
(
edit
)
Template:No redirect
(
edit
)
Template:Shortcut
(
edit
)
Template:Shortcut/styles.css
(
edit
)
Template:Template shortcut
(
edit
)
Template:Tl
(
edit
)
Template:Tlc
(
edit
)
Template:Uses TemplateStyles
(
edit
)
Module:Arguments
(
edit
)
Module:List
(
edit
)
Module:Lua banner
(
edit
)
Module:Message box
(
edit
)
Module:Message box/configuration
(
edit
)
Module:No globals
(
edit
)
Module:Redirect
(
edit
)
Module:Shortcut
(
edit
)
Module:Shortcut/config
(
edit
)
Module:TableTools
(
edit
)
Module:Uses TemplateStyles
(
edit
)
Module:Yesno
(
edit
)
Navigation
Navigation
Main Page
Random page
Categories
All pages
Recent changes
Resources
Dictionaries
Reference material
Utilities
Community
Forums
Jalak Game Directory
Projects
Apocrypha
Unexplored Branches
All projects
Contribute
Stubs
Wanted
Cleanup
Dead ends
Image requested
Help
Help
Guide
Policies
Wiki tools
Wiki tools
Special pages
Page values
Page tools
Page tools
User page tools
More
What links here
Related changes
Page information
Page logs