Skip to content

Commit 22b90c7

Browse files
docs: Update docs for new global hotkeys (#7945)
1 parent 4503bb2 commit 22b90c7

File tree

8 files changed

+105
-82
lines changed

8 files changed

+105
-82
lines changed

docs/source/guide/hotkeys.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Hotkeys
3+
short: Hotkeys
4+
tier: all
5+
type: guide
6+
order: 138
7+
order_enterprise: 138
8+
meta_title: Hotkeys in Label Studio
9+
section: "Create & Manage Projects"
10+
parent: "labeling"
11+
parent_enterprise: "labeling"
12+
date: 2025-05-24 17:19:21
13+
---
14+
15+
Use keyboard shortcuts, or hotkeys, to improve your labeling performance.
16+
17+
## View out-of-the-box hotkeys
18+
19+
From the labeling editor, click the settings icon to see more details about hotkeys or to enable or disable hotkeys.
20+
21+
![Screenshot of settings icon](/images/label/settings.png)
22+
23+
!!! info Tip
24+
If `enter` is specified and you have a Mac keyboard, use `return` instead. Use `delete` instead of `backspace`, and `option` instead of `alt`.
25+
26+
## Customize global hotkeys from your account page
27+
28+
You can easily customize global hotkeys on from the [**Account & Settings > Hotkeys** page](user_account#Hotkeys).
29+
30+
![Screenshot of customized key](/images/admin/global-hotkeys.png)
31+
32+
## Customize global hotkeys using environment variables
33+
34+
If you want to change the hotkeys used for specific actions, set the `EDITOR_KEYMAP` environment variable with valid JSON in your `.env` file or when starting Label Studio. For example, to change the keyboard shortcut used to submit an annotation to `shift` + `s`, set the environment variable as follows:
35+
```
36+
EDITOR_KEYMAP='{"annotation:submit":{"key": "shift+s","description": "My Custom Submit Hotkey!"}}'
37+
```
38+
This overwrites the existing hotkey mapping with your custom mapping. See [more about how to set environment variables](https://labelstud.io/guide/start#Set-environment-variables).
39+
40+
Refer to the full list of customizable hotkeys in the [`keymap.json` file](https://github.com/HumanSignal/label-studio/blob/develop/web/libs/editor/src/core/settings/keymap.json) to update a different hotkey combination.
41+
42+
You cannot use this environment variable to remove an existing or add a new keyboard shortcut.
43+
44+
## Use the `<Shortcut>` tag
45+
46+
Use the [Shortcut tag](/tags/shortcut) to allow annotators to insert a predefined text snippet into their current annotation.
47+
48+
They can do this by either clicking the shortcut button or by pressing its hotkey.
49+
50+
!!! info Tip
51+
Shortcuts work inside control tags (e.g., `<TextArea>`, `<Labels>`)
52+
53+
For example, use the following to insert predefined text into a text area:
54+
55+
```html
56+
<View>
57+
<Image name="image" value="$captioning"/>
58+
<Header value="Describe the image:"/>
59+
<TextArea name="caption" toName="image">
60+
<!-- Inserts “CAR” when clicked or on Ctrl+1 -->
61+
<Shortcut alias="Car" value="CAR" hotkey="ctrl+1" background="#333333"/>
62+
<!-- Inserts “AIRPLANE” when clicked or on Ctrl+2 -->
63+
<Shortcut alias="Airplane" value="AIRPLANE" hotkey="ctrl+2" background="#FFEE00"/>
64+
</TextArea>
65+
</View>
66+
```

docs/source/guide/labeling.md

Lines changed: 0 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -140,85 +140,6 @@ If you have a machine learning backend set up to [get interactive preannotations
140140
2. For image labeling, you can choose whether to **Auto accept annotation suggestions** after you enable auto-annotation. If you automatically accept annotation suggestions, regions show up automatically and are immediately created. If you don't automatically accept suggestions, the regions appear, but you can reject or approve them manually, either individually or all at once. Predicted text regions are automatically accepted.
141141

142142

143-
## Use keyboard shortcuts
144-
145-
Use keyboard shortcuts, or hotkeys, to improve your labeling performance. When performing a labeling task, click the gear icon to see more details about hotkeys or to enable or disable hotkeys.
146-
147-
This table describes the hotkeys for a standard keyboard. For a Mac keyboard, use return instead of enter, delete instead of backspace, and option instead of alt.
148-
149-
| Key | Description |
150-
| --- | --- |
151-
| `ctrl` + `enter` | Submit a task. |
152-
| `alt` + `enter` | Update a task. |
153-
| `ctrl` + `backspace` OR `cmd` + `backspace` | Delete all regions. |
154-
| `escape` | Exit relation mode or unselect a selected region. |
155-
| `backspace` | Delete a selected region. |
156-
| `alt` + `r` | Create a relation between regions, when a region is selected. |
157-
| `alt` + `.` | Cycle through all regions in the order listed on the regions' sidebar. |
158-
| `alt` + `h` | Hide a selected region. |
159-
| `ctrl` + `d` OR `cmd` + `d` | Duplicate a selected region. |
160-
| `u` | Unselect a selected region. |
161-
| `shift + down` | On the data manager, change the row selection to the next row, 1 below the current row. The quick view for the selected task row appears automatically. |
162-
| `shift + up` | On the data manager, change the row selection to the previous row, 1 above the current row. The quick view for the selected task row appears automatically. |
163-
| `shift + right` | On the data manager, open the labeling quick view for the selected task row. |
164-
| `shift + left` | On the data manager, close the labeling quick view for the selected task row. |
165-
166-
Other annotation types have labeling-specific shortcuts, such as numbers to select specific labels for named entity recognition tasks.
167-
168-
### Image-specific hotkeys
169-
When labeling image data types with the `Rectangle`, `BrushLabels`, `Ellipse`, `Polygon`, or `KeyPoints` tags, you can use specific hotkeys to take image labeling-specific actions.
170-
171-
| Key | Description |
172-
| --- | --- |
173-
| `h` | Pan the image, after zooming in. |
174-
| `v` | Select the mouse arrow. |
175-
| `alt` + `left arrow` | Rotate the image to the left. |
176-
| `alt` + `right arrow` | Rotate the image to the right. |
177-
| `ctrl` + `+` | Zoom in to the image. |
178-
| `ctrl` + `-` | Zoom out of the image. |
179-
| `k` | If performing key point labeling, select the key point option in the toolbar. |
180-
| `e` | Select the eraser option in the toolbar. |
181-
| `b` | If performing brush mask labeling, select the brush option in the toolbar.
182-
| `[` | When the brush or eraser option is selected, decrease the size of the brush or eraser. |
183-
| `]` | When the brush or eraser option is selected, increase the size of the brush or eraser. |
184-
185-
### Time series-specific hotkeys
186-
When labeling timeseries data with the `TimeSeries` tag, you can use specific hotkeys to take actions on a selected region on the time series data.
187-
188-
| Key | Description |
189-
| --- | --- |
190-
| `left arrow` | Expand the region area to the left. |
191-
| `right arrow` | Expand the region area to the right. |
192-
| `alt` + `left arrow` | Decrease the region area on the left. |
193-
| `alt` + `right arrow` | Decrease the region area on the right. |
194-
| `shift` + `left arrow` | Expand the region area by a larger amount to the left. |
195-
| `shift` + `right arrow` | Expand the region area by a larger amount to the right. |
196-
| `shift` + `alt` + `left arrow` | Decrease the region area by a larger amount on the left. |
197-
| `shift` + `alt` + `right arrow` | Decrease the region area by a larger amount on the right. |
198-
199-
### Video-specific hotkeys
200-
When labeling video data with the `Video` tag, you can use specific hotkeys to take video-specific actions.
201-
202-
| Key | Description |
203-
| --- | --- |
204-
| `alt` + `spacebar` | Play or pause video. |
205-
| `alt` + `left arrow` | Rewind one frame. |
206-
| `alt` + `right arrow` | Fast forward one frame. |
207-
208-
### Customize hotkeys
209-
You can specify custom hotkeys for labeling using the [Shortcut tag](/tags/shortcut.html), or change the hotkeys used for specific actions using an environment variable.
210-
211-
If you want to change the hotkeys used for specific actions, set the `EDITOR_KEYMAP` environment variable with valid JSON in your `.env` file or when starting Label Studio. For example, to change the keyboard shortcut used to submit an annotation to `shift` + `s`, set the environment variable as follows:
212-
```
213-
EDITOR_KEYMAP='{"annotation:submit":{"key": "shift+s","description": "My Custom Submit Hotkey!"}}'
214-
```
215-
This overwrites the existing hotkey mapping with your custom mapping. See [more about how to set environment variables](https://labelstud.io/guide/start#Set-environment-variables).
216-
217-
Refer to the full list of customizable hotkeys in the [`keymap.json` file](https://github.com/HumanSignal/label-studio/blob/develop/web/libs/editor/src/core/settings/keymap.json) to update a different hotkey combination.
218-
219-
You cannot use this environment variable to remove an existing or add a new keyboard shortcut.
220-
221-
222143
## Customize the labeling interface
223144

224145
Click the settings icon when labeling to configure the labeling interface to suit your labeling use case.

docs/source/guide/labeling_bulk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ short: Bulk labeling
44
tier: enterprise
55
type: guide
66
order: 0
7-
order_enterprise: 135
7+
order_enterprise: 137
88
meta_title: Bulk Labeling
99
meta_description: Bulk labeling in Label Studio
1010
section: "Create & Manage Projects"

docs/source/guide/user_account.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,18 @@ date: 2024-01-03 12:03:59
1414

1515
To access your user account and settings, click your user icon in the upper right and select **Account & Settings**.
1616

17+
<div class="opensource-only">
18+
1719
![Screenshot of the account and settings option](/images/admin/account_settings.png)
1820

21+
</div>
22+
23+
<div class="enterprise-only">
24+
25+
![Screenshot of the account and settings option](/images/admin/account_settings_lse.png)
26+
27+
</div>
28+
1929

2030
## Personal info
2131

@@ -28,13 +38,39 @@ After you create an account in Label Studio, you can update the following:
2838

2939
Because your email address is your username, you cannot update it. If you need to change your email address, you will need to create a different user with the new email address.
3040

41+
## Hotkeys
42+
43+
Use this page to configure custom hotkeys for your user account.
44+
45+
### Actions
46+
47+
| Action | Description |
48+
| ----------------------- | -------------------------------------------------------------------------------- |
49+
| **Export Hotkeys** | Generate a JSON file that you can share with other Label Studio users. |
50+
| **Import Hotkeys** | Copy and paste JSON-formatted custom hotkey mapping. |
51+
| **Reset to Defaults** | Reset all hotkeys to their default values. |
52+
53+
### Set custom hotkeys
54+
55+
For each hotkey, click the default hotkeys listed next each action. Then, when prompted, press the keys that you would like to use instead.
56+
57+
!!! note
58+
Each hotkey can be a single character key (a number, letter, symbol) or it can be a combination of a character key and multiple control keys (for example, `Shift`, `Control` `Option`, etc).
59+
60+
61+
<div style="width: 80%; margin-left: auto; margin-right: auto">
62+
63+
![Screenshot of customized key](/images/admin/global-hotkeys.png)
64+
65+
</div>
66+
3167
## Email preferences
3268

33-
Use this section to opt out of Label Studio news and tips sent to your email address.
69+
Use this page to select what kind of email notifications you want to receive.
3470

3571
## Membership info
3672

37-
In this section, you can find information about your organization, such as when the organization was created and the email address of the Owner (the user who initially created the Label Studio organization).
73+
On this page, you can find information about your organization, such as when the organization was created and the email address of the Owner (the user who initially created the Label Studio organization).
3874

3975
<div class="enterprise-only">
4076

132 KB
Loading
201 KB
Loading
119 KB
Loading
19.8 KB
Loading

0 commit comments

Comments
 (0)