[GSoC'24] Keyboard Shortcuts Customization, Documentation #8345
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe document has been revised to improve the organization and clarity of keyboard and mouse shortcuts in the CVAT application. It now categorizes shortcuts, introduces a customization section with instructions, and enhances navigation through a refined layout. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
bsekachev
reviewed
Aug 29, 2024
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (9)
site/content/en/images/shortcuts01.pngis excluded by!**/*.pngsite/content/en/images/shortcuts02.pngis excluded by!**/*.pngsite/content/en/images/shortcuts03.pngis excluded by!**/*.pngsite/content/en/images/shortcuts04.pngis excluded by!**/*.pngsite/content/en/images/shortcuts05.pngis excluded by!**/*.pngsite/content/en/images/shortcuts06.pngis excluded by!**/*.pngsite/content/en/images/shortcuts07.pngis excluded by!**/*.pngsite/content/en/images/shortcuts08.pngis excluded by!**/*.pngsite/content/en/images/shortcuts09.pngis excluded by!**/*.png
Files selected for processing (1)
- site/content/en/docs/manual/advanced/shortcuts.md (1 hunks)
Additional context used
LanguageTool
site/content/en/docs/manual/advanced/shortcuts.md
[style] ~40-~40: In American English, abbreviations like “etc.” require a period.
Context: ...tching tabs) or ctrl + w (closing tabs) etc, are reserved by the browser and shortc...(ETC_PERIOD)
[uncategorized] ~54-~54: Possible missing comma found.
Context: ... - If pressed cancel it will remain the same otherwise the conflicting shortcut will...(AI_HYDRA_LEO_MISSING_COMMA)
Additional comments not posted (1)
site/content/en/docs/manual/advanced/shortcuts.md (1)
5-5: Approved: Updated description.The updated description accurately reflects the customizable nature of the shortcuts, aligning with the PR's objectives.
Comment on lines
8
to
58
| | `Space` | Start/stop automatic changing frames | | ||
| | `` ` `` or `~` | Focus on the element to change the current frame | | ||
| | | _Modes_ | | ||
| | `N` | Repeat the latest procedure of drawing with the same parameters | | ||
| | `M` | Activate or deactivate mode to merging shapes | | ||
| | `Alt+M` | Activate or deactivate mode to splitting shapes | | ||
| | `G` | Activate or deactivate mode to grouping shapes | | ||
| | `Shift+G` | Reset group for selected shapes (in group mode) | | ||
| | `Esc` | Cancel any active canvas mode | | ||
| | | _Image operations_ | | ||
| | `Ctrl+R` | Change image angle (add 90 degrees) | | ||
| | `Ctrl+Shift+R` | Change image angle (subtract 90 degrees) | | ||
| | | _Operations with objects_ | | ||
| | `Ctrl` | Switch automatic bordering for polygons and polylines during drawing/editing | | ||
| | Hold `Ctrl` | When the shape is active and fix it | | ||
| | `Alt+Click` on point | Deleting a point (used when hovering over a point of polygon, polyline, points) | | ||
| | `Shift+Click` on point | Editing a shape (used when hovering over a point of polygon, polyline or points) | | ||
| | `Right-Click` on shape | Display of an object element from objects sidebar | | ||
| | `T+L` | Change locked state for all objects in the sidebar | | ||
| | `L` | Change locked state for an active object | | ||
| | `T+H` | Change hidden state for objects in the sidebar | | ||
| | `H` | Change hidden state for an active object | | ||
| | `Q` or `/` | Change occluded property for an active object | | ||
| | `Del` or `Shift+Del` | Delete an active object. Use shift to force delete of locked objects | | ||
| | `-` or `_` | Put an active object "farther" from the user (decrease z axis value) | | ||
| | `+` or `=` | Put an active object "closer" to the user (increase z axis value) | | ||
| | `Ctrl+C` | Copy shape to CVAT internal clipboard | | ||
| | `Ctrl+V` | Paste a shape from internal CVAT clipboard | | ||
| | Hold `Ctrl` while pasting | When pasting shape from the buffer for multiple pasting. | | ||
| | `Ctrl+B` | Make a copy of the object on the following frames | | ||
| | `Ctrl+(0..9)` | Changes a label for an activated object or for the next drawn object if no objects are activated | | ||
| | | _Operations are available only for track_ | | ||
| | `K` | Change keyframe property for an active track | | ||
| | `O` | Change outside property for an active track | | ||
| | `R` | Go to the next keyframe of an active track | | ||
| | `E` | Go to the previous keyframe of an active track | | ||
| | | _Attribute annotation mode_ | | ||
| | `Up Arrow` | Go to the next attribute (up) | | ||
| | `Down Arrow` | Go to the next attribute (down) | | ||
| | `Tab` | Go to the next annotated object in current frame | | ||
| | `Shift+Tab` | Go to the previous annotated object in current frame | | ||
| | `<number>` | Assign a corresponding value to the current attribute | | ||
| | | _Standard 3d mode_ | | ||
| | `Shift+Up Arrow` | Increases camera roll angle | | ||
| | `Shift+Down Arrow` | Decreases camera roll angle | | ||
| | `Shift+Left Arrow` | Decreases camera pitch angle | | ||
| | `Shift+Right Arrow` | Increases camera pitch angle | | ||
| | `Alt+O` | Move the camera up | | ||
| | `Alt+U` | Move the camera down | | ||
| | `Alt+J` | Move the camera left | | ||
| | `Alt+L` | Move the camera right | | ||
| | `Alt+I` | Performs zoom in | | ||
| | `Alt+K` | Performs zoom out | | ||
| These shortcuts are organized by scopes. Some are global, meaning they work across the entire application, while others are specific to certain sections or workspaces. This setup allows for shortcut reuse in different scopes, depending on whether they might conflict. For example, global shortcuts must be unique since they apply across all pages and workspaces. However, similar shortcuts can be used in different workspaces, like having the same shortcuts in both the Standard Workspace and the Standard 3D Workspace, as these two do not coexist. | ||
|
|
||
| | **Scope** | **Shortcut Conflicts** | | ||
| |----------------------------------|----------------------------------------------------------------------------------------------| | ||
| | **Global** | Must be unique across all scopes, as they apply universally. | | ||
| | **Annotation Page** | Must be unique across all scopes, except Labels Editor. | | ||
| | **Standard Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | ||
| | **Standard 3D Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | ||
| | **Attribute Annotation Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | ||
| | **Review Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | ||
| | **Tag Annotation Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | ||
| | **Control Sidebar** | Must be unique across itself, all workspaces, Annotation Page and Global Scope. | | ||
| | **Objects Sidebar** | Must be unique across itself, all workspaces, Annotation Page and Global Scope. | | ||
| | **Labels Editor** | Must be unique across itself and Global Scope. | | ||
|
|
||
| ## Shortcuts Customization | ||
|
|
||
| You can customize shortcuts in the CVAT settings. | ||
|
|
||
| - Open Settings:\ | ||
|  | ||
|
|
||
| - Go to the Shortcuts tab:\ | ||
|  | ||
|
|
||
| - You'll see the shortcuts customization menu:\ | ||
|  | ||
|
|
||
| - As it can be seen there is a warning, that some shortcuts are reserved by the browser and cannot be overridden by CVAT, there isn't a specific list available for such combinations, but shortcuts such as ctrl + tab (switching tabs) or ctrl + w (closing tabs) etc, are reserved by the browser and shortcuts such as alt + f4 (closing the window) are reserved by the operating system. | ||
|
|
||
| - All sections collapsable, so you can easily navigate through the list of shortcuts. Here is the Global scope expanded:\ | ||
|  | ||
|
|
||
| - To add a custom shortcut all you have to do is click in the input field and start pressing the sequence you want to assign to the action. As an example `f3` has been set here for Show Shortcuts along with `f1`:\ | ||
|  | ||
|
|
||
| - Shortcuts can be any combination of modifiers(ctrl, shift or alt) and up to one non-modifier key e.g. `ctrl+shift+key` etc.\ | ||
|  | ||
|
|
||
| - But if you try to add a shortcut that is already in use, you will get a warning message:\ | ||
|  | ||
|
|
||
| - If pressed cancel it will remain the same otherwise the conflicting shortcut will be unset.\ | ||
|  | ||
|
|
||
| - If you want to reset all the shortcuts to default, you can do so by clicking the Restore Defaults button at the top of the shortcut settings.\ | ||
|  |
There was a problem hiding this comment.
Approved: Enhanced structure and detailed customization instructions.
The changes significantly enhance the document's usability by categorizing shortcuts and providing detailed customization instructions. The inclusion of visual aids is particularly helpful.
However, consider the following minor corrections:
- Line 40: Add a period after "etc" as it is an abbreviation.
- Line 54: Insert a comma after "cancel" for better readability.
Consider applying these corrections:
- ...ctrl + w (closing tabs) etc, are reserved...
+ ...ctrl + w (closing tabs) etc., are reserved...
- If pressed cancel it will remain the same otherwise...
+ If pressed, cancel it will remain the same, otherwise...Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| CVAT provides a wide range of customizable shortcuts, with many UI elements offering shortcut hints when hovered over with the mouse. | |
|  | |
| | Shortcut | Common | | |
| | -------------------------- | -------------------------------------------------------------------------------------------------------- | | |
| | | _Main functions_ | | |
| | `F1` | Open/hide the list of available shortcuts | | |
| | `F2` | Go to the settings page or go back | | |
| | `Ctrl+S` | Go to the settings page or go back | | |
| | `Ctrl+Z` | Cancel the latest action related with objects | | |
| | `Ctrl+Shift+Z` or `Ctrl+Y` | Cancel undo action | | |
| | Hold `Mouse Wheel` | To move an image frame (for example, while drawing) | | |
| | | _Player_ | | |
| | `F` | Go to the next frame | | |
| | `D` | Go to the previous frame | | |
| | `V` | Go forward with a step | | |
| | `C` | Go backward with a step | | |
| | `Right` | Search the next frame that satisfies to the filters <br> or next frame which contain any objects | | |
| | `Left` | Search the previous frame that satisfies to the filters <br> or previous frame which contain any objects | | |
| | `Space` | Start/stop automatic changing frames | | |
| | `` ` `` or `~` | Focus on the element to change the current frame | | |
| | | _Modes_ | | |
| | `N` | Repeat the latest procedure of drawing with the same parameters | | |
| | `M` | Activate or deactivate mode to merging shapes | | |
| | `Alt+M` | Activate or deactivate mode to splitting shapes | | |
| | `G` | Activate or deactivate mode to grouping shapes | | |
| | `Shift+G` | Reset group for selected shapes (in group mode) | | |
| | `Esc` | Cancel any active canvas mode | | |
| | | _Image operations_ | | |
| | `Ctrl+R` | Change image angle (add 90 degrees) | | |
| | `Ctrl+Shift+R` | Change image angle (subtract 90 degrees) | | |
| | | _Operations with objects_ | | |
| | `Ctrl` | Switch automatic bordering for polygons and polylines during drawing/editing | | |
| | Hold `Ctrl` | When the shape is active and fix it | | |
| | `Alt+Click` on point | Deleting a point (used when hovering over a point of polygon, polyline, points) | | |
| | `Shift+Click` on point | Editing a shape (used when hovering over a point of polygon, polyline or points) | | |
| | `Right-Click` on shape | Display of an object element from objects sidebar | | |
| | `T+L` | Change locked state for all objects in the sidebar | | |
| | `L` | Change locked state for an active object | | |
| | `T+H` | Change hidden state for objects in the sidebar | | |
| | `H` | Change hidden state for an active object | | |
| | `Q` or `/` | Change occluded property for an active object | | |
| | `Del` or `Shift+Del` | Delete an active object. Use shift to force delete of locked objects | | |
| | `-` or `_` | Put an active object "farther" from the user (decrease z axis value) | | |
| | `+` or `=` | Put an active object "closer" to the user (increase z axis value) | | |
| | `Ctrl+C` | Copy shape to CVAT internal clipboard | | |
| | `Ctrl+V` | Paste a shape from internal CVAT clipboard | | |
| | Hold `Ctrl` while pasting | When pasting shape from the buffer for multiple pasting. | | |
| | `Ctrl+B` | Make a copy of the object on the following frames | | |
| | `Ctrl+(0..9)` | Changes a label for an activated object or for the next drawn object if no objects are activated | | |
| | | _Operations are available only for track_ | | |
| | `K` | Change keyframe property for an active track | | |
| | `O` | Change outside property for an active track | | |
| | `R` | Go to the next keyframe of an active track | | |
| | `E` | Go to the previous keyframe of an active track | | |
| | | _Attribute annotation mode_ | | |
| | `Up Arrow` | Go to the next attribute (up) | | |
| | `Down Arrow` | Go to the next attribute (down) | | |
| | `Tab` | Go to the next annotated object in current frame | | |
| | `Shift+Tab` | Go to the previous annotated object in current frame | | |
| | `<number>` | Assign a corresponding value to the current attribute | | |
| | | _Standard 3d mode_ | | |
| | `Shift+Up Arrow` | Increases camera roll angle | | |
| | `Shift+Down Arrow` | Decreases camera roll angle | | |
| | `Shift+Left Arrow` | Decreases camera pitch angle | | |
| | `Shift+Right Arrow` | Increases camera pitch angle | | |
| | `Alt+O` | Move the camera up | | |
| | `Alt+U` | Move the camera down | | |
| | `Alt+J` | Move the camera left | | |
| | `Alt+L` | Move the camera right | | |
| | `Alt+I` | Performs zoom in | | |
| | `Alt+K` | Performs zoom out | | |
| These shortcuts are organized by scopes. Some are global, meaning they work across the entire application, while others are specific to certain sections or workspaces. This setup allows for shortcut reuse in different scopes, depending on whether they might conflict. For example, global shortcuts must be unique since they apply across all pages and workspaces. However, similar shortcuts can be used in different workspaces, like having the same shortcuts in both the Standard Workspace and the Standard 3D Workspace, as these two do not coexist. | |
| | **Scope** | **Shortcut Conflicts** | | |
| |----------------------------------|----------------------------------------------------------------------------------------------| | |
| | **Global** | Must be unique across all scopes, as they apply universally. | | |
| | **Annotation Page** | Must be unique across all scopes, except Labels Editor. | | |
| | **Standard Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | |
| | **Standard 3D Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | |
| | **Attribute Annotation Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | |
| | **Review Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | |
| | **Tag Annotation Workspace** | Must be unique across itself, Annotation Page and Global Scope. | | |
| | **Control Sidebar** | Must be unique across itself, all workspaces, Annotation Page and Global Scope. | | |
| | **Objects Sidebar** | Must be unique across itself, all workspaces, Annotation Page and Global Scope. | | |
| | **Labels Editor** | Must be unique across itself and Global Scope. | | |
| ## Shortcuts Customization | |
| You can customize shortcuts in the CVAT settings. | |
| - Open Settings:\ | |
|  | |
| - Go to the Shortcuts tab:\ | |
|  | |
| - You'll see the shortcuts customization menu:\ | |
|  | |
| - As it can be seen there is a warning, that some shortcuts are reserved by the browser and cannot be overridden by CVAT, there isn't a specific list available for such combinations, but shortcuts such as ctrl + tab (switching tabs) or ctrl + w (closing tabs) etc, are reserved by the browser and shortcuts such as alt + f4 (closing the window) are reserved by the operating system. | |
| - All sections collapsable, so you can easily navigate through the list of shortcuts. Here is the Global scope expanded:\ | |
|  | |
| - To add a custom shortcut all you have to do is click in the input field and start pressing the sequence you want to assign to the action. As an example `f3` has been set here for Show Shortcuts along with `f1`:\ | |
|  | |
| - Shortcuts can be any combination of modifiers(ctrl, shift or alt) and up to one non-modifier key e.g. `ctrl+shift+key` etc.\ | |
|  | |
| - But if you try to add a shortcut that is already in use, you will get a warning message:\ | |
|  | |
| - If pressed cancel it will remain the same otherwise the conflicting shortcut will be unset.\ | |
|  | |
| - If you want to reset all the shortcuts to default, you can do so by clicking the Restore Defaults button at the top of the shortcut settings.\ | |
|  | |
| - As it can be seen there is a warning, that some shortcuts are reserved by the browser and cannot be overridden by CVAT, there isn't a specific list available for such combinations, but shortcuts such as ctrl + tab (switching tabs) or ctrl + w (closing tabs) etc., are reserved by the browser and shortcuts such as alt + f4 (closing the window) are reserved by the operating system. | |
| - If pressed, cancel it will remain the same, otherwise the conflicting shortcut will be unset.\ |
Tools
LanguageTool
[style] ~40-~40: In American English, abbreviations like “etc.” require a period.
Context: ...tching tabs) or ctrl + w (closing tabs) etc, are reserved by the browser and shortc...(ETC_PERIOD)
[uncategorized] ~54-~54: Possible missing comma found.
Context: ... - If pressed cancel it will remain the same otherwise the conflicting shortcut will...(AI_HYDRA_LEO_MISSING_COMMA)
bsekachev
reviewed
Aug 31, 2024
bsekachev
approved these changes
Aug 31, 2024
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and context
How has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit
New Features
Improvements