Added iOS remote instructions, updated Android remote and split out Mac install instructions.

bzr-revno: 132

manual/source/android-remote.rst

@@ -1,36 +1,31 @@
-.. _android:
+.. _android-remote:
 
-Android App
+Android Remote
-===========
+==============
+
+OpenLP gives you the ability to control your service from an Android based 
+device. The following tutorial will describe how to install and 
+use the application.
 
 Installation
 ------------
 
-OpenLP gives you the ability to control your service from an Android based 
+Open the :guilabel:`Google Play Store` app and search for OpenLP. You should
-smartphone. The following tutorial will describe how to install and 
+find the `OpenLP - Remote 2`_ app. Now install the app.
-use the application. For this example we will be using a LG G2. Other Android
-smartphones or tablets may vary slightly in appearance.
-
-Open the :guilabel:`Google Play Store` app and search for OpenLP, and you will
-find :guilabel:`OpenLP - Remote 2`. As an alternative use `this link
-<https://play.google.com/store/apps/details?id=org.openlp.android2>`_ to go to
-the apps page in Google Play Store. 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.
 
-Android application settings
+Settings
-----------------------------
+--------
 
-After the installation is complete and you open the OpenLP Android application 
+After the installation is complete and you open the OpenLP Remote app you will need to
-you will need to configure your preferences and settings. 
+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.
 
 .. image:: pics/droid_right_menu.png
 
-Open the settings by opening the menu in the top right corner and choosing 
-:guilabel:`Settings`. This will show the preferences.
-
 Display Text Size
 ^^^^^^^^^^^^^^^^^
 
@@ -49,9 +44,9 @@ Auto center display
 Set Custom Timeout
 ^^^^^^^^^^^^^^^^^^
 
-In general the OpenLP Android application will work fine without having to 
+In general the OpenLP Remote will work fine without having to change the custom timeout
-change the custom timeout settings. If you experience connection issues or are 
+settings. If you experience connection issues or are having trouble staying connected,
-having trouble staying connected, you can change these settings.
+you can change these settings.
 
 .. image:: pics/droid_preferences2.png
 
@@ -69,8 +64,8 @@ You will need to configure the server settings you will use with your phone.
 You can find these instructions and settings in the OpenLP desktop application 
 under :ref:`remote_tab`.
 
-**Note:** To use the Android application you will need to be on the same 
+**Note:** To use the OpenLP Remote you will need to be on the same network as the main
-network as the main computer.
+computer.
 
 **Hostname or IP:**
     Enter the :guilabel:`Server on IP address` found in :ref:`remote_tab`. After
@@ -94,8 +89,8 @@ network as the main computer.
     must be the same as set in :ref:`user_auth`.
 
 
-Using OpenLP Android Application
+Using the Android Remote
---------------------------------
+------------------------
 
 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.
@@ -198,5 +193,6 @@ operates on the main computer at :ref:`blank_control`.
 
 
 .. |droid_alert_button| image:: pics/droid_alert_button.png
-
 .. |droid_blank_button| image:: pics/droid_blank_button.png
+
+.. _OpenLP - Remote 2: https://play.google.com/store/apps/details?id=org.openlp.android2

manual/source/configure.rst

@@ -210,8 +210,7 @@ time when saving your service file.
   name when saving the file.
 
 **Note:** If the date and time format does not suit your needs and you are 
-technically inclined, there is more information at 
+technically inclined, there is more information at `Python.org`_.
-`Python.org <http://docs.python.org/library/datetime.html#strftime-strptime-behavior>`_.
 
 Data Location
 ^^^^^^^^^^^^^
@@ -316,9 +315,9 @@ players control the following:
    This uses the well-known VLC media player to show videos. VLC has a
    reputation of being able to handle almost any video or audio format.
 
-**Note:** You must have `VLC <http://www.videolan.org/vlc/>`_ installed for the 
+**Note:** You must have `VLC`_ installed for the VLC option to be available. On
-VLC option to be available. On Windows you must install the 32-bit version of VLC.
+Windows you must install the 32-bit version of VLC. On Mac OS X you must install
-On Mac OS X you must install the 64-bit version of VLC.
+the 64-bit version of VLC.
 
 Player Order
 ^^^^^^^^^^^^
@@ -740,12 +739,13 @@ Then generate your keys and certificate::
 
 The crt and key files need to then be placed in {data}/remotes directory.
 
-Android App
+Android and iOS Remotes
-^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^
 
-You can quickly find and download the OpenLP Android application using your 
+You can quickly find and download the OpenLP Android or iOS remote apps using your 
-Android device barcode scanner or by clicking on the :guilabel:`download` link. 
+barcode scanner or by clicking on the :guilabel:`download` link. See the sections on
-More details on the OpenLP Android application can be found at :ref:`android`.
+the :ref:`android-remote` and ref:`ios-remote` for more details on how to install
+and use them.
 
 Finding your IP address
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -796,3 +796,6 @@ port number or one or both computers are not connected to the network.
 .. |BUTTONS_OPEN| image:: pics/buttons_open.png
 
 .. |BUTTONS_REVERT| image:: pics/button_rerun.png
+
+.. _Python.org: http://docs.python.org/library/datetime.html#strftime-strptime-behavior
+.. _VLC: http://www.videolan.org/vlc/

manual/source/index.rst

@@ -9,7 +9,8 @@ Getting Started With OpenLP
 
    introduction
    system_requirements
-   install_windows_mac
+   install_windows
+   install_mac
    install_linux
    install_bsd
 
@@ -40,7 +41,8 @@ Reference Manual
    alert
    web_remote
    stage_view
-   android
+   android-remote
+   ios-remote
    glossary
 
 Questions and Troubleshooting

manual/source/install_mac.rst

@@ -0,0 +1,30 @@
+Installing OpenLP on Mac OS X
+=============================
+
+If you have not already downloaded the correct file from the `OpenLP website`_,
+download it now. Then double click on the .dmg file. This will open a window with two
+icons: An OpenLP icon and an Applications Folder icon. To install OpenLP, simply drag
+the OpenLP icon over to the Applications folder icon and you will be ready to use
+OpenLP. OpenLP will be available in your Applications folder.
+
+.. image:: pics/mac-os-x-dnd-install.png
+
+With the release of Mac OS X 10.8 applications not downloaded throught the Mac
+App Store will not run by default. A setting must be changed in the Security &
+Privacy Settings to run OpenLP.
+
+Click the Apple icon and open System Preferences
+
+.. image:: pics/mac-os-x-system-menu.png
+
+Open the Security & Privacy settings
+
+.. image:: pics/mac-os-x-settings.png
+
+Change the setting from Mac App Store to Anywhere. If the settings are grayed
+out click on the lock in the lower lefthand corner of the settings window to  
+enable editing.
+
+.. image:: pics/mac-os-x-security-and-privacy.png
+
+.. _OpenLP website: https://openlp.org/

manual/source/install_windows.rst

@@ -51,35 +51,3 @@ When the install is complete you will have the option to launch OpenLP.
 
 After making your selection click :guilabel:`Finish`
 
-Installing OpenLP on Mac OS X
-=============================
-
-Version 10.8 (Mountain Lion) and Newer
---------------------------------------
-
-With the release of version 10.8 applications not downloaded throught the Mac
-App Store will not run by default. A setting must be changed in the Security &
-Privacy Settings to run OpenLP.
-
-Click the Apple icon and open System Preferences
-
-.. image:: pics/mac-os-x-system-menu.png
-
-Open the Security & Privacy settings
-
-.. image:: pics/mac-os-x-settings.png
-
-Change the setting from Mac App Store to Anywhere. If the settings are grayed
-out click on the lock in the lower lefthand corner of the settings window to  
-enable editing.
-
-.. image:: pics/mac-os-x-security-and-privacy.png
-
-If you have not already downloaded the correct file from the OpenLP
-`website <http://www.openlp.org/>`_, download it now. Then double click on the
-.dmg file. This will open a window with two icons: An OpenLP icon and an
-Applications Folder icon. To install OpenLP, simply drag the OpenLP icon over to
-the Applications folder icon and you will be ready to use OpenLP. OpenLP will be
-available in your Applications folder.
-
-.. image:: pics/mac-os-x-dnd-install.png

manual/source/ios-remote.rst

@@ -0,0 +1,141 @@
+.. _ios-remote:
+
+iOS Remote
+==========
+
+OpenLP gives you the ability to control your service from an iOS-based device. The
+following tutorial will describe how to install and use the application.
+
+Installation
+------------
+
+Open the *Apple App Store* and search for ``OpenLP``. You should find the
+`OpenLP Remote`_ app. Install this app.
+
+.. image:: pics/ios-app-icon.png
+   :align: center
+
+When you start the app, you will initially see the launch screen, followed by the
+service screen once the app has loaded.
+
+.. image:: pics/ios-service-screen.png
+   :width: 25%
+   :align: center
+
+Settings
+--------
+
+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 settings icon in the top
+left corner.
+
+.. image:: pics/ios-settings-screen.png
+   :width: 25%
+   :align: center
+
+Server Details
+^^^^^^^^^^^^^^
+
+You will need to configure the server settings you will use with your device. You can
+find these instructions and settings in the OpenLP desktop application under
+:ref:`remote_tab`.
+
+**Note:** To use the OpenLP Remote you will need to be on the same network as the main
+computer.
+
+**Server IP:**
+    Enter the :guilabel:`Server on IP address` found in :ref:`remote_tab`.
+
+**Server port:**
+    Enter the :guilabel:`Port number` found in :ref:`remote_tab` and enter it in the box. By default this is ``4316``.
+
+Authentication
+^^^^^^^^^^^^^^
+
+**Needs auth:**
+    Tap this switch to enable authentication. Authentication needs to be set up in
+    :ref:`user_auth`.
+
+**User ID:**
+    Here you can enter a username used for accessing OpenLP remotely. This
+    must be the same as set in :ref:`user_auth`.
+
+**Password:**
+    Here you can enter a password used for accessing OpenLP remotely. This
+    must be the same as set in :ref:`user_auth`.
+
+Scrolling
+^^^^^^^^^
+
+**Use precise slide scrolling:**
+    By default, iOS's scrolling effects can make scrolling up and down the slides
+    difficult. When tapping this switch you can turn iOS's scrolling effects on and off,
+    which may result in more precise scrolling.
+
+
+Using the iOS Remote
+--------------------
+
+After you have completed the setup you are now ready to use the app. At the bottom of
+the app you can see the *Service*, *Slides*, *Alert* and *Search* tabs.
+
+Service
+^^^^^^^
+
+Selecting :guilabel:`Service` will take you to the Service tab. Selecting an item with
+a in the service manager will immediately take it live on the projection screen and you
+will be taken to the *Slides* 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. 
+
+.. image:: pics/ios-service-screen.png
+   :width: 25%
+   :align: center
+
+Along the bottom of the Service tab you can see buttons that say, *Blank*, *Theme*,
+*Desktop* and *Show*. These buttons will blank the display, set it to the current theme,
+show the main computer's desktop, or show the currently live item, respectively.
+
+Slides
+^^^^^^
+
+Selecting :guilabel:`Slides` will take you to the Slides tab. This displays what ever is
+live at the moment. You can use the arrow buttons shown on the top right to move to the
+next slide inside the item. 
+
+.. image:: pics/ios-slides-screen.png
+   :width: 25%
+   :align: center
+
+Along the bottom of the Slides tab you can also see the *Blank*, *Theme*, *Desktop* and
+*Show* buttons.
+
+Alerts
+^^^^^^
+
+To send an alert to the display, touch the *Alerts* tab at the bottom of the screen.
+Type in your alert text in the text box and press the *show* button at the bottom to
+show your alert in OpenLP. The alert will be displayed as you have it configured in
+:ref:`configure_alerts`.
+
+.. image:: pics/ios-alerts-screen.png
+   :width: 25%
+   :align: center
+
+Search
+^^^^^^
+
+If you want to search for an item that is not currently in your service, press on the
+*Search* tab at the bottom of the screen. Type your search term in the search box at the top of the screen, and then select which type of item you want to search for.
+
+.. image:: pics/ios-search-screen.png
+   :width: 25%
+   :align: center
+
+Once OpenLP has finished searching for you, the results of your search will be visible
+in the search screen. Touch a search result to add it to your service.
+
+.. image:: pics/ios-results-screen.png
+   :width: 25%
+   :align: center
+
+.. _OpenLP Remote: https://itunes.apple.com/us/app/openlp-remote/id1096218725?mt=8