diff --git a/help/create-a-poll.md b/help/create-a-poll.md index 6db46b7e76..d56ce2e3c8 100644 --- a/help/create-a-poll.md +++ b/help/create-a-poll.md @@ -1,29 +1,109 @@ -# Create a poll +# Polls -Zulip natively supports creating and editing lightweight polls. +Zulip makes it easy to create a poll. Polls in Zulip are collaborative, so +anyone can add new options to a poll. However, only the creator of the poll can +edit the question. + +## Create a poll + +{start_tabs} + +{tab|via-compose-box-buttons} + +{!start-composing.md!} + +1. Make sure the compose box is empty. + +1. Click the **Add poll** icon at the bottom of the compose box. + +1. Fill out poll information as desired, and click **Add poll** to insert poll + formatting. + +1. Click the **Send** () button, or + use a [keyboard + shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) + to send your message. + +!!! tip "" + + To reorder the list of options, click and drag the **vertical dots** + () to the left of each + option. To delete an option, click the **trash** + () icon to the right of it. + +{tab|via-markdown} + +{!start-composing.md!} + +1. Make sure the compose box is empty. + +2. Type `/poll` followed by a space, and the question you want to ask. + +3. _(optional)_ Type each option on a new line. + +4. Click the **Send** () button, or + use a [keyboard shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message) + to send your message. + +!!! tip "" + + You will be able to add options after the poll is created. + +{end_tabs} + +## Add options to a poll + +!!! warn "" + + To preserve the meaning of votes in the poll, existing poll options cannot + be modified. + +{start_tabs} + +1. Fill out the **New option** field at the bottom of the poll. + +1. Click **Add option** or press Enter to add the new option to + the poll. + +{end_tabs} + +## Edit the question + +!!! warn "" + + Only the creator of a poll can edit the question. + +{start_tabs} + +1. Click the **pencil** () icon + to the right of the question. + +1. Edit the question as desired. + +1. Click the **checkmark** () icon or press + Enter to save your changes. + +!!! tip "" + + You can click the icon or press + Esc to discard your changes. + +{end_tabs} + +## Examples + +### What you type -To create a poll, send a message like ``` -/poll -``` -or -``` -/poll -option 1 -option 2 -... +/poll What did you drink this morning? +Milk +Tea +Coffee ``` -Once the poll is created, you'll be able to edit the name of the poll and -add options, but you won't be able to edit options once they are created. +### What it looks like -Note that anyone can add options to any poll, though only the poll creator -can edit the name. - -## Troubleshooting - -`/poll` must come at the beginning of the message. It is not possible to -send a message that both has a poll and has any other content. +![Markdown polls](/static/images/help/markdown-polls.png) ## Related articles diff --git a/static/images/help/markdown-polls.png b/static/images/help/markdown-polls.png new file mode 100644 index 0000000000..50a5eb3d2c Binary files /dev/null and b/static/images/help/markdown-polls.png differ