Skip to content

Create new help categories related to opening compose box #1520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 7, 2024
Merged

Create new help categories related to opening compose box #1520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e7de8b
keys: Add a new help category for opening compose box.
Niloth-p Jun 17, 2024
5b6f02e
keys: Rename the help category of message compose box actions.
Niloth-p Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/hotkeys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
|Show/hide Help Menu|<kbd>?</kbd>|
|Show/hide Markdown Help Menu|<kbd>Meta</kbd> + <kbd>m</kbd>|
|Show/hide About Menu|<kbd>Meta</kbd> + <kbd>?</kbd>|
|Open draft message saved in this session|<kbd>d</kbd>|
|Copy information from About Menu to clipboard|<kbd>c</kbd>|
|Redraw screen|<kbd>Ctrl</kbd> + <kbd>l</kbd>|
|Quit|<kbd>Ctrl</kbd> + <kbd>c</kbd>|
Expand Down Expand Up @@ -47,13 +46,7 @@
## Message actions
|Command|Key Combination|
| :--- | :---: |
|Reply to the current message|<kbd>r</kbd> / <kbd>Enter</kbd>|
|Reply mentioning the sender of the current message|<kbd>@</kbd>|
|Reply quoting the current message text|<kbd>></kbd>|
|Reply directly to the sender of the current message|<kbd>R</kbd>|
|Edit message's content or topic|<kbd>e</kbd>|
|New message to a stream|<kbd>c</kbd>|
|New message to a person or group of people|<kbd>x</kbd>|
|Show/hide emoji picker for current message|<kbd>:</kbd>|
|Narrow to the stream of the current message|<kbd>s</kbd>|
|Narrow to the topic of the current message|<kbd>S</kbd>|
Expand All @@ -77,7 +70,18 @@
|Show/hide stream members (from stream information)|<kbd>m</kbd>|
|Copy stream email to clipboard (from stream information)|<kbd>c</kbd>|

## Composing a Message
## Begin composing a message
|Command|Key Combination|
| :--- | :---: |
|Open draft message saved in this session|<kbd>d</kbd>|
|Reply to the current message|<kbd>r</kbd> / <kbd>Enter</kbd>|
|Reply mentioning the sender of the current message|<kbd>@</kbd>|
|Reply quoting the current message text|<kbd>></kbd>|
|Reply directly to the sender of the current message|<kbd>R</kbd>|
|New message to a stream|<kbd>c</kbd>|
|New message to a person or group of people|<kbd>x</kbd>|

## Writing a message
|Command|Key Combination|
| :--- | :---: |
|Cycle through recipient and content boxes|<kbd>Tab</kbd>|
Expand Down
33 changes: 17 additions & 16 deletions zulipterminal/config/keys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class KeyBinding(TypedDict):
'OPEN_DRAFT': {
'keys': ['d'],
'help_text': 'Open draft message saved in this session',
'key_category': 'general',
'key_category': 'open_compose',
},
'COPY_ABOUT_INFO': {
'keys': ['c'],
Expand Down Expand Up @@ -104,22 +104,22 @@ class KeyBinding(TypedDict):
'REPLY_MESSAGE': {
'keys': ['r', 'enter'],
'help_text': 'Reply to the current message',
'key_category': 'msg_actions',
'key_category': 'open_compose',
},
'MENTION_REPLY': {
'keys': ['@'],
'help_text': 'Reply mentioning the sender of the current message',
'key_category': 'msg_actions',
'key_category': 'open_compose',
},
'QUOTE_REPLY': {
'keys': ['>'],
'help_text': 'Reply quoting the current message text',
'key_category': 'msg_actions',
'key_category': 'open_compose',
},
'REPLY_AUTHOR': {
'keys': ['R'],
'help_text': 'Reply directly to the sender of the current message',
'key_category': 'msg_actions',
'key_category': 'open_compose',
},
'EDIT_MESSAGE': {
'keys': ['e'],
Expand All @@ -129,38 +129,38 @@ class KeyBinding(TypedDict):
'STREAM_MESSAGE': {
'keys': ['c'],
'help_text': 'New message to a stream',
'key_category': 'msg_actions',
'key_category': 'open_compose',
},
'PRIVATE_MESSAGE': {
'keys': ['x'],
'help_text': 'New message to a person or group of people',
'key_category': 'msg_actions',
'key_category': 'open_compose',
},
'CYCLE_COMPOSE_FOCUS': {
'keys': ['tab'],
'help_text': 'Cycle through recipient and content boxes',
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'SEND_MESSAGE': {
'keys': ['ctrl d', 'meta enter'],
'help_text': 'Send a message',
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'SAVE_AS_DRAFT': {
'keys': ['meta s'],
'help_text': 'Save current message as a draft',
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'AUTOCOMPLETE': {
'keys': ['ctrl f'],
'help_text': ('Autocomplete @mentions, #stream_names, :emoji:'
' and topics'),
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'AUTOCOMPLETE_REVERSE': {
'keys': ['ctrl r'],
'help_text': 'Cycle through autocomplete suggestions in reverse',
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'ADD_REACTION': {
'keys': [':'],
Expand All @@ -180,12 +180,12 @@ class KeyBinding(TypedDict):
'NARROW_MESSAGE_RECIPIENT': {
'keys': ['meta .'],
'help_text': 'Narrow to compose box message recipient',
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'EXIT_COMPOSE': {
'keys': ['esc'],
'help_text': 'Exit message compose box',
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'TOGGLE_NARROW': {
'keys': ['z'],
Expand Down Expand Up @@ -426,7 +426,7 @@ class KeyBinding(TypedDict):
# and to differentiate from other hotkeys using 'enter'.
'keys': ['enter'],
'help_text': 'Insert new line',
'key_category': 'msg_compose',
'key_category': 'compose_box',
},
'FULL_RENDERED_MESSAGE': {
'keys': ['f'],
Expand All @@ -447,7 +447,8 @@ class KeyBinding(TypedDict):
"searching": "Searching",
"msg_actions": "Message actions",
"stream_list": "Stream list actions",
"msg_compose": "Composing a Message",
"open_compose": "Begin composing a message",
"compose_box": "Writing a message",
"editor_navigation": "Editor: Navigation",
"editor_text_manipulation": "Editor: Text Manipulation",
}
Expand Down