openlp/documentation
1
0
Fork 0
mirror of https://gitlab.com/openlp/documentation.git synced 2024-12-22 04:22:49 +00:00
Code Issues Projects Releases Wiki Activity

Update docs to 2.4

Browse Source
This commit is contained in:
Tomas Groth 2016-02-16 00:15:44 +01:00
parent f972b3dc4a
commit 87e65225b3
7 changed files with 31 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api/source/index.rst
View File

@ -6,7 +6,7 @@
Welcome 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 information relating to OpenLP's core classes, core plugins, and anything else
deemed necessary or interesting by the developers. deemed necessary or interesting by the developers.

6
manual/source/conf.py
View File

@ -49,9 +49,9 @@ copyright = u'2004 - 2015, Raoul Snyman'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '2.2' version = '2.4'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '2.2' release = '2.4'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # 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 # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<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. # A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None #html_short_title = None

36
manual/source/faq.rst
View File

@ -30,20 +30,20 @@ A variety of places!
* If you are a member of any Christian Forums or websites, and their rules allow * 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. 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, on Windows (Vista, 7, 8, 10), Linux (Ubuntu and its variants, Fedora, Debian,
ArchLinux, Mint, OpenSUSE and many many others), FreeBSD & Mac OS X. ArchLinux, Mint, OpenSUSE and many many others), FreeBSD & Mac OS X.
`Please let us know <http://wiki.openlp.org/Help:Contents>`_ if you have `Please let us know <http://wiki.openlp.org/Help:Contents>`_ if you have
successfully run it on something else. 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 OpenLP 2.4 is written in `Python3 <http://www.python.org>`_ and uses the
`Qt4 toolkit <http://qt.nokia.com>`_. Both are cross-platform which allows 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 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 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>`_ 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 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 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/>`_. 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 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/>`_. 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 OpenLP 2.4 and earlier 2.x versions cannot run side by side. When running 2.4 for first time
any existing 2.0 data will automatically be converted to the 2.2 format. any existing 2.x data will automatically be converted to the 2.4 format.
Note that OpenLP 2.2 is not backwards compatible with 2.0. Once you have Note that OpenLP 2.4 is not backwards compatible with earlier 2.x versions. Once you have
upgraded from 2.0, version 2.0 cannot read the upgraded files. OpenLP 2.2 will 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 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. read service files created by OpenLP 2.0.5.
Using OpenLP Using OpenLP
@ -242,7 +242,7 @@ Why has popular feature request X not been implemented?
------------------------------------------------------- -------------------------------------------------------
There are only a handful of developers working in their spare time. If 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. likely ever get released.
I have a great idea for a new feature, where should I suggest it? I have a great idea for a new feature, where should I suggest it?

2
manual/source/index.rst
View File

@ -1,4 +1,4 @@
Welcome to the OpenLP 2.2 User Manual Welcome to the OpenLP 2.4 User Manual
===================================== =====================================
Getting Started With OpenLP Getting Started With OpenLP

4
manual/source/install_linux.rst
View File

@ -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 or the command line. Command line instructions will be included at the end of
this section on Ubuntu and its variants. 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 15.10 or later versions. There is currently an older
version of OpenLP available in the official Ubuntu repositories, which can be 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. the OpenLP Personal Package Archive (PPA) to your system.
Ubuntu, Ubuntu GNOME, Xubuntu Ubuntu, Ubuntu GNOME, Xubuntu

4
manual/source/songs.rst
View File

@ -13,8 +13,8 @@ Song Importer
============= =============
If you are using an earlier version of OpenLP or, come from another software 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 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`. To access the Song Importer click :menuselection:`File --> Import --> Song`.
You will see the Song Importer window, then click :guilabel:`Next`. You will see the Song Importer window, then click :guilabel:`Next`.
.. image:: pics/songimporter.png .. image:: pics/songimporter.png

14
manual/source/troubleshooting.rst
View File

@ -80,7 +80,7 @@ the link to the page that is created.
Windows 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 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, option, and an Explorer window will appear containing folders such as alerts,
@ -404,15 +404,9 @@ 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 hoping a future release of the toolkit we are using (QtWebKit) will help improve
this, but there is no timeframe at present. 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), Due to bugs in one of the underlying frameworks that OpenLP uses (Qt5),
live backgrounds do not work in OpenLP 2.2. This will be fixed in OpenLP 2.4. live backgrounds do not work in OpenLP 2.4. This will be fixed in OpenLP 2.6.
Why do playback of linked audio not work in OpenLP 2.2 on Mac OS X
------------------------------------------------------------------
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.