XWiki Keyboard Shortcuts

Last modified by Eleni Cojocariu on 2026/06/02 15:58

Using keyboard shortcuts

See Keyboard Shortcuts Available when Viewing a Page (for Users).
See Keyboard Shortcuts Available when Viewing a Page (for Administrators).

Edit Mode

See Keyboard Shortcuts Available when Editing a Page

Preview Mode

See Keyboard Shortcuts Available when Previewing a Page.

Annotations

See Keyboard Shortcuts Available when Viewing a Page (for Users).

Navigation

See Keyboard Shortcuts for Navigation.

Developer shortcuts

See Global Keyboard Shortcuts.

Configuring keyboard shortcuts

Modifying keyboard shortcuts

  • Create a new page in your wiki, for example XWiki.KeyboardShortcuts and paste the following content inside:
    core.shortcuts.view.edit=e
    core.shortcuts.view.wiki=k
    core.shortcuts.view.wysiwyg=g
    core.shortcuts.view.inline=f
    core.shortcuts.view.rights=r
    core.shortcuts.view.objects=o
    core.shortcuts.view.class=s
    core.shortcuts.view.comments=c
    core.shortcuts.view.attachments=a
    core.shortcuts.view.history=h
    core.shortcuts.view.information=i
    core.shortcuts.view.code=d
    core.shortcuts.view.annotations=n
    core.shortcuts.view.delete=Delete
    core.shortcuts.view.rename=F2
    core.shortcuts.edit.cancel=Alt+C
    core.shortcuts.edit.backtoedit=Alt+B
    core.shortcuts.edit.preview=Alt+P
    core.shortcuts.edit.saveandcontinue=Alt+Shift+S
    core.shortcuts.edit.saveandview=Alt+S
  • Modify entries in this list at your convenience
  • Save the page
  • Edit the page in object mode and add an  XWiki.TranslationDocumentClass xobject
    • Select the wiki scope for the new translations (i.e. the new keyboard shortcuts) to apply to the whole wiki. WarningYou'll need to have Admin permissions for it to work

Adding your own shortcuts

You can add your own keyboard shortcuts in a few javascript lines. You can do that, for example, by adding a JavaScript StyleSheet Extension and putting the following content:

shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); });

Also check the complete documentation.

Removing keyboard shortcuts

To remove a shortcut adapt the following snippet to your needs and use by putting it in a JavaScript StyleSheet Extension:

shortcut.remove("Ctrl+Alt+n");

Removing all shortcuts at once

for (binding in shortcut.all_shortcuts()) {
  shortcut.remove(binding.keys.join(' '));
}

Credits

XWiki keyboard shortcuts are powered by Keypress JS shortcut library.

Get Connected