diff --git a/static/images/help/alert-word-notification-example.png b/static/images/help/alert-word-notification-example.png new file mode 100644 index 0000000000..c8c781b6e1 Binary files /dev/null and b/static/images/help/alert-word-notification-example.png differ diff --git a/static/images/help/alert-words-message-example.png b/static/images/help/alert-words-message-example.png new file mode 100644 index 0000000000..2eb4704340 Binary files /dev/null and b/static/images/help/alert-words-message-example.png differ diff --git a/static/images/help/delete-button.png b/static/images/help/delete-button.png new file mode 100644 index 0000000000..99181fbe87 Binary files /dev/null and b/static/images/help/delete-button.png differ diff --git a/static/images/help/settings-custom-alerts-sample.png b/static/images/help/settings-custom-alerts-sample.png new file mode 100644 index 0000000000..8a526e700b Binary files /dev/null and b/static/images/help/settings-custom-alerts-sample.png differ diff --git a/static/images/help/settings-custom-alerts.png b/static/images/help/settings-custom-alerts.png new file mode 100644 index 0000000000..2585d98dbe Binary files /dev/null and b/static/images/help/settings-custom-alerts.png differ diff --git a/templates/zerver/help/alert-words.md b/templates/zerver/help/alert-words.md new file mode 100644 index 0000000000..cf00e5b11c --- /dev/null +++ b/templates/zerver/help/alert-words.md @@ -0,0 +1,33 @@ +# Alert Words +Zulip allows you to define custom alert words and phrases. +When they are used in any stream you are subscribed to, it works +similarly to being [@-mentioned](/help/at-mention-a-team-member) +by another user. + +## Adding Alert Words +1. Click the cog (![cog](/static/images/help/cog.png)) in the upper +right corner of the right sidebar. +2. Select **Settings** from the dropdown menu that appears. + ![Settings dropdown](/static/images/help/settings-dropdown-menu.png) + +3. Scroll down until you reach the **Custom Alert Words** section. + + ![Custom Alert Words](/static/images/help/settings-custom-alerts.png) + +4. Type the word/phrase you wish to be notified for into the text box, + then click the **Add Alert Word** button. + +Once these steps are completed, you should see something similar to: + +![Alert Settings](/static/images/help/settings-custom-alerts-sample.png) + +If any alert words are mentioned, they will be highlighted within the message, +and you will be alerted in accordance with your notification settings. + +![Example Notification](/static/images/help/alert-word-notification-example.png) + +## Removing Alert Words + +Alert Words can be removed easily in the settings menu, by clicking the +red bin button (![Trash Can](/static/images/help/delete-button.png)) +next to the word/phrase to be deleted. diff --git a/templates/zerver/help/index.md b/templates/zerver/help/index.md index 8c40e5f080..dc16b5839d 100644 --- a/templates/zerver/help/index.md +++ b/templates/zerver/help/index.md @@ -110,7 +110,7 @@ as a “**realm**”. * Configure audible notifications * Configure email notifications * Configure mobile push notifications -* Add an alert word +* [Add an alert word](/help/alert-words) ## Tools & Customization * [Keyboard shortcuts](/help/keyboard-shortcuts)