Changes for page XWiki Keyboard Shortcuts

Last modified by Lucas Charpentier (Sereza7) on 2024/02/27

From version 11.2
edited by Eduard Moraru
on 2010/07/14
Change comment: Added comment
To version 12.2
edited by Sergiu Dumitriu
on 2011/01/26
Change comment: Added a missing bold (sample custom shortcut).

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Features.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.enygma
1 +XWiki.Sergiu
Content
... ... @@ -1,70 +1,84 @@
1 +{{velocity}}$xwiki.ssx.use("Features.KeyboardShortcuts"){{/velocity}}
2 +
1 1  {{box cssClass="floatinginfobox" title="**Contents**"}}
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -**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.
7 +**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.
6 6  
7 -= Shortcuts =
9 += Using keyboard shortcuts =
8 8  
9 -== View mode ==
11 +== View Mode ==
10 10  
11 11  {{info}}
12 12  View keyboard shortcuts are only available to advanced users, preventing simple users to get unexpected behavior when pressing keyboard keys by mistake
13 13  {{/info}}
14 14  
15 -=== Edit ===
17 +=== a) Edit Actions ===
16 16  
17 -(% style="width:400px;" %)
18 -|**e** |Edit the page using the default edition mode
19 -|**k** |Edit the page in wiki edition mode
20 -|**g** |Edit the page using the WYSIWYG editor
21 -|**f** |Inline Form
22 -|**r** |Edit page access rights
23 -|**o** |Edit page objects
24 -|**s** |Edit class
19 +(% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate edit actions"%)
20 +| (% class="shortcut" %)((((% class="key"%)E(%%))))(%%) |Edit the page using the default edition mode
21 +| (% class="shortcut" %)((((% class="key"%)K(%%))))(%%) |Edit the page in wiki edition mode
22 +| (% class="shortcut" %)((((% class="key"%)G(%%))))(%%) |Edit the page using the WYSIWYG editor
23 +| (% class="shortcut" %)((((% class="key"%)F(%%))))(%%) |Inline Form
24 +| (% class="shortcut" %)((((% class="key"%)R(%%))))(%%) |Edit page access rights
25 +| (% class="shortcut" %)((((% class="key"%)O(%%))))(%%) |Edit page objects
26 +| (% class="shortcut" %)((((% class="key"%)S(%%))))(%%) |Edit class
25 25  
26 -=== Show ===
28 +=== b) View Actions ===
27 27  
28 -(% style="width:400px;" %)
29 -|**c** |Go to page comments
30 -|**a** |Go to page attachments
31 -|**h** |Go to page history
32 -|**d** |View page wiki code
30 +(% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate view actions"%)
31 +| (% class="shortcut" %)((((% class="key"%)C(%%))))(%%) |Go to page comments
32 +| (% class="shortcut" %)((((% class="key"%)A(%%))))(%%) |Go to page attachments
33 +| (% class="shortcut" %)((((% class="key"%)H(%%))))(%%) |Go to page history
34 +| (% class="shortcut" %)((((% class="key"%)D(%%))))(%%) |View page wiki code
33 33  
34 -=== Actions ===
36 +=== c) Other Actions ===
35 35  
36 -(% style="width:400px;" %)
37 -|**F2** |Rename page
38 -|**Delete** |Delete page
38 +(% class="keyboard" summary="Keyboard Shortcuts for View Mode in order to activate other actions"%)
39 +| (% class="shortcut" %)((((% class="key"%)F2(%%))))(%%) |Rename page
40 +| (% class="shortcut" %)((((% class="key"%)Delete(%%))))(%%) |Delete page
39 39  
40 -== Edit & inline mode ==
42 +== Edit Wiki & Edit Inline Mode ==
41 41  
42 42  {{warning}}
43 43  Keyboard shortcuts aren't available from the wysiwyg edit mode (since the wysiwyg editor grabs all the key pressed events)
44 44  {{/warning}}
45 45  
46 -(% style="width:400px;" %)
47 -|**<Alt> + c** |Cancel edition
48 -|**<Alt> + p** |Preview the page without saving
49 -|**<Alt> + <Shift> + s** |Save and continue to edit the page
50 -|**<Alt> + s** |Save and view the page
48 +(% class="keyboard" summary="Keyboard Shortcuts for Edit Wiki and Inline Mode" %)
49 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)C(%%))))(%%) |Cancel edition
50 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)P(%%))))(%%) |Preview the page without saving
51 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)Shift(%%) + (% class="key"%)S(%%))))(%%) |Save and continue to edit the page
52 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)S(%%))))(%%) |Save and view the page
51 51  
52 -== Preview mode ==
54 +== Edit WYSIWYG Mode ==
53 53  
54 -(% style="width:400px;" %)
55 -|**<Alt> + c** |Cancel edition
56 -|**<Alt> + b** |Back to the edition
57 -|**<Alt> + <Shift> + s** |Save and continue to edit the page
58 -|**<Alt> + s** |Save and view the page
56 +{{include document="WysiwygEditorShortcuts"/}}
59 59  
58 +== Preview Mode ==
59 +
60 +(% class="keyboard" summary="Keyboard Shortcuts for Preview Mode" %)
61 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)C(%%))))(%%) |Cancel edition
62 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)B(%%))))(%%) |Back to the edition
63 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)Shift(%%) + (% class="key"%)S(%%))))(%%) |Save and continue to edit the page
64 +| (% class="shortcut" %)((((% class="key"%)Alt(%%) + (% class="key"%)S(%%))))(%%) |Save and view the page
65 +
60 60  == Annotations ==
61 61  
62 -(% style="width:400px;" %)
63 -|**<Ctrl> + m** |Annotate a piece of text
68 +(% class="keyboard" summary="Keyboard Shortcuts for Annotations" %)
69 +| (% class="shortcut" %)((((% class="key"%)Ctrl(%%) + (% class="key"%)M(%%))))(%%) |Annotate a piece of text
64 64  
65 -= Modifying keyboard shortcuts =
71 +== Navigation ==
66 66  
73 +(% class="keyboard" summary="Keyboard Shortcuts for Navigation" %)
74 +| (% class="shortcut" %)((((% class="key"%)Ctrl(%%) + (% class="key"%)G(%%))))(%%) (% class="separator"%)or(%%) (% class="shortcut" %)((((% class="key"%)Meta(%%) + (% class="key"%)G(%%))))(%%)|Jump to any page in the wiki
75 +
76 += Configuring keyboard shortcuts =
77 +
78 +== Modifying keyboard shortcuts ==
79 +
67 67  * Create a new page in your wiki, for example //XWiki.KeyboardShortcuts// and paste the following content inside:
81 +
68 68  {{code}}core.shortcuts.view.edit=e
69 69  core.shortcuts.view.wiki=k
70 70  core.shortcuts.view.wysiwyg=g
... ... @@ -87,9 +87,9 @@
87 87  * Modify entries in this list at your convenience
88 88  * Save the page
89 89  * Go to the wiki administration into the "//Programming//" category
90 -* At the bottom, add //XWiki.KeyboardShortcuts// to the "//Internationalization Document Bundles//" list
104 +* At the bottom, add //XWiki.KeyboardShortcuts// to the "//Internationalization Document Bundles//" list
91 91  
92 -= Adding your own shortcuts =
106 +== Adding your own shortcuts ==
93 93  
94 94  You can add your own keyboard shortcuts in a few javascript lines :
95 95  
... ... @@ -107,11 +107,11 @@
107 107  </script>
108 108  {{/html}}
109 109  
110 -Try the snippet by pressing Ctrl+Alt+n.
124 +Try the snippet by pressing **(% class="key"%)Ctrl(%%)** + **(% class="key"%)Alt(%%)** + **(% class="key"%)n(%%)**.
111 111  
112 -[[Complete documentation>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].
126 +Also check the [[complete documentation>>http://www.openjs.com/scripts/events/keyboard_shortcuts/]].
113 113  
114 -= Removing shortcuts =
128 +== Removing keyboard shortcuts ==
115 115  
116 116  To remove a shortcut adapt this snippet to your needs :
117 117  
... ... @@ -132,7 +132,7 @@
132 132  <a onclick="removeCtrlAltN(); return false;" href="#">Click here to try the snippet, it will remove the Ctrl+Alt+n shortcut</a>.
133 133  {{/html}}
134 134  
135 -= Removing all shortcuts at once =
149 +== Removing all shortcuts at once ==
136 136  
137 137  {{code language="html"}}
138 138  <script type="text/javascript">
... ... @@ -161,6 +161,6 @@
161 161  #end
162 162  {{/velocity}}
163 163  
164 -= Credits =
178 +== Credits ==
165 165  
166 166  XWiki keyboard shortcuts are powered by [[openjs.org shortcut library>>http://www.openjs.com/scripts/events/keyboard_shortcuts]].
XWiki.XWikiComments[0]
Date
... ... @@ -1,1 +1,1 @@
1 -2010-07-14 15:51:27.144
1 +2010-07-14 15:51:27.0
XWiki.XWikiComments[1]
Date
... ... @@ -1,1 +1,1 @@
1 -2010-07-14 16:45:42.127
1 +2010-07-14 16:45:42.0
XWiki.StyleSheetExtension[0]
Caching policy
... ... @@ -1,0 +1,1 @@
1 +long
Code
... ... @@ -1,0 +1,38 @@
1 +.keyboard td {
2 + border: none;
3 + line-height: 2em;
4 + vertical-align: top;
5 +}
6 +
7 +.keyboard .description {
8 + line-height: 1.4em;
9 + max-width: 50em;
10 + *width: 50em; /* IE7 */
11 +}
12 +
13 +.keyboard .shortcut {
14 + display: inline-block;
15 + *display: inline; /* IE7 */
16 + font-weight: bold;
17 + white-space: nowrap;
18 +}
19 +
20 +.keyboard .shortcut p {
21 + *display: inline; /* IE7 */
22 +}
23 +
24 +.key {
25 + -moz-border-radius: 5px;
26 + -webkit-border-radius: 5px;
27 + border-radius: 5px;
28 + background-color: #fafafa;
29 + background: -moz-linear-gradient(270deg , #fff 70%, #EFEFEF) repeat scroll 0 0 transparent;
30 + *background-color: #fafafa;
31 + border: 1px solid #ddd;
32 + display: inline-block;
33 + *display: inline; /* IE7 */
34 + min-width: 10px;
35 + padding: 4px 8px;
36 + *line-height: 2em; /* IE6 */
37 + text-align: center;
38 +}
Name
... ... @@ -1,0 +1,1 @@
1 +Keyboard Shortcuts Style
Use this extension
... ... @@ -1,0 +1,1 @@
1 +currentPage

Get Connected