Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

help: Restructure "Mastering the compose box" article. 

This help center article should include more features rather than just
focusing on the "go to conversation" button. We should broaden and
restructure this page to cover other advanced features.

Refactors the "Go to conversation" section as step-by-step instructions,
and adds a `keyboard_tip`.

Adds new section "Toggle between Ctrl+Enter and Enter".
Deletes the "Enable Enter to send" help center article, and adds its
content as a new subheading in this section.
Updates existing links accordingly and adds a URL redirect.
Documents "Enable Control + Enter to send".
Tweaks intro paragraph of "Mastering the compose box".

Fixes: #22817.
This commit is contained in:
David Rosa 2022-09-12 21:18:30 -04:00 committed by Tim Abbott
parent 2a5e4e2820
commit c6abb7bedf
8 changed files with 66 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
templates/zerver/help/enable-enter-to-send.md
View File

@ -1,26 +0,0 @@
# Enable Enter to send
By default, the <kbd>Enter</kbd> key adds a new line to a message,
and <kbd>Ctrl</kbd> + <kbd>Enter</kbd> sends the 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 <kbd>Enter</kbd> sends the message.
## Enable <kbd>Enter</kbd> to send
{start_tabs}
{!start-composing.md!}
1. Click **<kbd>Ctrl</kbd> + <kbd>Enter</kbd> to send** in the bottom right
corner of the compose box, just below the **Send** button.
1. Select **<kbd>Enter</kbd> to send**.
{end_tabs}
!!! tip ""
<kbd>Shift</kbd> + <kbd>Enter</kbd> always adds a new line, regardless
of whether **<kbd>Enter</kbd> to send** is enabled.

2
templates/zerver/help/include/compose-and-send-message.md
View File

@ -3,4 +3,4 @@
1. Click **Send**, or use <kbd>Enter</kbd> or <kbd>Ctrl</kbd> +
<kbd>Enter</kbd> (depending on your settings. See
[enable enter to send](https://zulip.com/help/enable-enter-to-send)).
[enable enter to send](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message)).

2
templates/zerver/help/include/set-up-your-account.md
View File

@ -17,7 +17,7 @@
- [Browse and subscribe to streams](/help/browse-and-subscribe-to-streams).
- Decide whether you want <kbd>Enter</kbd> [to send your message
or add a new line](/help/enable-enter-to-send).
or add a new line](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message).
- [Configure your notifications](/#settings/notifications) to work the way
you do. If you're joining a low traffic organization and aren't using the

1
templates/zerver/help/include/sidebar_index.md
View File

@ -63,7 +63,6 @@
* [Mention a user or group](/help/mention-a-user-or-group)
* [Typing notifications](/help/typing-notifications)
* [Preview messages before sending](/help/preview-your-message-before-sending)
* [Enable Enter to send](/help/enable-enter-to-send)
* [Verify a message was sent](/help/verify-your-message-was-successfully-sent)
* [Edit or delete a message](/help/edit-or-delete-a-message)
* [Message drafts](/help/view-and-edit-your-message-drafts)

4
templates/zerver/help/keyboard-shortcuts.md
View File

@ -116,11 +116,11 @@ below, and add more to your repertoire as needed.
* **Send message**: <kbd>Enter</kbd>, <kbd>Tab</kbd> then <kbd>Enter</kbd>,
and/or <kbd>Ctrl</kbd> + <kbd>Enter</kbd>, depending on your settings. See
[enable enter to send](https://zulip.com/help/enable-enter-to-send).
[enable enter to send](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message).
* **Insert new line**: <kbd>Enter</kbd>, or <kbd>Shift</kbd> + <kbd>Enter</kbd>,
depending on your settings. See
[enable enter to send](https://zulip.com/help/enable-enter-to-send).
[enable enter to send](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message).
* **Insert italic text**: `*italic*` or <kbd>Ctrl</kbd> + <kbd>I</kbd>

62
templates/zerver/help/mastering-the-compose-box.md
View File

@ -10,15 +10,63 @@ conversation you are composing to are faded for clarity.
## Go to conversation
To narrow the view to the conversation you're currently composing to,
click on the **Go to conversation** (<i class="zulip-icon
zulip-icon-arrow-left-circle"></i>) button in the compose box.
Zulip lets you narrow the message view to the conversation you're currently
composing to.
You can also use the keyboard shortcut <kbd>Ctrl</kbd> + <kbd>.</kbd>
to go to the conversation to which you are composing.
{start_tabs}
While the button is only shown when composing to a stream, the keyboard shortcut
will work in both stream messages and private messages.
{!start-composing.md!}
1. If composing a stream message, click the **Go to conversation**
(<i class="zulip-icon zulip-icon-arrow-left-circle"></i>) button in the
compose box.
!!! keyboard_tip ""
For both stream and private messages, use <kbd>Ctrl</kbd> + <kbd>.</kbd> to
go to the conversation you are composing to.
{end_tabs}
## Toggle between <kbd>Ctrl</kbd> + <kbd>Enter</kbd> and <kbd>Enter</kbd> to send a message
By default, the <kbd>Enter</kbd> key adds a new line to your message,
and <kbd>Ctrl</kbd> + <kbd>Enter</kbd> 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 <kbd>Enter</kbd> key sends your message.
!!! tip ""
<kbd>Shift</kbd> + <kbd>Enter</kbd> always adds a new line, regardless
of whether **<kbd>Enter</kbd> to send** is enabled.
### Enable <kbd>Enter</kbd> to send
{start_tabs}
{!start-composing.md!}
1. Click **<kbd>Ctrl</kbd> + <kbd>Enter</kbd> to send** in the bottom right
corner of the compose box, just below the **Send** button.
1. Select **<kbd>Enter</kbd> to send**.
{end_tabs}
### Enable **<kbd>Ctrl</kbd> + <kbd>Enter</kbd> to send**
{start_tabs}
{!start-composing.md!}
1. Click **<kbd>Enter</kbd> to send** in the bottom right
corner of the compose box, just below the **Send** button.
1. Select **<kbd>Ctrl</kbd> + <kbd>Enter</kbd> to send**.
{end_tabs}
## Related articles

4
zerver/lib/url_redirects.py
View File

@ -21,6 +21,10 @@ POLICY_DOCUMENTATION_REDIRECTS: List[URLRedirect] = [
HELP_DOCUMENTATION_REDIRECTS: List[URLRedirect] = [
# Add URL redirects for help center documentation here:
URLRedirect(
"/help/enable-enter-to-send",
"/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message",
),
URLRedirect(
"/help/change-the-default-language-for-your-organization",
"/help/configure-organization-language",

6
zerver/openapi/zulip.yaml
View File

@ -10546,7 +10546,7 @@ paths:
enter_sends:
type: boolean
description: |
Whether the user setting for [sending on pressing Enter](/help/enable-enter-to-send)
Whether the user setting for [sending on pressing Enter](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message)
in the compose box is enabled.
enable_drafts_synchronization:
type: boolean
@ -12547,7 +12547,7 @@ paths:
enter_sends:
type: boolean
description: |
Whether the user setting for [sending on pressing Enter](/help/enable-enter-to-send)
Whether the user setting for [sending on pressing Enter](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message)
in the compose box is enabled.
enable_drafts_synchronization:
type: boolean
@ -12777,7 +12777,7 @@ paths:
and only for clients that did not include `user_settings_object` in
their client_capabilities` when registering the event queue.
Whether the user setting for [sending on pressing Enter](/help/enable-enter-to-send)
Whether the user setting for [sending on pressing Enter](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message)
in the compose box is enabled.
**Changes**: Deprecated in Zulip 5.0 (feature level 89). Clients