View source for Manual:Access keys

{{draft}}
'''Access keys''' or '''keyboard shortcuts''' are defined for many actions in MediaWiki. This page documents all access keys in use, and details the ways in which developers can add them to MediaWiki core and extensions. End user help is at {{ll|Help:Keyboard shortcuts}}.

Access keys are invoked with different modifier keys on different operating systems and web browsers. The [[Wikipedia:Access key]] page lists all combinations. MediaWiki will add tooltips where it can to help users discover what access keys are available for a given action (including platform-specific modifiers).

== Defining an access key ==

Defining an access key is usually done via the <code>accesskey=""</code> HTML attribute, and in some cases (e.g. in [[VisualEditor/Portal/Keyboard_shortcuts|VisualEditor]]) is done with custom keypress handling.

The key used should not be hard-coded, but should be added as a {{Manual|Messages API|system message}}. The message should start with <code>accesskey-''extname''-</code> and its message documentation in <code>qqq.json</code> should include the <code><nowiki>{{doc-accesskey}}</nowiki></code> template from [[Translatewiki.net]]. Acccess key messages should also be listed in TranslateWiki's {{Git file|file=groups/MediaWiki/MediaWiki.yaml|project=translatewiki}} file (for example, {{gerrit|780284}}).

All access keys should be recorded on this page (see below), to make it easier for developers to choose new available access keys.

=== JavaScript ===

To create a button with an access key the following code could be used:

{{code|lang=js|1=
var myButton = new OO.ui.ButtonWidget( {
	label: mw.msg( 'myext-myaction' ),
	accessKey: mw.msg( 'accesskey-myext-myaction' ),
	title: mw.msg( 'myext-myaction-title' )
} );
}}

Note that when using OOUI, it's worth adding a title to any [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/OO.ui.mixin.AccessKeyedElement AccessKeyedElement] because this results in the access key be appended to the title/tooltip and so is more discoverable by users.

=== PHP ===

The <code>Linker::{{Method doclink|class=Linker|method=tooltipAndAccesskeyAttribs()|anchor=af1f9dd972b0d5c35d12dd7ae8d6107e0}}</code> method should be used when constructing links with access keys. For example:

{{codesample|lang=json|name=en.json|1=
"accesskey-myext-myaction": "{{doc-accesskey}}",
"tooltip-myext-myaction": "Tooltip for my action",
"myext-myaction": "Link text for my action",
}}

{{codesample|lang=json|name=qqq.json|1=
"accesskey-myext-myaction": "a",
"tooltip-myext-myaction": "This is my action",
"myext-myaction": "My Action",
}}

{{codesample|lang=php|name=Foo.php|1=
$link = \Html::element(
	'a',
	\Linker::tooltipAndAccesskeyAttribs( 'myext-myaction' ),
	wfMessage( 'myext-myaction' )
);
}}

This will result in the following HTML:

{{codesample|lang=html|1=
<a title="This is my action [a]" accesskey="a">My Action</a>"
}}

In JavaScript-enabled browsers, the <code>[a]</code> will be dynamically updated (to e.g. <code>[Ctrl-Shift-a]</code>) by [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/jQuery.plugin.accessKeyLabel-method-updateTooltipAccessKeys updateTooltipAccessKeys()] to include the correct modifier keys depending on the user's browser and operating system.

== MediaWiki core ==

{|class="wikitable sortable"
! Message !! Access key !! Usage
|-
| accesskey-pt-userpage
| .
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-userpage Codesearch]
|-
| accesskey-pt-anonuserpage
| .
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-anonuserpage Codesearch]
|-
| accesskey-pt-mytalk
| n
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-mytalk Codesearch]
|-
| accesskey-pt-anontalk
| n
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-anontalk Codesearch]
|-
| accesskey-pt-preferences
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-preferences Codesearch]
|-
| accesskey-pt-watchlist
| l
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-watchlist Codesearch]
|-
| accesskey-pt-mycontris
| y
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-mycontris Codesearch]
|-
| accesskey-pt-anoncontribs
| y
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-anoncontribs Codesearch]
|-
| accesskey-pt-login
| o
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-login Codesearch]
|-
| accesskey-pt-login-private
| o
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-login-private Codesearch]
|-
| accesskey-pt-logout
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-logout Codesearch]
|-
| accesskey-pt-createaccount
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-pt-createaccount Codesearch]
|-
| accesskey-ca-view
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-view Codesearch]
|-
| accesskey-ca-talk
| t
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-talk Codesearch]
|-
| accesskey-ca-edit
| e
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-edit Codesearch]
|-
| accesskey-ca-addsection
| +
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-addsection Codesearch]
|-
| accesskey-ca-viewsource
| e
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-viewsource Codesearch]
|-
| accesskey-ca-history
| h
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-history Codesearch]
|-
| accesskey-ca-protect
| =
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-protect Codesearch]
|-
| accesskey-ca-unprotect
| =
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-unprotect Codesearch]
|-
| accesskey-ca-delete
| d
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-delete Codesearch]
|-
| accesskey-ca-undelete
| d
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-undelete Codesearch]
|-
| accesskey-ca-move
| m
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-move Codesearch]
|-
| accesskey-ca-watch
| w
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-watch Codesearch]
|-
| accesskey-ca-unwatch
| w
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-unwatch Codesearch]
|-
| accesskey-search
| f
| [https://codesearch.wmcloud.org/search/?q=accesskey-search Codesearch]
|-
| accesskey-search-go
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-search-go Codesearch]
|-
| accesskey-search-fulltext
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-search-fulltext Codesearch]
|-
| accesskey-p-logo
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-p-logo Codesearch]
|-
| accesskey-n-help-mediawiki
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-help-mediawiki Codesearch]
|-
| accesskey-n-mainpage
| z
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-mainpage Codesearch]
|-
| accesskey-n-mainpage-description
| z
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-mainpage-description Codesearch]
|-
| accesskey-n-portal
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-portal Codesearch]
|-
| accesskey-n-currentevents
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-currentevents Codesearch]
|-
| accesskey-n-recentchanges
| r
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-recentchanges Codesearch]
|-
| accesskey-n-randompage
| x
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-randompage Codesearch]
|-
| accesskey-n-help
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-n-help Codesearch]
|-
| accesskey-t-whatlinkshere
| j
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-whatlinkshere Codesearch]
|-
| accesskey-t-recentchangeslinked
| k
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-recentchangeslinked Codesearch]
|-
| accesskey-feed-rss
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-feed-rss Codesearch]
|-
| accesskey-feed-atom
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-feed-atom Codesearch]
|-
| accesskey-t-contributions
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-contributions Codesearch]
|-
| accesskey-t-emailuser
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-emailuser Codesearch]
|-
| accesskey-t-info
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-info Codesearch]
|-
| accesskey-t-permalink
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-permalink Codesearch]
|-
| accesskey-t-print
| p
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-print Codesearch]
|-
| accesskey-t-upload
| u
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-upload Codesearch]
|-
| accesskey-t-specialpages
| q
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-specialpages Codesearch]
|-
| accesskey-ca-nstab
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab Codesearch]
|-
| accesskey-ca-nstab-main
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-main Codesearch]
|-
| accesskey-ca-nstab-user
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-user Codesearch]
|-
| accesskey-ca-nstab-media
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-media Codesearch]
|-
| accesskey-ca-nstab-special
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-special Codesearch]
|-
| accesskey-ca-nstab-project
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-project Codesearch]
|-
| accesskey-ca-nstab-image
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-image Codesearch]
|-
| accesskey-ca-nstab-mediawiki
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-mediawiki Codesearch]
|-
| accesskey-ca-nstab-template
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-template Codesearch]
|-
| accesskey-ca-nstab-help
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-help Codesearch]
|-
| accesskey-ca-nstab-category
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-nstab-category Codesearch]
|-
| accesskey-minoredit
| i
| [https://codesearch.wmcloud.org/search/?q=accesskey-minoredit Codesearch]
|-
| accesskey-save
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-save Codesearch]
|-
| accesskey-publish
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-publish Codesearch]
|-
| accesskey-preview
| p
| [https://codesearch.wmcloud.org/search/?q=accesskey-preview Codesearch]
|-
| accesskey-diff
| v
| [https://codesearch.wmcloud.org/search/?q=accesskey-diff Codesearch]
|-
| accesskey-compareselectedversions
| v
| [https://codesearch.wmcloud.org/search/?q=accesskey-compareselectedversions Codesearch]
|-
| accesskey-watch
| w
| [https://codesearch.wmcloud.org/search/?q=accesskey-watch Codesearch]
|-
| accesskey-watchlist-expiry
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-watchlist-expiry Codesearch]
|-
| accesskey-upload
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-upload Codesearch]
|-
| accesskey-preferences-save
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-preferences-save Codesearch]
|-
| accesskey-summary
| b
| [https://codesearch.wmcloud.org/search/?q=accesskey-summary Codesearch]
|-
| accesskey-userrights-set
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-userrights-set Codesearch]
|-
| accesskey-blockip-block
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-blockip-block Codesearch]
|-
| accesskey-export
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-export Codesearch]
|-
| accesskey-import
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-import Codesearch]
|-
| accesskey-watchlistedit-normal-submit
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-watchlistedit-normal-submit Codesearch]
|-
| accesskey-watchlistedit-raw-submit
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-watchlistedit-raw-submit Codesearch]
|}

== Extensions ==

{| class="wikitable sortable"
|-
! Extension
! Message name
! Access key
! Usages
|-
| [[mw:Extension:CiteThisPage|CiteThisPage]]
| accesskey-citethispage
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-citethispage Codesearch]
|-
| [[mw:Extension:Drafts|Drafts]]
| accesskey-drafts-save
| g
| [https://codesearch.wmcloud.org/search/?q=accesskey-drafts-save Codesearch]
|-
| [[mw:Extension:EducationProgram|EducationProgram]]
| accesskey-ep-form-save
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-ep-form-save Codesearch]
|-
| [[mw:Extension:EducationProgram|EducationProgram]]
| accesskey-ep-edit-institution
| e
| [https://codesearch.wmcloud.org/search/?q=accesskey-ep-edit-institution Codesearch]
|-
| [[mw:Extension:EducationProgram|EducationProgram]]
| accesskey-ep-edit-course
| e
| [https://codesearch.wmcloud.org/search/?q=accesskey-ep-edit-course Codesearch]
|-
| [[mw:Extension:EducationProgram|EducationProgram]]
| accesskey-ep-summary
| b
| [https://codesearch.wmcloud.org/search/?q=accesskey-ep-summary Codesearch]
|-
| [[mw:Extension:EducationProgram|EducationProgram]]
| accesskey-ep-minor
| i
| [https://codesearch.wmcloud.org/search/?q=accesskey-ep-minor Codesearch]
|-
| [[mw:Extension:MediaUploader|MediaUploader]]
| accesskey-save-upload-campaign
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-save-upload-campaign Codesearch]
|-
| [[mw:Extension:MediaUploader|MediaUploader]]
| accesskey-cancel-upload-campaign
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-cancel-upload-campaign Codesearch]
|-
| [[mw:Extension:PageForms|PageForms]]
| accesskey-ca-formedit
| &
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-formedit Codesearch]
|-
| [[mw:Extension:TweetANew|TweetANew]]
| tweetanew-accesskey
| e
| [https://codesearch.wmcloud.org/search/?q=tweetanew-accesskey Codesearch]
|-
| [[mw:Extension:UploadWizard|UploadWizard]]
| accesskey-save-upload-campaign
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-save-upload-campaign Codesearch]
|-
| [[mw:Extension:UploadWizard|UploadWizard]]
| accesskey-cancel-upload-campaign
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-cancel-upload-campaign Codesearch]
|-
| [[mw:Extension:WatchSubpages|WatchSubpages]]
| accesskey-watchsubpages-submit
| s
| [https://codesearch.wmcloud.org/search/?q=accesskey-watchsubpages-submit Codesearch]
|-
| [[mw:Extension:WikiEditor|WikiEditor]]
| accesskey-wikieditor-realtimepreview
| )
| [https://codesearch.wmcloud.org/search/?q=accesskey-wikieditor-realtimepreview Codesearch]
|-
| [[mw:Extension:Wikibase|Wikibase]]
| accesskey-t-wikibase
| g
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-wikibase Codesearch]
|-
| [[mw:Extension:FlaggedRevs|FlaggedRevs]]
| accesskey-ca-current
| v
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-current Codesearch]
|-
| [[mw:Extension:FlaggedRevs|FlaggedRevs]]
| accesskey-ca-stable
| c
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-stable Codesearch]
|-
| [[mw:Extension:VisualEditor|VisualEditor]]
| accesskey-ca-editsource
| e
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-editsource Codesearch]
|-
| [[mw:Extension:VisualEditor|VisualEditor]]
| accesskey-ca-ve-edit
| v
| [https://codesearch.wmcloud.org/search/?q=accesskey-ca-ve-edit Codesearch]
|-
| [[mw:Extension:ListTransclusions|ListTransclusions]]
| accesskey-t-listtransclusions
| 
| [https://codesearch.wmcloud.org/search/?q=accesskey-t-listtransclusions Codesearch]
|}

== See also ==

* [[Wikipedia:Access key]] — General information, including how to use them on different browsers.
* [[TranslateWiki:Template:Doc-accesskey]] — All access keys should use this template in their qqq.json documentation.

[[Category:Manual]]