Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Remove all the redundant content from the index.

This commit is contained in:
Tim Abbott 2017-01-06 18:40:35 -08:00
parent e2533cac7d
commit e256073214
1 changed files with 0 additions and 266 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

266
templates/zerver/help/index.md
View File

@ -160,269 +160,3 @@ as a **realm**.
# Include Zulip
* [Chat with zulip button](/help/chat-with-zulip-button)
---
## Posting and replying
**[… To a stream](#posting-and-replying-to-a-stream)** |
**[… To individual users](#posting-and-replying-to-individual-users-pm-private-message)** |
**[Some facts about messages](#some-facts-about-messages)** |
**[Editing past messages](/help/edit-or-delete-a-message)**
At the bottom of your screen, choose whether to post to a stream or to
individual users. ![New message](/static/images/help/new_message.png)
### Posting and replying to a stream
1. If you click on a message, the default action is to open a
text-box for you to enter a new message.
1. If you would rather post something new, click “New stream message”
at the bottom of your screen (or select a stream from the list on
the left side of your
screen). ![Post to stream](/static/images/help/post_to_stream.png)
1. Enter a stream name, or the beginning of one. Private
(“invite-only”) streams show a lock next to the name.
1. Enter a topic name — we recommend keeping them brief, and they are
truncated after 50 characters.
1. Enter your message.
**[Go back to “Posting and replying”](#posting-and-replying)** |
**[Go back to “Table of contents”](#using-zulip)**
### Posting and replying to individual users (“PM”: private message)
![Post to user](/static/images/help/post_to_user.png)
* Enter the name or email address of a user, or the first letters of
one. There is no topic when you PM someone.
* You can send a message to multiple users at once, by separating
their email addresses with a comma. Each recipient will see all the
other recipients. For several days, the list of recipients will
appear under “GROUP PMs” at the lower right corner of your screen.
* If you’re bashful about using the pronoun “I”, you can get your own
registered name to appear boldfaced in a message by entering
`/me`. At present it has to be the first thing on a line, and
followed by at least one non-space character. Some people find it
easier to say things like `/me is puzzled` or `/me nods` than to
use a massively freighted word like “I”.
**[Go back to “Posting and replying”](#posting-and-replying)** |
**[Go back to “Table of contents”](#using-zulip)**
### Some facts about messages
* The paperclip icon
(<i class="icon-vector-paper-clip"></i>) under the message
field lets you attach files, including images, sound, and
video. These are uploaded to a server and a link is supplied, but
we display a thumbnail if we can. You’ll see the link in Markdown
format: `[link_text](link_URL)`
* Zulip uses a subset of
[GitHub Flavored Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables)
(GFM), and the **A** icon under the message field brings up a
cheat-sheet for what we support. You can also see that cheat-sheat
by going to the cog (<i class="icon-vector-cog"></i>) in the
upper right corner of the right sidebar and choosing “Message
formatting” from the drop-down menu.
* If a message is interrupted before you send it, the next time you
open the “New stream message” interface you’ll see “Restore draft”
below the message field. Currently we only save a single
interrupted message, and if you log out of the Zulip site or close
the tab, the message will be deleted.
* Type a tab and then the “return” key to click the Send button
without having to use your mouse.
* Typing “return” will begin a new paragraph within your message; if
you want typing “return” simply to send your message, check the
“Press Enter to send” box under the message field. It stays checked
until you uncheck it.
* If you want greater separation of your paragraphs, enter a
non-breaking space (option-space on Macintosh) on a line alone
between other paragraphs.
**[Go back to “Posting and replying”](#posting-and-replying)** |
**[Go back to “Table of contents”](#using-zulip)**
---
## Other common questions
**[Keyboard shortcuts](#keyboard-shortcuts)** |
**[Searching](search-messages)** |
**[Filtering](search-messages#filtering-messages)** |
**[Date of a message](#date-of-a-message)** |
**[Change topic title or stream name](#changing-the-title-of-a-topic-or-stream)** |
**[Edit topic titles](#editing-a-topic-title)** |
**[Message formatting](#message-formatting)** |
**[Emoji](#emoji)** |
**[Customization](#customization)** |
**[Muting vs. unsubscribing](#muting-a-stream-vs-unsubscribing-from-it)**
### Keyboard shortcuts
Go to the cog (<i class="icon-vector-cog"></i>) in the upper right
corner of the right sidebar and choose “Keyboard shortcuts” from the
drop-down menu.
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**
### Find starred messages
If you have starred a message and sometime later want to find it
again, you can bring up all the message you have starred by clicking
the "Starred messages" view (in the filters at the top of the left
sidebar).
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**
### Date of a message
If you “mouse over” the time stamp of a message (upper right corner of
the message), you’ll see a fuller date-time stamp and time zone.
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**
### Changing the title of a topic or stream
If discussion drifts, at what point should the title of a topic or
stream be changed?
In the end, this is a question of community culture within your
organization. But here are some thoughts:
* **Topics**: Topics drift more often than streams. Some people like
to announce that they are “moving” or “forking” the topic and then
creating a new topic with its own title — the new title could, if
you wish, say “was ‘former topic’” or “forked from ‘previous
topic’”. Also, please see
**[Editing a topic titles](#editing-a-topic-title)**, below.
* **Streams**: If a stream has to be divided, it is best to retire
the original stream complete, otherwise the separated-out subject
may periodically reappear in the original stream. This is is an
issue for administrators to watch for.
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**
### Editing a topic title
As long you have contributed a message to some topic, you can edit the
topic title. Go to one of your own messages in that topic and follow
**[the instructions for editing it](/help/edit-or-delete-a-message)**. Notice
that the topic title is now editable, too. You will be offered the
chance to change the topic in one of three ways:
* Change only this message topic
* Change later messages to this topic
* Change previous and later messages to this topic
Your edits will be applied if you “save” the message, even if the body
of the message is unchanged.
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**
### Emoji
* **Adding emoji to a message**. There are two ways to do this:
* Zulip fully supports Unicode, so if you find any emoji you like
and paste them into your message (👛🚹🏪🎿), they will be
accepted. You can browse the
[Unicode Consortium's full list of emoji](http://unicode.org/emoji/charts/full-emoji-list.html),
although our emoji images may differ from what you see there.
* Zulip also lets you enter emoji by name, using the format
`:name:`. So sending `:octopus: :film_projector:
:revolving_hearts:` will produce
<img alt="octopus" class="inline" src="/static/generated/emoji/images/emoji/octopus.png"/>
<img alt="film_projector" class="inline" src="/static/generated/emoji/images/emoji/film_projector.png"/>
<img alt="revolving_hearts" class="inline" src="/static/generated/emoji/images/emoji/revolving_hearts.png"/>
can find emoji that are accessible this way by typing a colon and
two or more letters of the alphabet — a pop-up menu will appear
showing the first five emoji-names containing the letters you
typed (consecutively).
In addition, an emoji pop-over menu is planned, to let you choose
them by eye.
* **What if I'd rather not see emoji in other people's
messages?**. Sorry, this isn't yet supported.
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**
### Customization
* **Zulip**. For customizing Zulip itself, there is a cog
(<i class="icon-vector-cog"></i>) in the upper right corner of
the right sidebar, and it brings up a menu of options.
* **Streams**. For customizing your stream subscriptions and
individual streams, you can either use the “Manage Streams”
menu-option under the main cog, or use the smaller cog above the
list of streams in the left sidebar. The message table will be
replaced with a “Streams” pane. (You can also get to this pane
using the cog-icon above the list of streams in the left sidebar.)
On the Streams pane you can create streams, subscribe or
unsubscribe to existing streams, subscribe other people, mute or
unmute a stream, and control a stream’s color and notification
settings.
For customizing an individual stream without opening the Streams
pane, there is a “down-chevron”
<i class="icon-vector-chevron-down"></i> to the right
of each stream-name in the left sidebar. Clicking the chevron opens
a menu of options.
Special things you can do with a stream you are subscribed to:
* Turning off (“muting”) a stream, while staying subscribed to it.
* “Pinning” a stream (moving it to the top of the list of streams).
* Marking all messages as read.
* Choosing a custom color.
You can leave the Streams pane by clicking on Home near the top of
the left sidebar.
* **Other customizations** are available in the Settings pane. Please
experiment with them.
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**
### Muting a stream vs. unsubscribing from it
When a stream is muted you can still see (greyed out) how many unread
messages are there, and you can still read it and post to it while
it's muted — useful if you only want to read the stream on demand but
not have its messages populate your main Home message table.
And since subscribed-to streams are now sorted, with recently active
streams at the top of the list and inactive streams below, your
recently active but muted streams will be interlarded among your
unmuted streams, saving space.
You can't do any of that with a unsubscribed stream.
**[Go back to “Other common questions”](#other-common-questions)** |
**[Go back to “Table of contents”](#using-zulip)**