openlp-core team mailing list archive

[Tomas Groth <tomasgroth@xxxxxxxx>]

Tomas Groth has proposed merging lp:~tomasgroth/openlp/doc22update7 into lp:openlp/documentation.

Requested reviews:
  OpenLP Core (openlp-core)

For more details, see:
https://code.launchpad.net/~tomasgroth/openlp/doc22update7/+merge/274695

Updated some links/URLs.
Updated screenshots for Mac OS X installation.
Update the install guide for unbuntu, and added some levels to the headings.
Update to the unity disapproval.
Added docs for dual monitors setup on Xfce4 and workaround.
Updated android sceenshots and docs, and added to troubleshooting.
-- 
Your team OpenLP Core is requested to review the proposed merge of lp:~tomasgroth/openlp/doc22update7 into lp:openlp/documentation.

=== modified file 'manual/source/bibles.rst'
--- manual/source/bibles.rst	2015-09-27 14:11:51 +0000
+++ manual/source/bibles.rst	2015-10-16 11:16:49 +0000
@@ -157,7 +157,7 @@
 
 If you have a Bible in .csv format OpenLP can import it. If you wish to create
 a bible in the CSV format yourself the format is documented in the 
-`OpenLP API documentation <http://docs.openlp.org/plugins/bibles.html#module-openlp.plugins.bibles.lib.csvbible>`_.
+`OpenLP API documentation <http://api.openlp.io/api/openlp/plugins/bibles/lib/csvbible.html#module-openlp.plugins.bibles.lib.csvbible>`_.
 
 CSV Bibles will consist of two files a `books` file and a `verse` file. 
 Select CSV from the list of Bible types to import.

=== modified file 'manual/source/dualmonitors.rst'
--- manual/source/dualmonitors.rst	2015-09-30 13:44:40 +0000
+++ manual/source/dualmonitors.rst	2015-10-16 11:16:49 +0000
@@ -149,10 +149,14 @@
 should seek out your distributions documentation if this general guide does not
 work.
 
-**Note to Ubuntu 11.04 Users:** Ubuntu 11.04 uses the new Unity interface. It
-is recommended to use the *Classic Desktop* option. OpenLP and other 
-applications requiring dual monitors may not work well with Unity due to issues
-experienced by other users with the Unity interface.
+**Note to Ubuntu Users:** Standard Ubuntu uses the Unity interface.
+Unfortunately we cannot recommend using Unity for a dual display setup with 
+OpenLP, since there seems to be no reliable way to hide the menubar from the
+secondary display, as well as other issues. Instead we recommend using a
+different desktop environment like GNOME, KDE or Xfce, all of which are
+available from the Ubuntu repositories, and via special Ubuntu variants, such as
+`Ubuntu GNOME <https://ubuntugnome.org/>`_, `Kubuntu <http://kubuntu.org/>`_ or
+`Xubuntu <http://xubuntu.org/>`_.
 
 GNOME 3
 ^^^^^^^
@@ -196,6 +200,34 @@
 resolution, and position. OpenLP works best projecting to the monitor on the
 right.
 
+.. _xfce4display:
+
+Xfce4
+^^^^^
+
+This guide is for users of the Xfce4 desktop. Open the Xfce4 menu and chose
+:guilabel:`Settings Manager`.
+
+.. image:: pics/xfce4-settings.png 
+
+Open :guilabel:`Display` to open the settings for displays.
+
+.. image:: pics/xfce4-display.png 
+
+If the second display has not yet been enabled, enable it by selecting it in the
+window and tick `Use this display`.
+
+There is an issue with the Xfce4 compositor that makes OpenLP freeze when using
+a dual monitor setup. This issue can be worked around by disabling an option for
+the compositor. To do this open :guilabel:`Settings Manager` and open
+:guilabel:`Window Manager Tweaks`.
+
+.. image:: pics/xfce4-win-manager-tweaks-comp.png
+
+Go to the :guilabel:`Compositor` tab and disable :guilabel:`Display fullscreen
+overlay windows directly`. Click :guilabel:`Close` and now OpenLP should run
+without issues.
+
 Linux Systems Using nVidia Drivers
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

=== modified file 'manual/source/faq.rst'
--- manual/source/faq.rst	2015-09-30 20:16:49 +0000
+++ manual/source/faq.rst	2015-10-16 11:16:49 +0000
@@ -151,7 +151,7 @@
 from a variety of sources. The following sources are supported:
 
 CSV
-    The format is documented in the `OpenLP API documentation <http://docs.openlp.org/plugins/bibles.html#module-openlp.plugins.bibles.lib.csvbible>`_.
+    The format is documented in the `OpenLP API documentation <http://api.openlp.io/api/openlp/plugins/bibles/lib/csvbible.html#module-openlp.plugins.bibles.lib.csvbible>`_.
 
 OSIS
     An XML format for Bible. You can export Bibles from the `Sword Project <http://www.crosswire.org/sword/software/>`_

=== modified file 'manual/source/install_linux.rst'
--- manual/source/install_linux.rst	2012-06-13 10:01:35 +0000
+++ manual/source/install_linux.rst	2015-10-16 11:16:49 +0000
@@ -13,59 +13,19 @@
 or the command line. Command line instructions will be included at the end of
 this section on Ubuntu and its variants.
 
-Ubuntu 12.04 or later
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you are using Ubuntu 12.10 or a more recent version then OpenLP is
-included in the standard distribution. If you are using Ubuntu 12.04 then 
-OpenLP has been added to the backports packages and so is available
-with the appropriate setting below.
-
-Open up the software center by clicking on the :guilabel:`Software Center` icon
-in the Launcher if you are using the Unity desktop, or if you are using an 
-older version of Ubuntu, or the Classic Desktop go to :menuselection:`Applications`
-and select the Software Center from the bottom of the menu. You will need to 
-be the administrator of the system to install OpenLP and will be asked for the
-administrator password several times through this process.
-
-If using Ubuntu 12.04 then when you have the Software Center running you need to
-turn on support for backports. From the menu choose Edit/Software Sources and 
-then the "Updates" tab. Now make sure that "Unsupported Updates 
-(precise-backports) is ticked. Then click :guilabel:`close`.
-
-.. image:: pics/ubuntu-backports.png
-
-Next in any of these versions simply search for OpenLP in the Software Center 
-and click :guilabel:`Install`.
-
-.. image:: pics/4searchopenlp.png
-
-You will see the install progress as OpenLP and the dependencies required for
-it to run are downloaded.
-
-.. image:: pics/5installprogressubuntu.png
-
-After installation you should see that OpenLP is installed.
-
-.. image:: pics/6installcompleteubuntu.png
-
-You can now run OpenLP by either searching for it in the *Dash*, or clicking on
-the category *Media Apps* in Unity. If you are running the Classic Desktop you 
-will have OpenLP available by clicking 
-:menuselection:`Applications --> Sound and Video --> OpenLP`
-
-Ubuntu older than 12.04
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-In older versions of Ubuntu you will first need to add the 
-OpenLP Personal Package Archive (PPA) to your system. 
+OpenLP 2.2 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
+the OpenLP Personal Package Archive (PPA) to your system. 
+
+Ubuntu, Ubuntu GNOME, Xubuntu
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Open up the software center using :menuselection:`Applications`
 and select the Software Center from the bottom of the menu. You will need to 
 be the administrator of the system to install OpenLP and will be asked for the
 administrator password several times through this process.
 
-
 Then go to :menuselection:`Edit --> Software Sources`
 
 .. image:: pics/1softwaresources.png
@@ -104,7 +64,7 @@
 :menuselection:`Applications --> Sound and Video --> OpenLP`
 
 Kubuntu
--------
+^^^^^^^
 
 From the Kickoff Menu click :guilabel:`System Settings` Then click on 
 :guilabel:`Software Management`.
@@ -160,22 +120,10 @@
 .. image:: pics/kubuntuopenlplaunch.png
 
 Ubuntu Command Line Install
----------------------------
-
-If you are using Ubuntu 12.10 or a more recent version then OpenLP is included
-in the standard distribution. To Install OpenLP open a terminal and type::
-
-  user@ubuntu:~$ sudo apt-get install openlp
-
-OpenLP should now be available in your desktop's menu system, but if you wish 
-to run OpenLP from the command line type::
-
-  user@ubuntu:~$ openlp
-
-If you are using an older Ubuntu that does not include OpenLP in the standard
-distribution then the following install procedure should work across all Ubuntu 
-variants. First you will need to add the Personal Package Archive (PPA) to 
-Ubuntu's software sources. From a terminal type::
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First you will need to add the Personal Package Archive (PPA) to Ubuntu's
+software sources. From a terminal type::
 
   user@ubuntu:~$ sudo add-apt-repository ppa:openlp-core/release
   
@@ -192,11 +140,17 @@
 
   user@ubuntu:~$ openlp
 
+Fedora
+------
+
+To install OpenLP on Fedora follow the instructions below. The instructions
+describes how to do the install when using GNOME, KDE or the command line.
+
+**Note** When installing OpenLP you will need to have administrator privileges.
+You will be asked for the administrator password to install.
+
 Fedora (GNOME)
---------------
-
-**Note** When installing OpenLP you will need to have administrator privileges.
-You will be asked for the administrator password to install.
+^^^^^^^^^^^^^^
 
 Installing with Fedora you will use the default Add/Remove Programs available
 from :menuselection:`System --> Administration --> Add/Remove Programs` in 
@@ -229,10 +183,7 @@
 OpenLP will be available in :menuselection:`Applications --> Sound & Video --> OpenLP`
 
 Fedora (KDE)
-------------
-
-**Note** when installing OpenLP you will need to have administrator privileges.
-You will be asked for the administrator password to install.
+^^^^^^^^^^^^
 
 From the Kickoff open *Software Management*. Type OpenLP into the search
 box. Then click :guilabel:`Find by name` or press :kbd:`Enter`.
@@ -254,7 +205,7 @@
 .. image:: pics/4fedoracompleted.png
 
 Fedora Command Line Install
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To install OpenLP from the command line type::
 
@@ -269,9 +220,15 @@
 ----------
 
 The following instructions are for a standard Linux Mint install. These 
-instructions will not work with Linux Mint Debian Edition. If your are running
-Linux Mint without the standard desktop please see the :ref:`mint-command`
-install instructions.
+instructions will not work with Linux Mint Debian Edition. Most users should
+be able to follow the instructions for :ref:`mint-softman`, but if your are
+running Linux Mint without the standard desktop please see the
+:ref:`mint-command` install instructions.
+
+.. _mint-softman:
+
+Software Manager Install
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 The administrator password will be required several times during the 
 installation. To install OpenLP open the Software Manager from the Mint Menu.
@@ -317,7 +274,7 @@
 .. _mint-command:
 
 Linux Mint Command Line Install
--------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 You will need to add the Personal Package Archive (PPA) to Linux Mint's
 software sources. From a terminal type::

=== modified file 'manual/source/install_windows_mac.rst'
--- manual/source/install_windows_mac.rst	2015-09-18 09:36:31 +0000
+++ manual/source/install_windows_mac.rst	2015-10-16 11:16:49 +0000
@@ -2,7 +2,7 @@
 ======================================
 
 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>`_ 
+downloading the file from the `website <http://www.openlp.org/>`_ 
 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.
 On Windows 8 you might have to click :guilabel:`More info` before you can
@@ -63,22 +63,23 @@
 
 Click the Apple icon and open System Preferences
 
-.. image:: pics/gatekeeper1.png
+.. image:: pics/mac-os-x-system-menu.png
 
 Open the Security & Privacy settings
 
-.. image:: pics/gatekeeper2.png
+.. image:: pics/mac-os-x-settings.png
 
 Change the setting from Mac App Store to Anywhere. If the settings are grayed
 out click on the lock in the lower lefthand corner of the settings window to  
 enable editing.
 
-.. image:: pics/gatekeeper3.png
+.. image:: pics/mac-os-x-security-and-privacy.png
 
 If you have not already downloaded the correct file from the OpenLP
-`download page <http://www.openlp.org/en/download.html>`_, download it now.
-Then 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.
+`website <http://www.openlp.org/>`_, download it now. Then double click on the
+.dmg file. This will open a window with two icons: An OpenLP icon and an
+Applications Folder icon. To install OpenLP, simply drag the OpenLP icon over to
+the Applications folder icon and you will be ready to use OpenLP. OpenLP will be
+available in your Applications folder.
 
-.. image:: pics/osxinstall.png
+.. image:: pics/mac-os-x-dnd-install.png

=== modified file 'manual/source/mediamanager.rst'
--- manual/source/mediamanager.rst	2015-09-30 13:44:40 +0000
+++ manual/source/mediamanager.rst	2015-10-16 11:16:49 +0000
@@ -143,7 +143,7 @@
         
         A detailed description of the format and how it is parsed by OpenLP can
         be read `In the OpenLP API documentation
-        <http://docs.openlp.org/plugins/bibles.html#openlp.plugins.bibles.lib.parse_reference>`_.
+        <http://api.openlp.io/api/openlp/plugins/bibles/lib.html#openlp.plugins.bibles.lib.parse_reference>`_.
 
         If an invalid format is used for a search a popup window will show the
         examples also shown above.
@@ -328,8 +328,7 @@
 for media. The media item shows a list of imported audio or video files.
 
 **Note:** On some computers OpenLP has trouble displaying videos. Please read
-the `Frequently Asked Questions <http://wiki.openlp.org/faq>`_ for tips on how
-to resolve these issues.
+the :ref:`troubleshooting` for tips on how to resolve these issues.
 
 .. image:: pics/mediamanager_media.png
 

=== added file 'manual/source/pics/mac-os-x-dnd-install.png'
Binary files manual/source/pics/mac-os-x-dnd-install.png	1970-01-01 00:00:00 +0000 and manual/source/pics/mac-os-x-dnd-install.png	2015-10-16 11:16:49 +0000 differ
=== added file 'manual/source/pics/mac-os-x-security-and-privacy.png'
Binary files manual/source/pics/mac-os-x-security-and-privacy.png	1970-01-01 00:00:00 +0000 and manual/source/pics/mac-os-x-security-and-privacy.png	2015-10-16 11:16:49 +0000 differ
=== added file 'manual/source/pics/xfce4-display.png'
Binary files manual/source/pics/xfce4-display.png	1970-01-01 00:00:00 +0000 and manual/source/pics/xfce4-display.png	2015-10-16 11:16:49 +0000 differ
=== added file 'manual/source/pics/xfce4-settings.png'
Binary files manual/source/pics/xfce4-settings.png	1970-01-01 00:00:00 +0000 and manual/source/pics/xfce4-settings.png	2015-10-16 11:16:49 +0000 differ
=== added file 'manual/source/pics/xfce4-win-manager-tweaks-comp.png'
Binary files manual/source/pics/xfce4-win-manager-tweaks-comp.png	1970-01-01 00:00:00 +0000 and manual/source/pics/xfce4-win-manager-tweaks-comp.png	2015-10-16 11:16:49 +0000 differ
=== modified file 'manual/source/troubleshooting.rst'
--- manual/source/troubleshooting.rst	2015-10-12 13:02:25 +0000
+++ manual/source/troubleshooting.rst	2015-10-16 11:16:49 +0000
@@ -207,3 +207,10 @@
 internally by OpenLP for temporary files and anything in there can and will be
 deleted by OpenLP. In general you should not modify or create files in OpenLP's
 data folder unless you know what you are doing.
+
+OpenLP freezes on Xfce4 in a dual monitor setup
+-----------------------------------------------
+
+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.

=== modified file 'scripts/batch-drop-shadow.scm'
--- scripts/batch-drop-shadow.scm	2015-09-28 15:38:13 +0000
+++ scripts/batch-drop-shadow.scm	2015-10-16 11:16:49 +0000
@@ -3,7 +3,7 @@
  ;
  ; Place the script in your gimp scripts folder (eg. ~/.gimp-2.8/scripts) go to the
  ; folder with images you wish to add shadow to and execute like this:
- ; gimp --no-data -i -b '(batch-drop-shadow "*.png" 8 8 10)' -b '(gimp-quit 0)'
+ ; gimp --no-data -i -b '(batch-drop-shadow "*.png" 3 3 5)' -b '(gimp-quit 0)'
  ;
 
  (define (batch-drop-shadow pattern