From 517b15dc8d19b6eaf1a1a64f3a5f34c38868a375 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Wed, 9 Oct 2024 21:05:21 +0200 Subject: [PATCH] help: Create "Configure send message keys" article. Document setting the keys that will send a message or create a new line when composting a message via the compose box and via the personal settings overlay. Updates links and redirect from former help center article about this feature. Fixes #31620. --- help/collaborative-to-do-lists.md | 12 ++++--- help/configure-send-message-keys.md | 41 ++++++++++++++++++++++ help/create-a-poll.md | 9 +++-- help/include/compose-and-send-message.md | 4 +-- help/include/replying-to-messages.md | 4 +-- help/include/set-up-your-account.md | 4 +-- help/include/sidebar_index.md | 1 + help/keyboard-shortcuts.md | 2 +- help/mastering-the-compose-box.md | 43 +----------------------- zerver/lib/markdown/tabbed_sections.py | 1 + zerver/lib/url_redirects.py | 5 +-- zerver/openapi/zulip.yaml | 6 ++-- 12 files changed, 66 insertions(+), 66 deletions(-) create mode 100644 help/configure-send-message-keys.md diff --git a/help/collaborative-to-do-lists.md b/help/collaborative-to-do-lists.md index 92b8434f85..dcc3295d86 100644 --- a/help/collaborative-to-do-lists.md +++ b/help/collaborative-to-do-lists.md @@ -10,12 +10,13 @@ 1. Make sure the compose box is empty. -2. Type `/todo` followed by a space, and the title of the to-do list. +1. Type `/todo` followed by a space, and the title of the to-do list. -3. _(optional)_ Type each task on a new line, with its description, if any, after a : and blank space. +1. _(optional)_ Type each task on a new line, with its description, if + any, after a : and blank space. -4. Click the **Send** () button, or - use a [keyboard shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) +1. Click the **Send** () + button, or use a [keyboard shortcut](/help/configure-send-message-keys) to send your message. !!! tip "" @@ -28,7 +29,8 @@ {start_tabs} -1. Fill out the **New task** field and optionally the **Description** field at the bottom of the to-do list. +1. Fill out the **New task** field and optionally the **Description** + field at the bottom of the to-do list. 1. Click **Add task** to add the new task to the to-do list. diff --git a/help/configure-send-message-keys.md b/help/configure-send-message-keys.md new file mode 100644 index 0000000000..be5a080351 --- /dev/null +++ b/help/configure-send-message-keys.md @@ -0,0 +1,41 @@ +# Configure send message keys + +By default, the Enter key adds a new line to your message, +and Ctrl + Enter sends your message. + +This is convenient for typing multi-line messages, which are more common in +Zulip than in most other chat products. However, you can also configure +Zulip so that the Enter key sends your message. + +!!! tip "" + + Shift + Enter always adds a new line, regardless + of whether **Enter to send** is enabled. + +## Configure send message keys + +{start_tabs} + +{tab|via-compose-box} + +{!start-composing.md!} + +1. Click on the **ellipsis** () + in the bottom right corner of the compose box, next to the **Send** + () button. + +1. Toggle your preferred option for **Press ... to send**. + +{tab|via-personal-settings} + +{settings_tab|preferences} + +1. Under **General**, toggle **Enter sends when composing a message**. + +{end_tabs} + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Mastering the compose box](/help/mastering-the-compose-box) diff --git a/help/create-a-poll.md b/help/create-a-poll.md index 0ee51890c2..6c92c31cac 100644 --- a/help/create-a-poll.md +++ b/help/create-a-poll.md @@ -21,9 +21,8 @@ edit the question. formatting. 1. Click the **Send** () button, or - use a [keyboard - shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) - to send your message. + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. !!! tip "" @@ -43,8 +42,8 @@ edit the question. 3. _(optional)_ Type each option on a new line. 4. Click the **Send** () button, or - use a [keyboard shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) - to send your message. + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. !!! tip "" diff --git a/help/include/compose-and-send-message.md b/help/include/compose-and-send-message.md index a31794388c..661d91c74a 100644 --- a/help/include/compose-and-send-message.md +++ b/help/include/compose-and-send-message.md @@ -3,5 +3,5 @@ sending. 1. Click the **Send** () button, or - use a [keyboard shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) - to send your message. + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. diff --git a/help/include/replying-to-messages.md b/help/include/replying-to-messages.md index 4e43be022c..df5a4e4bef 100644 --- a/help/include/replying-to-messages.md +++ b/help/include/replying-to-messages.md @@ -9,8 +9,8 @@ To reply to an existing thread: sending. 1. Click the **Send** () button, or - use a [keyboard shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) - to send your message. + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. !!! tip "" You can also reply by clicking on a message, or using the R or diff --git a/help/include/set-up-your-account.md b/help/include/set-up-your-account.md index a705a1db87..fac917a5cb 100644 --- a/help/include/set-up-your-account.md +++ b/help/include/set-up-your-account.md @@ -19,8 +19,8 @@ - [Browse and subscribe to channels](/help/introduction-to-channels#browse-and-subscribe-to-channels). -- Decide whether you want Enter [to send your message - or add a new line](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message). +- Decide whether you want Enter [to send your message or add a + new line](/help/configure-send-message-keys). - [Configure your notifications](/#settings/notifications) to work the way you do. If you're joining a low traffic organization and aren't using the diff --git a/help/include/sidebar_index.md b/help/include/sidebar_index.md index 31f22f74f1..44a4c30225 100644 --- a/help/include/sidebar_index.md +++ b/help/include/sidebar_index.md @@ -46,6 +46,7 @@ ## Preferences * [Dark theme](/help/dark-theme) +* [Configure send message keys](/help/configure-send-message-keys) * [Font size](/help/font-size) * [Change your language](/help/change-your-language) * [Change your time zone](/help/change-your-timezone) diff --git a/help/keyboard-shortcuts.md b/help/keyboard-shortcuts.md index 7a41ab05c1..44312a9419 100644 --- a/help/keyboard-shortcuts.md +++ b/help/keyboard-shortcuts.md @@ -145,7 +145,7 @@ in the Zulip app to add more to your repertoire as needed. Enter or Ctrl + Enter based on [your settings][toggle-enter-to-send] -[toggle-enter-to-send]: /help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message +[toggle-enter-to-send]: /help/configure-send-message-keys * **Insert italic text**: `*italic*` or Ctrl + I diff --git a/help/mastering-the-compose-box.md b/help/mastering-the-compose-box.md index 127c7db7c4..c3c96b3d3c 100644 --- a/help/mastering-the-compose-box.md +++ b/help/mastering-the-compose-box.md @@ -78,51 +78,10 @@ where you sent a message**, as desired. {end_tabs} -## Toggle between Ctrl + Enter and Enter to send a message - -By default, the Enter key adds a new line to your message, -and Ctrl + Enter sends your message. - -This is convenient for typing multi-line messages, which are more common in -Zulip than in most other chat products. However, you can also configure -Zulip so that the Enter key sends your message. - -!!! tip "" - - Shift + Enter always adds a new line, regardless - of whether **Enter to send** is enabled. - -### Enable Enter to send - -{start_tabs} - -{!start-composing.md!} - -1. Click on the **ellipsis** () - in the bottom right corner of the compose box, next to the **Send** - () button. - -1. Select **Enter to send**. - -{end_tabs} - -### Enable **Ctrl + Enter to send** - -{start_tabs} - -{!start-composing.md!} - -1. Click on the **ellipsis** () - in the bottom right corner of the compose box, next to the **Send** - () button. - -1. Select **Ctrl + Enter to send**. - -{end_tabs} - ## Related articles * [Resize the compose box](/help/resize-the-compose-box) * [Message formatting](/help/format-your-message-using-markdown) * [Preview messages before sending](/help/preview-your-message-before-sending) +* [Configure send message keys](/help/configure-send-message-keys) * [Messaging tips and tricks](/help/messaging-tips) diff --git a/zerver/lib/markdown/tabbed_sections.py b/zerver/lib/markdown/tabbed_sections.py index 5c1c2dca5b..dc2157534b 100644 --- a/zerver/lib/markdown/tabbed_sections.py +++ b/zerver/lib/markdown/tabbed_sections.py @@ -88,6 +88,7 @@ TAB_SECTION_LABELS = { "via-organization-settings": "Via organization settings", "via-personal-settings": "Via personal settings", "via-channel-settings": "Via channel settings", + "via-compose-box": "Via compose box", "default-subdomain": "Default subdomain", "custom-subdomain": "Custom subdomain", "zulip-cloud-standard": "Zulip Cloud Standard", diff --git a/zerver/lib/url_redirects.py b/zerver/lib/url_redirects.py index 5fa07fddd1..48a4e43419 100644 --- a/zerver/lib/url_redirects.py +++ b/zerver/lib/url_redirects.py @@ -36,10 +36,7 @@ HELP_DOCUMENTATION_REDIRECTS: list[URLRedirect] = [ "/help/add-custom-profile-fields", "/help/custom-profile-fields", ), - URLRedirect( - "/help/enable-enter-to-send", - "/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message", - ), + URLRedirect("/help/enable-enter-to-send", "/help/configure-send-message-keys"), URLRedirect( "/help/change-the-default-language-for-your-organization", "/help/configure-organization-language", diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index abc4bdb14c..95618e09ee 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -15130,7 +15130,7 @@ paths: enter_sends: type: boolean description: | - Whether the user setting for [sending on pressing Enter](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) + Whether the user setting for [sending on pressing Enter](/help/configure-send-message-keys) in the compose box is enabled. enable_drafts_synchronization: type: boolean @@ -16107,7 +16107,7 @@ paths: `update_display_settings`. [capabilities]: /api/register-queue#parameter-client_capabilities - [set-enter-send]: /help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message + [set-enter-send]: /help/configure-send-message-keys emojiset_choices: deprecated: true description: | @@ -17828,7 +17828,7 @@ paths: enter_sends: type: boolean description: | - Whether the user setting for [sending on pressing Enter](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) + Whether the user setting for [sending on pressing Enter](/help/configure-send-message-keys) in the compose box is enabled. enable_drafts_synchronization: type: boolean