Head

documentation/api/source/core/index.rst

@@ -3,9 +3,13 @@
 :mod:`core` Module
 ==================
 
+.. automodule:: openlp.core
+   :members:
+
 .. toctree::
    :maxdepth: 2
 
    lib
    theme
-
+   ui
+   utils

documentation/api/source/core/lib.rst

@@ -1,7 +1,7 @@
 .. _core-lib:
 
-:mod:`lib` Module
-=================
+Object Library
+==============
 
 .. automodule:: openlp.core.lib
    :members:

documentation/api/source/core/ui.rst

@@ -0,0 +1,27 @@
+.. _core-ui:
+
+User Interface
+==============
+
+.. automodule:: openlp.core.ui
+
+Main Windows
+------------
+
+.. autoclass:: openlp.core.ui.mainwindow.MainWindow
+   :members:
+
+.. autoclass:: openlp.core.ui.maindisplay.MainDisplay
+   :members:
+
+Managers
+--------
+
+.. autoclass:: openlp.core.ui.servicemanager.ServiceManager
+   :members:
+
+.. autoclass:: openlp.core.ui.mediadockmanager.MediaDockManager
+   :members:
+
+.. autoclass:: openlp.core.ui.thememanager.ThemeManager
+   :members:

documentation/api/source/core/utils.rst

@@ -0,0 +1,7 @@
+.. _core-utils:
+
+Utilities
+=========
+
+.. automodule:: openlp.core.utils
+   :members:

documentation/api/source/index.rst

@@ -15,7 +15,6 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   openlp
    core/index
    plugins/index
 

documentation/api/source/plugins/alerts.rst

@@ -0,0 +1,31 @@
+.. _plugins-alerts:
+
+Alerts Plugin
+=============
+
+.. automodule:: openlp.plugins.alerts
+   :members:
+
+Plugin Class
+------------
+
+.. autoclass:: openlp.plugins.alerts.alertsplugin.AlertsPlugin
+   :members:
+
+Forms
+-----
+
+.. automodule:: openlp.plugins.alerts.forms
+   :members:
+
+.. autoclass:: openlp.plugins.alerts.forms.alertform.AlertForm
+   :members:
+
+Helper Classes & Functions
+--------------------------
+
+.. automodule:: openlp.plugins.alerts.lib
+   :members:
+
+.. automodule:: openlp.plugins.alerts.lib.db
+   :members:

documentation/api/source/plugins/custom.rst

@@ -0,0 +1,34 @@
+.. _plugins-custom:
+
+Custom Slides Plugin
+====================
+
+.. automodule:: openlp.plugins.custom
+   :members:
+
+Plugin Class
+------------
+
+.. autoclass:: openlp.plugins.custom.customplugin.CustomPlugin
+   :members:
+
+Forms
+-----
+
+.. automodule:: openlp.plugins.custom.forms
+   :members:
+
+.. autoclass:: openlp.plugins.custom.forms.editcustomform.EditCustomForm
+   :members:
+
+.. autoclass:: openlp.plugins.custom.forms.editcustomslideform.EditCustomSlideForm
+   :members:
+
+Helper Classes & Functions
+--------------------------
+
+.. automodule:: openlp.plugins.custom.lib
+   :members:
+
+.. automodule:: openlp.plugins.custom.lib.mediaitem
+   :members:

documentation/api/source/plugins/index.rst

@@ -1,7 +1,7 @@
 .. _plugins-index:
 
-:mod:`plugins` Module
-=====================
+Plugins
+=======
 
 .. automodule:: openlp.plugins
    :members:
@@ -14,15 +14,7 @@
    presentations
    media
    images
-
-:mod:`custom` Plugin
---------------------
-
-.. automodule:: openlp.plugins.custom
-   :members:
-
-:mod:`songusage` Plugin
------------------------
-
-.. automodule:: openlp.plugins.songusage
-   :members:
+   custom
+   remotes
+   songusage
+   alerts

documentation/api/source/plugins/remotes.rst

@@ -0,0 +1,19 @@
+.. _plugins-remotes:
+
+Remotes Plugin
+==============
+
+.. automodule:: openlp.plugins.remotes
+   :members:
+
+Plugin Class
+------------
+
+.. autoclass:: openlp.plugins.remotes.remoteplugin.RemotesPlugin
+   :members:
+
+Helper Classes & Functions
+--------------------------
+
+.. automodule:: openlp.plugins.remotes.lib
+   :members:

documentation/api/source/plugins/songusage.rst

@@ -0,0 +1,34 @@
+.. _plugins-songusage:
+
+Song Usage Plugin
+=================
+
+.. automodule:: openlp.plugins.songusage
+   :members:
+
+Plugin Class
+------------
+
+.. autoclass:: openlp.plugins.songusage.songusageplugin.SongUsagePlugin
+   :members:
+
+Forms
+-----
+
+.. automodule:: openlp.plugins.songusage.forms
+   :members:
+
+.. autoclass:: openlp.plugins.songusage.forms.songusagedeleteform.SongUsageDeleteForm
+   :members:
+
+.. autoclass:: openlp.plugins.songusage.forms.songusagedetailform.SongUsageDetailForm
+   :members:
+
+Helper Classes & Functions
+--------------------------
+
+.. automodule:: openlp.plugins.songusage.lib
+   :members:
+
+.. automodule:: openlp.plugins.songusage.lib.db
+   :members:

documentation/manual/source/dualmonitors.rst

@@ -3,7 +3,7 @@ Dual Monitor Setup
 ==================
 
 The first step in getting OpenLP working on your system is to setup your
-computer properly for dual monitors. This is not very difficult, but the steps 
+computer properly for dual monitors. This is not very difficult, but the steps
 do vary depending on operating system.
 
 Most modern computers do have the ability for dual monitors. To be certain
@@ -19,11 +19,13 @@ monitors will have two of, or a combination of the two connectors below.
 .. image:: pics/dvi.png
 
 A laptop computer setup only varies slightly, generally you will need only one
-of outputs pictured above since your laptops screen serves as one of the 
-monitors. Sometimes with older laptops a key stroke generally involving the FN
-key and another key is required to enable the second monitor on laptops.
+of outputs pictured above since your laptops screen serves as one of the
+monitors. Sometimes with older laptops a key stroke generally involving the
+:kbd:`Fn` key and another key is required to enable the second monitor on
+laptops.
 
-Some computers also incorporate the use of S-Video or HDMI connections.
+Some computers also incorporate the use of :abbr:`S-Video (Separate Video)` or
+:abbr:`HDMI (High-Definition Multimedia Interface)` connections.
 
 A typical OpenLP set up consist of your normal single monitor setup, with your
 projector setup as the second monitor. With the option of extending your
@@ -39,49 +41,47 @@ next.
 Windows 7
 ^^^^^^^^^
 
-Windows 7 has using  a projector in mind. Simply connect your projector and 
-press the **Windows key and tap P**.
+Windows 7 has using  a projector in mind. Simply connect your projector and
+press :kbd:`Windows+P`.
 
-The more traditional way is also fairly straight forward. Go to the control 
-panel and click on display. This will open up the Display options. You can 
-also bypass this step by right click on a blank area on your desktop and 
-selecting **resolution**.
+The more traditional way is also fairly straight forward. Go to
+:guilabel:`Control Panel` and click on :guilabel:`Display`. This will open up
+the :guilabel:`Display` dialog. You can also bypass this step by right click on
+a blank area on your desktop and selecting :guilabel:`Resolution`.
 
 .. image:: pics/winsevendisplay.png
 
-Then click on the Screen Resolution from the left pane.
+Then click on the :guilabel:`Adjust resolution` link in the left pane. Enable
+your projector and make sure that the selected value for :guilabel:`Multiple
+displays` is :guilabel:`Extend these displays`.
 
 .. image:: pics/winsevenresolution.png
 
-Then enable your projector and ensure your desktop is extended.
-
 Windows Vista
 ^^^^^^^^^^^^^
 
-From the control panel click on personalize, or right click a blank place on
-the desktop and click personalization. 
+From :guilabel:`Control Panel` click on :guilabel:`Personalize`, or right click
+a blank place on the desktop and click :guilabel:`Personalization`.
 
 .. image:: pics/vistapersonalize.png
 
-From the **Personalization** window click on Display Settings.
+From the :guilabel:`Personalization` window click on :guilabel:`Display
+Settings`. Then enable the montior that represents your projector and make sure
+you have checked :guilabel:`Extend the desktop onto this monitor`.
 
 .. image:: pics/vistadisplaysettings.png
 
-Then enable the montior that represents your projector an make sure your
-you have checked Extend the desktop.
-
 Windows XP
 ^^^^^^^^^^
 
-From the control panel select Display, or right click on a blank area of the 
-desktop and select properties. From the properties window click on the settings
-tab.
+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.
+Then 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
 
-Then enable the monitor that represents your projector an make sure your
-you have checked Extend the desktop.
-
 Linux
 -----
 
@@ -91,22 +91,22 @@ assumes that you have properly set up any proprietary drivers if needed. You
 should seek out your distributions documentation if this general guide does not
 work.
 
-GNOME 
+GNOME
 ^^^^^
 
 This guide is for users of the GNOME desktop who do not use proprietary drivers.
-From most distros go to System --> Preferences --> Display Settings (Monitors)
+From most distros go to :menuselection:`System --> Preferences --> Display
+Settings (Monitors)`. Set up your projector with the correct resolution and make
+sure that :guilabel:`Same image on all monitors` is **unchecked**.
 
 .. image:: pics/gnome.png
 
-Setup your projector with the correct resolution and make sure you do **not**
-have mirrored desktop enabled (same image on all monitors).
-
 KDE
 ^^^
 
 This guide is for users of the KDE desktop who do not use proprietary drivers.
-From most distros click the Kick Off menu and navigate to **system settings**
+From most distros click the Kick Off menu and navigate to
+:guilabel:`System Settings`
 
 .. image:: pics/kdesystemsettings.png
 
@@ -118,10 +118,63 @@ From here you will need to set up your projector with the appropriate
 resolution, and position. OpenLP works best projecting to the monitor on the
 right.
 
+Linux Systems Using nVidia Drivers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+This guide is for users of the proprietary nVidia driver on Linux Distributions.
+It is assumed that you have properly setup your drivers according to your
+distribution's documentation, and you have a working ``xorg.conf`` file in place.
 
+If you wish to make the changes permanent in setting up your system for dual
+monitors it will be necessary to modify your ``xorg.conf`` file. It is always a
+good idea to make a backup of any critical file before making changes::
 
+  user@linux:~ $ sudo cp /etc/X11/xorg.conf /etc/X11/xorg.conf.old
 
+Or for those using systems that use the root user instead of sudo, change to
+root and enter::
 
+  root@linux: # cp /etc/X11/xorg.conf /etc/X11/xorg.conf.old
 
+The exact location of the ``xorg.conf`` file can vary so check your
+distribution's documentation.
 
+If you want to make your changes permanent run nVidia settings from the
+terminal::
+
+  user@linux:~ $ sudo nvidia-settings
+
+Or, as root::
+
+  root@linux: # nividia-settings
+
+If you do not want to write the changes to your ``xorg.conf`` file simply run
+the nVidia Settings program (``nvidia-settings``) from your desktop's menu,
+usually in an administration or system menu, or from the terminal as a normal
+user run::
+
+ user@linux:~ $ nvidia-settings
+
+Once you have opened nVidia Settings, click on
+:guilabel:`X Server Display Configuration`. Then select the monitor you are
+wanting to use as your second monitor and click :guilabel:`Configure`.
+
+.. image:: pics/nvlinux1.png
+
+After clicking :guilabel:`Configure`, select :guilabel:`TwinView`. Then click
+:guilabel:`OK`.
+
+.. image:: pics/twinview.png
+
+Then click :guilabel:`Apply` and if you are happy with the way things look click
+:guilabel:`Keep` to keep your new settings. Don't worry if all goes wrong the
+settings will return back to the previous settings in 15 seconds without any
+action. nVidia Settings should take care of selecting your optimum resolution
+etc, but that can be changed as needed. When you are happy with everything click
+on :guilabel:`Save to X Configuration File`.
+
+.. image:: pics/xorgwrite.png
+
+Then click :guilabel:`Save` and you should be set. You may want to restart X or
+your machine just to make sure all the settings carry over the next time you log
+in.

openlp/core/lib/spelltextedit.py

@@ -25,7 +25,6 @@
 ###############################################################################
 
 import re
-import sys
 try:
     import enchant
     from enchant import DictNotFoundError
@@ -37,7 +36,7 @@ except ImportError:
 # http://john.nachtimwald.com/2009/08/22/qplaintextedit-with-in-line-spell-check/
 
 from PyQt4 import QtCore, QtGui
-from openlp.core.lib import html_expands, translate, context_menu_action
+from openlp.core.lib import html_expands, translate
 
 class SpellTextEdit(QtGui.QPlainTextEdit):
     def __init__(self, *args):

openlp/core/lib/theme.py

@@ -87,12 +87,12 @@ class ThemeLevel(object):
     Service = 2
     Song = 3
 
-boolean_list = [u'italics', u'override', u'outline', u'shadow', \
-u'slide_transition']
+boolean_list = [u'italics', u'override', u'outline', u'shadow',
+    u'slide_transition']
 
-integer_list =[u'proportion', u'line_adjustment', u'x', u'height', u'y', \
-u'width', u'shadow_size', u'outline_size', u'horizontal_align', \
-u'vertical_align', u'wrap_style' ]
+integer_list = [u'proportion', u'line_adjustment', u'x', u'height', u'y',
+    u'width', u'shadow_size', u'outline_size', u'horizontal_align',
+    u'vertical_align', u'wrap_style']
 
 class ThemeXML(object):
     """

openlp/core/ui/__init__.py

@@ -39,7 +39,6 @@ class HideMode(object):
 
 from filerenameform import FileRenameForm
 from maindisplay import MainDisplay
-from slidecontroller import HideMode
 from servicenoteform import ServiceNoteForm
 from serviceitemeditform import ServiceItemEditForm
 from screen import ScreenList

openlp/core/ui/exceptionform.py

@@ -24,7 +24,7 @@
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
 
-from PyQt4 import QtCore, QtGui
+from PyQt4 import QtGui
 
 from exceptiondialog import Ui_ExceptionDialog
 

openlp/core/ui/filerenameform.py

@@ -27,7 +27,6 @@
 from PyQt4 import QtCore, QtGui
 
 from filerenamedialog import Ui_FileRenameDialog
-from openlp.core.lib import translate
 
 class FileRenameForm(QtGui.QDialog, Ui_FileRenameDialog):
     """

openlp/core/ui/maindisplay.py

@@ -90,6 +90,9 @@ class DisplayWidget(QtGui.QGraphicsView):
             event.ignore()
 
 class MainDisplay(DisplayWidget):
+    """
+    This is the display screen.
+    """
 
     def __init__(self, parent, screens, live):
         DisplayWidget.__init__(self, live, parent=None)

openlp/core/ui/thememanager.py

@@ -34,9 +34,8 @@ from PyQt4 import QtCore, QtGui
 
 from openlp.core.ui import AmendThemeForm, FileRenameForm
 from openlp.core.theme import Theme
-from openlp.core.lib import OpenLPToolbar, context_menu_action, \
-    ThemeXML, str_to_bool, get_text_file_string, build_icon, Receiver, \
-    context_menu_separator, SettingsManager, translate, check_item_selected
+from openlp.core.lib import OpenLPToolbar, ThemeXML, get_text_file_string, \
+    build_icon, Receiver, SettingsManager, translate, check_item_selected
 from openlp.core.utils import AppLocation, get_filesystem_encoding
 
 log = logging.getLogger(__name__)
@@ -267,7 +266,7 @@ class ThemeManager(QtGui.QWidget):
             filename = \
                 os.path.split(unicode(oldThemeData.background_filename))[1]
             new_theme.add_background_image(filename)
-            save_to = os.path.join(self.path, theme_name, filename)
+            save_to = os.path.join(self.path, newThemeName, filename)
             save_from = oldThemeData.background_filename
         new_theme.add_font(unicode(oldThemeData.font_main_name),
             unicode(oldThemeData.font_main_color),

openlp/core/utils/languagemanager.py

@@ -28,7 +28,6 @@ The :mod:`languagemanager` module provides all the translation settings and
 language file loading for OpenLP.
 """
 import logging
-import os
 
 from PyQt4 import QtCore, QtGui
 

openlp/plugins/bibles/lib/mediaitem.py

@@ -32,7 +32,6 @@ from PyQt4 import QtCore, QtGui
 from openlp.core.lib import MediaManagerItem, Receiver, BaseListWithDnD, \
     ItemCapabilities, translate
 from openlp.plugins.bibles.forms import BibleImportForm
-from openlp.plugins.bibles.lib.db import BibleDB
 
 log = logging.getLogger(__name__)
 

openlp/plugins/bibles/resources/osisbooks.csv

@@ -6,8 +6,8 @@ Deut,Deuteronomy,Deut
 Josh,Joshua,Josh
 Judg,Judges,Judg
 Ruth,Ruth,Ruth
-1Sam,1 Samual,1Sam
-2Sam,2 Samual,2Sam
+1Sam,1 Samuel,1Sam
+2Sam,2 Samuel,2Sam
 1Kgs,1 Kings,1Kgs
 2Kgs,2 Kings,2Kgs
 1Chr,1 Chronicles,1Chr

openlp/plugins/custom/forms/editcustomslideform.py

@@ -28,7 +28,6 @@ import logging
 
 from PyQt4 import QtCore, QtGui
 
-from openlp.core.lib import Receiver, translate
 from editcustomslidedialog import Ui_CustomSlideEditDialog
 
 log = logging.getLogger(__name__)

openlp/plugins/songs/lib/ewimport.py

@@ -28,7 +28,6 @@ The :mod:`ewimport` module provides the functionality for importing
 EasyWorship song databases into the current installation database.
 """
 
-import sys
 import os
 import struct
 
@@ -192,8 +191,9 @@ class EasyWorshipSongImport(SongImport):
             num_fields)
         field_names.pop()
         field_descs = []
-        for i,field_name in enumerate(field_names):
-            field_type, field_size = struct.unpack_from('BB', field_info, i * 2)
+        for i, field_name in enumerate(field_names):
+            field_type, field_size = struct.unpack_from('BB',
+                field_info, i * 2)
             field_descs.append(FieldDescEntry(field_name, field_type,
                 field_size))
         self.set_record_struct(field_descs)
@@ -272,7 +272,7 @@ class EasyWorshipSongImport(SongImport):
         return success
 
     def find_field(self, field_name):
-        return [i for i,x in enumerate(self.field_descs) \
+        return [i for i, x in enumerate(self.field_descs) \
             if x.name == field_name][0]
 
     def set_record_struct(self, field_descs):
@@ -331,7 +331,7 @@ class EasyWorshipSongImport(SongImport):
             # Memo or Blob
             block_start, blob_size = \
                 struct.unpack_from('<II', field, len(field)-10)
-            sub_block = block_start & 0xff;
+            sub_block = block_start & 0xff
             block_start &= ~0xff
             self.memo_file.seek(block_start)
             memo_block_type, = struct.unpack('b', self.memo_file.read(1))
@@ -339,12 +339,12 @@ class EasyWorshipSongImport(SongImport):
                 self.memo_file.seek(8, os.SEEK_CUR)
             elif memo_block_type == 3:
                 if sub_block > 63:
-                    return u'';
+                    return u''
                 self.memo_file.seek(11 + (5 * sub_block), os.SEEK_CUR)
                 sub_block_start, = struct.unpack('B', self.memo_file.read(1))
                 self.memo_file.seek(block_start + (sub_block_start * 16))
             else:
-                return u'';
+                return u''
             return self.memo_file.read(blob_size)
         else:
             return 0

openlp/plugins/songs/lib/songbeamerimport.py

@@ -29,7 +29,6 @@ The :mod:`songbeamerimport` module provides the functionality for importing
 """
 import logging
 import os
-import re
 import chardet
 import codecs
 

resources/bibles/osisbooks_en.txt

@@ -6,8 +6,8 @@ Deut,Deuteronomy,Deut
 Josh,Joshua,Josh
 Judg,Judges,Judg
 Ruth,Ruth,Ruth
-1Sam,1 Samual,1Sam
-2Sam,2 Samual,2Sam
+1Sam,1 Samuel,1Sam
+2Sam,2 Samuel,2Sam
 1Kgs,1 Kings,1Kgs
 2Kgs,2 Kings,2Kgs
 1Chr,1 Chronicles,1Chr