Merge branch 'droid_update' into 'master'

Issue #2 Updated Android documentation page

Closes #2

See merge request openlp/documentation!11
This commit is contained in:
Tim Bentley 2019-06-18 19:51:20 +00:00
commit abd910e0e7
45 changed files with 74 additions and 25 deletions

View File

@ -11,18 +11,25 @@ Installation
------------
Open the :guilabel:`Google Play Store` app and search for OpenLP. You should
find the `OpenLP - Remote 2`_ app. Now install the app.
find the `OpenLP - Remote 2.0`_ app. Now install the app.
.. image:: pics/droid_start.png
You can now start the app and when you do you will see the startup screen.
To use the Android application you must be on the same network as the OpenLP
instance you are going to operate. If your Android device has Celluar data,
you may need to turn it off so that you can communicate with your OpenLP
instance through your Wifi connection.
Settings
--------
You can now start the app and when you do, you will see the startup screen.
Preferences
-----------
|droid_menu_button| **Menu button**
After the installation is complete and you open the OpenLP Remote app you will need to
configure your settings. Open the settings by touching the menu button in the top right
corner and tapping on :guilabel:`Settings`. This will show the settings screen.
configure your Preferences. Open the preferences by touching the menu button in the top right
corner and tapping on :guilabel:`Preferences`. This will show the Preferences screen.
.. image:: pics/droid_right_menu.png
@ -69,17 +76,13 @@ computer.
**Hostname or IP:**
Enter the :guilabel:`Server on IP address` found in :ref:`remote_tab`. After
entering the IP address in the box select :guilabel:`OK`
entering the IP address in the box then select :guilabel:`OK`
**Port:**
Enter the :guilabel:`Port number` found in :ref:`remote_tab` and enter it in
the box. By default this is 4316. After entering the port number select
:guilabel:`OK`.
**Use HTTPS:**
This specifies if HTTPS should be used. **Note:** To use HTTPS you must
setup OpenLP to be secure, see :ref:`secure_server`.
**Username:**
Here you can enter a username used for accessing OpenLP remotely. This
must be the same as set in :ref:`user_auth`.
@ -92,6 +95,8 @@ computer.
Using the Android Remote
------------------------
|droid_left_menu_button| **Left Menu**
After you have completed the setup you are now ready to use the app. Touch the
menu button in the top left corner to see the list of views the app supports.
@ -101,7 +106,7 @@ Service List
^^^^^^^^^^^^
Selecting :guilabel:`Service List` will take you to the Service Manager.
Selecting an item with a in the service manager will immediately take it
Selecting an item in the service manager will immediately make it
live on the projection screen and you will stay on the service screen on your
device. You can use the arrows buttons shown on the bottom left and right to
move to the next slide inside the item.
@ -137,21 +142,61 @@ description.
Live View
^^^^^^^^^^
Selecting :guilabel:`Live View` will display the live view on your Android
device. See the :ref:`main_view` section in the manual for a detailed
description.
Selecting :guilabel:`Live View` will provide an exact copy of what is on
the main display. See the :ref:`main_view` section in the manual for a
detailed description.
.. image:: pics/droid_live_view.png
When using the :guilabel:`Live view` it can be an advantage to use the device in
landscape mode.
.. image:: pics/droid_live_view_landscape.png
Search
^^^^^^
Selecting :guilabel:`Search` will display the search window. On the search
window you are able to search the OpenLP instance library and add items to
the service or display them to the live display.
.. image:: pics/droid_search_initial.png
Selecting the library item to the right of :guilabel:`Select Plugin` will
open the library search menu. Selecting any item on the menu will allow
you to search that library item.
.. image:: pics/droid_search_menu.png
Selecting the blank line to the right of :guilabel:`Search Text` will allow you
to enter the text you want to find. The search is the same search you would
make on the instance of OpenLP :ref:`media-manager` and will find parts of the lyrics within a
song if you type in part of the lyrics. When you have typed in your search
criteria, select the search icon in the keyboard to activate the search.
.. image:: pics/droid_search_text.png
The search results will be displayed. If no results are shown, please refine
your serch criteria by selecting the search text to make changes.
When the search results contain what you are looking for, select the item in
the search results.
.. image:: pics/droid_search_results.png
After selecting an item from the search results you can choose to :guilabel:`Send Live`,
:guilabel:`Add to Service` or :guilabel:`Cancel`.
.. image:: pics/droid_search_send_to_menu.png
Alert
^^^^^
To send an alert to the display, touch the alert button at the top right of the
To send an alert to the live display, touch the alert button at the top right of the
screen.
|droid_alert_button| **Alert button**
You can send an alert to the display by entering the text in the box and
You can send an alert to the live display by entering the text in the box and
clicking on :guilabel:`Process`. The alert will be displayed as you have it
configured in :ref:`configure_alerts`.
@ -171,28 +216,32 @@ Using the display blank type gives you the ability to blank your screen to the
methods described below. You can find out more about this feature and how it
operates on the main computer at :ref:`blank_control`.
**Show Live:**
.. image:: pics/droid_blank.png
**Live display:**
Do not blank, or unblank the display.
**Display Blank:**
**Display Black Only:**
Choosing this option will blank your projector to black as if it were shut
off.
**Display Theme:**
**Display Theme only:**
Choosing this option will show your blank theme only, without lyrics or
verses. If you are blanking a song with an assigned theme it will blank to
that theme. If no theme is assigned or you are blanking a presentation or
image, it will blank to the global theme.
**Display Desktop:**
**Display Desktop background:**
Choosing this option will show your desktop wallpaper or a program that you
have open on the extended monitor or projector. You can seamlessly switch
between the desktop wallpaper or a program and OpenLP by Blank to Desktop.
.. image:: pics/droid_blank.png
.. |droid_alert_button| image:: pics/droid_alert_button.png
.. |droid_blank_button| image:: pics/droid_blank_button.png
.. |droid_menu_button| image:: pics/droid_menu_button.png
.. |droid_left_menu_button| image:: pics/droid_left_menu_button.png
.. _OpenLP - Remote 2: https://play.google.com/store/apps/details?id=org.openlp.android2
.. _OpenLP - Remote 2.0: https://play.google.com/store/apps/details?id=org.openlp.android2

View File

@ -746,7 +746,7 @@ Android and iOS Remotes
You can quickly find and download the OpenLP Android or iOS remote apps using your
barcode scanner or by clicking on the :guilabel:`download` link. See the sections on
the :ref:`android-remote` and ref:`ios-remote` for more details on how to install
the :ref:`android-remote` and :ref:`ios-remote` for more details on how to install
and use them.
Finding your IP address

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 KiB

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 143 KiB

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 272 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 636 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 52 KiB