head

api/source/conf.py

@@ -39,7 +39,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'OpenLP'
-copyright = u'2004-2010, Raoul Snyman'
+copyright = u'2004-2011, Raoul Snyman'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -48,7 +48,7 @@ copyright = u'2004-2010, Raoul Snyman'
 # The short X.Y version.
 version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.9.3'
+release = '1.9.8'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

api/source/core/lib.rst

@@ -6,6 +6,12 @@ Object Library
 .. automodule:: openlp.core.lib
    :members:
 
+:mod:`Manager`
+--------------------
+
+.. autoclass:: openlp.core.lib.db.Manager
+   :members:
+
 :mod:`EventReceiver`
 --------------------
 
@@ -42,10 +48,10 @@ Object Library
 .. autoclass:: openlp.core.lib.renderer.Renderer
    :members:
 
-:mod:`RenderManager`
+:mod:`SearchEdit`
 --------------------
 
-.. autoclass:: openlp.core.lib.rendermanager.RenderManager
+.. autoclass:: openlp.core.lib.searchedit.SearchEdit
    :members:
 
 :mod:`ServiceItem`
@@ -65,3 +71,9 @@ Object Library
 
 .. autoclass:: openlp.core.lib.toolbar.OpenLPToolbar
    :members:
+
+:mod:`UiStrings`
+--------------------
+
+.. autoclass:: openlp.core.lib.ui.UiStrings
+   :members:

api/source/core/ui.rst

@@ -17,6 +17,9 @@ Main Windows
 Managers
 --------
 
+.. autoclass:: openlp.core.ui.slidecontroller.SlideController
+   :members:
+
 .. autoclass:: openlp.core.ui.servicemanager.ServiceManager
    :members:
 

api/source/plugins/media.rst

@@ -6,17 +6,17 @@ Media Plugin
 .. automodule:: openlp.plugins.media
    :members:
 
-Plugin Class
+  Plugin Class
-------------
+  ------------
 
 .. autoclass:: openlp.plugins.media.mediaplugin.MediaPlugin
    :members:
 
-Helper Classes & Functions
+  Helper Classes & Functions
---------------------------
+  --------------------------
 
 .. automodule:: openlp.plugins.media.lib
    :members:
 
-.. automodule:: openlp.plugins.media.lib.mediaitem
+  .. automodule:: openlp.plugins.media.lib.mediaitem
    :members:

manual/source/configure.rst

@@ -343,6 +343,8 @@ Custom Display
 **Note:** If you have an entry in the Credits box of your custom slide, title and
 credits will always be displayed.
 
+.. _configure_alerts:
+
 Alerts
 ======
 
@@ -386,13 +388,12 @@ interface to control the whole service remotely by a visiting missionary or
 worship team leader. 
 
 Stage view gives you the opportunity to set up a remote computer, netbook or 
-smartphone to view the service being displayed in an easy to read font and black
+smartphone to view the service being displayed in an easy to read font with a 
-background. This is a text only viewer. 
+black background. Stage view is a text only viewer. 
 
-.. image:: pics/configure_remotes_stage.png
+The remote feature will work in any web browser that has network access whether 
-
+it is another computer, a netbook or a smartphone. You can find more information 
-This will work in any web browser that has network access whether it is another 
+about this feature here: :ref:`web_remote`.
-computer, a netbook or a smartphone. 
 
 **Note:** To use either of these features, your computers will need to be on the 
 same network, wired or wireless. 

manual/source/creating_service.rst

@@ -227,6 +227,8 @@ group of images as another item at the bottom of the Service. If you click
 :guilabel:`Add to Selected Item` your image will be added to your group of
 images.
 
+.. _adding_note:
+
 Adding a Service Note
 ---------------------
 

manual/source/index.rst

@@ -36,6 +36,8 @@ Reference Manual
    export_songs
    song_usage
    alert
+   web_remote
+   stage_view
    glossary
 
 Questions and Troubleshooting

manual/source/stage_view.rst

@@ -0,0 +1,34 @@
+.. _stage_view:
+
+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.
+
+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`.
+
+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.
+
+.. image:: pics/web_remote_stage.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 
+the song it will be the next line below the time. See :ref:`adding_note` 
+for adding notes. Below the note will be the Bible or song verse numbers and one 
+of those will be highlighted. The lyrics or verses highlighted below the verse 
+numbers correspond to the highlighted verse number. In this example V1 is 
+highlighted and the corresponding first verse below it is highlighted.
+
+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 

manual/source/web_remote.rst

@@ -0,0 +1,137 @@
+.. _web_remote:
+
+The Web Remote
+==============
+
+OpenLP gives you the ability to control the :ref:`creating_service`. You also 
+have the ability to search for and add or display media from the 
+:ref:`media-manager` or send an :ref:`alerts`, using a remote computer, netbook 
+or smartphone and a web browser. You can use the web remote to control the 
+entire service away from the main computer or, have the nursery or daycare send 
+an :ref:`alerts` message to the projection screen. This could also be used for a 
+guest speaker or worship team leader to control their own slides if needed.
+
+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`.
+
+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
+OpenLP Remote.
+
+.. image:: pics/web_remote_start.png
+
+Service Manager
+---------------
+
+Clicking on :guilabel:`Service Manager` will display the service item list from 
+the :ref:`creating_service`.
+
+.. image:: pics/web_remote_service.png
+
+Clicking on any item in the Service Manager will immediately take you to the 
+Slide Controller. 
+
+You will find the following buttons throughout the web remote interface. 
+
+    |web_remote_home| The home button is found on most of the pages in the top 
+    left hand corner of the remote interface and clicking it will take you back 
+    to the home page of the OpenLP remote.
+
+    |web_remote_refresh| When changes are made on the main computer clicking on 
+    refresh will show the changes in the remote viewer.
+
+    |web_remote_blank| Clicking this button will blank the display on the 
+    projector screen. 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.
+
+    |web_remote_previous| This button will move you upward through the Service 
+    Manager and Slide Controller.
+
+    |web_remote_next| This button will move you downward through the Service 
+    Manager and Slide Controller.
+
+**Note:** The buttons Blank, Show, Prev and Next are conveniently located on 
+the top and the bottom of the remote interface to help eliminate scrolling.
+
+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
+
+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. 
+
+**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 
+presentation will also be displayed immediately when clicked on in the 
+web remote service manager.
+
+Alerts
+------
+
+You can send an alert to the projection screen by entering the text in the box 
+and clicking on :guilabel:`Show Alert`. The alert will be displayed as you have 
+it configured in :ref:`configure_alerts`.
+
+.. image:: pics/web_remote_alert.png
+
+Search
+------
+
+Using the search function gives you the ability to search for a particular media, 
+add it to the service or display it immediately.
+
+.. image:: pics/web_remote_search.png
+
+Clicking on :guilabel:`Songs` will display your media options to search through. 
+Click on the media type that you want to search. 
+
+.. image:: pics/web_remote_search_choice.png
+
+Enter the text you want to search for. You can click :guilabel:`Search` or press 
+:kbd:`Enter` on the keyboard. If you do not enter any text to search for, you 
+will be presented with your entire list of media for the selected media. 
+
+**Note:** When searching :guilabel:`Bibles` media you must enter the exact name, 
+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 
+be displayed below the search button.
+
+.. image:: pics/web_remote_search_complete.png
+
+After finding the song you searched for, clicking on the song will bring up the 
+next screen.
+
+.. image:: pics/web_remote_search_options.png
+
+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`.
+
+.. These are all the image templates that are used in this page.
+
+.. |WEB_REMOTE_HOME| image:: pics/web_remote_home.png
+
+.. |WEB_REMOTE_REFRESH| image:: pics/web_remote_refresh.png
+
+.. |WEB_REMOTE_BLANK| image:: pics/web_remote_blank.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