Skip to Content

Wiki source code of XWiki Keyboard Shortcuts

Version 12.5 by Manuel Smeria on 2012/11/30
Show last authors
1 {{velocity}}
2 $xwiki.ssx.use("Features.KeyboardShortcuts")
3 {{/velocity}}
4
5 {{box cssClass="floatinginfobox" title="**Contents**"}}
6 {{toc/}}
7 {{/box}}
8
9 **Since XWiki Enterprise version 1.4M1**, you can use keyboard shortcuts to use some XWiki features. Keyboard shortcuts help you save time since you never have to take your hands off the keyboard to use the mouse.
10
11 = Using keyboard shortcuts =
12
13 == View Mode ==
14
15 {{info}}
16 View keyboard shortcuts are only available to advanced users, preventing simple users to get unexpected behavior when pressing keyboard keys by mistake
17 {{/info}}
18
19 === a) Edit Actions ===
20
21 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate edit actions" %)
22 | (% class="shortcut" %)
23 (((
24 (% class="key" %)E
25 ))) |Edit the page using the default edition mode
26 | (% class="shortcut" %)
27 (((
28 (% class="key" %)K
29 ))) |Edit the page in wiki edition mode
30 | (% class="shortcut" %)
31 (((
32 (% class="key" %)G
33 ))) |Edit the page using the WYSIWYG editor
34 | (% class="shortcut" %)
35 (((
36 (% class="key" %)F
37 ))) |Inline Form
38 | (% class="shortcut" %)
39 (((
40 (% class="key" %)R
41 ))) |Edit page access rights
42 | (% class="shortcut" %)
43 (((
44 (% class="key" %)O
45 ))) |Edit page objects
46 | (% class="shortcut" %)
47 (((
48 (% class="key" %)S
49 ))) |Edit class
50
51 === b) View Actions ===
52
53 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate view actions" %)
54 | (% class="shortcut" %)
55 (((
56 (% class="key" %)C
57 ))) |Go to page comments
58 | (% class="shortcut" %)
59 (((
60 (% class="key" %)A
61 ))) |Go to page attachments
62 | (% class="shortcut" %)
63 (((
64 (% class="key" %)H
65 ))) |Go to page history
66 | (% class="shortcut" %)
67 (((
68 (% class="key" %)D
69 ))) |View page wiki code
70
71 === c) Other Actions ===
72
73 (% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate other actions" %)
74 | (% class="shortcut" %)
75 (((
76 (% class="key" %)F2
77 ))) |Rename page
78 | (% class="shortcut" %)
79 (((
80 (% class="key" %)Delete
81 ))) |Delete page
82
83 == Edit Wiki & Edit Inline Mode ==
84
85 {{warning}}
86 While in Inline Edit mode and focusing on a WYSIWYG edit area, the keyboard shortcuts listed below won't work since the WYSIWYG editor grabs all the key pressed events.
87 {{/warning}}
88
89 (% class="keyboard" summary="Keyboard Shortcuts for Edit Wiki and Inline Mode" %)
90 | (% class="shortcut" %)
91 (((
92 (% class="key" %)Alt(%%) + (% class="key" %)C
93 )))|Cancel edition
94 | (% class="shortcut" %)
95 (((
96 (% class="key" %)Alt(%%) + (% class="key" %)P
97 )))|Preview the page without saving
98 | (% class="shortcut" %)
99 (((
100 (% class="key" %)Alt(%%) + (% class="key" %)Shift(%%) + (% class="key" %)S
101 )))|Save and continue to edit the page
102 | (% class="shortcut" %)
103 (((
104 (% class="key" %)Alt(%%) + (% class="key" %)S
105 )))|Save and view the page
106
107 == Edit WYSIWYG Mode ==
108
109 {{include document="WysiwygEditorShortcuts"/}}
110
111 == Preview Mode ==
112
113 (% class="keyboard" summary="Keyboard Shortcuts for Preview Mode" %)
114 | (% class="shortcut" %)
115 (((
116 (% class="key" %)Alt(%%) + (% class="key" %)C
117 ))) |Cancel edition
118 | (% class="shortcut" %)
119 (((
120 (% class="key" %)Alt(%%) + (% class="key" %)B
121 ))) |Back to the edition
122 | (% class="shortcut" %)
123 (((
124 (% class="key" %)Alt(%%) + (% class="key" %)Shift(%%) + (% class="key" %)S
125 ))) |Save and continue to edit the page
126 | (% class="shortcut" %)
127 (((
128 (% class="key" %)Alt(%%) + (% class="key" %)S
129 ))) |Save and view the page
130
131 == Annotations ==
132
133 (% class="keyboard" summary="Keyboard Shortcuts for Annotations" %)
134 | (% class="shortcut" %)
135 (((
136 (% class="key" %)Ctrl(%%) + (% class="key" %)M
137 ))) |Annotate a piece of text
138
139 == Navigation ==
140
141 (% class="keyboard" summary="Keyboard Shortcuts for Navigation" %)
142 | (% class="shortcut" %)
143 (((
144 (% class="key" %)Ctrl(%%) + (% class="key" %)G
145 ))) (% class="separator" %)or(%%) (% class="shortcut" %)
146 (((
147 (% class="key" %)Meta(%%) + (% class="key" %)G
148 )))|Jump to any page in the wiki
149
150 = Configuring keyboard shortcuts =
151
152 == Modifying keyboard shortcuts ==
153
154 * Create a new page in your wiki, for example //XWiki.KeyboardShortcuts// and paste the following content inside:(((
155 {{code}}
156 core.shortcuts.view.edit=e
157 core.shortcuts.view.wiki=k
158 core.shortcuts.view.wysiwyg=g
159 core.shortcuts.view.inline=f
160 core.shortcuts.view.rights=r
161 core.shortcuts.view.objects=o
162 core.shortcuts.view.class=s
163 core.shortcuts.view.comments=c
164 core.shortcuts.view.attachments=a
165 core.shortcuts.view.history=h
166 core.shortcuts.view.information=i
167 core.shortcuts.view.code=d
168 core.shortcuts.view.delete=Delete
169 core.shortcuts.view.rename=F2
170 core.shortcuts.edit.cancel=Alt+C
171 core.shortcuts.edit.backtoedit=Alt+B
172 core.shortcuts.edit.preview=Alt+P
173 core.shortcuts.edit.saveandcontinue=Alt+Shift+S
174 core.shortcuts.edit.saveandview=Alt+S
175 {{/code}}
176 )))
177 * Modify entries in this list at your convenience
178 * Save the page
179 * Go to the wiki administration into the "//Programming//" category
180 * At the bottom, add //XWiki.KeyboardShortcuts// to the "//Internationalization Document Bundles//" list
181
182 == Adding your own shortcuts ==
183
184 You can add your own keyboard shortcuts in a few javascript lines :
185
186 {{code language="html"}}
187 <script type="text/javascript">
188 //<![CDATA[
189 shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); });
190 //]]>
191 </script>
192 {{/code}}
193
194 {{html clean="false"}}
195 <script type="text/javascript">
196 shortcut.add("Ctrl+Alt+n", function() { alert("Hey there! Congratulations on typing this one ;)"); }, {'propagate':false} );
197 </script>
198 {{/html}}
199
200 Try the snippet by pressing (% class="key" %)**Ctrl**(%%) + (% class="key" %)**Alt**(%%) + (% class="key" %)**n**(%%).
201
202 Also check the [[complete documentation>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].
203
204 == Removing keyboard shortcuts ==
205
206 To remove a shortcut adapt this snippet to your needs :
207
208 {{code language="html"}}
209 <script type="text/javascript">
210 //<![CDATA[
211 shortcut.remove("Ctrl+Alt+n");
212 //]]>
213 </script>
214 {{/code}}
215
216 {{html clean="false"}}
217 <script type="text/javascript">
218 function removeCtrlAltN() {
219 shortcut.remove("Ctrl+Alt+n");
220 }
221 </script>
222 <a onclick="removeCtrlAltN(); return false;" href="#">Click here to try the snippet, it will remove the Ctrl+Alt+n shortcut</a>.
223 {{/html}}
224
225 == Removing all shortcuts at once ==
226
227 {{code language="html"}}
228 <script type="text/javascript">
229 //<![CDATA[
230 for (binding in shortcut.all_shortcuts) {
231 shortcut.remove(binding);
232 }
233 //]]>
234 </script>
235 {{/code}}
236
237 {{velocity}}
238 #if (!$isGuest && $isAdvancedUser)
239 {{html clean="false"}}
240 <script type="text/javascript">
241 //<![CDATA[
242 function removeAll() {
243 for (binding in shortcut.all_shortcuts) {
244 shortcut.remove(binding);
245 }
246 }
247 //]]>
248 </script>
249 <a onclick="removeAll(); return false;" href="#">Click here to try the snippet, it will disable all keyboard shortcuts</a>.
250 {{/html}}
251 #end
252 {{/velocity}}
253
254 == Credits ==
255
256 XWiki keyboard shortcuts are powered by [[openjs.com shortcut library>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected