docs: Add user guide for alert words.

This commit is contained in:
Callum 2016-12-27 13:39:06 +00:00 committed by Tim Abbott
parent 5db1a69542
commit 76807d4c82
7 changed files with 34 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 458 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -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.

View File

@ -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)