Head

documentation/api/source/conf.py

@@ -17,7 +17,7 @@ import sys
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
+sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..')))
 
 # -- General configuration -----------------------------------------------------
 
@@ -39,7 +39,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'OpenLP'
-copyright = u'2009, Raoul Snyman'
+copyright = u'2004-2010, 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'2009, Raoul Snyman'
 # The short X.Y version.
 version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.0.pre'
+release = '1.9.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -111,7 +111,7 @@ html_theme_options = {
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+html_title = 'OpenLP 2.0 Developer API'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -166,7 +166,7 @@ html_static_path = ['_static']
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'OpenLPdoc'
+htmlhelp_basename = 'OpenLP-2.0-api'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -180,7 +180,7 @@ htmlhelp_basename = 'OpenLPdoc'
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'OpenLP.tex', u'OpenLP Documentation',
+  ('index', 'OpenLP.tex', u'OpenLP 2.0 Developer API',
    u'Raoul Snyman', 'manual'),
 ]
 

documentation/api/source/plugins/images.rst

@@ -0,0 +1,19 @@
+.. _plugins-images:
+
+Images Plugin
+=============
+
+Plugin Class
+------------
+
+.. autoclass:: openlp.plugins.images.imageplugin.ImagePlugin
+   :members:
+
+Helper Classes & Functions
+--------------------------
+
+.. automodule:: openlp.plugins.images.lib
+   :members:
+
+.. automodule:: openlp.plugins.images.lib.mediaitem
+   :members:

documentation/manual/Makefile

@@ -0,0 +1,88 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  dirhtml   to make HTML files named index.html in directories"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  qthelp    to make HTML files and a qthelp project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf build/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
+	@echo
+	@echo "Build finished. The HTML pages are in build/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in build/dirhtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in build/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in build/qthelp, like this:"
+	@echo "# qcollectiongenerator build/qthelp/OpenLP.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile build/qthelp/OpenLP.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in build/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
+	@echo
+	@echo "The overview file is in build/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in build/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in build/doctest/output.txt."

documentation/manual/make.bat

@@ -0,0 +1,112 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+set SPHINXBUILD=sphinx-build
+set ALLSPHINXOPTS=-d build/doctrees %SPHINXOPTS% source
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html      to make standalone HTML files
+	echo.  dirhtml   to make HTML files named index.html in directories
+	echo.  pickle    to make pickle files
+	echo.  json      to make JSON files
+	echo.  htmlhelp  to make HTML files and a HTML help project
+	echo.  qthelp    to make HTML files and a qthelp project
+	echo.  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  changes   to make an overview over all changed/added/deprecated items
+	echo.  linkcheck to check all external links for integrity
+	echo.  doctest   to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (build\*) do rmdir /q /s %%i
+	del /q /s build\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% build/html
+	echo.
+	echo.Build finished. The HTML pages are in build/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% build/dirhtml
+	echo.
+	echo.Build finished. The HTML pages are in build/dirhtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% build/pickle
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% build/json
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% build/htmlhelp
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in build/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% build/qthelp
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in build/qthelp, like this:
+	echo.^> qcollectiongenerator build\qthelp\OpenLP.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile build\qthelp\OpenLP.ghc
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% build/latex
+	echo.
+	echo.Build finished; the LaTeX files are in build/latex.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% build/changes
+	echo.
+	echo.The overview file is in build/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% build/linkcheck
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in build/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% build/doctest
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in build/doctest/output.txt.
+	goto end
+)
+
+:end

documentation/manual/source/conf.py

@@ -0,0 +1,202 @@
+# -*- coding: utf-8 -*-
+#
+# OpenLP documentation build configuration file, created by
+# sphinx-quickstart on Fri Jul 10 17:20:40 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+import sys
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+#extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'OpenLP'
+copyright = u'2004-2010 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
+# built documents.
+#
+# The short X.Y version.
+version = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.9.3'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = False
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    'sidebarbgcolor': '#3a60a9',
+    'relbarbgcolor': '#203b6f',
+    'footerbgcolor': '#26437c',
+    'headtextcolor': '#203b6f',
+    'linkcolor': '#26437c',
+    'sidebarlinkcolor': '#ceceff'
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+html_title = u'OpenLP 2.0 User Manual'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenLP-2.0-manual'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'OpenLP.tex', u'OpenLP 2.0 User Manual',
+   u'Raoul Snyman', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True

documentation/manual/source/dualmonitors.rst

@@ -12,11 +12,11 @@ monitors will have two of, or a combination of the two connectors below.
 
 **VGA**
 
-.. image:: /pics/vga.png
+.. image:: pics/vga.png
 
 **DVI**
 
-.. image:: /pics/dvi.png
+.. 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 
@@ -47,11 +47,11 @@ 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**.
 
-.. image:: /pics/winsevendisplay.png
+.. image:: pics/winsevendisplay.png
 
 Then click on the Screen Resolution from the left pane.
 
-.. image:: /pics/winsevenresolution.png
+.. image:: pics/winsevenresolution.png
 
 Then enable your projector and ensure your desktop is extended.
 
@@ -61,11 +61,11 @@ Windows Vista
 From the control panel click on personalize, or right click a blank place on
 the desktop and click personalization. 
 
-.. image:: /pics/vistapersonalize.png
+.. image:: pics/vistapersonalize.png
 
 From the **Personalization** window click on Display Settings.
 
-.. image:: /pics/vistadisplaysettings.png
+.. image:: pics/vistadisplaysettings.png
 
 Then enable the montior that represents your projector an make sure your
 you have checked Extend the desktop.
@@ -77,7 +77,7 @@ 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.
 
-.. image:: /pics/xpdisplaysettings.png
+.. image:: pics/xpdisplaysettings.png
 
 Then enable the monitor that represents your projector an make sure your
 you have checked Extend the desktop.
@@ -97,7 +97,7 @@ 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)
 
-.. image:: /pics/gnome.png
+.. 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).
@@ -108,11 +108,11 @@ 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**
 
-.. image:: /pics/kdesystemsettings.png
+.. image:: pics/kdesystemsettings.png
 
 Click on the display and monitor icon.
 
-.. image:: /pics/kdedisplay.png
+.. image:: pics/kdedisplay.png
 
 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

documentation/manual/source/glossary.rst

@@ -11,7 +11,7 @@ Main Window
 
 The Main Window is what you will see when you first open OpenLP
 
-.. image:: /pics/mainwindow.png
+.. image:: pics/mainwindow.png
 
 The Main Window contains all the tools and plugins that make OpenLP function
 
@@ -21,7 +21,7 @@ Media Manager
 The Media Manager contains a number of tabs that plugins supply to OpenLP.
 Each tab in the Media Manager is called a **Media Item**
 
-.. image:: /pics/mediamanager.png
+.. image:: pics/mediamanager.png
 
 From the Media Manager you can send Media Items to the Preview or Live screens.
 
@@ -31,7 +31,7 @@ Preview
 The preview pane is a section to preview your media items before you go live 
 with them.
 
-.. image:: /pics/preview.png
+.. image:: pics/preview.png
 
 Service File
 ------------
@@ -51,7 +51,7 @@ The service manager contains the media items in your service file. This is the
 area from wich your media items go live, and you can also save, open, and edit 
 services files.
 
-.. image:: /pics/servicemanager.png
+.. image:: pics/servicemanager.png
 
 Slide Controller
 ----------------
@@ -59,7 +59,7 @@ Slide Controller
 The Slide Controller controls which slide from a **Service Item** is currently
 being displayed, and moving between the various slides.
 
-.. image:: /pics/slidecontroller.png
+.. image:: pics/slidecontroller.png
 
 Theme Manager
 -------------
@@ -67,4 +67,4 @@ Theme Manager
 The theme manager is where themes are created and edited. Themes are the text
 styles backgrounds that you use to personalize your services.
 
-.. image:: /pics/thememanager.png
+.. image:: pics/thememanager.png

documentation/manual/source/index.rst

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to OpenLP's documentation
-==================================
+Welcome to the OpenLP 2.0 User Manual
+=====================================
 
 Contents:
 

documentation/source/plugins/images.rst

@@ -1,8 +0,0 @@
-.. _plugins-images:
-
-Images Plugin
-=============
-
-.. automodule:: openlp.plugins.images
-   :members:
-

openlp/core/lib/serviceitem.py

@@ -399,6 +399,6 @@ class ServiceItem(object):
 
     def get_frame_path(self, row=0):
         """
-        Returns the title of the raw frame
+        Returns the path of the raw frame
         """
         return self._raw_frames[row][u'path']

openlp/core/ui/slidecontroller.py

@@ -996,4 +996,3 @@ class SlideController(QtGui.QWidget):
             self.video.hide()
         self.SlidePreview.clear()
         self.SlidePreview.show()
-

openlp/plugins/songs/lib/songbeamerimport.py

@@ -127,11 +127,10 @@ class SongBeamerImport(SongImport):
                 self.import_wizard.incrementProgressBar(
                     "Importing %s" % (self.file_name))
             return True
-            
+
     def parse_tags(self, line):
         tag_val = line.split('=')
-        if len(tag_val[0]) == 0 or \
-            len(tag_val[1]) == 0:
+        if len(tag_val[0]) == 0 or len(tag_val[1]) == 0:
             return True
         if tag_val[0] == '#(c)':
             self.add_copyright(tag_val[1])
@@ -225,11 +224,10 @@ class SongBeamerImport(SongImport):
         else:
             pass
         return True
-        
+
     def check_verse_marks(self, line):
         marks = line.split(' ')
-        if len(marks) <= 2 and \
-            marks[0] in SongBeamerTypes.MarkTypes:
+        if len(marks) <= 2 and marks[0] in SongBeamerTypes.MarkTypes:
             self.current_verse_type = SongBeamerTypes.MarkTypes[marks[0]]
             if len(marks) == 2:
                 #TODO: may check, because of only digits are allowed