Raoul Snyman
commit
611195f281
|
|
@ -0,0 +1,8 @@
|
|||
openlp.org 2.x Plugin Developer's Guide
|
||||
========================================================================
|
||||
|
||||
Introduction
|
||||
------------
|
||||
This document will show you how to write your own module for openlp.org.
|
||||
openlp.org has been written in plugins so that you can add your own
|
||||
functionality to openlp.org.
|
||||
|
|
@ -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."
|
||||
|
|
@ -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
|
||||
|
|
@ -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 = 'OpenLP 2.0 Developer API'
|
||||
|
||||
# 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-api'
|
||||
|
||||
|
||||
# -- 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 Developer API',
|
||||
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
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
.. _core-index:
|
||||
|
||||
:mod:`core` Module
|
||||
==================
|
||||
|
||||
.. automodule:: openlp.core
|
||||
:members:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lib
|
||||
theme
|
||||
ui
|
||||
utils
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
.. _core-lib:
|
||||
|
||||
Object Library
|
||||
==============
|
||||
|
||||
.. automodule:: openlp.core.lib
|
||||
:members:
|
||||
|
||||
:mod:`EventReceiver`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.eventreceiver.EventReceiver
|
||||
:members:
|
||||
|
||||
:mod:`ListWidgetWithDnD`
|
||||
------------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.listwidgetwithdnd.ListWidgetWithDnD
|
||||
:members:
|
||||
|
||||
:mod:`MediaManagerItem`
|
||||
-----------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.mediamanageritem.MediaManagerItem
|
||||
:members:
|
||||
|
||||
:mod:`Plugin`
|
||||
-------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.plugin.Plugin
|
||||
:members:
|
||||
|
||||
:mod:`PluginManager`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.pluginmanager.PluginManager
|
||||
:members:
|
||||
|
||||
:mod:`Renderer`
|
||||
---------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.renderer.Renderer
|
||||
:members:
|
||||
|
||||
:mod:`RenderManager`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.rendermanager.RenderManager
|
||||
:members:
|
||||
|
||||
:mod:`ServiceItem`
|
||||
------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.serviceitem.ServiceItem
|
||||
:members:
|
||||
|
||||
:mod:`SettingsTab`
|
||||
------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.settingstab.SettingsTab
|
||||
:members:
|
||||
|
||||
:mod:`OpenLPToolbar`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.toolbar.OpenLPToolbar
|
||||
:members:
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
.. _core-theme:
|
||||
|
||||
Theme Function Library
|
||||
======================
|
||||
|
||||
.. automodule:: openlp.core.theme
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.core.theme.theme.Theme
|
||||
:members:
|
||||
|
|
@ -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:
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
.. _core-utils:
|
||||
|
||||
Utilities
|
||||
=========
|
||||
|
||||
.. automodule:: openlp.core.utils
|
||||
:members:
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
.. OpenLP documentation master file, created by
|
||||
sphinx-quickstart on Fri Jul 10 17:20:40 2009.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome
|
||||
=======
|
||||
|
||||
Welcome to the OpenLP 2.0 API Documentation! In here you will find all
|
||||
information relating to OpenLP's core classes, core plugins, and anything else
|
||||
deemed necessary or interesting by the developers.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
core/index
|
||||
plugins/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
@ -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:
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
.. _plugins-bibles:
|
||||
|
||||
Bibles Plugin
|
||||
=============
|
||||
|
||||
.. automodule:: openlp.plugins.bibles
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.bibles.bibleplugin.BiblePlugin
|
||||
:members:
|
||||
|
||||
Forms
|
||||
-----
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.forms
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.bibles.forms.bibleimportform.BibleImportForm
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.db
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.biblestab
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.manager
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.mediaitem
|
||||
:members:
|
||||
|
||||
Bible Importers
|
||||
---------------
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.csvbible
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.http
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.osis
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.opensong
|
||||
:members:
|
||||
|
|
@ -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:
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
.. _plugins-images:
|
||||
|
||||
Images Plugin
|
||||
=============
|
||||
|
||||
.. automodule:: openlp.plugins.images
|
||||
:members:
|
||||
|
||||
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:
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
.. _plugins-index:
|
||||
|
||||
Plugins
|
||||
=======
|
||||
|
||||
.. automodule:: openlp.plugins
|
||||
:members:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
songs
|
||||
bibles
|
||||
presentations
|
||||
media
|
||||
images
|
||||
custom
|
||||
remotes
|
||||
songusage
|
||||
alerts
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
.. _plugins-media:
|
||||
|
||||
Media Plugin
|
||||
============
|
||||
|
||||
.. automodule:: openlp.plugins.media
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.media.mediaplugin.MediaPlugin
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.media.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.media.lib.mediaitem
|
||||
:members:
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
.. _plugins-presentations:
|
||||
|
||||
Presentations Plugin
|
||||
====================
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.presentations.presentationplugin.PresentationPlugin
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.mediaitem
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.presentationtab
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.messagelistener
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.presentationcontroller
|
||||
:members:
|
||||
|
||||
Presentation Application Controllers
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.impresscontroller
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.pptviewcontroller
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.powerpointcontroller
|
||||
:members:
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
.. _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:
|
||||
|
||||
.. autoclass:: openlp.plugins.remotes.lib.httpserver.HttpConnection
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.remotes.lib.httpserver.HttpResponse
|
||||
:members:
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
.. _plugins-songs:
|
||||
|
||||
Songs Plugin
|
||||
============
|
||||
|
||||
.. automodule:: openlp.plugins.songs
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.songsplugin.SongsPlugin
|
||||
:members:
|
||||
|
||||
Forms
|
||||
-----
|
||||
|
||||
.. automodule:: openlp.plugins.songs.forms
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.authorsform.AuthorsForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.editsongform.EditSongForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.editverseform.EditVerseForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.songbookform.SongBookForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.songimportform.SongImportForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.songmaintenanceform.SongMaintenanceForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.topicsform.TopicsForm
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.db
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.importer
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.mediaitem
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.songimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.songstab
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.xml
|
||||
:members:
|
||||
|
||||
Song Importers
|
||||
--------------
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.cclifileimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.ewimport
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.lib.ewimport.FieldDescEntry
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.olp1import
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.olpimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.oooimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.opensongimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.sofimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.songbeamerimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.wowimport
|
||||
:members:
|
||||
|
|
@ -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:
|
||||
|
|
@ -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."
|
||||
|
|
@ -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
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
=====
|
||||
Alert
|
||||
=====
|
||||
|
||||
From time to time it may be necessary to display a small unobtrusive message to
|
||||
the congregation. In OpenLP this is known as an `Alert`. Examples could be a car
|
||||
with the headlights left on, a parent needed in nursery, or anything else
|
||||
somebody may need notified about. This is easily accomplished using the Alert,
|
||||
which is accessible from the top Menu under :menuselection:`Tools --> Alert`.
|
||||
|
||||
.. image:: pics/alert.png
|
||||
|
||||
:guilabel:`Alert text:` Enter the message you want displayed in this box.
|
||||
|
||||
:guilabel:`Parameter:` This box is used for words you want to insert into the
|
||||
alert text.
|
||||
|
||||
You will add the Parameter text into the alert text using “<>” (without
|
||||
quotations). Anywhere in the Alert text that you add these two symbols, <> side
|
||||
by side, will insert any text you have in the parameter box into the Alert
|
||||
message.
|
||||
|
||||
Examples of use
|
||||
---------------
|
||||
|
||||
:guilabel:`Alert text:` The owner of the vehicle with license plate number <>
|
||||
your lights are on.
|
||||
|
||||
:guilabel:`Parameter:` HNN432
|
||||
|
||||
These two settings will display like this:
|
||||
|
||||
The owner of the vehicle with the license plate number HNN432 your lights are on.
|
||||
|
||||
You could also reverse this example:
|
||||
|
||||
:guilabel:`Alert text:` HNN432 <>
|
||||
|
||||
:guilabel:`Parameter:` left their lights on.
|
||||
|
||||
`Will display like this:` HNN432 left their lights on.
|
||||
|
||||
If you use the same alerts on a regular basis, Save your Alert and you will have
|
||||
access to the alert with a click of the mouse. You may also click on `New` to
|
||||
make a new alert or `Delete` an alert you do not need.
|
||||
|
||||
When you are ready to Display your Alert you have two options. Clicking on
|
||||
Display will display the Alert and the Alert Message window will remain open.
|
||||
Clicking Display & Close will display the alert and close the Alert Message
|
||||
window.
|
||||
|
||||
All details of the display, font, color, size and position are adjusted from the
|
||||
top Menu item :menuselection:`Settings --> Configure OpenLP`, Alert tab and the
|
||||
instructions here. :doc:`configure`
|
||||
|
||||
**Please note:** Alert Message is a Plugin that needs to be Active in the Plugin
|
||||
List for use.
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
======
|
||||
Bibles
|
||||
======
|
||||
|
||||
Managing Bibles in OpenLP is a relatively simple process. There are also
|
||||
converters provided to get data from other formats into OpenLP.
|
||||
|
||||
.. _bibleimporter:
|
||||
|
||||
Bible Importer
|
||||
==============
|
||||
|
||||
If you are using an earlier version of OpenLP or, come from another software
|
||||
package, you may be able to convert your existing database to work in OpenLP
|
||||
2.0. To access the Bible Importer :menuselection:`File --> Import --> Bible`.
|
||||
You may also enter the Bible Importer by clicking the :guilabel:`Import Icon:`
|
||||
|
||||
.. image:: pics/themeimportexport.png
|
||||
|
||||
You will see the Bible Importer window, click :guilabel:`Next`.
|
||||
|
||||
.. image:: pics/bibleimport01.png
|
||||
|
||||
After clicking :guilabel:`Next` you can select from the various types of
|
||||
software that OpenLP will convert Bibles from. Click on the file folder icon to
|
||||
choose the file(s) of the Bible database you want to import. See the sections
|
||||
below for more information on the different formats that OpenLP will import.
|
||||
Click :guilabel:`Next` to continue.
|
||||
|
||||
.. image:: pics/bibleimport02.png
|
||||
|
||||
After selecting your file(s), you'll be asked to fill in the details of the
|
||||
Bible you are importing. Remember to check what information you need to display
|
||||
for your Bible's translation, as some of them have strict rules around the
|
||||
copyright notice. Click :guilabel:`Next` to continue.
|
||||
|
||||
.. image:: pics/bibleimportdetails1.png
|
||||
|
||||
After filling in the copyright details, OpenLP will start to import your Bible.
|
||||
It may take some time to import your Bible so please be patient.
|
||||
|
||||
.. image:: pics/bibleimportfinished1.png
|
||||
|
||||
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
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Importing OSIS files is very simple. Select OSIS as your import source, select
|
||||
your OSIS Bible file and continue the import process.
|
||||
|
||||
**About OSIS Formatted Bibles**
|
||||
|
||||
The OSIS XML standard was designed to provide a common format for distribution
|
||||
of electronic Bibles. More information can be found out at the `Bible Technologies website
|
||||
<http://www.bibletechnologies.net/>`_.
|
||||
|
||||
If you have any software installed that is part of the `Sword Project
|
||||
<http://www.crosswire.org/sword/index.jsp>`_ it can be easily converted.
|
||||
|
||||
You can use the commands below convert Bibles from that software to OSIS format.
|
||||
|
||||
The following commands are used in all platforms and the commands are case
|
||||
sensitive across all platforms. To convert a Bible using the command prompt in
|
||||
Windows or a terminal in Linux or Mac OS X you would type::
|
||||
|
||||
mod2osis biblename > biblename.osis
|
||||
|
||||
For example: if I wanted to convert a King James Version Bible I would type
|
||||
something similar to this::
|
||||
|
||||
mod2osis KJV > kjv.osis
|
||||
|
||||
You may also wish to dictate a file location for the conversion to place the
|
||||
osis file for example::
|
||||
|
||||
mod2osis KJV > /home/user/bibles/kjv.osis
|
||||
|
||||
Importing OpenSong Bibles
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Converting from OpenSong you will need to locate your bibles database. In the
|
||||
later versions of OpenSong you are asked to define the location of this. The
|
||||
songs will be located in a folder named :guilabel:`Bibles`. This folder should
|
||||
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,
|
||||
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`.
|
||||
|
||||
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
|
||||
OpenSong Bibles.
|
||||
|
||||
Importing Web Download Bibles
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**About Web Download**
|
||||
|
||||
OpenLP provides a Web Download method to import Bibles when you do not have a
|
||||
locally installed Bible available. The Web Download method registers the Bible
|
||||
in OpenLP like the other bibles only it downloads the verses as you need them.
|
||||
This import is not meant to be used as your sole source for Bibles, but rather
|
||||
as another option and does require an internet connection.
|
||||
|
||||
To use the web download feature select web download from the import wizard.
|
||||
|
||||
You can select from several options of location to download from and also
|
||||
what Bible translation you need. You will probably want to choose the location
|
||||
from where you get the best performance or has the translation you need.
|
||||
|
||||
.. image:: pics/webbible1.png
|
||||
|
||||
You can also select a proxy server if needed from the `Proxy Server` tab. Your
|
||||
network administrator will know if this is necessary, in most cases this will
|
||||
not be needed.
|
||||
|
||||
.. image:: pics/webbibleproxy1.png
|
||||
|
||||
After selecting your download location and the Bible you wish to use, click
|
||||
:guilabel:`Next` to continue the import process. When your import is completed
|
||||
you should now be ready to use the web bible.
|
||||
|
||||
Importing CSV formatted Bibles
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you have a Bible in .csv format OpenLP can import it. CSV Bibles will
|
||||
consist of two files a `books` file and a `verse` file. Select CSV from the list
|
||||
of Bible types to import.
|
||||
|
||||
You are now ready to select your .csv files. You will need to select both your
|
||||
books and verse file location.
|
||||
|
||||
.. image:: pics/csvimport1.png
|
||||
|
||||
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.
|
||||
|
|
@ -0,0 +1,228 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# OpenLP documentation build configuration file, created by
|
||||
# sphinx-quickstart on Thu Sep 30 21:24:54 2010.
|
||||
#
|
||||
# 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 sys
|
||||
import os
|
||||
|
||||
# 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('.'))
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = []
|
||||
|
||||
# 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-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'OpenLP'
|
||||
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
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '2.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '2.0'
|
||||
|
||||
# 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 patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# 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 = True
|
||||
|
||||
# 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. See the documentation for
|
||||
# a list of builtin themes.
|
||||
if sys.argv[2] == 'qthelp' or sys.argv[2] == 'htmlhelp':
|
||||
html_theme = 'openlp_qthelp'
|
||||
else:
|
||||
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.
|
||||
if sys.argv[2] == 'html':
|
||||
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 = [os.path.join(os.path.abspath('..'), 'themes')]
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
html_title = u'OpenLP 2.0 Reference 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 = 'pics/logo.png'
|
||||
|
||||
# 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 = 'pics/openlp.ico'
|
||||
|
||||
# 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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = 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 = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'OpenLP'
|
||||
|
||||
|
||||
# -- 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 Reference Manual',
|
||||
u'Wesley Stout', '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
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = 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_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'openlp', u'OpenLP Reference Manual',
|
||||
[u'Wesley Stout'], 1)
|
||||
]
|
||||
|
|
@ -0,0 +1,376 @@
|
|||
==================
|
||||
Configuring OpenLP
|
||||
==================
|
||||
|
||||
OpenLP has many options you can configure to suit your needs. Most options are
|
||||
self-explanatory and we will quickly review them.
|
||||
|
||||
To configure OpenLP, click on :menuselection:`Settings --> Configure OpenLP...`
|
||||
|
||||
The plugins you have activated will have configure options. If all the plugins
|
||||
are activated there will be 9 tabs across the top you can configure.
|
||||
|
||||
General Tab
|
||||
===========
|
||||
|
||||
.. image:: pics/configuregeneral.png
|
||||
|
||||
Monitors
|
||||
^^^^^^^^
|
||||
To select the monitor you want to display OpenLP on, click the drop-down box
|
||||
and choose.
|
||||
|
||||
Display if a single screen
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When this box is selected, you will be able to see your display on a separate
|
||||
window on the monitor you are using. Click the display and push the Esc key
|
||||
on your keyboard to close the display window.
|
||||
|
||||
Application Startup
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**Show blank screen warning:**
|
||||
|
||||
When this box is selected, you will get a warning when opening OpenLP that the
|
||||
output display has been blanked. You may have blanked it and shut down the
|
||||
program and this will warn you it is still blanked.
|
||||
|
||||
**Automatically open the last service:**
|
||||
|
||||
When this box is selected, OpenLP will remember the last service you were
|
||||
working on when you closed the program.
|
||||
|
||||
**Show the splash screen:**
|
||||
|
||||
The OpenLP logo is displayed while OpenLP loads when this checkbox is checked.
|
||||
This is useful to give some indication that the program is loading.
|
||||
|
||||
**Check for updates to OpenLP**
|
||||
|
||||
OpenLP will check to see if there is a newer version available on a regular
|
||||
basis when this checkbox is checked. Please note that this requires Internet
|
||||
access.
|
||||
|
||||
Application Settings
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**Prompt to save before starting a new service**
|
||||
|
||||
When this box is selected, OpenLP will prompt you to save the service you are
|
||||
working on before starting a new service.
|
||||
|
||||
**Automatically preview next item in service**
|
||||
|
||||
When this box is selected, the next item in the Service Manager will show in the
|
||||
Preview pane.
|
||||
|
||||
**Unblank display when adding new live item**
|
||||
|
||||
When using the :guilabel:`blank to` button with this checkbox checked, on going
|
||||
live with the next item, the screen will be automatically re-enabled. If this
|
||||
checkbox is not checked you will need to click the :guilabel:`blank to` button
|
||||
again to reverse the action.
|
||||
|
||||
|
||||
**Slide loop delay**
|
||||
|
||||
This setting is the time delay in seconds if you want to continuously loop
|
||||
images, verses, or lyrics. This control timer is also accessible on the "live
|
||||
toolbar.
|
||||
|
||||
CCLI Details
|
||||
^^^^^^^^^^^^
|
||||
|
||||
**CCLI number**
|
||||
|
||||
If you subscribe to CCLI, this box is for your License number. This number is
|
||||
also displayed in the Song Footer box.
|
||||
|
||||
Display Position
|
||||
^^^^^^^^^^^^^^^^
|
||||
This setting will default to your computer monitor. It will override the output
|
||||
display combo box. If your projector display is different, select the Override
|
||||
display position and make the changes here to match your projector display. This
|
||||
option also comes in handy when you have the "Display if a single screen" box
|
||||
selected. You can make the display smaller so it does not cover your whole
|
||||
screen.
|
||||
|
||||
Themes Tab
|
||||
==========
|
||||
|
||||
.. image:: pics/configurethemes.png
|
||||
|
||||
Global Theme
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Choose the theme you would like to use as your default global theme from the
|
||||
drop down box. The theme selected appears below. The global theme use is
|
||||
determined by the Theme Level you have selected.
|
||||
|
||||
Theme Level
|
||||
^^^^^^^^^^^
|
||||
|
||||
Choose from one of three options for the default use of your theme.
|
||||
|
||||
**Song Level:**
|
||||
|
||||
With this level selected, your theme is associated with the song. The theme is
|
||||
controlled by adding or editing a song in the Song editor and your song theme
|
||||
takes priority. If your song does not have a theme associated with it, OpenLP
|
||||
will use the theme set in the Service Manager.
|
||||
|
||||
**Service Level:**
|
||||
|
||||
With this level selected, your theme is controlled at the top of the Service
|
||||
Manager. Select your default service theme there. This setting will override
|
||||
your Song theme.
|
||||
|
||||
**Global Level:**
|
||||
|
||||
With this level selected, all songs and verses will use the theme selected on
|
||||
the left in the Global Theme drop down.
|
||||
|
||||
Advanced Tab
|
||||
============
|
||||
|
||||
.. image:: pics/configureadvanced.png
|
||||
|
||||
|
||||
UI Settings (user interface)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**Number of recent files to display:**
|
||||
|
||||
Set this number for OpenLP to remember your last files open. These will show
|
||||
under File.
|
||||
|
||||
**Remember active media manager tab on startup:**
|
||||
|
||||
With this box selected OpenLP media manager will open on the same tab that it
|
||||
was closed on.
|
||||
|
||||
**Double-click to send items straight to live:**
|
||||
|
||||
With this box selected, double-clicking on anything in the Media Manager will
|
||||
immediately send it live instead of to Preview.
|
||||
|
||||
**Expand new service items on creation:**
|
||||
|
||||
With this box selected, everything you add to the Service Manager will be
|
||||
expanded so you can see all the verses, lyrics and presentations, line by line.
|
||||
When you open OpenLP, everything will automatically be expanded in the Service
|
||||
Manager.
|
||||
|
||||
Songs Tab
|
||||
=========
|
||||
|
||||
.. image:: pics/configuresongs.png
|
||||
|
||||
Songs Mode
|
||||
^^^^^^^^^^
|
||||
|
||||
**Enable search as you type:**
|
||||
|
||||
With this box selected, Media Manager/Songs will display the song you are
|
||||
searching for as you are typing. If this box is not selected, you need to type
|
||||
in your search box and then click on the Search button.
|
||||
|
||||
**Display verses on live tool bar:**
|
||||
|
||||
With this box selected, a Go To drop down box is available on the live toolbar
|
||||
to select any part of the verse type you want displayed live.
|
||||
|
||||
**Update service from song edit:**
|
||||
|
||||
With this box selected and you edit a song in the media manager, the results
|
||||
will also change the song if it is added to the Service Manager. If this box
|
||||
is not selected, your song edit changes will only be available in the Service
|
||||
Manager if you add it again.
|
||||
|
||||
**Add missing songs when opening service:**
|
||||
|
||||
With this box selected, when you open an order of service created on another
|
||||
computer, or if one of the songs are no longer in your Media Manager, it will
|
||||
automatically enter the song in your Songs Media Manager. If this box is not
|
||||
checked, the song is available in the service but will not be added to the
|
||||
Media Manager.
|
||||
|
||||
Bibles Tab
|
||||
==========
|
||||
|
||||
.. image:: pics/configurebibles.png
|
||||
|
||||
Verse Display
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
**Only show new chapter numbers:**
|
||||
|
||||
With this box selected, the live display of the verse will only show the
|
||||
chapter number and verse for the first verse, and just the verse numbers after
|
||||
that. If the chapter changes, the new chapter number will be displayed with the
|
||||
verse number for the first line, and only the verse number displayed thereafter.
|
||||
|
||||
**Display style:**
|
||||
|
||||
This option will put brackets around the chapter and verse numbers. You may
|
||||
select No Brackets or your bracket style from the drop down menu.
|
||||
|
||||
**Layout style:**
|
||||
|
||||
There are three options to determine how your Bible verses are displayed.
|
||||
|
||||
`Verse Per Slide` will display one verse per slide.
|
||||
`Verse Per Line` will start each verse on a new line until the slide is full.
|
||||
`Continuous` will run all verses together separated by verse number and chapter
|
||||
if chapter is selected to show above.
|
||||
|
||||
**Note: Changes do not affect verses already in the service.**
|
||||
|
||||
**Display second Bible verses:**
|
||||
|
||||
OpenLP has the ability to display the same verse in two different Bible
|
||||
versions for comparison. With this option selected, there will be a Second
|
||||
choice in the Bible Media Manager to use this option. Verses will display with
|
||||
one verse per slide with the second Bible verse below.
|
||||
|
||||
**Bible theme:**
|
||||
|
||||
You may select your default Bible theme from this drop down box. This selected
|
||||
theme will only be used if your `Theme Level` is set at `Song Level`.
|
||||
|
||||
**Note: Changes do not affect verses already in the service.**
|
||||
|
||||
|
||||
Presentations Tab
|
||||
=================
|
||||
|
||||
.. image:: pics/configurepresentations.png
|
||||
|
||||
Available Controllers
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
OpenLP has the ability to import OpenOffice Impress or Microsoft PowerPoint
|
||||
presentations, and use Impress, PowerPoint, or PowerPoint Viewer to display
|
||||
them and they are controlled from within OpenLP. Please remember that in order
|
||||
to use this function, you must have Impress, PowerPoint or PowerPoint Viewer
|
||||
installed on your computer because OpenLP uses these programs to open and run
|
||||
the presentation. You may select your default controllers here in this tab.
|
||||
|
||||
Advanced
|
||||
^^^^^^^^
|
||||
|
||||
**Allow presentation application to be overridden**
|
||||
|
||||
With this option selected, you will see `Present using` area with a dropdown
|
||||
box on the Presentations toolbar in Media Manager which gives you the option
|
||||
to select the presentation program you want to use.
|
||||
|
||||
Media Tab
|
||||
=========
|
||||
|
||||
.. image:: pics/configuremedia.png
|
||||
|
||||
Media Display
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
**Use Phonon for video playback**
|
||||
|
||||
If you are having trouble displaying media, selecting this box could help.
|
||||
|
||||
Custom Tab:
|
||||
===========
|
||||
|
||||
.. image:: pics/configurecustom.png
|
||||
|
||||
Custom Display
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
**Display Footer**
|
||||
|
||||
With this option selected, your Custom slide Title will be displayed in the
|
||||
footer.
|
||||
|
||||
**Note: If you have an entry in the Credits box of your custom slide, title and
|
||||
credits will always be displayed.**
|
||||
|
||||
Alerts Tab
|
||||
==========
|
||||
|
||||
.. image:: pics/configurealerts.png
|
||||
|
||||
Font
|
||||
^^^^
|
||||
|
||||
**Font name:**
|
||||
|
||||
Choose your desired font from the drop down menu
|
||||
|
||||
**Font color:**
|
||||
|
||||
Choose your font color here.
|
||||
|
||||
**Background color:**
|
||||
|
||||
Choose the background color the font will be displayed on.
|
||||
|
||||
**Font size:**
|
||||
|
||||
This will adjust the size of the font.
|
||||
|
||||
**Alert timeout:**
|
||||
|
||||
This setting will determine how long your Alert will be displayed on the screen,
|
||||
in seconds.
|
||||
|
||||
**Location:**
|
||||
|
||||
Choose the location where you want the alert displayed on the
|
||||
screen, Top, Middle or Bottom.
|
||||
|
||||
**Preview:**
|
||||
|
||||
Your choices will be displayed here.
|
||||
|
||||
Remote Tab
|
||||
===========
|
||||
|
||||
.. image:: pics/configureremotes.png
|
||||
|
||||
OpenLP gives you the ability to control your Service Manager from a remote
|
||||
computer through a web browser. This was written actually for a nursery or day
|
||||
care where a "come and get YYYY" message could be triggered remotely. It has
|
||||
now become an interface to control the whole service remotely.
|
||||
|
||||
An example of one use for this would be if you have a missionary with a
|
||||
PowerPoint presentation, it may be easier for that missionary to remotely
|
||||
connect to your projection computer and change the slides when he wants to.
|
||||
|
||||
To use this feature you will need to be on a network, wired or wireless, know
|
||||
the IP address of the projection computer and enter that IP address and port
|
||||
number in the remote computer's web browser.
|
||||
|
||||
To find your projection computer's IP address for Windows, open Command Prompt
|
||||
and type in “ipconfig” (without quotations), press Enter key and your IP
|
||||
address will show. In Linux, open Terminal and type “ifconfig” (without
|
||||
quotations), and use the IP address after “inet addr:” The IP address will
|
||||
always have a format of xxx.xxx.xxx.xxx where x is one to three digits long.
|
||||
|
||||
Server Settings
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Serve on IP address: Put your projection computer's IP address here.
|
||||
|
||||
Port Number
|
||||
^^^^^^^^^^^
|
||||
|
||||
You can use the default port number or change it to another number.
|
||||
|
||||
With these two settings written down, open a web browser in the remote computer
|
||||
and enter the IP address followed by a colon and then the port number, ie:
|
||||
192.168.1.104:4316 then press enter. You should now have access to the OpenLP
|
||||
Controller. If it does not come up, you either entered the wrong IP address,
|
||||
port number or one or both computer's are not connected to the network.
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,231 @@
|
|||
.. _dualmonitors:
|
||||
|
||||
==================
|
||||
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
|
||||
will vary depending on operating system.
|
||||
|
||||
Most modern computers have the ability for dual monitors. To be certain,
|
||||
check your computer's documentation. A typical desktop computer capable of dual
|
||||
monitors will have two of, or a combination of the two, connectors below.
|
||||
|
||||
**VGA**
|
||||
|
||||
.. image:: pics/vga.png
|
||||
|
||||
**DVI**
|
||||
|
||||
.. image:: pics/dvi.png
|
||||
|
||||
A laptop computer setup only varies slightly. Generally you will need only one
|
||||
of the outputs pictured above since your laptop 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 :abbr:`S-Video (Separate Video)` or
|
||||
:abbr:`HDMI (High-Definition Multimedia Interface)` connections.
|
||||
|
||||
A typical OpenLP setup consist of your normal single monitor, with your
|
||||
projector hooked up to your computer as the second monitor. With the option of
|
||||
extending your desktop across the second monitor, or your operating system's
|
||||
equivalent.
|
||||
|
||||
**Special Note For Projectors Using USB Connections**
|
||||
|
||||
Users have reported experiencing difficulties when using a projector with a USB
|
||||
connection, as third party software is often required to properly configure
|
||||
dual monitors. If possible, it is best to use a direct output (VGA, DVI, HDMI,
|
||||
S-Video) from your machine's video card. If a USB connection is your only option
|
||||
please consult the manufacturer's manual for instructions on a proper setup.
|
||||
|
||||
Microsoft Windows
|
||||
-----------------
|
||||
|
||||
Dual monitor setup is similar among all the currently supported Windows
|
||||
releases (XP, Vista, Windows 7), but does vary slightly from one release to the
|
||||
next.
|
||||
|
||||
Windows 7
|
||||
^^^^^^^^^
|
||||
|
||||
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
|
||||
:guilabel:`Control Panel` and click on :guilabel:`Display`. This will open up
|
||||
the :guilabel:`Display` dialog. You may also bypass this step by a right click
|
||||
on a blank area on your desktop and selecting :guilabel:`Resolution`.
|
||||
|
||||
.. image:: pics/winsevendisplay.png
|
||||
|
||||
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
|
||||
|
||||
Windows Vista
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
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 :guilabel:`Personalization` window click on :guilabel:`Display
|
||||
Settings`. Click on the monitor that represents your projector and make sure
|
||||
you have checked :guilabel:`Extend the desktop onto this monitor`.
|
||||
|
||||
.. image:: pics/vistadisplaysettings.png
|
||||
|
||||
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
|
||||
-----
|
||||
|
||||
Due to the vast varieties of hardware, distributions, desktops, and drivers
|
||||
this is not an exhaustive guide to dual monitor setup on Linux. This guide
|
||||
assumes 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
|
||||
^^^^^
|
||||
|
||||
This guide is for users of the GNOME desktop who do not use proprietary drivers.
|
||||
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
|
||||
|
||||
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
|
||||
:guilabel:`System Settings`
|
||||
|
||||
.. image:: pics/kdesystemsettings.png
|
||||
|
||||
Click on the display and monitor icon.
|
||||
|
||||
.. 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
|
||||
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 (:command:`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
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
Linux Systems With Intel Video
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Generally systems with Intel video cards work very well. They are well supported
|
||||
by open source drivers. There are, however, a couple of issues that may require
|
||||
some work arounds.
|
||||
|
||||
**Resolution Issue**
|
||||
|
||||
There is a limitation with certain cards which limits the total resolution to
|
||||
2048x2048, so both monitors can not have a total resolution totaling more than
|
||||
that. To work around this it may be necessary to position your monitor as a top
|
||||
or bottom monitor as opposed to the typical side by side setup. This can easily
|
||||
be accomplished through your desktop's control of monitors. Please see the
|
||||
sections on dual monitors with KDE and GNOME above.
|
||||
|
||||
**Primary Monitor Issues**
|
||||
|
||||
With certain cards your system may get confused on what is the primary display.
|
||||
For example many users will be using a laptop. You will want your laptop screen
|
||||
to be the primary screen, and your projector to be the secondary monitor.
|
||||
Certain Intel cards reverse this. To work around this you will need to know the
|
||||
name of your monitor. If you are a KDE user this info is given to you in the
|
||||
display settings. If you are not using KDE enter the following in a terminal
|
||||
without your projector connected to your computer::
|
||||
|
||||
user@linux:~ $ xrandr -q
|
||||
|
||||
This will give you a long string of output. Screen names will be something along
|
||||
the lines of LVDM, VGA-0 or some convention similar to that. Without your
|
||||
projector connected to your computer only one monitor will show as being
|
||||
connected. That will be the monitor you will need to use as the primary. Now
|
||||
connect your projector and enter::
|
||||
|
||||
user@linux:~ $ xrandr --output LVDM --primary
|
||||
|
||||
**Note** it has been reported that when this issue is occurring you will not
|
||||
want to connect your projector until your desktop is running.
|
||||
|
|
@ -0,0 +1,572 @@
|
|||
==========================
|
||||
Frequently Asked Questions
|
||||
==========================
|
||||
|
||||
General Questions
|
||||
=================
|
||||
|
||||
When is the release date for OpenLP 2.0?
|
||||
----------------------------------------
|
||||
|
||||
*It will be ready when it's ready!* We do not have fixed dates, but we have
|
||||
set some `targets for the releases <http://wiki.openlp.org/Version_2_Milestones>`_.
|
||||
If you take part in the `development <http://wiki.openlp.org/Development:Getting_Started>`_,
|
||||
start to `test OpenLP <http://wiki.openlp.org/Testing:Getting_Started>`_ and
|
||||
`provide feedback <http://wiki.openlp.org/Help:Contents>`_ this will speed up
|
||||
the progress.
|
||||
|
||||
Can I help with OpenLP?
|
||||
-----------------------
|
||||
|
||||
OpenLP is possible because of the commitment of individuals. If you would like
|
||||
to help there are several things that you can get involved with. Please see:
|
||||
`Contributing <http://openlp.org/en/documentation/introduction/contributing.html>`_
|
||||
for more information.
|
||||
|
||||
I use and like OpenLP and would like to tell others online. Where can I do this?
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
A variety of places!
|
||||
|
||||
* Are you on facebook? Then `become a fan <http://www.facebook.com/openlp>`_
|
||||
* Are you on twitter? Then `follow openlp <http://twitter.com/openlp>`_, and
|
||||
retweet the announcements.
|
||||
* Give us a thumbs up on the
|
||||
`SourceForge project page <http://www.sourceforge.net/projects/openlp>`_
|
||||
* If you have a website or blog, then link to our site http://www.openlp.org
|
||||
with a few words saying what the software is and why you like it.
|
||||
* Add a placemark on our `Worldwide Usage map <http://maps.google.com/maps/ms?ie=UTF8&source=embed&msa=0&msid=113314234297482809599.00047e88b1985e07ad495&ll=13.923404,0&spn=155.179835,316.054688&z=2>`_,
|
||||
so others in your locality can see someone close by is using it.
|
||||
* If you are a member of any Christian Forums or websites, and their rules allow
|
||||
it, then perhaps review the software or ask others to review it.
|
||||
|
||||
What operating systems will OpenLP 2.0 support?
|
||||
-----------------------------------------------
|
||||
|
||||
OpenLP 2.0 is designed to be cross platform. Currently it has been known to run
|
||||
on Windows (XP, Vista, 7), Linux (Ubuntu/Kubuntu, Fedora), FreeBSD & Mac OSX.
|
||||
`Please let us know <http://wiki.openlp.org/Help:Contents>`_ if you've
|
||||
successfully run it on something else.
|
||||
|
||||
Which programming language is 2.0 developed in?
|
||||
-----------------------------------------------
|
||||
|
||||
OpenLP 2.0 is written in `Python <http://www.python.org>`_ and uses the
|
||||
`Qt4 toolkit <http://qt.nokia.com>`_. Both are cross-platform which allows the
|
||||
software to run on different types of machine and so allow more people access to
|
||||
free worship software. Python is one of the easier programming languages to
|
||||
learn, so this helps us develop and `find bugs <http://wiki.openlp.org/Bug#Something_has_gone_wrong.2C_what_should_I_do_to_help_get_it_fixed.3F>`_
|
||||
quicker, and also allows more developers to contribute with the project.
|
||||
|
||||
Which written languages does OpenLP support?
|
||||
--------------------------------------------
|
||||
|
||||
The beta now has support for a few languages which can be seen on the
|
||||
:menuselection:`Settings -->Translate` menu. However some of these translations
|
||||
are incomplete. If you would like to help complete or start to translate OpenLP
|
||||
into your language then see the `Getting started page <http://wiki.openlp.org/Translation:Getting_Started>`_.
|
||||
|
||||
What is a beta release?
|
||||
-----------------------
|
||||
|
||||
A beta release is a release which is almost feature complete and is fairly
|
||||
stable. However there may still be a few `features <http://wiki.openlp.org/Version_2_Features>`_
|
||||
to complete, and `bugs <https://bugs.launchpad.net/openlp>`_ we've not yet fixed.
|
||||
It is used by several people without serious problems. However there is a small
|
||||
possibility that it could still crash occasionally or do unexpected things. It
|
||||
is intended for those who want the latest version, and are prepared to give the
|
||||
program a good test before using it in a live situation to ensure they won't
|
||||
encounter any unexpected problems. If you want to have a look at the latest beta
|
||||
release then just `download it <http://openlp.org/en/download.html>`_.
|
||||
|
||||
Should I use this beta release at Church in my Sunday services?
|
||||
---------------------------------------------------------------
|
||||
|
||||
As long as you have taken the time to run through your service a couple of times
|
||||
on your target machine, the answer to this question is **yes**. The OpenLP
|
||||
team believes that OpenLP 2.0 beta 1 is stable enough to be used in Sunday
|
||||
services. As of beta 1, there are a good number of churches already using
|
||||
version 2.0 successfully. The OpenLP team works hard to make sure each release
|
||||
is solid, but cannot yet guarantee that everything works perfectly, or even
|
||||
correctly.
|
||||
|
||||
If however your congregation is made up of 85 year old women who snarl when you
|
||||
suggest replacing the gas lamps with electric light bulbs and consider the pipe
|
||||
organ too loud and modern, then we recommend sticking with version 1.2 for now.
|
||||
|
||||
As of beta 1, version 1.2 of OpenLP is "put out to pasture" - no more
|
||||
development or even bugfixes will be performed on that version.
|
||||
|
||||
Upgrading
|
||||
=========
|
||||
|
||||
Does 2.0 replace 1.2, or can they be run side by side?
|
||||
------------------------------------------------------
|
||||
|
||||
It is perfectly safe to install 2.0 on a system with 1.2. Both versions are
|
||||
installed in separate places, so you can still go back to 1.2. You can even run
|
||||
them at the same time!
|
||||
|
||||
2.0 stores its data in a separate folder to 1.2, so your data is perfectly safe,
|
||||
and whatever you do in 2.0 will not damage 1.2
|
||||
|
||||
Are 1.2 and 2.0 compatible?
|
||||
---------------------------
|
||||
|
||||
No. However imports exist to transfer your data to the new version.
|
||||
|
||||
I have a computer that is quite old, should I upgrade?
|
||||
------------------------------------------------------
|
||||
|
||||
2.0 does require significantly more resources than v1.2. Therefore if your
|
||||
computer does not have much memory you may find 2.0 will struggle, `especially`
|
||||
when changing between slides.
|
||||
|
||||
Why can I not see my 1.2 songs, bibles and themes in 2.0?
|
||||
---------------------------------------------------------
|
||||
|
||||
This is an beta release, which means it is not finished and one of the things we
|
||||
haven't completely finished yet is importing 1.2 data automatically. We plan to
|
||||
do this `Version 1.9.6 (beta 2) <http://wiki.openlp.org/Version_2_Milestones#Version_1.9.6_.28beta_2.29>`_.
|
||||
|
||||
How do I transfer my 1.2 song database?
|
||||
---------------------------------------
|
||||
|
||||
In OpenLP 2.0, go to the :menuselection:`File --> Import --> Song` menu.
|
||||
In the Wizard that appears, click Next and choose "openlp.org v1.x" from the
|
||||
Format list. Click the search button on the Filename prompt, and at the bottom
|
||||
of the dialog, copy the following into the File name prompt::
|
||||
|
||||
%ALLUSERSPROFILE%\Application Data\openlp.org\Data\songs.olp
|
||||
|
||||
*(This must be in the popup file chooser dialog. Don't enter it directly into
|
||||
the wizard).*
|
||||
|
||||
Click Open, then in the wizard just click Next and wait for the import to complete.
|
||||
|
||||
How do I transfer my 1.2 Bibles?
|
||||
--------------------------------
|
||||
|
||||
In OpenLP 2.0, go to the :menuselection:`File --> Import --> Bible` menu.
|
||||
In the Wizard that appears, click Next and choose "openlp.org v1.x" from the
|
||||
Format list.
|
||||
Click the search button on the Filename prompt, and at the bottom of the dialog,
|
||||
copy the following into the File name prompt::
|
||||
|
||||
%ALLUSERSPROFILE%\Application Data\openlp.org\Data\Bibles
|
||||
|
||||
*(This must be in the popup file chooser dialog. Don't enter it directly into
|
||||
the wizard).*
|
||||
|
||||
Choose the Bible, Click Open, then in the wizard just click Next, enter the
|
||||
License details, and wait for the import to complete.
|
||||
|
||||
How do I transfer my 1.2 Themes?
|
||||
--------------------------------
|
||||
|
||||
In openlp.org v1, export each theme by selecting it in the Theme Manager, and
|
||||
then clicking the picture of a blue folder with red arrow on the Theme Managers
|
||||
toolbox. This theme file can then be imported into V2 using the
|
||||
:menuselection:`File --> Import --> Theme` menu.
|
||||
|
||||
I can't get my 2.0 theme to look the same as 1.2
|
||||
------------------------------------------------
|
||||
|
||||
OpenLP 2.0 is a complete rewrite using a completely different programming
|
||||
language so it would work on different types of system. There are differences in
|
||||
how the old and new languages draw text on the screen, and therefore it is
|
||||
unlikely you'll get an exact match.
|
||||
|
||||
Using OpenLP
|
||||
============
|
||||
|
||||
Is there a manual or any documentation for 2.0?
|
||||
-----------------------------------------------
|
||||
|
||||
Some folks are working on a brand new manual for OpenLP 2.0. You can find the
|
||||
latest version of this manual at http://manual.openlp.org. If you need help,
|
||||
use the live chat feature or ask in the forums. If you would like to help write
|
||||
the manual, please let us know - we are always happy for new volunteers to join
|
||||
the team and contribute to the project.
|
||||
|
||||
I've started OpenLP, but I can't see the songs or bibles section in the Media Manager
|
||||
-------------------------------------------------------------------------------------
|
||||
|
||||
When you installed OpenLP, the first time wizard would have asked which plugins
|
||||
you wanted, and songs and bibles should have been selected. If for some reason
|
||||
they were not, then you will need to activate them yourself. See
|
||||
`How do I activate / deactivate a plugin <http://wiki.openlp.org/Bug#How_do_I_activate_.2F_deactivate_a_plugin.3F>`_
|
||||
for instructions.
|
||||
|
||||
How do I activate / deactivate a plugin?
|
||||
----------------------------------------
|
||||
|
||||
Plugins can be turned on and off from the Plugin List Screen. Select the plugin
|
||||
you wish to start/stop and change it's status. You should not need to restart
|
||||
OpenLP.
|
||||
|
||||
What are these plugins that I keep seeing mentioned?
|
||||
----------------------------------------------------
|
||||
|
||||
The plugins allow OpenLP to be extend easily. A number have been written
|
||||
(Songs, Bibles, Presentations) etc but it is possible for the application to be
|
||||
extended with functionality only you require. If this is the case then go for
|
||||
it but lets us know as we can help and it may be something someone else wants.
|
||||
|
||||
How do I enable PowerPoint/Impress/PowerPoint Viewer?
|
||||
-----------------------------------------------------
|
||||
|
||||
First of all ensure that the presentation plugin is enabled (see above).
|
||||
Then to enable a presentation application, go to the `Settings` dialog, switch
|
||||
to the `Presentations` tab and check one of the enabled checkboxes. OpenLP will
|
||||
automatically detect which of the three you have installed, and enable the
|
||||
appropriate checkbox(es). Check the applications you require, and then restart
|
||||
OpenLP for the change to be detected.
|
||||
Note, PowerPoint Viewer 2010 is not yet supported, use 2003 or 2007.
|
||||
|
||||
See also `I'm on Windows and PowerPoint is installed, but it doesn't appear as an option <http://wiki.openlp.org/OpenLP_2_Introduction_and_FAQ#I.27m_on_Windows_and_PowerPoint_is_installed.2C_but_it_doesn.27t_appear_as_an_option>`_
|
||||
and `Why is there no presentations plugin available on OS X? <http://wiki.openlp.org/OpenLP_2_Introduction_and_FAQ#Why_is_there_no_presentations_plugin_available_on_OS_X.3F>`_
|
||||
|
||||
Why is there no presentations plugin available on OS X?
|
||||
-------------------------------------------------------
|
||||
|
||||
Currently the presentations plugin is not bundled with OpenLP on OS X. The
|
||||
reason for that is that the OpenOffice.org version on Mac OS X does not contain
|
||||
the (more exact: does only contain a broken) interoperability component (the so
|
||||
called pyuno bridge) which could be used by OpenLP. As soon as the
|
||||
interoperability component works on OS X we can re-enable the plugin and bundle
|
||||
it. We are really sorry for that.
|
||||
|
||||
Is it possible to get Bible x? How?
|
||||
-----------------------------------
|
||||
|
||||
The Bible plugin has a much improved `Import Wizard` which can import Bibles
|
||||
from a variety of sources. The following sources are supported:
|
||||
|
||||
CSV
|
||||
The same format as documented for `openlp.org 1.x <http://www.openlp.org/en/documentation/importing_exporting_data/bibles/importing_comma_delimited_files.html>`_.
|
||||
|
||||
OSIS
|
||||
An XML format for Bible. You can export Bibles from the `Sword Project <http://www.crosswire.org/sword/software/>`_
|
||||
into OSIS using the ``mod2osis`` tool. After using the Sword software Media
|
||||
Manager (or other Sword frontend, like BibleTime or Xiphos) to download the
|
||||
required Bible, run the following command from the command line (works on
|
||||
Windows and Linux)::
|
||||
|
||||
mod2osis <name> > <name>.osis
|
||||
|
||||
The ``<name>`` parameter is the name of your Bible, as you see it in Sword.
|
||||
Note that the ``<name>`` is case sensitive on all environments. Once you
|
||||
have exported your Bible to OSIS, the Bible import wizard will the read
|
||||
``<name>.osis`` file and import your Bible.
|
||||
|
||||
OpenSong
|
||||
OpenSong have a good selection of Bibles on their
|
||||
`download page <http://www.opensong.org/d/downloads#bible_translations>`_.
|
||||
|
||||
Web Download
|
||||
OpenLP can download Bibles on demand from the following 3 sites:
|
||||
|
||||
* `Crosswalk <http://biblestudy.crosswalk.com/bibles/>`_
|
||||
* `BibleGateway <http://www.biblegateway.com/versions/>`_
|
||||
* `BibleServer <http://www.bibleserver.com>`_
|
||||
|
||||
Why do my Bible verses take a long time to load?
|
||||
------------------------------------------------
|
||||
|
||||
In order to better conform to copyright law, the Web Download Bibles are not
|
||||
downloaded when you import them, but on the fly as you search for them. As a
|
||||
result, the search takes a little longer if you need to download those
|
||||
particular verses. Having said that, the Web Download Bibles cache downloaded
|
||||
verses so that you don't need to download them again.
|
||||
|
||||
My Bible is on the Web Download sites, but my Church isn't on the internet. What options do I have?
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
When you create and save a service, all the items in the service are saved with
|
||||
it. That means any images, presentations, songs and media items are saved. This
|
||||
is also true for bibles. What this means is you can create the service on your
|
||||
home computer, insert a Bible passage from the web, save it and then open the
|
||||
service using your church computer and voila, the Bible passage should be there!
|
||||
Note this can also be done with songs, etc!
|
||||
|
||||
(Advanced) Where do I find the configuration file?
|
||||
==================================================
|
||||
|
||||
Linux, FreeBSD & PC-BSD
|
||||
-----------------------
|
||||
|
||||
If your distribution supports the XDG standard, you'll find OpenLP's
|
||||
configuration file in::
|
||||
|
||||
/home/<user>/.config/OpenLP/OpenLP.conf
|
||||
|
||||
If that file and/or directory does not exist, look for::
|
||||
|
||||
/home/<user>/.openlp/openlp.conf
|
||||
|
||||
``<user>`` is your username.
|
||||
|
||||
OS X
|
||||
----
|
||||
|
||||
You'll find your configuration file here::
|
||||
|
||||
/Users/<user>/Library/Preferences/org.openlp.OpenLP.plist
|
||||
|
||||
``<user>`` is your username.
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
On Windows, OpenLP does not use a configuration file, it uses the Windows
|
||||
registry. You can find the settings here::
|
||||
|
||||
HKEY_CURRENT_USER\Software\OpenLP\OpenLP
|
||||
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
Something has gone wrong, what should I do to help get it fixed?
|
||||
----------------------------------------------------------------
|
||||
|
||||
If you have found an error in the program (what we call a bug) you should report
|
||||
this to us so that OpenLP can be improved. Before reporting any bugs please
|
||||
first make sure that there isn't already a bug report about your problem:
|
||||
|
||||
#. Check the `Launchpad bug list <https://bugs.launchpad.net/openlp>`_
|
||||
#. `OpenLP support System <http://www.support.openlp.org/projects/openlp>`_
|
||||
#. Check the `bug reports <http://openlp.org/en/forums/openlp_20/bug_reports.html>`_ forum
|
||||
|
||||
If there **is already a bug report**, you may be able to help by providing
|
||||
further information. However, **if no one else has reported** it yet, then
|
||||
please post a new bug report.
|
||||
|
||||
#. The **preferred place** for reporting bugs is the
|
||||
`bugs list <https://bugs.launchpad.net/openlp>`_ on Launchpad.
|
||||
#. Alternatively, if you don't have a Launchpad account and don't want to sign
|
||||
up for one, you can post in the
|
||||
`bug reports forum <http://openlp.org/en/forums/openlp_20/bug_reports.html>`_.
|
||||
#. If none of these ways suits you, you can send an email to
|
||||
``bugs (at) openlp.org``.
|
||||
|
||||
What information should I include in a bug report?
|
||||
--------------------------------------------------
|
||||
|
||||
Since OpenLP 1.9.4, there is a bug report dialog which automatically opens when
|
||||
OpenLP hits a serious bug. However, this doesn't appear all the time, and in
|
||||
some behavioural bugs, you'll have to file a bug report yourself. The following
|
||||
items are information the developers need in order to reproduce the bug.
|
||||
|
||||
Operating System
|
||||
Include information such as the version of your operating system, the
|
||||
distribution (e.g. Ubuntu, Fedora, etc.) if you're using Linux, or the
|
||||
edition (e.g. Home, Basic, Business, etc.) if you're using Windows.
|
||||
|
||||
Version of OpenLP
|
||||
You can find out the version of OpenLP by going to :menuselection:`Help --> About`
|
||||
|
||||
Steps to Reproduce
|
||||
The exact steps the developers need to follow in order to reproduce the bug.
|
||||
|
||||
Version of MS Office or OpenOffice
|
||||
If you're using the song imports or the presentation plugin, you'll need to
|
||||
supply the version of Office, OpenOffice.org or LibreOffice.
|
||||
|
||||
Bible Translation and Source
|
||||
If the bug occurred while you were working with Bibles, specify the
|
||||
translation of the Bible, and the source format if you imported it yourself.
|
||||
|
||||
**Any** Other Information
|
||||
Often bugs are caused by something that might not seem to be directly
|
||||
related to the bug itself. If you have any other information with regards to
|
||||
actions you performed or other activities when the bug occurred, it would be
|
||||
welcomed by the developers.
|
||||
|
||||
The more information you give us, the better we can help you.
|
||||
|
||||
I've been asked to email a debug log, where do I find this?
|
||||
-----------------------------------------------------------
|
||||
|
||||
We may need a debug log to help pin-point the issue. A new log file is created
|
||||
each time you start OpenLP so copy the file before you run the software a second
|
||||
time. On Windows a Debug option is available in the start menu. On other systems,
|
||||
you will need to run OpenLP from the command line, with the following
|
||||
option: ```-l debug```. Please note, that is a lowercase **L**.
|
||||
|
||||
If you haven't been given a specific email address to send it to, then please do
|
||||
not paste the log contents straight into a forum post. Instead, open the log
|
||||
file in a text editor (such as notepad on Windows) and copy and paste the
|
||||
contents into somewhere like `pastebin.com <http://pastebin.com>`_. Then give us
|
||||
the link to the page that is created.
|
||||
|
||||
Windows
|
||||
^^^^^^^
|
||||
|
||||
Find the OpenLP 2.0 folder in your Start menu. Choose the "OpenLP (Debug)" option.
|
||||
|
||||
OpenLP will start up. Go to the :menuselection:`Tools --> Open Data Folder` menu
|
||||
option, and an Explorer window will appear containing folders such as alerts,
|
||||
bibles, custom etc. Keep this Explorer window open.
|
||||
|
||||
Now repeat the steps you need to take in OpenLP to reproduce the problem you had,
|
||||
and then close down OpenLP.
|
||||
|
||||
In the Explorer window you left open, navigate up one level into the openlp
|
||||
folder. You will see the ``openlp.log`` file. This is the file to e-mail.
|
||||
|
||||
Linux/FreeBSD
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
If you installed OpenLP from a package::
|
||||
|
||||
@:~$ openlp -l debug
|
||||
|
||||
Alternately, if you're running OpenLP from source::
|
||||
|
||||
@:~$ ./openlp.pyw -l debug
|
||||
|
||||
If your Linux distribution supports the XDG standard, you'll find the log in::
|
||||
|
||||
~/.cache/openlp/openlp.log
|
||||
|
||||
Otherwise, you'll find the log file in::
|
||||
|
||||
~/.openlp/openlp.log
|
||||
|
||||
Mac OS X
|
||||
^^^^^^^^
|
||||
|
||||
Open Terminal.app and navigate to where you installed OpenLP, usually
|
||||
``/Applications``::
|
||||
|
||||
@:~$ cd /Applications
|
||||
|
||||
Then go into the OpenLP.app directory, down to the OpenLP executable::
|
||||
|
||||
@:~$ cd OpenLP.app/Contents/MacOS
|
||||
|
||||
And then run OpenLP in debug mode::
|
||||
|
||||
@:~$ ./openlp -l debug
|
||||
|
||||
Once you've done that, you need to get the log file. In your home directory,
|
||||
open the Library directory, and the Application Support directory within that.
|
||||
Then open the openlp directory, and you should find the openlp.log file in that
|
||||
directory::
|
||||
|
||||
/Users/<username>/Library/Application Support/openlp/openlp.log
|
||||
|
||||
``<username>`` is your username.
|
||||
|
||||
I'm on Windows and PowerPoint is installed, but it doesn't appear as an option
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
Try installing the `Visual C++ Runtime Redistributable <http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en>`_.
|
||||
|
||||
The command line shows many error messages
|
||||
------------------------------------------
|
||||
|
||||
When running OpenLP from the command line, you might get something like this::
|
||||
|
||||
WARNING: bool Phonon::FactoryPrivate::createBackend() phonon backend plugin could not be loaded
|
||||
WARNING: bool Phonon::FactoryPrivate::createBackend() phonon backend plugin could not be loaded
|
||||
WARNING: Phonon::createPath: Cannot connect Phonon::MediaObject ( no objectName ) to VideoDisplay ( no objectName ).
|
||||
WARNING: Phonon::createPath: Cannot connect Phonon::MediaObject ( no objectName ) to Phonon::AudioOutput ( no objectName ).
|
||||
WARNING: bool Phonon::FactoryPrivate::createBackend() phonon backend plugin could not be loaded
|
||||
|
||||
These error messages indicate that you need to install an appropriate backend
|
||||
for Phonon.
|
||||
|
||||
Linux/FreeBSD
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
If you're using Gnome, you need to install the GStreamer backend for Phonon. On
|
||||
Ubuntu you would install the ```phonon-backend-gstreamer``` package::
|
||||
|
||||
@:~$ sudo aptitude install phonon-backend-gstreamer
|
||||
|
||||
If you're using KDE, you need to install the Xine backend for Phonon. On Kubuntu
|
||||
you would install the ```phonon-backend-xine``` package::
|
||||
|
||||
@:~$ sudo aptitude install phonon-backend-xine
|
||||
|
||||
If you know which audiovisual system you're using, then install the appropriate
|
||||
backend.
|
||||
|
||||
phonon-backend-vlc may also be worth trying on some systems.
|
||||
|
||||
Windows & Mac OS X
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Phonon should already be set up properly. If you're still having issues, let the
|
||||
developers know.
|
||||
|
||||
I've upgraded from 1.9.2 to a newer version, and now OpenLP crashes on load
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
You need to upgrade your song database. See this `blog post <http://openlp.org/en/users/jt/blog/2010-07-20-flag_day_database_schema_changes_in_trunk_revision_956.html>`_
|
||||
for information on how to do this.
|
||||
|
||||
I've upgraded to 1.9.5, and now OpenLP has duplicates of many songs in the Media Manager
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
You need to run :menuselection:`Tools --> Re-index Songs`.
|
||||
|
||||
There are no menu icons in OpenLP
|
||||
---------------------------------
|
||||
|
||||
This may affect (only) Linux users with XFCE or Gnome. To solve the problem,
|
||||
follow the instructions on `this bug report <https://bugs.launchpad.net/ubuntu/+source/qt4-x11/+bug/501468/comments/3>`_.
|
||||
|
||||
JPEG images don't work
|
||||
----------------------
|
||||
|
||||
This is a known issue on some Mac OS X 10.5 systems, and has also been seen on
|
||||
Windows XP too. The solution is to convert the image into another format such as
|
||||
PNG.
|
||||
|
||||
MP3's and other audio formats don't work
|
||||
----------------------------------------
|
||||
|
||||
This is a known issue on some systems, including some XP machines, and we have
|
||||
no solution at the moment.
|
||||
|
||||
Videos can be slow or pixelated. Background Videos are very slow
|
||||
----------------------------------------------------------------
|
||||
|
||||
If you are just playing videos from the Media plugin, try selecting the
|
||||
:guilabel:`Use Phonon for Video playback` option in the Media configuration,
|
||||
accessible by going to :menuselection:`Settings --> Configure OpenLP --> Media`.
|
||||
As for text over video, we have no solution for speeding this up. Reducing the
|
||||
monitor resolution and avoiding shadows and outline text will help. We are
|
||||
hoping a future release of the toolkit we are using (QtWebKit) will help improve
|
||||
this, but there is no timeframe at present.
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
What new features will I find in 2.0?
|
||||
-------------------------------------
|
||||
|
||||
Since 2.0 was a rewrite from the ground up, you won't find a great deal of new
|
||||
features since initially we want to ensure all the 1.2 features are included.
|
||||
However the developers have managed to sneak a few in. Take a look at the
|
||||
`complete list <http://wiki.openlp.org/Version_2_Features>`_.
|
||||
|
||||
Why hasn't popular feature request X been implemented?
|
||||
------------------------------------------------------
|
||||
|
||||
We made a decision to first implement 1.2 features, before going wild on new
|
||||
features. There are only a handful of developers working in their spare time. If
|
||||
we were to try and include everything we wanted to implement, then 2.0 would not
|
||||
likely ever get released.
|
||||
|
||||
I have a great idea for a new feature, where should I suggest it?
|
||||
-----------------------------------------------------------------
|
||||
|
||||
First of all check it isn't on the `Feature Requests <http://wiki.openlp.org/Feature_Requests>`_
|
||||
page. If it is, then you need to say no more, it's already been suggested! If it
|
||||
isn't on the list, then head to the
|
||||
`feature request forum <http://openlp.org/en/forums/openlp_20/feature_requests.html>`_
|
||||
and post the idea there.
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
========
|
||||
Glossary
|
||||
========
|
||||
|
||||
The developers of OpenLP have strived to make it a straightforward and easy to
|
||||
use application. However, it is good to be familiar with a few terms that will
|
||||
be used throughout this documentation, and when seeking support.
|
||||
|
||||
Main Window
|
||||
-----------
|
||||
|
||||
The Main Window is what you will see when you first open OpenLP
|
||||
|
||||
.. image:: pics/mainwindow.png
|
||||
|
||||
The Main Window contains all the tools and plugins that make OpenLP function
|
||||
|
||||
Media Manager
|
||||
-------------
|
||||
|
||||
The Media Manager contains a number of tabs the plugins supply to OpenLP.
|
||||
Each tab in the Media Manager is called a **Media Item**
|
||||
|
||||
.. image:: pics/mediamanager.png
|
||||
|
||||
From the Media Manager you can send Media Items to the Preview or Live screens.
|
||||
|
||||
Platform
|
||||
--------
|
||||
|
||||
When the word platform is used, it is usually referring to your operating system,
|
||||
Windows, Linux or MAC OS.
|
||||
|
||||
Preview
|
||||
-------
|
||||
|
||||
The preview pane is a section to preview your media items before you go live
|
||||
with them.
|
||||
|
||||
.. image:: pics/preview.png
|
||||
|
||||
Service File
|
||||
------------
|
||||
|
||||
A service file is the file that is created when you save your service in OpenLP.
|
||||
The service file consist of **Service Items**
|
||||
|
||||
Service Item
|
||||
------------
|
||||
|
||||
Service items are the **media items** that are in the **service manager**
|
||||
|
||||
Service Manger
|
||||
--------------
|
||||
|
||||
The service manager contains the media items in your service file. This is the
|
||||
area where your media items go live. You can also save, open, and edit
|
||||
services files from here.
|
||||
|
||||
.. image:: pics/servicemanager.png
|
||||
|
||||
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
|
||||
|
||||
Theme Manager
|
||||
-------------
|
||||
|
||||
The theme manager is where themes are created and edited. Themes are the text
|
||||
styles and backgrounds that you use to personalize your services.
|
||||
|
||||
.. image:: pics/thememanager.png
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
.. OpenLP documentation master file, created by
|
||||
sphinx-quickstart on Thu Sep 30 21:24:54 2010.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to the OpenLP 2.0 User Manual
|
||||
=====================================
|
||||
|
||||
Getting Started With OpenLP
|
||||
---------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
introduction
|
||||
installation
|
||||
|
||||
Reference Manual
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
alert
|
||||
bibles
|
||||
configure
|
||||
dualmonitors
|
||||
wizard
|
||||
glossary
|
||||
mediamanager
|
||||
songs
|
||||
themes
|
||||
|
||||
Questions and Troubleshooting
|
||||
-----------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
faq
|
||||
troubleshooting
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
Installing OpenLP
|
||||
=================
|
||||
|
||||
Microsoft Windows
|
||||
-----------------
|
||||
|
||||
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.
|
||||
|
||||
Next select your language and click :guilabel:`OK`
|
||||
|
||||
.. image:: pics/selectlanguage.png
|
||||
|
||||
After reading the welcome message click :guilabel:`Next` to continue the
|
||||
installation.
|
||||
|
||||
.. image:: pics/welcome.png
|
||||
|
||||
Agree to the license agreement. Click :guilabel:`Next` to continue.
|
||||
|
||||
.. image:: pics/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
|
||||
|
||||
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
|
||||
|
||||
Select if you want to create a desktop or Quick Launch icon. Click :guilabel:`Next`
|
||||
to continue.
|
||||
|
||||
.. image:: pics/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
|
||||
|
||||
The progress bar will update you on how far along the installation has gone.
|
||||
|
||||
.. image:: pics/progress.png
|
||||
|
||||
When the install is complete you will have the option to launch OpenLP. After
|
||||
making your selection click :guilabel:`Finish`
|
||||
|
||||
Mac OS X
|
||||
--------
|
||||
|
||||
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
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Installation process on Linux distributions vary by distribution. See the OpenLP `download page <http://www.openlp.org/en/download.html>`_ for distribution specific instructions.
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
=============
|
||||
Introduction
|
||||
=============
|
||||
|
||||
About
|
||||
-----
|
||||
|
||||
OpenLP stands for "Open Source Lyrics Projection" and is presentation software
|
||||
developed for churches to provide a single easy to use interface for the
|
||||
projection needs of a typical worship service. First created in 2004, it has
|
||||
steadily grown in features and maturity such that it is now a mainstay in
|
||||
hundreds of churches around the world.
|
||||
|
||||
OpenLP has searchable databases of songs and Bible verses allowing them to be
|
||||
projected instantly or saved in a pre-prepared order of service file. Themes
|
||||
allow for a variety of presentation options and allow you to add attractive
|
||||
visuals to enhance your presentations. PowerPoint and OpenOffice presentations,
|
||||
videos and audio files can be run from within the program removing the need to
|
||||
switch between different programs. Alert messages can be displayed so the
|
||||
nursery or car park stewards can notify the congregation easily. Remote
|
||||
capability allows the worship leader to change songs, or for alert messages to
|
||||
be sent from anywhere on the network, even via a smart phone or tablet.
|
||||
|
||||
Being free, this software can be installed on as many PCs as required,
|
||||
including the home PCs of worship leader(s) at no additional cost. Compared to
|
||||
the expensive site licenses and restrictions of commercial software we believe
|
||||
OpenLP is the perfect choice for quality and value. Still in active development
|
||||
by a growing team of enthusiastic developers, features are being added all the
|
||||
time resulting in continual improvement of the software.
|
||||
|
||||
OpenLP is licensed under the GNU Generic Public License, which means
|
||||
that it is free to use, distribute, modify, and it stays free.
|
||||
|
||||
GNU General Public License
|
||||
--------------------------
|
||||
|
||||
The GNU General Public License was specifically chosen because it ensures the
|
||||
above mentioned freedoms. It specifically states that you are not allowed
|
||||
to charge for the software, and that you have to distribute the source code as
|
||||
well.
|
||||
|
||||
You can find a copy of the GNU General Public License from the Help menu
|
||||
selecting about OpenLP or `view the license on-line <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>`_.
|
||||
|
|
@ -0,0 +1,251 @@
|
|||
=============
|
||||
Media Manager
|
||||
=============
|
||||
|
||||
Once you get your system set up for OpenLP you will be ready to add content to
|
||||
your Service Manager. This will all happen through the **Media Manager**. The
|
||||
`Media Manager` contains all the Bibles, Songs, Presentations, Media, and
|
||||
everything else that you will project through OpenLP.
|
||||
|
||||
Enabling the Plugins
|
||||
--------------------
|
||||
|
||||
You may need to enable the plugins that came with OpenLP. As you can see below
|
||||
this is what the `Media Manager` looks like with all the plugins enabled.
|
||||
|
||||
.. image:: pics/mediamanager.png
|
||||
|
||||
To enable the plugins navigate to :menuselection:`Settings --> Plugins` or
|
||||
press :kbd:`Alt+F7`. You will want to click on the plugin to the left that you
|
||||
would like to enable and select **active** from the drop down box to the right.
|
||||
|
||||
.. image:: pics/plugins.png
|
||||
|
||||
|
||||
You are now ready to add content for your service.
|
||||
|
||||
Adding Media Content
|
||||
--------------------
|
||||
|
||||
This section will describe how to add the different types of media OpenLP is
|
||||
capable of displaying.
|
||||
|
||||
Songs
|
||||
^^^^^
|
||||
Clicking on Songs in the Media Manager will display all of the songs you have
|
||||
added by Title and Author/Authors.
|
||||
|
||||
Using the buttons you can:
|
||||
|
||||
`Add a song:` Brings up the dialog box to add a new song
|
||||
|
||||
`Edit the selected song:` Brings up the dialog box to make changes to the song
|
||||
|
||||
`Delete the selected song:` Removes the song from your song list
|
||||
|
||||
`Preview the selected song:` Lets you see what your song will look like
|
||||
displayed live
|
||||
|
||||
`Send the selected song live:` This option will immediately display your song
|
||||
live.
|
||||
|
||||
`Add the selected Song to the service:` This will enter your song in the Service
|
||||
Manager. You may also drag your song over to the Service Manager.
|
||||
|
||||
`Maintain the list of authors, topics and books:` Brings up a dialog box to edit
|
||||
Authors, Topics or Song Books.
|
||||
Note: Right clicking on a song file will bring up some of the same options.
|
||||
|
||||
Bibles
|
||||
^^^^^^
|
||||
Clicking on Bibles in the Media Manager will display your options for searching
|
||||
and adding chapters and verses to the Service Manager.
|
||||
|
||||
Using the buttons you can:
|
||||
|
||||
`Import a Bible:` This is discussed in detail on the Bible Importer page in the
|
||||
manual.
|
||||
|
||||
`Preview the selected Bible:` Sends your selected verses to the Preview window
|
||||
|
||||
`Send the selected Bible live:` This option will immediately display your
|
||||
selected verses live.
|
||||
|
||||
`Add the selected Bible to the service:` This will enter your verses into the
|
||||
Service Manager. You may also click and drag your verses over to the Service
|
||||
Manager.
|
||||
|
||||
**Quick tab**
|
||||
|
||||
`Version:` Once you have imported a Bible, it will be displayed in the Version
|
||||
drop down box. Select the version of the Bible you want to use here.
|
||||
|
||||
**Second**
|
||||
|
||||
If you have “Display second Bible verses” selected in Configure OpenLP, Bibles
|
||||
tab, this choice will be visible. This option is for displaying another version
|
||||
of the Bible for comparison. Both versions will be displayed. If there is not
|
||||
enough space on one slide, the Second version will be displayed on the next
|
||||
slide.
|
||||
|
||||
Use the `Search` button to display your results in the box below.
|
||||
|
||||
**Find**
|
||||
|
||||
You will type your search query in this box for the following two searches.
|
||||
|
||||
`Search type:` You may search for a specific verse using this format below.
|
||||
|
||||
Book Chapter
|
||||
Book Chapter-Chapter
|
||||
Book Chapter:Verse-Verse
|
||||
Book Chapter:Verse-End (this will display verses to the end of the chapter)
|
||||
Book Chapter:Verse-Verse, Verse-Verse
|
||||
Book Chapter:Verse-Verse,Chapter:Verse-Verse
|
||||
Book Chapter:Verse-Chapter:Verse
|
||||
|
||||
`Text Search:`
|
||||
|
||||
You may also search by a keyword or words. The more words you use for the
|
||||
search, the more you will narrow down your results.
|
||||
|
||||
**Results** `Clear and Keep.`
|
||||
|
||||
Each search you make will display your verses below. If you would like to
|
||||
display verses that are out of sequence you may select `Keep` in the drop down
|
||||
box and continue your search for the next verse or verses. All searches will be
|
||||
shown and kept below.
|
||||
If you select `Clear` from the drop down box, each new search clears the
|
||||
previous search from the list below.
|
||||
|
||||
**Advanced tab**
|
||||
|
||||
This tab is convenient for selecting book, chapter and verse by name and number.
|
||||
Version and Second are the same as in Quick tab above. Click on each box and
|
||||
select the version you wish to display and Second version if you wish to display
|
||||
an alternative version.
|
||||
|
||||
Use the `Search` button to display your results in the box below.
|
||||
|
||||
`Book:` Click on the drop down box and select the book you want to display.
|
||||
`Chapter: Verse:` Select your chapter From and To and Verse From and To
|
||||
|
||||
Results will work the same as the Quick tab above.
|
||||
|
||||
Presentations
|
||||
^^^^^^^^^^^^^
|
||||
Using the buttons you can:
|
||||
|
||||
`Load a new presentation:` This brings up a dialog box to find your presentation
|
||||
and list it in OpenLP.
|
||||
|
||||
`Delete the selected Presentation:` This removes your Presentation from the list.
|
||||
Please note: this will not delete the presentation from your computer, only from
|
||||
the OpenLP list.
|
||||
|
||||
`Preview the selected Presentation:` Sends your selected Presentation to the
|
||||
Preview window
|
||||
|
||||
`Send the selected Presentation live:` This option will immediately display your
|
||||
selected Presentation live.
|
||||
|
||||
`Add the selected Presentation to the service:` This will enter your
|
||||
Presentation into the Service Manager. You may also click and drag your
|
||||
Presentation over to the Service Manager.
|
||||
|
||||
Right clicking on a Presentation file will bring up some of the same options.
|
||||
|
||||
Images
|
||||
^^^^^^
|
||||
Using the buttons you can:
|
||||
|
||||
`Load a new Image:` This brings up a dialog box to find your Image and list it
|
||||
in OpenLP.
|
||||
|
||||
`Delete the selected Image:` This removes your Image from the list. Please note:
|
||||
this will not delete the Image from your computer, just the OpenLP list.
|
||||
|
||||
`Preview the selected Image:` Sends your selected Image to the Preview window
|
||||
|
||||
`Send the selected Image live:` This option will immediately display your
|
||||
selected Image live.
|
||||
|
||||
`Add the selected Image to the service:` This will enter your Image into the
|
||||
Service Manager. You may also click and drag your Image over to the Service
|
||||
Manager.
|
||||
|
||||
`Replace Live Background:` With an Image selected, clicking this button will
|
||||
immediately replace the live background being displayed with your selection.
|
||||
The Image will replace the theme background until the theme changes or the
|
||||
"Remove Background" button is pressed.
|
||||
|
||||
|
||||
Right clicking on an Image file will bring up some of the same options.
|
||||
|
||||
Media
|
||||
^^^^^
|
||||
|
||||
Media is an audio or video file. Generally if you can play or view your media
|
||||
on your computer without OpenLP, you can also play it in OpenLP.
|
||||
|
||||
Using the buttons you can:
|
||||
`Load a new Media:` This brings up a dialog box to find your Media and list it
|
||||
in OpenLP.
|
||||
|
||||
`Delete the selected Media:` This removes your Media from the list. Please note:
|
||||
this will not delete the Media from your computer, just the OpenLP list.
|
||||
|
||||
`Preview the selected Media:` Sends your selected Media to the Preview window
|
||||
|
||||
`Send the selected Media live:` This option will immediately display your
|
||||
selected Media live.
|
||||
|
||||
`Add the selected Media to the service:` This will enter your Media into the
|
||||
Service Manager. You may also click and drag your Media over to the Service
|
||||
Manager.
|
||||
|
||||
`Replace Live Background:` With a Media file selected, clicking this button will
|
||||
immediately replace the live background being displayed with your selection.
|
||||
|
||||
Right clicking on a Media file will bring up some of the same options.
|
||||
|
||||
Custom
|
||||
^^^^^^
|
||||
|
||||
Custom gives you the option of creating your own slide. This could be useful for
|
||||
displaying readings, liturgy or any text that may not be found in Songs or
|
||||
Bibles.
|
||||
|
||||
`Add a new Custom:` Brings up the dialog box to add a new Custom display.
|
||||
`Edit the selected Custom:` Brings up the dialog box to make changes to the
|
||||
Custom display.
|
||||
|
||||
`Delete the selected Custom:` Remove the Custom from your list
|
||||
|
||||
`Preview the selected Custom:` Lets you see what your Custom will look like
|
||||
displayed live
|
||||
|
||||
`Send the selected Custom live:` This option will immediately display your
|
||||
Custom live
|
||||
|
||||
`Add the selected Custom to the service:` This will enter your Custom in the
|
||||
Service Manager. You may also drag your Custom over to the Service Manager.
|
||||
|
||||
Right clicking on a Custom file will bring up some of the same options.
|
||||
|
||||
When you Add a new Custom slide a dialog box will appear.
|
||||
|
||||
`Title:` Name of your Custom slide.
|
||||
|
||||
`Add:` After clicking on Add you will enter your text you want to display in
|
||||
this box. To create multiple slides, click the Split Slide button. When you have
|
||||
finished adding your text, click on the Save button.
|
||||
|
||||
`Theme:` Select the theme you want to use for your Custom slide from this drop
|
||||
down box.
|
||||
`Credits:` Anything typed in this box will be displayed in the footer
|
||||
information on the display. When you are finished, click the Save button.
|
||||
|
||||
To Edit your slide, click on the Edit button to edit part of it or the Edit All
|
||||
if you need to make multiple changes. Use the Up and Down arrows to change the
|
||||
arrangement of your Custom slide.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 111 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 113 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 138 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 599 B |
Binary file not shown.
|
After Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 86 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 81 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 159 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 52 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 81 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 94 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 892 B |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 156 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 112 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 123 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 140 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 153 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue