Updated stage view and added live view.

Updated docs for webremote.
Updated the FTW docs.
Added more info on bible search format. Fixes bug 802166.
Added info about importing zefania bibles.
Added PyQt4.QtCore to import mocks to get api doc generating working.
Updated various pictures.

bzr-revno: 122
Fixes: https://launchpad.net/bugs/802166, https://launchpad.net/bugs/1022837

api/source/conf.py

@@ -349,4 +349,5 @@ autosummary_generate = True
 
 autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
 
-autodoc_mock_imports = ['pyodbc', 'uno', 'PyQt4.phonon', 'com.sun.star.connection', 'com.sun.star.beans']
+autodoc_mock_imports = ['pyodbc', 'uno', 'PyQt4.phonon', 'com.sun.star.connection', 'com.sun.star.beans',
+                        'PyQt4.QtCore']

manual/source/bibles.rst

@@ -52,24 +52,6 @@ It may take some time to import your Bible so please be patient.
 When the import has finished click :guilabel:`Finish` and you should be
 ready to use your Bible in OpenLP.
 
-Importing from openlp.org 1.x
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Importing Bibles from openlp.org 1.x is a simple process. First you will need to
-locate your version 1.x Bibles. Version 1.x Bibles have the `.bible` file
-extension.
-
-Windows XP::
-
-    C:\Documents and Settings\All Users\Application Data\openlp.org\Data\Bibles\
-
-Windows Vista / Windows 7::
-
-    C:\ProgramData\openlp.org\Data\Bibles\
-
-After selecting all of the openlp.org 1.x Bibles you want to convert, click
-:guilabel:`Next` to continue the import process.
-
 Importing OSIS Bibles
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -113,9 +95,12 @@ contain files with all your Bibles in them without a file extension. (file.xmms)
 When you have located this folder you will need to select the Bible from the
 folder.
 
-You may also import downloaded Bibles from OpenSong. The process is the same,
+You may also import downloaded Bibles from `OpenSongs webpage (scroll down to
+find bibles) <http://opensong.org/pages/downloads.html>`_. The process is the same,
 except you will need to extract the Bible from a zip file. This is usually done
 by right clicking on the downloaded file and select `Extract` or `Extract Here`.
+Note that some of the bibles on OpenSongs webpage are actually in the Zefania
+format, which OpenLP can also import, see :ref:`zefaniaimport`.
 
 After selecting the OpenSong Bibles you want to import, follow the rest of the
 import process. When the import has finished you should be ready to use your
@@ -167,3 +152,18 @@ books and verse file location.
 
 After you have selected the file locations you can continue with the import
 process. Once it is complete you should be ready to use your imported CSV Bible.
+
+.. _zefaniaimport:
+
+Importing Zefania Bibles
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+The Zefania project has many Bibles available from `their website
+<http://sourceforge.net/projects/zefania-sharp/files/Bibles/>`_.
+Find the Bible you would like to import and download the file. The downloaded
+file is a zip-file from which the Bible must be extracted. This is usually done
+by right clicking on the downloaded file and select `Extract` or `Extract Here`.
+
+You can now simply select the extracted file for import and click
+:guilabel:`Next` to continue the import process. When your import is completed
+you should now be ready to use the imported Zefania Bible.

manual/source/dualmonitors.rst

@@ -51,8 +51,37 @@ Microsoft Windows
 -----------------
 
 Dual monitor setup is similar among all the currently supported Windows
-releases (:ref:`win7monitor`, :ref:`winvistamonitor`, :ref:`winxpmonitor`), but 
-does vary slightly from one release to the next.
+releases (:ref:`win10monitor`, :ref:`win7monitor`,
+:ref:`winvistamonitor`), but does vary slightly from one release to the next.
+
+.. _win10monitor:
+
+Windows 8 & 10
+^^^^^^^^^^^^^^
+
+When using Windows 8 and 10 enabling your projector is easy. Simply connect your
+projector and press :kbd:`Windows+P`.
+
+The more traditional way is also fairly straight forward. Go to
+:guilabel:`Control Panel` and click on :guilabel:`Adjust screen resolution`
+under :guilabel:`Appearance and Personalization`.
+
+.. image:: pics/controlpanel-win10.png
+
+This will open up a window for configuring your screens. Enable your projector
+and make sure that the selected value for :guilabel:`Multiple displays` is 
+:guilabel:`Extend these displays`.
+
+.. image:: pics/screen-res-win10.png
+
+On Windows 10 there is also a different way of configuring your screens. By
+right-clicking on the desktop and choosing :guilabel:`Display settings` a
+different configuration window will appear.
+
+.. image:: pics/new-display-settings-win10.png
+
+To change the resolution of the screens you will have to click 
+:guilabel:`Advanced display settings`.
 
 .. _win7monitor:
 
@@ -91,19 +120,6 @@ you have checked :guilabel:`Extend the desktop onto this monitor`.
 
 .. image:: pics/vistadisplaysettings.png
 
-.. _winxpmonitor:
-
-Windows XP
-^^^^^^^^^^
-
-From :guilabel:`Control Panel` select :guilabel:`Display`, or right click on a
-blank area of the desktop and select :guilabel:`Properties`. From the
-:guilabel:`Display Properties` window click on the :guilabel:`Settings` tab.
-Click on the monitor that represents your projector and make sure you have
-checked :guilabel:`Extend my Windows desktop onto this monitor`.
-
-.. image:: pics/xpdisplaysettings.png
-
 Linux
 -----
 

manual/source/install_windows_mac.rst

@@ -5,63 +5,55 @@ Installing OpenLP is identical over all supported versions of Windows. After
 downloading the file from the `download page <http://www.openlp.org/en/download.html>`_ 
 open the file by double clicking when the download is complete. After opening 
 the downloaded file agree to open the unverified file if you are prompted.
+On Windows 8 you might have to click :guilabel:`More info` before you can
+verify by clicking :guilabel:`Run anyway`.
 
 Next select your language and click :guilabel:`OK`
 
-.. image:: pics/selectlanguage.png
+.. image:: pics/win10-selectlanguage.png
 
 After reading the welcome message click :guilabel:`Next` to continue the
 installation.
 
-.. image:: pics/welcome.png
+.. image:: pics/win10-welcome.png
 
 Agree to the license agreement. Click :guilabel:`Next` to continue.
 
-.. image:: pics/license.png
+.. image:: pics/win10-license.png
 
 Select the install location for OpenLP. Choosing the default location is
 generally the best choice. Click :guilabel:`Next` to continue.
 
-.. image:: pics/installlocation.png
+.. image:: pics/win10-installlocation.png
 
 Select a start menu folder for OpenLP to be visible in. The default location
 here is generally the best choice. Click :guilabel:`Next` to continue.
 
-.. image:: pics/startmenufolder.png
+.. image:: pics/win10-startmenufolder.png
 
 Select if you want to create a desktop or Quick Launch icon. Click :guilabel:`Next`
 to continue.
 
-.. image:: pics/additionaltask.png
+.. image:: pics/win10-additionaltask.png
 
 Review your previous choices. If you need to make any changes click the
 :guilabel:`Back button` to get to the previous choices, or click :guilabel:`Install`
 
-.. image:: pics/readytoinstall.png
+.. image:: pics/win10-readytoinstall.png
 
 The progress bar will update you on how far along the installation has gone.
 
-.. image:: pics/progress.png
+.. image:: pics/win10-progress.png
 
-When the install is complete you will have the option to launch OpenLP. After
-making your selection click :guilabel:`Finish`
+When the install is complete you will have the option to launch OpenLP.
+
+.. image:: pics/win10-launch.png
+
+After making your selection click :guilabel:`Finish`
 
 Installing OpenLP on Mac OS X
 =============================
 
-.. _macinstall:
-
-Version 10.6 (Snow Leopard) to 10.7 (Lion)
-------------------------------------------
-
-Installing OpenLP on OS X is very simple. After downloading the correct file
-from the OpenLP `download page <http://www.openlp.org/en/download.html>`_ 
-double click on the .dmg file. Drag the OpenLP icon over to the Applications
-folder and you will be ready to use OpenLP. OpenLP will be available in your
-Applications folder.
-
-.. image:: pics/osxinstall.png
-
 Version 10.8 (Mountain Lion) and Newer
 --------------------------------------
 
@@ -83,5 +75,10 @@ enable editing.
 
 .. image:: pics/gatekeeper3.png
 
-Now you can install OpenLP with the instructions for Mac :ref:`macinstall`.
+I you have not already downloaded the correct file from the OpenLP
+`download page <http://www.openlp.org/en/download.html>`_, download it now.
+Then double click on the .dmg file. Drag the OpenLP icon over to the Applications
+folder and you will be ready to use OpenLP. OpenLP will be available in your
+Applications folder.
 
+.. image:: pics/osxinstall.png

manual/source/mediamanager.rst

@@ -123,8 +123,8 @@ The following options are available on the quick search tab:
     |search_options|
 
     |search_reference| **Scripture Reference:**
-        Search for a specific verse using a scripture reference format. The 
-        following formats are supported:
+        Search for a specific verse using a scripture reference format. Below 
+        is some examples on supported formats:
 
         * Book Chapter
         * Book Chapter-Chapter
@@ -134,6 +134,17 @@ The following options are available on the quick search tab:
         * Book Chapter:Verse-Verse, Chapter:Verse-Verse
         * Book Chapter:Verse-Chapter:Verse
 
+        Note that the separators might change depending on the language chosen
+        for OpenLP. See and customise separators under
+        :menuselection:`Setttings --> Configure OpenLP` on the *Bibles* tab.
+        
+        A detailed description of the format and how it is parsed by OpenLP can
+        be read `In the OpenLP API documentation
+        <http://docs.openlp.org/plugins/bibles.html#openlp.plugins.bibles.lib.parse_reference>`_.
+
+        If an invalid format is used for a search a popup window will show the
+        examples also shown above.
+
     |search_text| **Text Search:**
         Search by a keyword or words. Use more words to narrow down the list
         of results. If you search for "Jesus God" it searches sentences 
@@ -410,4 +421,4 @@ same options.
 
 .. |SEARCH_TEXT| image:: pics/search_text.png
 
-.. |SEARCH_OPTIONS| image:: pics/mediamanager_bibles_find.png
+.. |SEARCH_OPTIONS| image:: pics/mediamanager_bibles_find.png

manual/source/stage_view.rst

@@ -5,7 +5,8 @@ The Stage View
 
 Stage view gives you the ability to set up a remote computer, netbook or 
 smartphone to view the live service being displayed on the projection screen in 
-an easy to read font on a black background. This is a text only viewer.
+an easy to read font on a black background. This is a text only viewer, tough it
+will show thumbnails of images and presentations.
 
 The first step is to make sure the Remote plugin is activated. You can accomplish
 this by following the instructions in the :ref:`plugin_list`. The second step is to 
@@ -14,10 +15,11 @@ instructions and settings in :ref:`remote_tab`.
 
 Open a web browser, type in the Stage View URL you found in :ref:`remote_tab` 
 and press the :kbd:`Enter` key. For this example we will use 
-\http://192.168.0.101:4316/stage. You will then be presented with the home page 
-of the OpenLP Stage View.
+\http://192.168.1.73:4316/stage. You will then be presented with the home page 
+of the OpenLP Stage View. On most browsers you can press F11 to go into
+fullscreen mode.
 
-.. image:: pics/web_remote_stage.png
+.. image:: pics/stage_view_song_w_note.png
 
 At the top right hand side you will see the time of day. This can be changed 
 from 12 hour to 24 hour format in :ref:`remote_tab`. If you added a note to the 
@@ -31,4 +33,28 @@ If there is an image, presentation or media being displayed you will see the
 title of the displayed item. Below the title will show the next item to be 
 displayed in the :ref:`creating_service`.
 
-.. image:: pics/web_remote_stage_other.png 
+.. image:: pics/stage_view_image_w_note.png 
+
+.. _main_view:
+
+The Live View
+=============
+
+Live view gives you the ability to set up remote computers that will mirror
+what your projector is showing. The Live view basically works by taking
+screenshots of what the projector is showing and then presenting it in a
+browser. This means that audio and video playback will not be presented in the
+Live View.
+
+The first step is to make sure the Remote plugin is activated. You can accomplish
+this by following the instructions in the :ref:`plugin_list`. The second step is to 
+configure the settings you will use with the web browser. You can find these 
+instructions and settings in :ref:`remote_tab`.
+
+.. image:: pics/live_view_song.png 
+
+Open a web browser, type in the Main View URL you found in :ref:`remote_tab` 
+and press the :kbd:`Enter` key. For this example we will use 
+\http://192.168.1.73:4316/main. You will then be presented with the home page 
+of the OpenLP Live View. On most web browsers you can press F11 to go into
+fullscreen mode.

manual/source/web_remote.rst

@@ -17,8 +17,8 @@ to configure the settings you will use with the web browser. You can find these
 instructions and settings in :ref:`remote_tab`.
 
 Open a web browser, type in the Remote URL you found in :ref:`remote_tab` and 
-press the :kbd:`Enter` key. For this example we will use 
-\http://192.168.0.101:4316. You will then be presented with the home page of the
+press the :kbd:`Enter` key. For this example we will use
+\http://192.168.1.73:4316. You will then be presented with the home page of the
 OpenLP Remote.
 
 .. image:: pics/web_remote_start.png
@@ -47,6 +47,16 @@ You will find the following buttons throughout the web remote interface.
     projector screen. Clicking on an item in the Service Manager will 
     automatically show the item on the screen.
 
+    |web_remote_theme| Clicking this button will blank the display on the 
+    projector screen to the current theme. Note that this is not available for
+    item which does not use themes, such as images, presentations and media. 
+    Clicking on an item in the Service Manager will automatically show the 
+    item on the screen.
+
+    |web_remote_desktop| Clicking this button will hide the display on the 
+    projector screen and therefore show the desktop. Clicking on an item in the
+    Service Manager will automatically show the item on the screen.
+
     |web_remote_show| If the screen is blanked, clicking on this button will
     unblank the display.
 
@@ -65,13 +75,18 @@ Slide Controller
 After you click on an item in the Service Manager you will be taken to the Slide 
 Controller interface. 
 
-.. image:: pics/web_remote_slide.png
+.. image:: pics/web_remote_slide1.png
 
 You will find the verses displayed as they appear in the live view on the main 
 computer and the first verse will be displayed on the projection screen. You can 
 use the :guilabel:`Prev`, :guilabel:`Next` or click on each verse using the 
 mouse to display them. 
 
+.. image:: pics/web_remote_slide2.png
+
+When the slides shown are either images or presentations a small thumbnail will
+be shown.
+
 **Note:** The remote interface replicates the OpenLP software. When displaying 
 images, clicking on a single image in the service manager will display it 
 immediately. The first image in a group of images and the first slide in a 
@@ -108,7 +123,7 @@ will be presented with your entire list of media for the selected media.
 chapter, verse or verses. Searching :guilabel:`Songs` will search titles and 
 lyrics with the text used.
 
-For this example we are searching "Songs" and the word "Jesus". The results will 
+For this example we are searching "Songs" and the word "God". The results will 
 be displayed below the search button.
 
 .. image:: pics/web_remote_search_complete.png
@@ -120,7 +135,9 @@ next screen.
 
 Click on :guilabel:`Go Live` to immediately display your media on the projection 
 screen. Click on :guilabel:`Add to Service` to add your media to the bottom of 
-the :ref:`creating_service`.
+the :ref:`creating_service`. Click on :guilabel:`Add & Go to Service` to add
+your media to the bottom of the :ref:`creating_service`, and go to the web
+remote service manager.
 
 .. These are all the image templates that are used in this page.
 
@@ -130,8 +147,12 @@ the :ref:`creating_service`.
 
 .. |WEB_REMOTE_BLANK| image:: pics/web_remote_blank.png
 
+.. |WEB_REMOTE_THEME| image:: pics/web_remote_theme.png
+
+.. |WEB_REMOTE_DESKTOP| image:: pics/web_remote_desktop.png
+
 .. |WEB_REMOTE_SHOW| image:: pics/web_remote_show.png
 
 .. |WEB_REMOTE_PREVIOUS| image:: pics/web_remote_previous.png
 
-.. |WEB_REMOTE_NEXT| image:: pics/web_remote_next.png
+.. |WEB_REMOTE_NEXT| image:: pics/web_remote_next.png

manual/source/wizard.rst

@@ -22,10 +22,17 @@ The "Welcome to the First Time Wizard" dialog box will appear next. Click
 
 .. image:: pics/002-first-time-wizard-welcome.png
 
+The wizard will now download information from a server about which bibles, songs
+and themes that can be downloaded be the wizard. This can take a few moments,
+depending on the speed of your internet connection and the load on the server,
+so please be patient.
+
+.. image:: pics/003-first-time-wizard-download-res.png
+
 Activate Required Plugins
 -------------------------
 
-.. image:: pics/003-first-time-wizard-plugins.png
+.. image:: pics/004-first-time-wizard-plugins.png
 
 OpenLP has several plugins to choose from. By default, all plugins are enabled, 
 except the *Remote Access* plugin. For more information on these plugins, please 
@@ -37,7 +44,7 @@ or deactivate plugins later, when OpenLP is running, by going to
 Sample Songs
 ------------
 
-.. image:: pics/004-first-time-wizard-songs.png
+.. image:: pics/005-first-time-wizard-songs.png
 
 OpenLP provides some sample songs in a few languages for downloading and 
 importing into your new song database. This is convenient for new users who do 
@@ -48,7 +55,7 @@ intact. Once you are happy with which songs you'd like, click :guilabel:`Next`.
 Sample Bibles
 -------------
 
-.. image:: pics/005-first-time-wizard-bibles.png
+.. image:: pics/006-first-time-wizard-bibles.png
 
 There are also a number of free Bibles that you can download and install. Using 
 the check box next to each Bible, select each Bible that you would like 
@@ -59,7 +66,7 @@ continue.
 Sample Themes
 -------------
 
-.. image:: pics/006-first-time-wizard-themes.png
+.. image:: pics/007-first-time-wizard-themes.png
 
 Some sample themes are also available for download and installation into OpenLP. 
 As with the Bibles, simply check the check box next to each theme to select it. 
@@ -69,7 +76,7 @@ you are happy with your selected themes, click :guilabel:`Next` to continue.
 Default Settings
 ----------------
 
-.. image:: pics/007-first-time-wizard-settings.png
+.. image:: pics/008-first-time-wizard-settings.png
 
 Default Display Monitor
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -97,12 +104,18 @@ On the last page of the wizard, OpenLP will download the sample songs, Bibles
 and themes, and set up OpenLP for you. Click :guilabel:`Finish` and OpenLP will 
 start.
 
+.. image:: pics/splash-screen.png
+
+First the OpenLP logo will be shown for a few seconds while the program loads.
+
 .. image:: pics/011-first-time-wizard-song-import.png
 
-The main window.
+Then OpenLP will import the songs that were added by the first time wizard.
 
 .. image:: pics/mainwindow.png
 
+The main window.
+
 .. _wizard-run-again:
 
 Re-run First Time Wizard