diff --git a/static/images/help/emoji-box.png b/static/images/help/emoji-box.png new file mode 100644 index 0000000000..e88b070a2d Binary files /dev/null and b/static/images/help/emoji-box.png differ diff --git a/static/images/help/eye.png b/static/images/help/eye.png new file mode 100644 index 0000000000..abfd7ef3f8 Binary files /dev/null and b/static/images/help/eye.png differ diff --git a/static/images/help/new-stream-message.png b/static/images/help/new-stream-message.png new file mode 100644 index 0000000000..9eb94bad1a Binary files /dev/null and b/static/images/help/new-stream-message.png differ diff --git a/static/images/help/new-stream.png b/static/images/help/new-stream.png new file mode 100644 index 0000000000..da5b3dadda Binary files /dev/null and b/static/images/help/new-stream.png differ diff --git a/static/images/help/nobody.png b/static/images/help/nobody.png new file mode 100644 index 0000000000..504594d291 Binary files /dev/null and b/static/images/help/nobody.png differ diff --git a/static/images/help/paper-clip.png b/static/images/help/paper-clip.png new file mode 100644 index 0000000000..d78ab37b74 Binary files /dev/null and b/static/images/help/paper-clip.png differ diff --git a/static/images/help/pencil-paper.png b/static/images/help/pencil-paper.png new file mode 100644 index 0000000000..d938daa32c Binary files /dev/null and b/static/images/help/pencil-paper.png differ diff --git a/static/images/help/press-enter.png b/static/images/help/press-enter.png new file mode 100644 index 0000000000..817e38521e Binary files /dev/null and b/static/images/help/press-enter.png differ diff --git a/static/images/help/preview.png b/static/images/help/preview.png new file mode 100644 index 0000000000..e645905af2 Binary files /dev/null and b/static/images/help/preview.png differ diff --git a/static/images/help/private-box.png b/static/images/help/private-box.png new file mode 100644 index 0000000000..a10b5d48ac Binary files /dev/null and b/static/images/help/private-box.png differ diff --git a/static/images/help/private-message.png b/static/images/help/private-message.png new file mode 100644 index 0000000000..a0605b4fac Binary files /dev/null and b/static/images/help/private-message.png differ diff --git a/static/images/help/restore-draft.png b/static/images/help/restore-draft.png new file mode 100644 index 0000000000..045dc7067c Binary files /dev/null and b/static/images/help/restore-draft.png differ diff --git a/static/images/help/send.png b/static/images/help/send.png new file mode 100644 index 0000000000..cc7e31752b Binary files /dev/null and b/static/images/help/send.png differ diff --git a/static/images/help/smiley-button.png b/static/images/help/smiley-button.png new file mode 100644 index 0000000000..c3f17a9d76 Binary files /dev/null and b/static/images/help/smiley-button.png differ diff --git a/static/images/help/stream-none.png b/static/images/help/stream-none.png new file mode 100644 index 0000000000..20a7562973 Binary files /dev/null and b/static/images/help/stream-none.png differ diff --git a/static/images/help/streams-private-overview.png b/static/images/help/streams-private-overview.png new file mode 100644 index 0000000000..4a61dd009e Binary files /dev/null and b/static/images/help/streams-private-overview.png differ diff --git a/static/images/help/uploaded.png b/static/images/help/uploaded.png new file mode 100644 index 0000000000..2bd468581b Binary files /dev/null and b/static/images/help/uploaded.png differ diff --git a/static/images/help/uploading.png b/static/images/help/uploading.png new file mode 100644 index 0000000000..6abc0cb10e Binary files /dev/null and b/static/images/help/uploading.png differ diff --git a/static/images/help/x.png b/static/images/help/x.png new file mode 100644 index 0000000000..4efa656f22 Binary files /dev/null and b/static/images/help/x.png differ diff --git a/templates/zerver/help/index.md b/templates/zerver/help/index.md index f446d750c2..eab83a2730 100644 --- a/templates/zerver/help/index.md +++ b/templates/zerver/help/index.md @@ -29,6 +29,7 @@ as a “**realm**”. - **[Posting and replying](#posting-and-replying)** - **[Mention a Team Member](/help/mention-a-team-member)** - **[Message formatting](/help/message-formatting.md)** +- **[Streams and private messages](/help/streams-and-private-messages.md)** - **[Uploading and Sharing Files](/help/uploading_sharing_files)** - **[Other common questions](#other-common-questions)** - **[Signing out](signing-out.md)** diff --git a/templates/zerver/help/streams-and-private-messages.md b/templates/zerver/help/streams-and-private-messages.md new file mode 100644 index 0000000000..f547d90810 --- /dev/null +++ b/templates/zerver/help/streams-and-private-messages.md @@ -0,0 +1,96 @@ +# Streams and private messages +![Streams and private messages overview](/static/images/help/streams-private-overview.png) + +Zulip supports both **private messaging** and group chats via conversation **streams**. + +**Streams** are either: +* **Public** - Public streams are for open discussions. All users can subscribe to public streams and discuss there. Any Zulip user can join any public stream in the realm, and can view the complete message history of any public stream without joining the stream. +* **Private** - Private streams are for confidential discussions and are only visible to users who've been invited to subscribe to them. Users who are not members of a private stream cannot subscribe to the stream or read or send messages to the stream. + +**Private messaging** can either be **one-on-one** or **group** conversations. They can only be seen by users participating in the message. + +## Creating a new stream message +![New stream message](/static/images/help/new-stream-message.png) + +To submit a new stream message, first click the **New stream message** button located at the bottom of your screen. + +![New stream message](/static/images/help/new-stream.png) + +A box similar to the one shown in the previous image will appear. + +In the **Stream** field, input the stream name of the message you want your message to be located in. When you begin typing a stream name, autocomplete suggestions will appear. + +![Stream does not exist](/static/images/help/stream-none.png) + +If you attempt to input a nonexistent stream name, an error message will appear. + +Once you have entered your stream name, enter the topic for your message in the **Topic** field. Your topic name can be no longer than 52 characters. + +Finally, enter your message in the box labeled **Compose your message here...** or messaging box. You can now send your message to the specified stream under the specified topic. + +You can always delete your message by clicking the **x** (![x](/static/images/help/x.png)) icon located at the top-right corner of your messaging box. + +## Private messaging +![New private message](/static/images/help/private-message.png) + +To submit a new stream message, first click the **New private message** button located at the bottom of your screen. + +![New stream message](/static/images/help/private-box.png) + +A box similar to the one shown in the previous image will appear. + +In the **one or more people...** field, input the username or email address of the user you want to privately message. When you begin typing an email address or username, autocomplete suggestions will appear. + +![Nobody does not exist](/static/images/help/nobody.png) + +If you attempt to input a nonexistent username or email address, an error message will appear. + +Once you have selected the user you want to message, enter your message in the box labeled **Compose your message here...** or messaging box. You can now privately send your message to the specified user. + +You can always delete your message by clicking the **x** (![x](/static/images/help/x.png)) icon located at the top-right corner of your messaging box. + +## Other features +While sending either a stream or private message, several features located below the messaging bn the bottom-left corner can aid you in composing your message. + +### Emoji + +![Emoji feature](/static/images/help/emoji-box.png) + +Clicking the **smiley face** (![smiley face](/static/images/help/smiley-button.png)) icon allows a box to appear featuring Zulip's vast collection of emojis. You can select an emoji to include in your message. + +### Attach files + +![File upload feature](/static/images/help/uploaded.png) + +Clicking the **paper clip** (![paper clip](/static/images/help/paper-clip.png)) icon allows you to select a file from your computer and attach it to your message, uploading it to Zulip to share with your peers. + +![File upload feature](/static/images/help/uploading.png) + +While the file is uploading, a blue box labeled **Uploading...** will appear, and a link to your file will be included in your message once the file has been uploaded. + +### Formatting + +![Message formatting modal](/static/images/help/message-formatting-summary.png) + +Clicking the **A** (![A](/static/images/help/formatting.png)) icon will reveal a modal window with a summary of message formatting in Zulip. For more information on message formatting, see our [message formatting guide](/help/message-formatting.md). + +### Restore draft + +![Restore draft](/static/images/help/restore-draft.png) + +If you accidentally delete your message by clicking the **x** (![x](/static/images/help/x.png)) icon in the upper right corner of your messaging box, you can restore your previous message by clicking a blue link labeled **Restore draft**, which appears between the **A** (![A](/static/images/help/formatting.png)) and **eye** (![eye](/static/images/help/eye.png)) icons. + +### Preview + +![Message preview](/static/images/help/preview.png) + +Clicking the **eye** (![eye](/static/images/help/eye.png)) icon will allow you to preview your message. To resume editing your message, click the **pencil and paper** (![pencil and paper](/static/images/help/pencil-paper.png)) icon that has replaced the eye icon. + +### Press Enter to send +![Press enter to send](/static/images/help/press-enter.png) + +The **Press Enter to send** checkbox allows you to automatically send your message when you press the enter (or return) key on your keyboard. + +![Send button](/static/images/help/send.png) + +If the box is unchecked, a green **Send** button will appear. You will have to click on the **Send** button to send your message.