mirror of
https://gitlab.com/openlp/documentation.git
synced 2024-12-22 12:32:48 +00:00
Added downgrade guide and guide to find the data folder.
Added FAQ answer to PowerPoint auto-slide changing. Removed phonon reference. Documented custom stage views. Updated song import docs. Update docs version reference to 2.4. bzr-revno: 131
This commit is contained in:
second@tgc.dk
Tomas Groth
commit
d8aa56b970
@ -6,7 +6,7 @@
|
||||
Welcome
|
||||
=======
|
||||
|
||||
Welcome to the OpenLP 2.2 API Documentation! In here you will find all
|
||||
Welcome to the OpenLP 2.4 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.
|
||||
|
||||
|
||||
@ -49,9 +49,9 @@ copyright = u'2004 - 2015, Raoul Snyman'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '2.2'
|
||||
version = '2.4'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '2.2'
|
||||
release = '2.4'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
@ -110,7 +110,7 @@ html_theme_path = [os.path.abspath(os.path.join('..', '..', 'common', 'themes'))
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
html_title = u'OpenLP 2.2 Reference Manual'
|
||||
html_title = u'OpenLP 2.4 Reference Manual'
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
@ -305,8 +305,8 @@ Available Media Players
|
||||
Select the media players you want to be available for use. As a general rule the
|
||||
players control the following:
|
||||
|
||||
**Phonon:**
|
||||
Phonon is an internal media player which uses your operating system's
|
||||
**System:**
|
||||
System is an internal media player which uses your operating system's
|
||||
built-in media player capabilities.
|
||||
|
||||
**Webkit:**
|
||||
|
||||
@ -285,10 +285,10 @@ arrow will give you two options for the use of the timer.
|
||||
Using the Media Timer
|
||||
---------------------
|
||||
|
||||
**Note:** The media timer is only available when you are using Phonon as your
|
||||
**Note:** The media timer is only available when you are using System as your
|
||||
default player. Please check your media configuration here:
|
||||
:menuselection:`Settings --> Configure OpenLP --> Media`. Configure your player
|
||||
using Phonon with these instructions. :ref:`media_configure`.
|
||||
using System with these instructions. :ref:`media_configure`.
|
||||
|
||||
The media timer is used when you have a media file in your service manager and
|
||||
you would like it to start and/or stop at a specified time.
|
||||
|
||||
@ -30,20 +30,20 @@ A variety of places!
|
||||
* 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.2 support?
|
||||
What operating systems will OpenLP 2.4 support?
|
||||
-----------------------------------------------
|
||||
|
||||
OpenLP 2.2 is designed to be cross platform. Currently it has been known to run
|
||||
OpenLP 2.4 is designed to be cross platform. Currently it has been known to run
|
||||
on Windows (Vista, 7, 8, 10), Linux (Ubuntu and its variants, Fedora, Debian,
|
||||
ArchLinux, Mint, OpenSUSE and many many others), FreeBSD & Mac OS X.
|
||||
`Please let us know <http://wiki.openlp.org/Help:Contents>`_ if you have
|
||||
successfully run it on something else.
|
||||
|
||||
Which programming language is 2.2 developed in?
|
||||
Which programming language is 2.4 developed in?
|
||||
-----------------------------------------------
|
||||
|
||||
OpenLP 2.2 is written in `Python3 <http://www.python.org>`_ and uses the
|
||||
`Qt4 toolkit <http://qt.nokia.com>`_. Both are cross-platform which allows the
|
||||
OpenLP 2.4 is written in `Python3 <http://www.python.org>`_ and uses the
|
||||
`Qt5 toolkit <http://www.qt.io>`_. 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>`_
|
||||
@ -60,31 +60,31 @@ into your language then see the `Getting started page <http://wiki.openlp.org/Tr
|
||||
Upgrading
|
||||
=========
|
||||
|
||||
Can I upgrade from any 1.9.x or 2.0.x release to 2.2?
|
||||
Can I upgrade from any 1.9.x or 2.0.x release to 2.4?
|
||||
-----------------------------------------------------
|
||||
|
||||
No, you should first upgrade to the last stable release in the 2.0-series
|
||||
(2.0.5) and then upgrade to 2.2 to ensure that data is correctly converted.
|
||||
(2.0.5) and then upgrade to 2.4 to ensure that data is correctly converted.
|
||||
You can download OpenLP 2.0.5 from <http://sourceforge.net/projects/openlp/files/openlp/2.0.5/>`_.
|
||||
|
||||
Can I upgrade directly from 1.2 to 2.2?
|
||||
Can I upgrade directly from 1.2 to 2.4?
|
||||
---------------------------------------
|
||||
|
||||
No, you will have to install 2.0.5 first, then import the 1.2 data and then
|
||||
upgrade to 2.2. See the 2.0 documentation for how to upgrade from 1.2 to
|
||||
upgrade to 2.4. See the 2.0 documentation for how to upgrade from 1.2 to
|
||||
2.0. You can download OpenLP 2.0.5 from <http://sourceforge.net/projects/openlp/files/openlp/2.0.5/>`_.
|
||||
|
||||
Does 2.2 replace 2.0, or can they be run side by side?
|
||||
------------------------------------------------------
|
||||
Does 2.4 replace older 2.x versions, or can they be run side by side?
|
||||
---------------------------------------------------------------------
|
||||
|
||||
OpenLP 2.2 and 2.0 cannot run side by side. When running 2.2 for first time
|
||||
any existing 2.0 data will automatically be converted to the 2.2 format.
|
||||
Note that OpenLP 2.2 is not backwards compatible with 2.0. Once you have
|
||||
upgraded from 2.0, version 2.0 cannot read the upgraded files. OpenLP 2.2 will
|
||||
OpenLP 2.4 and earlier 2.x versions cannot run side by side. When running 2.4 for first time
|
||||
any existing 2.x data will automatically be converted to the 2.4 format.
|
||||
Note that OpenLP 2.4 is not backwards compatible with earlier 2.x versions. Once you have
|
||||
upgraded from the older OpenLP versions cannot read the upgraded files. OpenLP 2.4 will
|
||||
ask if it should make a backup on startup, which can be used in case you want
|
||||
to downgrade to 2.0 again.
|
||||
to downgrade again.
|
||||
|
||||
OpenLP 2.2 cannot read service files created by OpenLP 2.0.4 and earlier, it can only
|
||||
OpenLP 2.4 cannot read service files created by OpenLP 2.0.4 and earlier, it can only
|
||||
read service files created by OpenLP 2.0.5.
|
||||
|
||||
Using OpenLP
|
||||
@ -145,6 +145,15 @@ I am on Windows and PowerPoint is installed, but it does not 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>`_.
|
||||
|
||||
Why does PowerPoint presentations not advance automatically
|
||||
-----------------------------------------------------------
|
||||
|
||||
The reason that PowerPoint does not advance automatically is that it can only do
|
||||
so when it has the focus. But when using OpenLP for controlling presentation,
|
||||
OpenLP has the focus. So in order to make PowerPoint advance automatically the
|
||||
focus must be switched to PowerPoint, which can be done by clicking the
|
||||
Powerpoint-icon in the taskbar once the PowerPoint presentation has opened.
|
||||
|
||||
Is it possible to get Bible x? How?
|
||||
-----------------------------------
|
||||
|
||||
@ -201,11 +210,15 @@ 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?
|
||||
==================================================
|
||||
|
||||
Location of OpenLP files
|
||||
========================
|
||||
|
||||
Where do I find the configuration file?
|
||||
---------------------------------------
|
||||
|
||||
Linux, FreeBSD & PC-BSD
|
||||
-----------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If your distribution supports the XDG standard, you will find OpenLP's
|
||||
configuration file in::
|
||||
@ -218,8 +231,8 @@ If that file and/or directory does not exist, look for::
|
||||
|
||||
``<user>`` is your username.
|
||||
|
||||
OS X
|
||||
----
|
||||
Mac OS X
|
||||
^^^^^^^^
|
||||
|
||||
You will find your configuration file here::
|
||||
|
||||
@ -228,13 +241,40 @@ You will find your configuration file here::
|
||||
``<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
|
||||
|
||||
.. _data_folder:
|
||||
|
||||
Where do I find the data folder?
|
||||
--------------------------------
|
||||
|
||||
Normally you can open the data folder by using the menu :menuselection:`Tools --> Open Data Folder`
|
||||
and a fileexplorer window will appear with the data folder. In some cases due to
|
||||
bugs or other issues this is not an option, and the folder must be found
|
||||
manually.
|
||||
|
||||
Linux, FreeBSD & PC-BSD
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The data folder is located in ``/home/<user>/.local/share/openlp``.
|
||||
|
||||
Mac OS X
|
||||
^^^^^^^^
|
||||
|
||||
On Mac OS X the data folder is located in ``/Users/<username>/Library/Application Support/openlp``
|
||||
|
||||
Windows
|
||||
^^^^^^^
|
||||
|
||||
To get to the data folder on Windows, pres the Windows Key and "R" at the same
|
||||
time. This will open a the :menuselection:`Run dialog`. Enter ``%appdata%\OpenLP``
|
||||
and press <Enter>. This will open a fileexplorer with in the data folder.
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
@ -242,7 +282,7 @@ Why has popular feature request X not been implemented?
|
||||
-------------------------------------------------------
|
||||
|
||||
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.2 would not
|
||||
we were to try and include everything we wanted to implement, then 2.4 would not
|
||||
likely ever get released.
|
||||
|
||||
I have a great idea for a new feature, where should I suggest it?
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
Welcome to the OpenLP 2.2 User Manual
|
||||
Welcome to the OpenLP 2.4 User Manual
|
||||
=====================================
|
||||
|
||||
Getting Started With OpenLP
|
||||
|
||||
@ -13,9 +13,9 @@ Installation of OpenLP on Ubuntu can either be done through the Software Center
|
||||
or the command line. Command line instructions will be included at the end of
|
||||
this section on Ubuntu and its variants.
|
||||
|
||||
OpenLP 2.2 supports Ubuntu 14.04 or later versions. There is currently an older
|
||||
OpenLP 2.4 supports Ubuntu 14.04 or later versions. There is currently an older
|
||||
version of OpenLP available in the official Ubuntu repositories, which can be
|
||||
found using the Software Center, but to get OpenLP 2.2 it is necessary to add
|
||||
found using the Software Center, but to get OpenLP 2.4 it is necessary to add
|
||||
the OpenLP Personal Package Archive (PPA) to your system.
|
||||
|
||||
Ubuntu, Ubuntu GNOME, Xubuntu
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 70 KiB |
@ -13,8 +13,35 @@ Song 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 Song Importer click :menuselection:`File --> Import --> Song`.
|
||||
package, you may be able to convert your existing database to work in OpenLP.
|
||||
OpenLP can import songs from the following sources:
|
||||
|
||||
* OpenLyrics or OpenLP 2 Exported Song
|
||||
* Generic Documents/Presentations (Requires LibreOffice)
|
||||
* CCLI SongSelect Files
|
||||
* DreamBeam Song Files
|
||||
* EasySlides XML File
|
||||
* EasyWorship 2009 Song Database
|
||||
* EasyWorship 2009 Service File
|
||||
* Foilpresenter Song Files
|
||||
* LyriX (Exported TXT-files)
|
||||
* MediaShout Database (Windows only)
|
||||
* PowerPraise Song Files'
|
||||
* PowerSong 1.0
|
||||
* PresentationManager Song Files
|
||||
* ProPresenter 4 Song Files
|
||||
* SongBeamer Files
|
||||
* SongPro (Export File)
|
||||
* SongShow Plus Song Files
|
||||
* Songs Of Fellowship Song Files (Requires LibreOffice)
|
||||
* SundayPlus Song Files
|
||||
* VideoPsalm Files
|
||||
* Words Of Worship Song Files
|
||||
* Worship Assistant (Export CSV)
|
||||
* WorshipCenter Pro Song Files (Windows only)
|
||||
* ZionWorx (Converted CSV)
|
||||
|
||||
To access the Song Importer click :menuselection:`File --> Import --> Song`.
|
||||
You will see the Song Importer window, then click :guilabel:`Next`.
|
||||
|
||||
.. image:: pics/songimporter.png
|
||||
@ -26,10 +53,10 @@ software that OpenLP will convert songs from.
|
||||
|
||||
Click on the file folder icon to choose the file of the song database you
|
||||
want to import. See the following sections for information on some of the
|
||||
different formats that OpenLP will import.
|
||||
different formats that OpenLP will import. Open
|
||||
|
||||
Importing from OpenLyrics or OpenLP 2.0 Exported Song
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Importing from OpenLyrics or OpenLP 2 Exported Song
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
OpenLyrics is an open format for song lyrics defined at `openlyrics.info
|
||||
<openlyrics.info>`_, and is the format the OpenLP can export songs to, see
|
||||
|
||||
@ -35,6 +35,24 @@ displayed in the :ref:`creating_service`.
|
||||
|
||||
.. image:: pics/stage_view_image_w_note.png
|
||||
|
||||
Custom Stage Views
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
It is possible to create custom stage view with custom styles, javescript and
|
||||
html. To create a custom stage view, go to the OpenLP Data Folder by going to
|
||||
:menuselection:`Tools --> Open Data Folder`. Inside the data folder create a
|
||||
folder names :file:`stages`. Inside the :file:`stages` folder you can now create
|
||||
a folder which will be the name of your custom view, an example could be
|
||||
:file:`myview`. Now copy :file:`stage.html`, :file:`stage.css` and
|
||||
:file:`stages.js` from inside OpenLPs program folder
|
||||
:file:`openlp/plugins/remote/html/`, and customize them to your needs. Remember
|
||||
to modify :file:`stage.html` to the other files from the custom stage view
|
||||
folder, for instance :file:`stages/myview/stage.css` for a custom
|
||||
:file:`stage.css`.
|
||||
|
||||
To access the custom stage view in a browser go to http://myopenlpip:4316/stage/myview.
|
||||
|
||||
|
||||
.. _main_view:
|
||||
|
||||
The Live View
|
||||
|
||||
@ -80,7 +80,7 @@ the link to the page that is created.
|
||||
Windows
|
||||
^^^^^^^
|
||||
|
||||
Find the OpenLP 2.2 folder in your Start menu. Choose the "OpenLP (Debug)" option.
|
||||
Find the OpenLP 2.4 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,
|
||||
@ -146,7 +146,7 @@ that the media players have not be properly configured. The recommended media
|
||||
player for OpenLP is VLC, see the manual for :ref:`config_players` for how to
|
||||
setup VLC as your default player.
|
||||
|
||||
If you want to use the Phonon player, but it cannot play your media files, you
|
||||
If you want to use the System player, but it cannot play your media files, you
|
||||
can look below for how best to set it up.
|
||||
|
||||
Codecs
|
||||
@ -349,45 +349,6 @@ There is an issue with the Xfce4 compositor that makes OpenLP freeze when using
|
||||
a dual monitor setup. See configuration of dual monitor for :ref:`xfce4display`
|
||||
for a solution.
|
||||
|
||||
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 are 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 are 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 are 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 are still having issues see
|
||||
:ref:`t-no-media` in the Troubleshooting section. If that does not work, let the
|
||||
developers know.
|
||||
|
||||
MP3's and other audio formats do not work
|
||||
-----------------------------------------
|
||||
|
||||
@ -397,22 +358,46 @@ 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,
|
||||
:guilabel:`Use System 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.
|
||||
|
||||
Why do live backgrounds not work in OpenLP 2.2 on Windows & Mac OS X
|
||||
Why do live backgrounds not work in OpenLP 2.4 on Windows & Mac OS X
|
||||
--------------------------------------------------------------------
|
||||
|
||||
Due to changes in one of the underlying frameworks that OpenLP uses (Qt4),
|
||||
live backgrounds do not work in OpenLP 2.2. This will be fixed in OpenLP 2.4.
|
||||
Due to issues in one of the underlying frameworks that OpenLP uses (Qt5),
|
||||
live backgrounds do not work in OpenLP 2.4. We aim to fix this in OpenLP 2.6.
|
||||
|
||||
Why do playback of linked audio not work in OpenLP 2.2 on Mac OS X
|
||||
------------------------------------------------------------------
|
||||
Downgrade guide (how to restore a backup)
|
||||
-----------------------------------------
|
||||
In some cases new versions of OpenLP can contain bugs that was not discovered
|
||||
during testing, which in some cases can mean that OpenLP cannot function
|
||||
probably and the only way out is to downgrade to the previous version.
|
||||
|
||||
Due to changes in one of the underlying frameworks that OpenLP uses (Qt4),
|
||||
playback of linked audio does not work in OpenLP 2.2. This will be fixed in
|
||||
OpenLP 2.4.
|
||||
Since the OpenLP 2.2 release, new versions of OpenLP always ask if a backup
|
||||
should be made of the data on the first run. It is always recommend to create
|
||||
this backup, since OpenLPs data format often changes between versions, which
|
||||
means that older OpenLP versions cannot read the data created by newer versions.
|
||||
In case of downgrading this backup can be restored. To perform a downgrade
|
||||
follow these steps:
|
||||
|
||||
#. Open OpenLP and in the menu go to :menuselection:`Tools --> Open Data` Folder
|
||||
to open the current data folder in a fileexplorer. If OpenLP cannot open due
|
||||
to a bug see :ref:`data_folder`.
|
||||
#. Keep the fileexplorer window open and close OpenLP
|
||||
#. Uninstall OpenLP and install the old version (if you have not done this
|
||||
already). Do not run OpenLP when the installation completes.
|
||||
#. In the fileexplorer go up one folder-level. You should now see a lot of
|
||||
folders, find the folders that starts with ``openlp``. Depending on how many
|
||||
upgrades you have done you will see some folders looking like
|
||||
``openlp-20160128-185424``. These folders are the backups made by OpenLP on
|
||||
upgrade. The numbers are a timestamp that you can use to find the backup with
|
||||
the you wish to restore.
|
||||
#. Rename the ``openlp`` folder to ``openlp-broken-update`` or similar.
|
||||
#. Rename the backup folder you wish to restore to ``openlp``.
|
||||
#. Start OpenLP and watch it load your restored data.
|
||||
|
||||
Note: This does not restore your settings!
|
||||
|
||||
Loading…
Reference in New Issue
Block a user