docs: Conform *Use Zulip on Android* doc to documentation styling guidelines.

This commit is contained in:
synicalsyntax 2017-01-11 18:09:06 -08:00 committed by Tim Abbott
parent 2505a1be5c
commit be26c4e67e
12 changed files with 77 additions and 125 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.8 KiB

View File

@ -1,148 +1,106 @@
# Using Zulip on Android
Zulip has an Android application, compatible with Android versions 3.2 and
higher.
It's available on the Google Play Store, and can be downloaded from
[here](https://play.google.com/store/apps/details?id=com.zulip.android), or by
clicking the badge below.
[![Play Store badge](/static/images/help/google-play-badge.png)](
https://play.google.com/store/apps/details?id=com.zulip.android)
higher. The app can be downloaded from the
[Google Play Store](https://play.google.com/store/apps/details?id=com.zulip.android).
## Initial setup
### Connecting to a server
When you open the app for the first time, or after you log out, a screen asking
When you open the app for the first time or after you log out, a screen asking
for your server's address appears. You have to write the server's URL in it, and
press *Enter*.
!!! tip ""
There's no need to add `https://` in case your server is running secure
HTTP (HTTPS) protocol.
press **Enter**.
!!! warn ""
If your server uses unsecure HTTP, you'll have to
**Note:** There's no need to add `https://` in case your server is running secure
HTTP (HTTPS) protocol.
However, if your server uses a unsecure HTTP connection, you'll have to
write `http://` manually. A message will appear, warning you about the risks
of using this type of connections. In case you have no other choice, choose
*Use HTTP*.
of using this type of connections. In case you have no other choice, choose the
**Use HTTP** option.
### Logging in
After connecting to the server, you'll be able to log in either with an email
address and a password, or using your Google account.
!!! tip ""
If you decide to log in with an email/password combination, enter them in
the text fields and press *Log in*.
* If you decide to log in with an email/password combination, enter your email
address in the **Email** field and your password in the **Password** field,
then press **Log in**.
![Login form](/static/images/help/android-log-in.png)
!!! tip ""
If you prefer to log in with your Google account, press the *Sign in* button
with Google's logo on it.
* If you prefer to log in with your Google account, press the **Sign in with Google** button.
![Google button](/static/images/help/android-google-sign-in-button.png)
You will be asked to choose which one do you want to
use, between those you have configured in your device.
You will be asked to choose which one do you want to use from those you have
configured in your device.
### Logging in (development servers)
The Android application supports using development servers as well. However,
after connecting to the server, the following will appear:
![Dev login screen](/static/images/help/android-dev-login-screen.png)
In order to log in, press *Dev backend testing server*, and choose the account
you want to use:
![Dev accounts](/static/images/help/android-dev-accounts.png)
The Android application supports connecting to development servers as well. To
do so, choose the **Dev backend testing server** option from the
**Authentication Options** menu, and select the account you want to use.
### Logging out
You only need to do this when you want to switch to another account or server.
Tap the three dots (<i class="icon-vector-ellipsis-vertical"></i>)
in the top right corner of the screen, and choose *Log out*.
![Log out](/static/images/help/android-log-out.png)
You only need to log out when you want to switch to another account or server.
To do so, tap the overflow ( <i class="icon-vector-ellipsis-vertical"></i> )
icon in the top right corner of the screen, and choose **Log out**.
## Using the app
### Sending a stream message
1. Press the pencil button at the right bottom side of the screen, in case the
1. Press the pencil button at the right bottom side of the screen if the
compose box isn't already there.
2. Make sure you are in the "stream message" mode. You should see the
icon of a person
(![Person icon](/static/images/help/android-person-icon.png)) at the
right-hand side of the composing area.
2. Make sure you are in **stream message** mode. You should see a person
(![Person](/static/images/help/android-person-icon.png)) icon at the
right-hand side of the composing box.
If it isn't there, tap the megaphone
(![Megaphone icon](/static/images/help/android-megaphone-icon.png)).
3. Fill the name of the stream where you want to send your message in the
*Stream* field.
!!! tip ""
Suggestions matching the entered name will appear as you type the stream's
name.
4. Enter the topic of your message in *Topic*.
5. Write your message in the field at the bottom, the one that says *Tap on a
message to compose reply*.
6. Hit the paper plane icon
(![Paper plane icon](/static/images/help/android-paperplane-icon.png)) to
send your message.
![Stream message](/static/images/help/android-stream-message.png)
(![Megaphone](/static/images/help/android-megaphone-icon.png)) icon.
3. Input the name of the stream where you want to send your message in the
**Stream** field. Autocompletion suggestions will appear as you type the
stream's name.
4. Enter the topic of your message in **Topic**.
5. Write your message in the field labeled **Tap on a message to compose reply**.
6. Click the send (![send](/static/images/help/android-paperplane-icon.png))
icon to send your message.
### Sending a private message
1. Press the pencil button at the right bottom side of the screen, in case the
1. Press the pencil button at the right bottom side of the screen if the
compose box isn't already there.
2. Make sure you are in the "stream message" mode. You should see the
icon of a megaphone
(![Megaphone icon](/static/images/help/android-megaphone-icon.png)) at the
right-hand side of the composing area.
If it isn't there, tap the person
(![Person icon](/static/images/help/android-person-icon.png)).
3. Enter the email address of the person you want to chat with in the *Person*
field.
!!! tip ""
Suggestions matching the entered email address will appear as you type it.
4. Write your message in the field at the bottom, the one that says *Tap on a
message to compose reply*.
5. Hit the paper plane icon
(![Paper plane icon](/static/images/help/android-paperplane-icon.png)) to
send your message.
![Private message](/static/images/help/android-private-message.png)
2. Make sure you are in **private message** mode. You should see a megaphone
(![Megaphone](/static/images/help/android-megaphone-icon.png)) icon at the
right-hand side of the compose box. If it isn't there, tap the person
(![Person](/static/images/help/android-person-icon.png)) icon.
3. Enter the email address of the person you want to chat with in the **Person**
field. Autocomplete suggestions will appear as you type the email address.
4. Write your message in the field labeled **Tap on a message to compose reply**.
5. Click the send (![send](/static/images/help/android-paperplane-icon.png))
icon to send your message.
### Replying to a message
1. Tap the message you want to reply to in the message list.
2. The *Stream* and *Topic* fields will automatically fill.
3. Write your message in the field at the bottom, the one that says *Tap on a
message to compose reply*.
4. Hit the paper plane icon
(![Paper plane icon](/static/images/help/android-paperplane-icon.png)) to
send your message.
2. The **Stream** and **Topic** fields will automatically fill.
3. Write your message in the field labeled **Tap on a message to compose reply**.
4. Click the send (![send](/static/images/help/android-paperplane-icon.png))
icon to send your message.
### Narrowing to a stream
There are multiple ways of narrowing to a stream in Zulip's Android app.
By swiping to the right from the border of the screen, or by hitting the menu
(<i class="icon-vector-reorder"></i>) icon, you'll be able to see a list of the
streams you're subscribed to.
By swiping to the right from the border of the screen or clicking the menu (<i
class="icon-vector-reorder"></i>) icon, you'll be able to see a list of the
streams you're subscribed to. You can tap one of them to narrow to that stream.
![Streams list](/static/images/help/android-streams-list.png)
You can tap one of them to narrow to that stream.
Another way is to press the name of a stream in a message. This will
automatically narrow your message list to the pressed stream.
!!! tip ""
You can also click on the stream name of a message to automatically narrow
your message list to only show messages from the pressed stream.
### Narrowing to a topic
@ -151,46 +109,40 @@ topic over a message.
### Searching for messages
To look for messages containing some specific terms:
You can search your organization for specific messages by using [search operators](/help/searching-for-messages).
1. Tap the magnifying glass
(![Magnifying glass icon](/static/images/help/android-magnifying-icon.png))
icon at the top of the screen.
2. Write the desired search terms.
3. Press enter in your keyboard.
![Message search](/static/images/help/android-search.png)
1. Tap the search (![search](/static/images/help/android-magnifying-icon.png))
icon at the top of the screen.
2. Enter the [search operators](/help/searching-for-messages#search-operators)
that you want to use to narrow your messages.
3. Press the **Enter** key in your keyboard to begin your search.
### Filtering messages
You can filter the messages in your list. To do it:
You can filter the messages in your message list.
1. Press the filter
(![Filter icon](/static/images/help/android-filter-icon.png)) icon in the top
right side of the screen (between the magnet and the three dots
<i class="icon-vector-ellipsis-vertical"></i>).
2. Choose the filtering criteria.
3. The message list will refresh, showing only the matching messages.
1. Press the filter (![Filter](/static/images/help/android-filter-icon.png))
icon on the top right side of the screen.
2. Select the filtering criteria from the dropdown that appears.
3. The message list will refresh to show only the filtered messages.
### Manually refreshing the message list
The messages will appear automatically as they are sent. However, you can
manually refresh them by scrolling to the bottom, or by tapping the three dots
(<i class="icon-vector-ellipsis-vertical"></i>) in the top right corner, and
choosing *Refresh*.
manually refresh them by:
![Refresh option](/static/images/help/android-refresh.png)
* scrolling to the bottom of the message list
* clicking the overflow (
<i class="icon-vector-ellipsis-vertical"></i> ) icon in the top right corner
and choosing the **Refresh** option from the dropdown that appears.
### Day/Night themes
### Day/Night Themes
Zulip's Android app offers two different themes. One lighter (day theme), and
one with dark colors (night theme), that makes reading more comfortable when
Zulip's Android app offers two different themes: one lighter (day theme), and
one with dark colors (night theme) that makes reading more comfortable when
there isn't much light.
![Night theme](/static/images/help/android-night-theme.png)
To switch between both, tap the three dots
(<i class="icon-vector-ellipsis-vertical"></i>) at the top right corner of the
screen, and hit *Switch Day/Night Theme*.
![Switch themes](/static/images/help/android-switch-themes.png)
To switch between the two themes, click the overflow ( <i
class="icon-vector-ellipsis-vertical"></i> ) icon at the top right corner of the
screen and choosing the **Switch Day/Night Theme** option from the dropdown that
appears.