Actions
Feature #33918
open
Add documentation for #29473
Status:
New
Priority:
Normal
Assignee:
-
Category:
Documentation
Target version:
-
Resolution:
Related issues
Updated by Mischa The Evil about 6 years ago
- Follows Feature #29473: Submit a form with Ctrl+Enter / Command+Return added
Updated by Mischa The Evil about 6 years ago
Especially should be made clear where this feature is and isn't available. All forms? From all active form elements?
Updated by Mizuki ISHIKAWA 21 days ago
I drafted the documentation based on the latest keyboard shortcut information. What do you think?
- Added an "Available in" column to each table to indicate where each shortcut can be used.
- Added several new shortcuts.
- Reorganized the sections to make it easier to distinguish between accesskey shortcuts and non-accesskey shortcuts.
Keyboard Navigation¶
- Table of contents
- Keyboard Navigation
Redmine has two kinds of keyboard shortcuts: accesskeys, which are provided by the browser, and shortcuts that Redmine handles itself and that therefore work the same way in every browser.
Accesskeys¶
Some functions in Redmine can be accessed using accesskeys.
The modifier keys used to trigger an accesskey vary between browsers and operating systems:
| Browser | Windows | macOS | Linux | Comments |
|---|---|---|---|---|
| Chrome | Alt | Ctrl + Option | Alt + Shift | Accesskeys 7 and 4 are not available on Windows and Linux. On Windows, use Alt + Shift instead for the accesskeys e and f. |
| Firefox | Alt + Shift | Ctrl + Option | Alt + Shift | |
| Safari | n/a | Ctrl + Option | n/a | Safari is available on macOS only. |
| Edge | Alt | -- | -- | Accesskey 7 is not available. |
Shortcuts using accesskeys¶
In the table below, <Accesskey> stands for the modifier keys listed above for your browser and operating system.
| Keyboard shortcut | Description | Available in |
|---|---|---|
| <Accesskey> + 7 | Creates a new issue. | Anywhere in a project. |
| <Accesskey> + 4 | Opens the project search view. | Anywhere in a project. |
| <Accesskey> + n | Moves forward. | * issue pages with previous/next issue navigation * paginated lists * activity pages * months in the calendar view * periods in the Gantt view * revisions in the repository |
| <Accesskey> + p | Moves backward. | * issue pages with previous/next issue navigation * paginated lists * activity pages * months in the calendar view * periods in the Gantt view * revisions in the repository |
| <Accesskey> + f | Moves the cursor into the global quick search field. | Pages with the global quick search field in the header bar. |
| <Accesskey> + e | Switches to edit mode. | Issues, wiki pages, news, documents and forum messages. |
Non-accesskey shortcuts¶
The following shortcuts are handled by Redmine itself and therefore work the same way in every browser.
Navigation shortcuts¶
| Keyboard shortcut | Description | Available in |
|---|---|---|
| → | Moves to the next file. | File preview pages. |
| ← | Moves to the previous file. | File preview pages. |
| ↑ / ↓ | Moves through the items. | Project jump box. |
Text editor shortcuts¶
| Keyboard shortcut | Description | Available in |
|---|---|---|
| ⌘ (Mac) / Ctrl + b | Makes the selected text bold. | Text fields with the wiki toolbar. Available in version 4.2 or higher. |
| ⌘ (Mac) / Ctrl + i | Makes the selected text italic. | Text fields with the wiki toolbar. Available in version 4.2 or higher. |
| ⌘ (Mac) / Ctrl + u | Underlines the selected text. | Text fields with the wiki toolbar. Available in version 4.2 or higher. |
| ⌘ (Mac) / Ctrl + Shift + p | Toggles between the Edit and Preview tabs. | Text fields with the wiki toolbar and preview tabs. Available in version 4.2 or higher. |
| ⌘ + Return (Mac) / Ctrl + Enter | Submits the form. | When a textarea inside the form is focused. Available in version 4.2 or higher. |
| Tab / Shift + Tab | Indents or outdents the selected lines by two spaces. | When text is selected in a textarea using CommonMark Markdown formatting. Available in version 7.0 or higher. |
Updated by Takenori TAKAKI about 10 hours ago
The new structure is much easier to follow. I checked the draft against the current trunk and have a few suggestions:
- <Accesskey> + 4: This works on every page, and opens the global search outside projects. Suggestion:
- Description: "Opens the search page."
- Available in: "Anywhere (project search inside a project, global search elsewhere)."
- <Accesskey> + 7: Suggestion for "Available in": "Anywhere in a project where you can add issues, unless "Project menu tab for creating new objects" is set to "none"."
- <Accesskey> + e: On the issue form, wiki edit page and forum message form, it moves the cursor into the text area rather than switching to edit mode. Maybe "Switches to edit mode or moves the cursor into the text area."
- → / ←: This works on both attachment previews and file pages in the repository browser. "Available in version 4.0 or higher." could be added (added in #29395).
- Project jump box: Home / End are also supported in addition to ↑ / ↓. Suggested row:
| Home / End | Moves to the first / last item. | Project jump box. | - Edge row: The "--" entries and the note about accesskey 7 seem to describe the legacy Edge. I tried the current Edge on macOS, and accesskeys 7 and 4 worked, so updating this row might make it more accurate.
Actions