How do I change the keys for keyboard shortcuts?
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Purpose
The customizations described on this page are outside the scope of Atlassian support. Please see Atlassian Support Offerings for more information.
For when you experience some problems with keyboard shortcuts that could clash with other operating system or application keyboard shortcuts.
The guide below is a workaround to change the keyboard shortcut for a particular function. The aim here is to change the quote shortcut in the editor to ctrl+alt+y:
Resolution
For Confluence 5.0 and above
To change a keyboard shortcut defined by the Keyboard Shortcut plugin
Unjar
<confluence-install>/confluence/WEB-INF/atlassian-bundled-plugins/confluence-keyboard-shortcuts-X.X.X.jarEdit the
atlassian-plugin.xmlChange the shortcut within a keyboard-shortcut block. For example:
1 2 3 4 5 6 7<keyboard-shortcut key="tinymce.blockquote" i18n-name="admin.keyboard.shortcut.tinymce.blockquote" name="Blockquote"> <order>30</order> <description key="tinymce.advanced.blockquote"/> <shortcut>[Ctrl+8]</shortcut> <operation type="execute">FormatBlock-blockquote</operation> <context>tinymce.block</context> </keyboard-shortcut>would be changed to:
1 2 3 4 5 6 7<keyboard-shortcut key="tinymce.blockquote" i18n-name="admin.keyboard.shortcut.tinymce.blockquote" name="Blockquote"> <order>30</order> <description key="tinymce.advanced.blockquote"/> <shortcut>[Ctrl+Alt+Y]</shortcut> <operation type="execute">FormatBlock-blockquote</operation> <context>tinymce.block</context> </keyboard-shortcut>Save the file
Jar the file back to
confluence-keyboard-shortcuts-X.X.X.jarRestart your Confluence instance. Your changes should be reflected after this. You may need to force refresh your browser.
To change a keyboard shortcut defined by a different plugin
Unjar the plugin
Locate either a keyboard-shortcut block in
atlassian-plugin.xmland change as above, or find a Javascript file containing a call to "addShortcut" and change it as described in For Confluence earlier than 5.0.Jar the plugin
For Confluence earlier than 5.0
Unzip the
<confluence-install>/confluence/WEB-INF/classes/com/atlassian/confluence/setup/atlassian-bundled-plugins.zip.Unjar the
confluence-tinymce-plugin-X.X.X.X.jarin theunzipped atlassian-bundled-plugins.zip.Edit the
/tinymce3/plugins/keyboardshortcuts/editor_plugins_src.js.Change the following line in the file from (for example):
1ed.addShortcut('ctrl+alt+q', '', ['FormatBlock', false, 'macro_quote']);to:
1ed.addShortcut('ctrl+alt+y', '', ['FormatBlock', false, 'macro_quote']);Save the file.
Jar the file back to
confluence-tinymce-plugin-X.X.X.X.jar.Zip the
atlassian-bundled-plugins.zip.Restart your Confluence instance. Your changes should be reflected after this. You may need to force refresh your browser.
If you need a guide to help with editing files within JAR archives, you can refer to How to edit files in Confluence JAR files. However, please keep in mind that the Tinymce plugin is a bundled plugin. Therefore it is stored in a certain directory, specifically <confluence-install>/confluence/WEB-INF/classes/com/atlassian/confluence/setup/atlassian-bundled-plugins.zip. If you are following the guide, please make sure the paths are correct.
Was this helpful?