From fe7d7b48dba4813938d4ec593523e1049c10b83b Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Thu, 2 Jun 2022 01:56:59 +0200 Subject: [PATCH] help-docs: Use `` HTML elements for references to keyboard keys. Updates references to keyboard keys in the help center docs to use `` HTML elements, which also means updating them to be as the key would appear on a keyboard. Previously, uppercase and lowercase letters were used to indicate when/if the `Shift` key was being used, and even that was not consistent throughout the documentation. For CSS styling, adds a similar rule for `` elements that is used in `/static/styles/app_components.css`. And updates the CSS class used in `/static/js/portico/help.js` for `adjust_mac_shortcuts` accordingly. Also, takes advantage of revising these pages for making small updates for current help center documentation practices. --- static/js/portico/help.js | 2 +- static/styles/portico/markdown.css | 24 +++ .../zerver/help/configure-default-view.md | 29 +-- templates/zerver/help/enable-enter-to-send.md | 20 +- .../help/include/compose-and-send-message.md | 8 +- .../help/include/how-to-start-a-new-topic.md | 18 +- templates/zerver/help/include/reading-pms.md | 21 +- .../zerver/help/include/reading-topics.md | 33 ++-- .../zerver/help/include/recent-topics.md | 9 +- .../help/include/replying-to-messages.md | 5 +- .../help/include/set-up-your-account.md | 10 +- .../include/starting-a-new-private-thread.md | 12 +- templates/zerver/help/keyboard-shortcuts.md | 187 ++++++++++-------- .../help/link-to-a-message-or-conversation.md | 9 +- .../zerver/help/marking-messages-as-read.md | 9 +- .../zerver/help/mastering-the-compose-box.md | 4 +- templates/zerver/help/open-the-compose-box.md | 18 +- templates/zerver/help/private-messages.md | 51 ++--- templates/zerver/help/quote-and-reply.md | 35 ++-- templates/zerver/help/reading-strategies.md | 15 +- templates/zerver/help/recent-topics.md | 7 +- templates/zerver/help/start-a-new-topic.md | 13 +- .../zerver/help/view-and-browse-images.md | 6 +- .../help/view-and-edit-your-message-drafts.md | 8 +- 24 files changed, 320 insertions(+), 233 deletions(-) diff --git a/static/js/portico/help.js b/static/js/portico/help.js index bf300b06e0..fa6e5ecf0a 100644 --- a/static/js/portico/help.js +++ b/static/js/portico/help.js @@ -58,7 +58,7 @@ function render_code_sections() { highlight_current_article(); - common.adjust_mac_shortcuts(".markdown .content code", false); + common.adjust_mac_shortcuts(".markdown kbd"); $("table").each(function () { $(this).addClass("table table-striped"); diff --git a/static/styles/portico/markdown.css b/static/styles/portico/markdown.css index e4a4c9524a..c9765b29ab 100644 --- a/static/styles/portico/markdown.css +++ b/static/styles/portico/markdown.css @@ -327,6 +327,30 @@ } } + kbd { + /* Same as kbd in app_components.css */ + display: inline-block; + border: 1px solid hsl(0, 0%, 80%); + border-radius: 4px; + font-weight: 600; + white-space: nowrap; + background-color: hsl(0, 0%, 98%); + color: hsl(0, 0%, 20%); + text-shadow: 0 1px 0 hsl(0, 0%, 100%); + /* Different from app_components.css */ + /* Removed margin setting */ + font-size: 0.85em; + padding: 0 0.4em; + + &.arrow-key { + /* Same as in informational_overlays.css */ + line-height: 1; + padding: 0 0.2em 0.2em; + /* Different from informational_overlays.css */ + font-size: 1.2em; + } + } + code { /* Copied from rendered_markdown.css */ font-size: 0.825em; diff --git a/templates/zerver/help/configure-default-view.md b/templates/zerver/help/configure-default-view.md index 43b91b6a1b..d723f9b12d 100644 --- a/templates/zerver/help/configure-default-view.md +++ b/templates/zerver/help/configure-default-view.md @@ -11,8 +11,9 @@ The default views available in Zulip are on how to use these views. You can configure which view is set as your default, and whether -the `Esc` key navigates to the default view. Also, you can always reach -the default view by using the `Ctrl` + `[` shortcut. +the Esc key navigates to the default view. Also, you can +always reach the default view by using the Ctrl + [ +shortcut. ## Change default view @@ -30,39 +31,41 @@ organization settings: {settings_tab|display-settings} -2. Under **Advanced**, click on the **Default view** dropdown -and select a view. +1. Under **Advanced**, click on the **Default view** dropdown + and select a view. 1. To see your changes in action, open a new Zulip tab, or use a keyboard -shortcut twice to exit the settings and navigate to your default view -(`Ctrl` + `[` or `Esc` if enabled). + shortcut twice to exit the settings and navigate to your default view + (Ctrl + [ or Esc if enabled). [configure-esc]: /help/configure-default-view#set-whether-esc-navigates-to-the-default-view {end_tabs} -## Set whether `Esc` navigates to the default view +## Set whether Esc navigates to the default view Zulip has a number of [keyboard shortcuts](/help/keyboard-shortcuts) designed to enhance the user experience in the app. -By default, the `Esc` key shortcut will ultimately navigate to your -default view. You can disable this key binding if you would prefer. -This will not disable other `Esc` key shortcuts used in Zulip, -and will not affect the behavior of the `Ctrl` + `[` shortcut. +By default, the Esc key shortcut will ultimately navigate to +your default view. You can disable this key binding if you would prefer. +This will not disable other Esc key shortcuts used in Zulip, +and will not affect the behavior of the Ctrl + [ +shortcut. -### Toggle whether `Esc` navigates to the default view +### Toggle whether Esc navigates to the default view {start_tabs} {settings_tab|display-settings} 1. Under **Advanced**, toggle **Escape key navigates to -default view**, as desired. + default view**, as desired. {end_tabs} ## Related articles + * [Reading strategies](/help/reading-strategies) * [Recent topics](/help/recent-topics) * [Keyboard shortcuts](/help/keyboard-shortcuts) diff --git a/templates/zerver/help/enable-enter-to-send.md b/templates/zerver/help/enable-enter-to-send.md index f52b517df7..5c3fd422ba 100644 --- a/templates/zerver/help/enable-enter-to-send.md +++ b/templates/zerver/help/enable-enter-to-send.md @@ -1,26 +1,26 @@ -# Enable `Enter` to send +# Enable Enter to send -By default, the `Enter` key adds a new line to a message, -and `Ctrl` + `Enter` sends the message. +By default, the Enter key adds a new line to a message, +and Ctrl + Enter 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 `Enter` sends the message. +Zulip so that Enter sends the message. -## Enable `Enter` to send +## Enable Enter to send {start_tabs} {!start-composing.md!} -1. Select **`Ctrl` + `Enter` to send** below the **Send** button in - the compose box. +1. Click **Ctrl + Enter to send** in the bottom right + corner of the compose box, just below the **Send** button. -1. Toggle your preferred option. +1. Select **Enter to send**. {end_tabs} !!! tip "" - `Shift` + `Enter` always adds a new line, regardless of whether - **`Enter` to send** is enabled. + Shift + Enter always adds a new line, regardless + of whether **Enter to send** is enabled. diff --git a/templates/zerver/help/include/compose-and-send-message.md b/templates/zerver/help/include/compose-and-send-message.md index 3387b7c8ac..40cd5fbf57 100644 --- a/templates/zerver/help/include/compose-and-send-message.md +++ b/templates/zerver/help/include/compose-and-send-message.md @@ -1,4 +1,6 @@ -1. Press `Tab` or click on the compose box to compose your message. +1. Press Tab or click on the compose box to compose your + message. -1. Click **Send**, or use `Enter` or `Ctrl` + `Enter` (depending on whether - the [**Press Enter to send** option](/help/enable-enter-to-send) is checked). +1. Click **Send**, or use Enter or Ctrl + + Enter (depending on your settings. See + [enable enter to send](https://zulip.com/help/enable-enter-to-send)). diff --git a/templates/zerver/help/include/how-to-start-a-new-topic.md b/templates/zerver/help/include/how-to-start-a-new-topic.md index a5561d1885..ffec9755c2 100644 --- a/templates/zerver/help/include/how-to-start-a-new-topic.md +++ b/templates/zerver/help/include/how-to-start-a-new-topic.md @@ -1,19 +1,24 @@ {start_tabs} -{tab|stream} -1. Click the **New topic** button at the bottom of the Zulip window, or type `c`. -2. Enter a topic name. Auto-complete will provide suggestions for previously +{tab|stream} + +1. Click the **New topic** button at the bottom of the Zulip window, + or type C. + +1. Enter a topic name. Auto-complete will provide suggestions for previously used topics. {!compose-and-send-message.md!} {tab|not-stream} -1. Click the **New topic** button at the bottom of the Zulip window, or type `c`. -2. Enter a stream name. Auto-complete will provide suggestions for streams you +1. Click the **New topic** button at the bottom of the Zulip window, or + type C. + +1. Enter a stream name. Auto-complete will provide suggestions for streams you can send to. -2. Enter a topic name. Auto-complete will provide suggestions for previously +1. Enter a topic name. Auto-complete will provide suggestions for previously used topics. {!compose-and-send-message.md!} @@ -21,6 +26,7 @@ {end_tabs} !!! warn "" + In Zulip, you can compose a message to a different place than the one you are viewing. In this situation, the message feed will fade to indicate what's going on. diff --git a/templates/zerver/help/include/reading-pms.md b/templates/zerver/help/include/reading-pms.md index 7f685c6139..68fbda2847 100644 --- a/templates/zerver/help/include/reading-pms.md +++ b/templates/zerver/help/include/reading-pms.md @@ -1,17 +1,20 @@ {start_tabs} + 1. Click on **Private messages** in the left sidebar. -2. Click on a conversation in the left sidebar under **Private messages**. +1. Click on a conversation in the left sidebar under **Private messages**. -3. Read the conversation, scrolling down with the mouse or by pressing `PgDn`. +1. Read the conversation, scrolling down with the mouse or by pressing + PgDn. -4. If the conversation is not of interest, you can - [mark all messages as read](/help/marking-messages-as-read) or do so by jumping - to the end using the `End` key. +1. If the conversation is not of interest, you can + [mark all messages as read](/help/marking-messages-as-read) or do so + by jumping to the end using the End key. -5. Click on the next conversation in the left sidebar, or use the `p` key to go to the - next unread conversation. +1. Click on the next conversation in the left sidebar, or use the + P key to go to the next unread conversation. + +1. To go to older unread conversations, use the P key or scroll + down in the **Private messages** section of the left sidebar to view. -6. To go to older unread conversations, use the `p` key or scroll down in the - **Private messages** section of the left sidebar to view. {end_tabs} diff --git a/templates/zerver/help/include/reading-topics.md b/templates/zerver/help/include/reading-topics.md index 019fd05146..6a7d6cba86 100644 --- a/templates/zerver/help/include/reading-topics.md +++ b/templates/zerver/help/include/reading-topics.md @@ -2,35 +2,40 @@ {tab|via-recent-topics} -1. Open **Recent topics** from the left sidebar or by pressing the `Esc` key. +1. Open **Recent topics** from the left sidebar or by pressing the + Esc key. 1. Click on the name of a topic in the **Topic** column. -1. Read the topic, scrolling down with the mouse or by pressing `PgDn`. +1. Read the topic, scrolling down with the mouse or by pressing + PgDn. 1. If the topic is not of interest, you can - [mark all messages as read](/help/marking-messages-as-read) or do so by jumping - to the end using the `End` key. + [mark all messages as read](/help/marking-messages-as-read) or + do so by jumping to the end using the End key. -1. You can then click on another topic in the left sidebar, use the `n` key to go to the - next unread topic, or go back to the **Recent topics** view. +1. You can then click on another topic in the left sidebar, use the + N key to go to the next unread topic, or go back to the + **Recent topics** view. {tab|via-left-sidebar} -1. Click on the name of a stream in the left sidebar. You will see a list of the - most recent unread topics in that stream. +1. Click on the name of a stream in the left sidebar. You will see a + list of the most recent unread topics in that stream. 1. Click on a topic in the left sidebar. -1. Read the topic, scrolling down with the mouse or by pressing `PgDn`. +1. Read the topic, scrolling down with the mouse or by pressing + PgDn. 1. If the topic is not of interest, you can - [mark all messages as read](/help/marking-messages-as-read) or do so by jumping - to the end using the `End` key. + [mark all messages as read](/help/marking-messages-as-read) or do + so by jumping to the end using the End key. -1. Click on the next topic in the left sidebar, or use the `n` key to go to the - next unread topic. +1. Click on the next topic in the left sidebar, or use the N + key to go to the next unread topic. -1. To go to older unread topics, use the `n` key or click **more topics** to view. +1. To go to older unread topics, use the N key or click + **more topics** to view. {end_tabs} diff --git a/templates/zerver/help/include/recent-topics.md b/templates/zerver/help/include/recent-topics.md index 1b9e1c6100..278ed00d79 100644 --- a/templates/zerver/help/include/recent-topics.md +++ b/templates/zerver/help/include/recent-topics.md @@ -4,10 +4,11 @@ messages sent while you were away. {start_tabs} -1. Open **Recent topics** from the left sidebar or by pressing the `Esc` key. +1. Open **Recent topics** from the left sidebar or by pressing the + Esc key. -1. The filters at the top help you quickly find relevant - conversations. For example, select **Participated** to narrow to - the topics you have sent messages to. +1. The filters at the top help you quickly find relevant conversations. + For example, select **Participated** to narrow to the topics you + have sent messages to. {end_tabs} diff --git a/templates/zerver/help/include/replying-to-messages.md b/templates/zerver/help/include/replying-to-messages.md index 36737571fc..061f160c0d 100644 --- a/templates/zerver/help/include/replying-to-messages.md +++ b/templates/zerver/help/include/replying-to-messages.md @@ -1,11 +1,12 @@ To reply to an existing thread: {start_tabs} + 1. Click the **Message...** button at the bottom of the Zulip window. {!compose-and-send-message.md!} {end_tabs} -You can also reply by clicking on a message, or using `r` or `Enter` to reply -to the message in the blue box. +You can also reply by clicking on a message, or using R or +Enter to reply to the message in the blue box. diff --git a/templates/zerver/help/include/set-up-your-account.md b/templates/zerver/help/include/set-up-your-account.md index e270305960..805baceaa1 100644 --- a/templates/zerver/help/include/set-up-your-account.md +++ b/templates/zerver/help/include/set-up-your-account.md @@ -1,18 +1,24 @@ !!! tip "" + If this is your first time using Zulip, we recommend starting with the web or desktop experience to set up your account and get oriented. - Get the [mobile and desktop apps](/apps). Zulip also works great in a browser. + - [Add a profile picture](/help/change-your-profile-picture) and [edit your profile information](https://zulip.com/help/edit-your-profile) to tell others about yourself. + - [Review your display settings](/help/review-your-settings#review-your-display-settings). You can [switch between light and dark theme](/help/dark-theme), [pick your favorite emoji theme](/help/emoji-and-emoticons#change-your-emoji-set), [change your language](/help/change-your-language), and make other tweaks to your Zulip experience. + - [Browse and subscribe to streams](/help/browse-and-subscribe-to-streams). -- Decide whether you [want `Enter` to send your message](/help/enable-enter-to-send) - or add a new line. + +- Decide whether you want Enter [to send your message + or add a new line](/help/enable-enter-to-send). + - [Configure your notifications](/#settings/notifications) to work the way you do. If you're joining a low traffic organization and aren't using the desktop app, consider sending all messages to email. diff --git a/templates/zerver/help/include/starting-a-new-private-thread.md b/templates/zerver/help/include/starting-a-new-private-thread.md index 5db94f9307..a987540a37 100644 --- a/templates/zerver/help/include/starting-a-new-private-thread.md +++ b/templates/zerver/help/include/starting-a-new-private-thread.md @@ -1,8 +1,9 @@ {start_tabs} -1. Click the **New private message** button at the bottom of the Zulip window, - or type `x`. -2. Type the names of one or more recipients. Auto-complete will provide +1. Click the **New private message** button at the bottom of the Zulip + window, or type X. + +1. Type the names of one or more recipients. Auto-complete will provide suggestions for users you can message. {!compose-and-send-message.md!} @@ -10,5 +11,6 @@ {end_tabs} !!! tip "" - Rather than kicking off a group thread, consider starting the conversation in - a new topic to make it easier to browse later on. + + Rather than kicking off a group thread, consider starting the + conversation in a new topic to make it easier to browse later on. diff --git a/templates/zerver/help/keyboard-shortcuts.md b/templates/zerver/help/keyboard-shortcuts.md index ed29eb54a7..3440b1bed3 100644 --- a/templates/zerver/help/keyboard-shortcuts.md +++ b/templates/zerver/help/keyboard-shortcuts.md @@ -15,186 +15,203 @@ below, and add more to your repertoire as needed. ## The basics -* **Reply to message**: `r` or `Enter` — Reply to the selected - message (outlined in blue). +* **Reply to message**: R or Enter — Reply to the + selected message (outlined in blue). -* **New stream message**: `c` — Start a new topic in the current stream. +* **New stream message**: C — Start a new topic in the current + stream. -* **New private message**: `x` +* **New private message**: X -* **Cancel compose and save draft**: `Esc` or `Ctrl` + `[` — Close the compose box and save - the unsent message as a draft. +* **Cancel compose and save draft**: Esc or Ctrl + + [ — Close the compose box and save the unsent message as a + draft. -* **View drafts**: `d` — Use the arrow keys and `Enter` to restore a draft. - Press `d` again to close. +* **View drafts**: D — Use the arrow keys and Enter + to restore a draft. Press D again to close. -* **Next message**: `↓` or `j` +* **Next message**: ↓ or J -* **Last message**: `End` or `G` — Also marks all messages in - the current view as read. +* **Last message**: End or Shift + G — + Also marks all messages in the current view as read. -* **Next unread topic**: `n` +* **Next unread topic**: N -* **Next unread private message**: `p` +* **Next unread private message**: P -* **Search messages**: `/` +* **Search messages**: / -* **Toggle keyboard shortcuts view**: `?` +* **Toggle keyboard shortcuts view**: ? -* **Go to default view**: `Ctrl` + `[` (or `Esc`, - [if enabled][disable-escape]) +* **Go to default view**: Ctrl + [ (or + Esc, [if enabled][disable-escape]) until you are in the [default view](/help/configure-default-view). [disable-escape]: /help/configure-default-view#set-whether-esc-navigates-to-the-default-view ## Navigation -* **Search messages**: `/` or `Ctrl` + `k` +* **Search messages**: / or Ctrl + K -* **Filter streams**: `q` +* **Filter streams**: Q -* **Search people**: `w` +* **Search people**: W -* **Last message**: `End` or `G` — Also marks all messages in - the current view as read. +* **Last message**: End or Shift + G — + Also marks all messages in the current view as read. -* **First message**: `Home` +* **First message**: Home -* **Previous message**: `↑` or `k` +* **Previous message**: ↑ or K -* **Next message**: `↓` or `j` +* **Next message**: ↓ or J -* **Scroll up**: `PgUp` or `K` +* **Scroll up**: PgUp or Shift + K -* **Scroll down**: `PgDn`, `J`, or `Spacebar` +* **Scroll down**: PgDn, Shift + J, or + Spacebar -* **Go back through viewing history**: `Alt` + `←` +* **Go back through viewing history**: Alt + + ← -* **Go forward through viewing history**: `Alt` + `→` +* **Go forward through viewing history**: Alt + + → ## Narrowing -* **Narrow to next unread topic**: `n` +* **Narrow to next unread topic**: N -* **Narrow to next unread private message**: `p` +* **Narrow to next unread private message**: P -* **Narrow to stream**: `s` +* **Narrow to stream**: S -* **Narrow to topic or PM conversation**: `S` +* **Narrow to topic or PM conversation**: Shift + S -* **Narrow to all private messages**: `P` +* **Narrow to all private messages**: Shift + P -* **Cycle between stream narrows**: `A` (previous) and `D` (next) +* **Cycle between stream narrows**: Shift + A + (previous) and Shift + D (next) -* **Narrow to all messages**: `a` — Shows all unmuted messages. +* **Narrow to all messages**: A — Shows all unmuted messages. -* **Narrow to current compose box recipient**: `Ctrl` + `.` +* **Narrow to current compose box recipient**: Ctrl + . ## Composing messages -* **Reply to message**: `r` or `Enter` — Reply to the selected - message (outlined in blue). Same behavior as clicking on the message. +* **Reply to message**: R or Enter — Reply to the + selected message (outlined in blue). Same behavior as clicking on the + message. -* **Reply to message, mentioning author**: `@` +* **Reply to message, mentioning author**: @ -* **Reply only to author**: `R` +* **Reply only to author**: Shift + R -* **Quote and reply to message**: `>` +* **Quote and reply to message**: > -* **New stream message**: `c` — For starting a new topic in a stream. +* **New stream message**: C — For starting a new topic in a + stream. -* **New private message**: `x` +* **New private message**: X ### In the compose box -* **Send message**: `Enter`, `Tab` then `Enter`, and/or `Ctrl` + `Enter`, +* **Send message**: Enter, Tab then Enter, + and/or Ctrl + Enter, depending on your settings. See + [enable enter to send](https://zulip.com/help/enable-enter-to-send). + +* **Insert new line**: Enter, or Shift + Enter, depending on your settings. See [enable enter to send](https://zulip.com/help/enable-enter-to-send). -* **Insert new line**: `Enter`, or `Shift` + `Enter`, depending on your - settings. See - [enable enter to send](https://zulip.com/help/enable-enter-to-send). +* **Insert italic text**: `*italic*` or Ctrl + I -* **Insert italic text**: `*italic*` or `Ctrl` + `I` -* **Insert bold text**: `**bold**` or `Ctrl` + `B` -* **Insert link**: `[Zulip website](https://zulip.org)` or `Ctrl` + `Shift` + `L` +* **Insert bold text**: `**bold**` or Ctrl + B -* **Cancel compose and save draft**: `Esc` or `Ctrl` + `[` — Close the compose box and save - the unsent message as a draft. +* **Insert link**: `[Zulip website](https://zulip.org)` or Ctrl + + Shift + L + +* **Cancel compose and save draft**: Esc or Ctrl + + [ — Close the compose box and save the unsent message as a draft. ## Message actions -* **Edit last message**: `←` — Open the last editable message in the current - view (if any). +* **Edit last message**: ← — Open the last + editable message in the current view (if any). ### For a selected message (outlined in blue) -* **Show sender's profile**: `u` +* **Show sender's profile**: U -* **View image**: `v` +* **View image**: V -* **Edit message**: `e` +* **Edit message**: E -* **Star message**: `Ctrl` + `s` +* **Star message**: Ctrl + S * **React with :thumbs_up:**: `+` + src="/static/generated/emoji/images/emoji/unicode/1f44d.png" + title="thumbs up"/>**: + -* **Collapse/show message**: `-` +* **Collapse/show message**: - -* **Toggle topic mute**: `M` — Muted topics don't show up in any views - (including All messages), and don't contribute to unread counts. Read more about - [muting topics](/help/mute-a-topic). +* **Toggle topic mute**: Shift + M — Muted topics + don't show up in any views (including All messages), and don't contribute + to unread counts. Read more about [muting topics](/help/mute-a-topic). ## Recent topics -* **View recent topics**: `t` -* **Search recent topics**: `t` -* **Escape from recent topics search**: `Esc` or arrow keys -* **Navigate recent topics**: Use arrow keys or vim keys (`j`, `k`, `l`, `h`). +* **View recent topics**: T -Use `Enter` to engage with elements. +* **Search recent topics**: T + +* **Escape from recent topics search**: Esc or arrow keys + +* **Navigate recent topics**: Use arrow keys or vim keys (J, + K, L, H). + +Use Enter to engage with elements. ## Drafts -* **Toggle drafts view**: `d` +* **Toggle drafts view**: D ### Within the drafts view -* **Edit selected draft**: `Enter` +* **Edit selected draft**: Enter -* **Delete selected draft**: `Backspace` +* **Delete selected draft**: Backspace Keyboard navigation (e.g. arrow keys) works as expected. ## Menus -* **Toggle shortcuts help**: `?` +* **Toggle shortcuts help**: ? -* **Toggle gear menu**: `g` +* **Toggle gear menu**: G ### For a selected message (outlined in blue) -* **Toggle emoji reactions menu**: `:` +* **Toggle emoji reactions menu**: : -* **Toggle message actions menu**: `i` +* **Toggle message actions menu**: I ## Streams settings page -* **Scroll through streams**: `↑` and `↓` +* **Scroll through streams**: ↑ and + ↓ !!! tip "" - Pressing `↑` from the first stream in the list moves - you to the **Filter streams** input. + Pressing ↑ from the first stream + in the list moves you to the **Filter streams** input. -* **Switch between tabs**: `←` and `→` — Switch between the -**Subscribed** and **All streams** tabs. +* **Switch between tabs**: ← and + → — Switch between the **Subscribed** + and **All streams** tabs. -* **Create new stream**: `n` +* **Create new stream**: N ### For a selected stream -* **View stream messages**: `V` +* **View stream messages**: Shift + V -* **Toggle subscription**: `S` +* **Toggle subscription**: Shift + S diff --git a/templates/zerver/help/link-to-a-message-or-conversation.md b/templates/zerver/help/link-to-a-message-or-conversation.md index fb14f9485b..e711afd177 100644 --- a/templates/zerver/help/link-to-a-message-or-conversation.md +++ b/templates/zerver/help/link-to-a-message-or-conversation.md @@ -14,13 +14,13 @@ The easiest way to link to a stream or topic is: 1. Type `#` followed by the one or more letters of the stream name. -2. Choose the desired stream from the auto-complete menu. The link will be +1. Choose the desired stream from the auto-complete menu. The link will be automatically formatted for you. -3. If linking to a topic, type `>` after selecting a stream as described above, - followed by one or more letters of the topic name. +1. If linking to a topic, type `>` after selecting a stream as + described above, followed by one or more letters of the topic name. -4. Choose the desired topic from the auto-complete menu. The link will be +1. Choose the desired topic from the auto-complete menu. The link will be automatically formatted for you. {end_tabs} @@ -90,6 +90,7 @@ message](/help/quote-and-reply). {!topic-long-press-menu-tip.md!} {end_tabs} + ### Get a link to a specific stream {start_tabs} diff --git a/templates/zerver/help/marking-messages-as-read.md b/templates/zerver/help/marking-messages-as-read.md index fbc380f013..a2946a33f7 100644 --- a/templates/zerver/help/marking-messages-as-read.md +++ b/templates/zerver/help/marking-messages-as-read.md @@ -12,17 +12,18 @@ There are two situations in which messages automatically get marked as read. * **Blue box**: Messages are marked as read when the blue box passes over them. -You can move the blue box either with the keyboard (arrow keys, `End`, etc.) -or by scrolling the feed with your mouse. +You can move the blue box either with the keyboard (arrow keys, End, +etc.) or by scrolling the feed with your mouse. You can also manually **mark all messages as read**, or **mark all messages in a stream or topic as read**. {start_tabs} -1. Hover over a stream, topic, or All messages in the left sidebar. +1. Hover over a stream, topic, or **All messages** in the left sidebar. -1. Click the ellipsis () to the right. +1. Click the ellipsis () + to the right. 1. Click **Mark all messages as read**. diff --git a/templates/zerver/help/mastering-the-compose-box.md b/templates/zerver/help/mastering-the-compose-box.md index d52cb4e40e..7a4b0c1abc 100644 --- a/templates/zerver/help/mastering-the-compose-box.md +++ b/templates/zerver/help/mastering-the-compose-box.md @@ -14,8 +14,8 @@ To narrow the view to the conversation you're currently composing to, click on the **Go to conversation** () button in the compose box. -You can also use the keyboard shortcut `Ctrl` + `.` to go to the conversation to -which you are composing. +You can also use the keyboard shortcut Ctrl + . +to go to the conversation to which you are composing. While the button is only shown when composing to a stream, the keyboard shortcut will work in both stream messages and private messages. diff --git a/templates/zerver/help/open-the-compose-box.md b/templates/zerver/help/open-the-compose-box.md index 02d5d41fe4..d2529de2f3 100755 --- a/templates/zerver/help/open-the-compose-box.md +++ b/templates/zerver/help/open-the-compose-box.md @@ -14,20 +14,22 @@ space for the message feed. There are a number of ways to open the compose box. All replies are to the message in the **blue box**. -* **Reply**: `r` or `Enter` +* **Reply**: R or Enter -* **New topic**: `c` +* **New topic**: C -* **New private message**: `x` +* **New private message**: X -You can move the blue box around using the **arrow keys**, `j`, or `k`. You -can close the compose box using `Esc`, or up/down arrow if the box is empty. +You can move the blue box around using the **arrow keys**, J, or +K. You can close the compose box using Esc, or up/down +arrow if the box is empty. !!! tip "" - Zulip offers handy - one-character [keyboard shortcuts](/help/keyboard-shortcuts) for + + Zulip offers handy one-character + [keyboard shortcuts](/help/keyboard-shortcuts) for [reading messages](/help/reading-strategies). With the compose - box closed, there is no need to use the `Ctrl` key all the time. + box closed, there is no need to use the Ctrl key all the time. ## Related articles diff --git a/templates/zerver/help/private-messages.md b/templates/zerver/help/private-messages.md index 75bdee8b94..b430570709 100644 --- a/templates/zerver/help/private-messages.md +++ b/templates/zerver/help/private-messages.md @@ -13,21 +13,21 @@ Note that group PMs are not the same as [user groups](/help/user-groups) or private streams. PMs and group PMs do not have [topics](/help/streams-and-topics) and do not appear in your list of streams. -### Send a PM +## Send a PM {start_tabs} {tab|desktop-web} 1. Click the **New private message** button at the bottom of the app, or -use the `x` keyboard shortcut. + use the X keyboard shortcut. 1. Start typing the name of the person you want to message, and -select their name from the list of suggestions. + select their name from the list of suggestions. 1. Compose your message, and click **Send**. -!!! Tip "" +!!! tip "" You can also click on any user in the right sidebar, or click on a user's profile picture or name, and select **Send private message**. @@ -35,73 +35,76 @@ select their name from the list of suggestions. {tab|mobile} 1. Tap the private messages -( private messages ) -tab at the bottom of the app. + ( private messages ) + tab at the bottom of the app. 1. Tap the **New PM** button at the top of the app. 1. Start typing the name of the person you want to message, and -select their name from the list of suggestions. + select their name from the list of suggestions. 1. Compose your message, and tap the send -(send) -button in the bottom right corner of the app. + (send) + button in the bottom right corner of the app. -!!! Tip "" +!!! tip "" You can also tap on a user's profile picture or name, and tap the **Send private message** button at the bottom of the app. {end_tabs} -### Send a group PM +## Send a group PM {start_tabs} {tab|desktop-web} 1. Click the **New private message** button at the bottom of the app, or -use the `x` keyboard shortcut. + use the X keyboard shortcut. 1. Start typing the name of the person you want to message, and -select their name from the list of suggestions. You can continue -adding as many message recipients as you like. + select their name from the list of suggestions. You can continue + adding as many message recipients as you like. 1. Compose your message, and click **Send**. {tab|mobile} 1. Tap the private messages -( private messages ) -tab at the bottom of the app. + ( private messages ) + tab at the bottom of the app. 1. Tap the **New group PM** button at the top of the app. 1. Start typing the name of the person you want to message, and -select their name from the list of suggestions. You can continue -adding as many message recipients as you like. + select their name from the list of suggestions. You can continue + adding as many message recipients as you like. 1. Approve by tapping the checkmark -(checkmark) -button in the bottom right corner of the app. + (checkmark) + button in the bottom right corner of the app. 1. Compose your message, and tap the send -(send) -button in the bottom right corner of the app. + (send) + button in the bottom right corner of the app. {end_tabs} -### Access a PM or group PM +## Access a PM or group PM If using Zulip in a browser or desktop, there are several ways to access an existing PM or group PM. * Click on **Private messages** near the top of the left sidebar to access recent conversations. + * Click on any user in the right sidebar. + * Start typing a user's name in the [search](/help/search-for-messages) bar. You'll be able to select PMs or group PMs with that user. + * Open the compose box, and enter a list of users on the **To:** - line. Type `Ctrl` + `.` to open that conversation. + line. Type Ctrl + . to open that conversation. ## Related articles diff --git a/templates/zerver/help/quote-and-reply.md b/templates/zerver/help/quote-and-reply.md index 41e56be3ea..36ed94479b 100644 --- a/templates/zerver/help/quote-and-reply.md +++ b/templates/zerver/help/quote-and-reply.md @@ -3,29 +3,40 @@ You can quote a previous message, either replying within a topic or to start a new topic. +The first line of the reply contains a [permanent link][link-to-message] +to the quoted message. Zulip automatically turns mentions in the quoted text +into [silent mentions](/help/mention-a-user-or-group#silently-mention-a-user) +to avoid unnecessarily mentioning someone twice. + +!!! tip "" + + You can use [quote blocks](/help/format-your-message-using-markdown#quotes) + when quoting emails or other non-Zulip content. + +## Quote and reply + {start_tabs} {!message-actions-menu.md!} 1. Click **Quote and reply**. -1. (optional) Delete paragraphs not relevant to your reply, just like - when replying to a multi-paragraph email. +1. *(optional)* Delete any parts of the quoted message that are not + relevant to your reply. 1. Send your message. {end_tabs} -You can also use the keyboard shortcut `>` to initiate quote-and-reply. +!!! keyboard_tip "" + + You can also use > to **quote and reply** to the + selected message. ## Related articles -* The first line of the reply contains a [permanent - link](/help/link-to-a-message-or-conversation) to the quoted - message. -* Zulip automatically turns mentions in quoted text into [silent - mentions](/help/mention-a-user-or-group#silently-mention-a-user) to - avoid unnecessarily mentioning someone twice. -* You can use [quote - blocks](/help/format-your-message-using-markdown#quotes) when - quoting emails or other non-Zulip content. +* [Format your message using markdown](/help/format-your-message-using-markdown) +* [Link to a message or conversation][link-to-message] +* [Mention a user or group](/help/mention-a-user-or-group) + +[link-to-message]: /help/link-to-a-message-or-conversation diff --git a/templates/zerver/help/reading-strategies.md b/templates/zerver/help/reading-strategies.md index 4c3290655b..8c79302047 100644 --- a/templates/zerver/help/reading-strategies.md +++ b/templates/zerver/help/reading-strategies.md @@ -10,7 +10,8 @@ in Zulip. ## Topic by topic -Like your email inbox, for most users, Zulip works best if you read it topic-by-topic. +Like your email inbox, for most users, Zulip works best if you read it +topic-by-topic. ### Finding a topic to read @@ -33,12 +34,12 @@ especially in situations where you just want a general idea of what's going on. * Click on a stream name in the left sidebar, and scroll using your mouse, - the arrow keys, `End`, or page up/down. + the arrow keys, End, or page up/down. * Click on a topic to narrow to messages from that topic. You can also search for a stream by clicking on **STREAMS** in the -left sidebar, or using the `q` [keyboard +left sidebar, or using the Q [keyboard shortcut](/help/keyboard-shortcuts). ## All messages @@ -46,10 +47,12 @@ shortcut](/help/keyboard-shortcuts). If you're all caught up, it can be useful to have a single place to keep track of all messages coming in. -* Click on **All messages** near the top left corner of the app, or hit `a`. +* Click on **All messages** near the top left corner of the app, or hit + A. -* You can use `s` (narrow to stream) or `S` (narrow to topic) to zoom in, - and `a` to get back to All messages. +* You can use S (narrow to stream) or Shift + + S (narrow to topic) to zoom in, and A to get back + to All messages. ## Starring messages for later diff --git a/templates/zerver/help/recent-topics.md b/templates/zerver/help/recent-topics.md index 729fbb1af5..836d34ed29 100644 --- a/templates/zerver/help/recent-topics.md +++ b/templates/zerver/help/recent-topics.md @@ -2,9 +2,10 @@ {!recent-topics.md!} -!!! tip "" - The arrows keys and vim navigation keys (`j`, `k`, `l`, `h`) can be - used to move between elements. +!!! keyboard_tip "" + + The arrow keys and vim navigation keys (J, K, + L, H) can be used to move between elements. ## Related articles * [Finding a topic to read](/help/finding-a-topic-to-read) diff --git a/templates/zerver/help/start-a-new-topic.md b/templates/zerver/help/start-a-new-topic.md index ffeab046f8..9f7bd36b56 100644 --- a/templates/zerver/help/start-a-new-topic.md +++ b/templates/zerver/help/start-a-new-topic.md @@ -3,29 +3,24 @@ Topics are a lightweight tool to keep conversations organized. You should start a new topic whenever you're not replying to an existing message. -### Start a new topic +## Start a new topic {start_tabs} 1. Click on a stream in the left sidebar. -1. Click **New topic** at the bottom of the app. - -!!! warn "" - - **Keyboard tip**: Use `c` to start a new topic. +1. Click **New topic** at the bottom of the app, or type C. {end_tabs} Don't worry about picking the perfect topic. The first 2-4 words that come to mind are great. -Note that topics are not available for [private messages (PMs)](/help/private-messages). If you find -yourself wanting topics in a PM, we recommend +Note that topics are not available for [private messages](/help/private-messages). +If you find yourself wanting topics in a PM, we recommend [creating a private stream](/help/create-a-stream). ## Related articles * [Rename a topic](/help/rename-a-topic) - * [Require topics](/help/require-topics) for all stream messages diff --git a/templates/zerver/help/view-and-browse-images.md b/templates/zerver/help/view-and-browse-images.md index 9e08bdcf1c..31e807239d 100644 --- a/templates/zerver/help/view-and-browse-images.md +++ b/templates/zerver/help/view-and-browse-images.md @@ -24,9 +24,9 @@ Exit the image viewer by clicking anywhere outside the image. !!! keyboard_tip "" - Use `v` to **open** the image viewer. Use `Z` and `z` to - zoom in and out of the image. Use `v` or `Esc` to **close** - the image viewer. + Use V to **open** the image viewer. Use Shift + + Z and Z to zoom in and out of the image. Use + V or Esc to **close** the image viewer. ## Troubleshooting diff --git a/templates/zerver/help/view-and-edit-your-message-drafts.md b/templates/zerver/help/view-and-edit-your-message-drafts.md index 7bc5937426..18634e511e 100644 --- a/templates/zerver/help/view-and-edit-your-message-drafts.md +++ b/templates/zerver/help/view-and-edit-your-message-drafts.md @@ -14,7 +14,7 @@ so that you never lose your work. Drafts are saved for 30 days. {tab|desktop-web} -Simply close the compose box. You can hit `Esc`, click +Simply close the compose box. You can hit Esc, click the in the top right corner of the compose box, or click on an empty part of the app. @@ -31,7 +31,7 @@ From there, you can delete or restore any of your drafts. {end_tabs} -!!! tip "" +!!! keyboard_tip "" - Use `d` to bring up the list of drafts. Check out other keyboard shortcuts - related to drafts [here](/help/keyboard-shortcuts#drafts) + Use D to bring up your list of drafts. Check out other + keyboard shortcuts related to drafts [here](/help/keyboard-shortcuts#drafts)