OpenLP

Merge lp:~raoul-snyman/openlp/update-macos-install into lp:openlp/documentation

  1. update-macos-install
  2. Merge into documentation
Proposed by Raoul Snyman
Status: Merged
Merged at revision: 133
Proposed branch: lp:~raoul-snyman/openlp/update-macos-install
Merge into: lp:openlp/documentation
Diff against target: 720 lines (+239/-214)
8 files modified
manual/source/bibles.rst (+1/-1)
manual/source/configure.rst (+4/-4)
manual/source/dualmonitors.rst (+9/-8)
manual/source/faq.rst (+166/-162)
manual/source/index.rst (+8/-2)
manual/source/install_mac.rst (+44/-28)
manual/source/system_requirements.rst (+2/-2)
manual/source/troubleshooting.rst (+5/-7)
To merge this branch: bzr merge lp:~raoul-snyman/openlp/update-macos-install
Reviewer Review Type Date Requested Status
Tomas Groth Approve
Tim Bentley Approve
Review via email: mp+322811@code.launchpad.net

Description of the change

- Update the macOS installation instructions
- Change Mac OS X -> macOS
- Update the FAQ a bit

Thanks to "froggles" on https://forums.openlp.org/discussion/2816/feedback-on-mac-os-x-content-in-openlp-2-2-manual for the updated install instructions.

To post a comment you must log in.
Revision history for this message
Tim Bentley (trb143) :
review: Approve
Revision history for this message
Tomas Groth (tomasgroth) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'manual/source/bibles.rst'
2--- manual/source/bibles.rst 2015-10-16 11:14:02 +0000
3+++ manual/source/bibles.rst 2017-04-20 06:15:33 +0000
4@@ -73,7 +73,7 @@
5
6 The following commands are used in all platforms and the commands are case
7 sensitive across all platforms. To convert a Bible using the command prompt in
8-Windows or a terminal in Linux or Mac OS X you would type::
9+Windows or a terminal in Linux or macOS you would type::
10
11 mod2osis biblename > biblename.osis
12
13
14=== modified file 'manual/source/configure.rst'
15--- manual/source/configure.rst 2017-02-14 06:40:26 +0000
16+++ manual/source/configure.rst 2017-04-20 06:15:33 +0000
17@@ -36,7 +36,7 @@
18 want to be able to make the display smaller so that it does not cover your
19 entire screen.
20
21-Display if a single screen
22+Display if a Single Screen
23 ^^^^^^^^^^^^^^^^^^^^^^^^^^
24
25 Checking this checkbox will show the display output in a separate window when
26@@ -316,7 +316,7 @@
27 reputation of being able to handle almost any video or audio format.
28
29 **Note:** You must have `VLC`_ installed for the VLC option to be available. On
30-Windows you must install the 32-bit version of VLC. On Mac OS X you must install
31+Windows you must install the 32-bit version of VLC. On macOS you must install
32 the 64-bit version of VLC.
33
34 Player Order
35@@ -489,7 +489,7 @@
36 due to the fact that OpenLP uses these application to open and run the
37 presentation.
38
39-Support of PDF is bundled with OpenLP on Mac OS X and Windows. On Linux you will
40+Support of PDF is bundled with OpenLP on macOS and Windows. On Linux you will
41 need to install :file:`mupdf` (recommended) or :file:`ghostscript`.
42
43 Advanced
44@@ -692,7 +692,7 @@
45 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46 To make the Remote access run in a secure manner ssl certificates need to be
47 provided to OpenLP. This is completely optional. On Linux you will need the
48-"openssl" package installed. On Mac OS X openssl should be installed by default.
49+"openssl" package installed. On macOS openssl should be installed by default.
50 On Windows you will need to download OpenSSL for Windows.
51
52 First create a configuration file for OpenSSL named openlp.cnf::
53
54=== modified file 'manual/source/dualmonitors.rst'
55--- manual/source/dualmonitors.rst 2015-10-16 10:02:10 +0000
56+++ manual/source/dualmonitors.rst 2017-04-20 06:15:33 +0000
57@@ -330,21 +330,22 @@
58 want to connect your projector until your desktop is running.
59
60
61-Mac OS X
62---------
63-
64-This short guide will tell users of Mac OS X how to setup dual displays.
65-
66-.. image:: pics/mac-os-x-system-menu.png
67+macOS
68+-----
69+
70+This short guide will tell users of macOS how to setup dual displays.
71
72 Open :guilabel:`System Preferences` in the Apple menu.
73
74-.. image:: pics/mac-os-x-settings.png
75+.. image:: pics/dual-monitors-macos-01-system-menu.png
76
77 Choose the :guilabel:`Displays` option.
78
79-.. image:: pics/mac-os-x-display-settings.png
80+.. image:: pics/dual-monitors-macos-02-settings.png
81
82 Click :guilabel:`Arrangement` in the top of the window. Make sure that
83 :guilabel:`Mirror Displays` is unchecked. You can now arrange the displays as
84 you wish.
85+
86+.. image:: pics/dual-monitors-macos-03-display-settings.png
87+
88
89=== modified file 'manual/source/faq.rst'
90--- manual/source/faq.rst 2016-02-20 22:40:13 +0000
91+++ manual/source/faq.rst 2017-04-20 06:15:33 +0000
92@@ -8,207 +8,194 @@
93 Can I help with OpenLP?
94 -----------------------
95
96-OpenLP is possible because of the commitment of individuals. If you would like
97-to help there are several things that you can get involved with. Please see:
98-`Contributing <http://wiki.openlp.org/Development:Getting_Started>`_
99-for more information.
100+OpenLP is possible because of the commitment of individuals. If you would like to help there are several things that
101+you can get involved with. Please see our `Contribute`_ page for more information.
102
103 I use and like OpenLP and would like to tell others online. Where can I do this?
104 --------------------------------------------------------------------------------
105
106 A variety of places!
107
108-* Are you on facebook? Then `become a fan <http://www.facebook.com/openlp>`_
109-* Are you on twitter? Then `follow openlp <http://twitter.com/openlp>`_, and
110- retweet the announcements.
111-* Give us a thumbs up on the
112- `SourceForge project page <http://www.sourceforge.net/projects/openlp>`_
113-* If you have a website or blog, then link to our site http://www.openlp.org
114- with a few words saying what the software is and why you like it.
115-* 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>`_,
116- so others in your locality can see someone close by is using it.
117-* If you are a member of any Christian Forums or websites, and their rules allow
118- it, then perhaps review the software or ask others to review it.
119-
120-What operating systems will OpenLP 2.4 support?
121------------------------------------------------
122-
123-OpenLP 2.4 is designed to be cross platform. Currently it has been known to run
124-on Windows (Vista, 7, 8, 10), Linux (Ubuntu and its variants, Fedora, Debian,
125-ArchLinux, Mint, OpenSUSE and many many others), FreeBSD & Mac OS X.
126-`Please let us know <http://wiki.openlp.org/Help:Contents>`_ if you have
127-successfully run it on something else.
128-
129-Which programming language is 2.4 developed in?
130------------------------------------------------
131-
132-OpenLP 2.4 is written in `Python3 <http://www.python.org>`_ and uses the
133-`Qt5 toolkit <http://www.qt.io>`_. Both are cross-platform which allows the
134-software to run on different types of machine and so allow more people access to
135-free worship software. Python is one of the easier programming languages to
136-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>`_
137-quicker, and also allows more developers to contribute with the project.
138+* Are you on Facebook? Then `become a fan`_.
139+* Are you on Twitter? Then `follow OpenLP`_, and retweet the announcements.
140+* If you have a website or blog, then link to `our web site`_ with a few words saying what OpenLP is and why you like it.
141+* Add a placemark on our `Worldwide Usage map`_, so others in your locality can see someone close by is using it.
142+* If you are a member of any Christian forums or websites, and their rules allow it, then perhaps review OpenLP or ask
143+ others to review it.
144+
145+What operating systems does OpenLP support?
146+-------------------------------------------
147+
148+OpenLP is designed to be cross platform. Currently it has been known to run on Windows (Vista, 7, 8, 10), Linux (Ubuntu
149+and its variants, Fedora, Debian, ArchLinux, Mint, OpenSUSE and many others), FreeBSD and macOS. `Please let us know`_
150+if you have successfully run it on something else.
151+
152+Which programming language is OpenLP developed in?
153+--------------------------------------------------
154+
155+OpenLP is written in `Python 3`_ and uses the `Qt5 toolkit`_ via the `PyQt5 library`. Both are cross-platform which
156+allows the software to run on different types of machine and so allow more people access to free worship software.
157+Python is one of the easier programming languages to learn, so this helps us develop and `find bugs`_ faster, and also
158+allows more developers to contribute with the project.
159
160 Which written languages does OpenLP support?
161 --------------------------------------------
162
163-OpenLP has support for multiple languages which can be seen on the
164-:menuselection:`Settings -->Translate` menu. However some of these translations
165-are incomplete. If you would like to help complete or start to translate OpenLP
166-into your language then see the `Getting started page <http://wiki.openlp.org/Translation:Getting_Started>`_.
167+OpenLP has support for multiple languages which can be seen on the :menuselection:`Settings -->Translate` menu. However
168+some of these translations are incomplete. If you would like to help complete or start to translate OpenLP into your
169+own language then see the `Getting started page`_ for translations.
170
171 Upgrading
172 =========
173
174+.. warning::
175+
176+ Newer versions of OpenLP are not backwards compatible with earlier versions. Once you have upgraded to a newer
177+ version, the older version of OpenLP will not be able to read the upgraded files.
178+
179+.. note::
180+
181+ It is always a good idea to make a backup when prompted by OpenLP.
182+
183 Can I upgrade from any 1.9.x or 2.0.x release to 2.4?
184 -----------------------------------------------------
185
186-No, you should first upgrade to the last stable release in the 2.0-series
187-(2.0.5) and then upgrade to 2.4 to ensure that data is correctly converted.
188-You can download OpenLP 2.0.5 from <http://sourceforge.net/projects/openlp/files/openlp/2.0.5/>`_.
189+No, you should first upgrade to the last stable release in the 2.0-series (2.0.5) and then upgrade to 2.4 to ensure
190+that data is correctly converted. You can download OpenLP 2.0.5 from `<https://get.openlp.org/2.0.5/>`_.
191
192 Can I upgrade directly from 1.2 to 2.4?
193 ---------------------------------------
194
195-No, you will have to install 2.0.5 first, then import the 1.2 data and then
196-upgrade to 2.4. See the 2.0 documentation for how to upgrade from 1.2 to
197-2.0. You can download OpenLP 2.0.5 from <http://sourceforge.net/projects/openlp/files/openlp/2.0.5/>`_.
198+No, you will have to install 2.0.5 first, then import the 1.2 data and then upgrade to 2.4. See the 2.0 documentation
199+for how to upgrade from 1.2 to 2.0. You can download OpenLP 2.0.5 from `<https://get.openlp.org/2.0.5/>`_.
200
201 Does 2.4 replace older 2.x versions, or can they be run side by side?
202 ---------------------------------------------------------------------
203
204-OpenLP 2.4 and earlier 2.x versions cannot run side by side. When running 2.4 for first time
205-any existing 2.x data will automatically be converted to the 2.4 format.
206-Note that OpenLP 2.4 is not backwards compatible with earlier 2.x versions. Once you have
207-upgraded from the older OpenLP versions cannot read the upgraded files. OpenLP 2.4 will
208-ask if it should make a backup on startup, which can be used in case you want
209-to downgrade again.
210-
211-OpenLP 2.4 cannot read service files created by OpenLP 2.0.4 and earlier, it can only
212-read service files created by OpenLP 2.0.5.
213+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
214+automatically be converted to the 2.4 format. OpenLP 2.4 will ask if it should make a backup on startup, which can be
215+used in case you want to downgrade again.
216+
217+OpenLP 2.4 cannot read service files created by OpenLP 2.0.4 and earlier, it can only read service files created by
218+OpenLP 2.0.5 and higher.
219+
220+Where can I download an older version of OpenLP?
221+------------------------------------------------
222+
223+.. warning::
224+
225+ Only the most current version of OpenLP is supported. If you submit a bug report for an older version, you will be
226+ told to upgrade first.
227+
228+Sometimes you might need to download an older version of OpenLP. You can always find previous versions of OpenLP on our
229+download server: `<https://get.openlp.org/>`_
230
231 Using OpenLP
232 ============
233
234-I have started OpenLP, but I cannot see the songs or bibles section in the Media Manager
235-----------------------------------------------------------------------------------------
236+I have started OpenLP, but I cannot see the songs or bibles section in the Library
237+----------------------------------------------------------------------------------
238
239-When you installed OpenLP, the first time wizard would have asked which plugins
240-you wanted, and songs and bibles should have been selected. If for some reason
241-they were not, then you will need to activate them yourself. See below
242-for instructions.
243+When you installed OpenLP, the first time wizard would have asked which plugins you wanted, and songs and bibles should
244+have been selected. If for some reason they were not, then you will need to activate them yourself. See below for
245+instructions.
246
247 How do I activate / deactivate a plugin?
248 ----------------------------------------
249
250-Plugins can be turned on and off from the Plugin List Screen. Select the plugin
251-you wish to start/stop and change its status. You should not need to restart
252-OpenLP.
253+Plugins can be turned on and off from the Plugin List Screen. Select the plugin you wish to start/stop and change its
254+status. You should not need to restart OpenLP.
255
256 What are these plugins that I keep seeing mentioned?
257 ----------------------------------------------------
258
259-The plugins allow OpenLP to be extend easily. A number have been written
260-(Songs, Bibles, Presentations) etc but it is possible for the application to be
261-extended with functionality only you require. If this is the case then go for
262-it but lets us know as we can help and it may be something someone else wants.
263+The plugins allow OpenLP to be extend easily. A number have been written (Songs, Bibles, Presentations) etc but it is
264+possible for the application to be extended with functionality only you require. If this is the case then go for it but
265+let us know as we can help and it may be something someone else wants.
266
267 How do I enable PowerPoint/Impress/PowerPoint Viewer?
268 -----------------------------------------------------
269
270-First of all ensure that the presentation plugin is enabled (see above).
271-Then to enable a presentation application, go to the `Settings` dialog, switch
272-to the `Presentations` tab and check one of the enabled checkboxes. OpenLP will
273-automatically detect which of the three you have installed, and enable the
274-appropriate checkbox(es). Check the applications you require, and then restart
275-OpenLP for the change to be detected.
276-Note, PowerPoint Viewer 2010 is not yet supported, use 2003 or 2007.
277-
278-Why can LibreOffice Impress not be used on Mac OS X?
279-----------------------------------------------------
280-
281-Currently the presentations plugin does not support Impress on OS X. The
282-reason for that is that the interoperability component (pyuno) in LibreOffice on
283-Mac OS X cannot be used by OpenLP due to incompatibilities between the version
284-of Python used by LibreOffice and the Python version used by OpenLP.
285-
286-Why can MS PowerPoint not be used on Mac OS X?
287-----------------------------------------------
288-
289-Currently the presentations plugin does not support PowerPoint on OS X. The
290-reason for that is that so far we have found that the available method to
291-control PowerPoint on OS X is not good enough for integration with OpenLP.
292-If this changes we will look at including this feature.
293+.. note::
294+
295+ PowerPoint, Keynote and LibreOffice are not supported on macOS due to limitations within the platform. This is
296+ outside of our control.
297+
298+.. note::
299+
300+ PowerPoint Viewer 2010 is not supported, use 2003 or 2007.
301+
302+First of all ensure that the presentation plugin is enabled (see above). Then to enable a presentation application, go
303+to the `Settings` dialog, switch to the `Presentations` tab and check one of the enabled checkboxes. OpenLP will
304+automatically detect which of the three you have installed, and enable the appropriate checkbox(es). Check the
305+applications you require, and then restart OpenLP for the change to be detected.
306
307 I am on Windows and PowerPoint is installed, but it does not appear as an option
308 --------------------------------------------------------------------------------
309
310-Try installing the `Visual C++ Runtime Redistributable <http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en>`_.
311-
312-Why does PowerPoint presentations not advance automatically
313------------------------------------------------------------
314-
315-The reason that PowerPoint does not advance automatically is that it can only do
316-so when it has the focus. But when using OpenLP for controlling presentation,
317-OpenLP has the focus. So in order to make PowerPoint advance automatically the
318-focus must be switched to PowerPoint, which can be done by clicking the
319-Powerpoint-icon in the taskbar once the PowerPoint presentation has opened.
320-
321-Is it possible to get Bible x? How?
322------------------------------------
323-
324-The Bible plugin has a `Import Wizard` which can import Bibles
325-from a variety of sources. The following sources are supported:
326+Try installing the `Visual C++ Runtime Redistributable`_.
327+
328+Why don't PowerPoint presentations advance automatically?
329+---------------------------------------------------------
330+
331+The reason that PowerPoint does not advance automatically is that it can only do so when it has the focus. But when
332+using OpenLP for controlling presentation, OpenLP has the focus. So in order to make PowerPoint advance automatically
333+the focus must be switched to PowerPoint, which can be done by clicking the Powerpoint-icon in the taskbar once the
334+PowerPoint presentation has opened.
335+
336+Is it possible to get a particular translation of the Bible? How?
337+-----------------------------------------------------------------
338+
339+.. note::
340+
341+ OpenLP does not have distrubution rights for most popular translations of the Bible. Bible societies require
342+ exhorbitant licensing costs which OpenLP could never afford. We cannot help you find those Bibles.
343+
344+The Bible plugin has a `Import Wizard` which can import Bibles from a variety of sources. The following sources are
345+supported:
346
347 CSV
348- 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>`_.
349+ The format is documented in the `OpenLP API documentation`_.
350
351 OSIS
352- An XML format for Bible. You can export Bibles from the `Sword Project <http://www.crosswire.org/sword/software/>`_
353- into OSIS using the ``mod2osis`` tool. After using the Sword software Media
354- Manager (or other Sword frontend, like BibleTime or Xiphos) to download the
355- required Bible, run the following command from the command line (works on
356- Windows and Linux)::
357-
358- mod2osis <name> > <name>.osis
359-
360- The ``<name>`` parameter is the name of your Bible, as you see it in Sword.
361- Note that the ``<name>`` is case sensitive on all environments. Once you
362- have exported your Bible to OSIS, the Bible import wizard will the read
363- ``<name>.osis`` file and import your Bible.
364+ An XML format for Bible. You can export Bibles from the `Sword Project`_ into OSIS using the ``mod2osis`` tool.
365+ After using the Sword software Media Manager (or other Sword frontend, like BibleTime or Xiphos) to download the
366+ required Bible, run the following command from the command line (works on Windows and Linux)::
367+
368+ mod2osis NAME > NAME.osis
369+
370+ The ``NAME`` parameter is the name of your Bible, as you see it in Sword. Note that the ``NAME`` is case sensitive
371+ on all environments. Once you have exported your Bible to OSIS, the Bible import wizard will the read ``NAME.osis``
372+ file and import your Bible.
373
374 OpenSong
375- OpenSong has a good selection of Bibles on their
376- `download page <http://www.opensong.org/d/downloads#bible_translations>`_.
377+ OpenSong has a good selection of Bibles on their `download page`_.
378
379 Web Download
380 OpenLP can download Bibles on demand from the following 3 sites:
381
382- * `Crosswalk <http://biblestudy.crosswalk.com/bibles/>`_
383- * `BibleGateway <http://www.biblegateway.com/versions/>`_
384- * `BibleServer <http://www.bibleserver.com>`_
385+ * `Crosswalk`_
386+ * `BibleGateway`_
387+ * `BibleServer`_
388
389 Zefania
390- The Zefania project has many bibles available from `their website <http://sourceforge.net/projects/zefania-sharp/files/Bibles/>`_
391+ The Zefania project has many bibles available from `their website`_.
392
393 Why do my Bible verses take a long time to load?
394 ------------------------------------------------
395
396-In order to better conform to copyright law, the Web Download Bibles are not
397-downloaded when you import them, but on the fly as you search for them. As a
398-result, the search takes a little longer if you need to download those
399-particular verses. Having said that, the Web Download Bibles cache downloaded
400-verses so that you do not need to download them again.
401+In order to better conform to copyright law, the Web Download Bibles are not downloaded when you import them, but on
402+the fly as you search for them. As a result, the search takes a little longer if you need to download those particular
403+verses. Having said that, the Web Download Bibles cache downloaded verses so that you do not need to download them
404+again.
405
406 My Bible is on the Web Download sites, but my Church is not on the internet. What options do I have?
407 ----------------------------------------------------------------------------------------------------
408
409-When you create and save a service, all the items in the service are saved with
410-it. That means any images, presentations, songs and media items are saved. This
411-is also true for bibles. What this means is you can create the service on your
412-home computer, insert a Bible passage from the web, save it and then open the
413-service using your church computer and voila, the Bible passage should be there!
414-Note this can also be done with songs, etc!
415+When you create and save a service, all the items in the service are saved with it. That means any images,
416+presentations, songs and media items are saved. This is also true for bibles. What this means is you can create the
417+service on your home computer, insert a Bible passage from the web, save it and then open the service using your church
418+computer and voila, the Bible passage should be there! Note this can also be done with songs, etc!
419
420
421 Location of OpenLP files
422@@ -217,11 +204,10 @@
423 Where do I find the configuration file?
424 ---------------------------------------
425
426-Linux, FreeBSD & PC-BSD
427-^^^^^^^^^^^^^^^^^^^^^^^
428+Linux, FreeBSD and PC-BSD
429+^^^^^^^^^^^^^^^^^^^^^^^^^
430
431-If your distribution supports the XDG standard, you will find OpenLP's
432-configuration file in::
433+If your distribution supports the XDG standard, you will find OpenLP's configuration file in::
434
435 /home/<user>/.config/OpenLP/OpenLP.conf
436
437@@ -231,8 +217,8 @@
438
439 ``<user>`` is your username.
440
441-Mac OS X
442-^^^^^^^^
443+macOS
444+^^^^^
445
446 You will find your configuration file here::
447
448@@ -243,8 +229,7 @@
449 Windows
450 ^^^^^^^
451
452-On Windows, OpenLP does not use a configuration file, it uses the Windows
453-registry. You can find the settings here::
454+On Windows, OpenLP does not use a configuration file, it uses the Windows registry. You can find the settings here::
455
456 HKEY_CURRENT_USER\Software\OpenLP\OpenLP
457
458@@ -253,27 +238,26 @@
459 Where do I find the data folder?
460 --------------------------------
461
462-Normally you can open the data folder by using the menu :menuselection:`Tools --> Open Data Folder`
463-and a fileexplorer window will appear with the data folder. In some cases due to
464-bugs or other issues this is not an option, and the folder must be found
465-manually.
466+Normally you can open the data folder by using the menu :menuselection:`Tools --> Open Data Folder` and a file manager
467+window will appear with the data folder. In some cases due to bugs or other issues this is not an option, and the
468+folder must be found manually.
469
470-Linux, FreeBSD & PC-BSD
471-^^^^^^^^^^^^^^^^^^^^^^^
472+Linux, FreeBSD and PC-BSD
473+^^^^^^^^^^^^^^^^^^^^^^^^^
474
475 The data folder is located in ``/home/<user>/.local/share/openlp``.
476
477-Mac OS X
478-^^^^^^^^
479+macOS
480+^^^^^
481
482-On Mac OS X the data folder is located in ``/Users/<username>/Library/Application Support/openlp``
483+On macOS the data folder is located in ``/Users/<username>/Library/Application Support/openlp``
484
485 Windows
486 ^^^^^^^
487
488-To get to the data folder on Windows, pres the Windows Key and "R" at the same
489-time. This will open a the :menuselection:`Run dialog`. Enter ``%appdata%\OpenLP``
490-and press <Enter>. This will open a fileexplorer with in the data folder.
491+To get to the data folder on Windows, pres the Windows Key and "R" at the same time. This will open a the
492+:menuselection:`Run dialog`. Enter ``%appdata%\OpenLP`` and press <Enter>. This will open a file manager within the
493+data folder.
494
495 Features
496 ========
497@@ -281,14 +265,34 @@
498 Why has popular feature request X not been implemented?
499 -------------------------------------------------------
500
501-There are only a handful of developers working in their spare time. If
502-we were to try and include everything we wanted to implement, then 2.4 would not
503-likely ever get released.
504+There are only a handful of developers working in their spare time. If we were to try and include everything we wanted
505+to implement, then we would never be able to release any new versions of OpenLP.
506
507 I have a great idea for a new feature, where should I suggest it?
508 -----------------------------------------------------------------
509
510-First of all check it is not on the `Feature Requests <http://wiki.openlp.org/Feature_Requests>`_
511-page. If it is, then you need to say no more, it has already been suggested! If it
512-is not on the list, then head to the `forum <http://forums.openlp.org>`_
513-and post the idea there.
514+First of all check it is not listed as a "wishlist" bug on `Launchpad`_. If it is, then you need to say no more, it has
515+already been suggested! If it is not on the list, then head to the `forums`_ and post the
516+idea there.
517+
518+.. _Contribute: https://openlp.org/contribute
519+.. _become a fan: https://www.facebook.com/openlp
520+.. _follow OpenLP: https://twitter.com/openlp
521+.. _our web site: https://openlp.org/
522+.. _Worldwide Usage map: https://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
523+.. _Please let us know: https://forums.openlp.org/
524+.. _Python 3: http://www.python.org/
525+.. _Qt5 toolkit: https://www.qt.io/
526+.. _PyQt5 library: https://www.riverbankcomputing.com/software/pyqt/intro
527+.. _find bugs: http://wiki.openlp.org/Bug#Something_has_gone_wrong.2C_what_should_I_do_to_help_get_it_fixed.3F
528+.. _Getting started page: http://wiki.openlp.org/Translation:Getting_Started
529+.. _Visual C++ Runtime Redistributable: http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en
530+.. _OpenLP API documentation: http://api.openlp.io/api/openlp/plugins/bibles/lib/csvbible.html#module-openlp.plugins.bibles.lib.csvbible
531+.. _Sword Project: http://www.crosswire.org/sword/software/
532+.. _download page: http://www.opensong.org/home/download#bibles
533+.. _Crosswalk: http://biblestudy.crosswalk.com/bibles/
534+.. _BibleGateway: http://www.biblegateway.com/versions/
535+.. _BibleServer: http://www.bibleserver.com
536+.. _their website: http://sourceforge.net/projects/zefania-sharp/files/Bibles/
537+.. _Launchpad: https://bugs.launchpad.net/openlp
538+.. _forums: https://forums.openlp.org/
539
540=== modified file 'manual/source/index.rst'
541--- manual/source/index.rst 2017-02-16 18:36:16 +0000
542+++ manual/source/index.rst 2017-04-20 06:15:33 +0000
543@@ -1,5 +1,9 @@
544-Welcome to the OpenLP 2.4 User Manual
545-=====================================
546+Welcome to the OpenLP User Manual
547+=================================
548+
549+The OpenLP User Manual is here to help you learn how to use OpenLP. From installing, to setting up your monitors, to
550+using OpenLP on a regular basis, all the information you need to know is in here. And if you see some of it is missing,
551+please `help us add it`_.
552
553 Getting Started With OpenLP
554 ---------------------------
555@@ -53,3 +57,5 @@
556
557 faq
558 troubleshooting
559+
560+.. _help us add it: https://openlp.org/contribute
561
562=== modified file 'manual/source/install_mac.rst'
563--- manual/source/install_mac.rst 2017-02-16 18:36:16 +0000
564+++ manual/source/install_mac.rst 2017-04-20 06:15:33 +0000
565@@ -1,30 +1,46 @@
566-Installing OpenLP on Mac OS X
567-=============================
568-
569-If you have not already downloaded the correct file from the `OpenLP website`_,
570-download it now. Then double click on the .dmg file. This will open a window with two
571-icons: An OpenLP icon and an Applications Folder icon. To install OpenLP, simply drag
572-the OpenLP icon over to the Applications folder icon and you will be ready to use
573-OpenLP. OpenLP will be available in your Applications folder.
574-
575-.. image:: pics/mac-os-x-dnd-install.png
576-
577-With the release of Mac OS X 10.8 applications not downloaded throught the Mac
578-App Store will not run by default. A setting must be changed in the Security &
579-Privacy Settings to run OpenLP.
580-
581-Click the Apple icon and open System Preferences
582-
583-.. image:: pics/mac-os-x-system-menu.png
584-
585-Open the Security & Privacy settings
586-
587-.. image:: pics/mac-os-x-settings.png
588-
589-Change the setting from Mac App Store to Anywhere. If the settings are grayed
590-out click on the lock in the lower lefthand corner of the settings window to
591-enable editing.
592-
593-.. image:: pics/mac-os-x-security-and-privacy.png
594+Installing OpenLP on macOS
595+==========================
596+
597+If you have not already downloaded the correct file from the `OpenLP website`_, download it now. Then double click on
598+the .dmg file. This will open a window with two icons: An OpenLP icon and an Applications Folder icon. To install
599+OpenLP, simply drag the OpenLP icon over to the Applications folder icon and you will be ready to use OpenLP. OpenLP
600+will be available in your Applications folder.
601+
602+.. image:: pics/install-macos-01-dnd-install.png
603+
604+With the release of Mac OS X 10.7.5, applications that are not signed by a developer registered with Apple will not run
605+by default. In order to run OpenLP the first time after installation, you will need to "teach" your computer to trust
606+the OpenLP application.
607+
608+First, go to the :guilabel:`Applications` folder and right-click on OpenLP (two-finger click on touch pads, or
609+:kbd:`Control+click` if you don't have a right mouse button). This will bring up a context menu as shown. Select "Open"
610+from that menu.
611+
612+.. image:: pics/install-macos-02-open.png
613+ :width: 40%
614+ :align: center
615+
616+Your computer may then verify the application, which will take a few seconds.
617+
618+.. image:: pics/install-macos-03-verifying.png
619+
620+You will see a prompt asking whether you are sure you want to open "OpenLP", noting that it is from an unidentified
621+developer. It will look very similar to the pictured dialog.
622+
623+To run OpenLP you simply need to click "Open". In future, you can simply run OpenLP just like any other application
624+(double-click in Applications, or keep it in the Dock for easy access) without going through these steps.
625+
626+.. image:: pics/install-macos-04-unidentified-developer.png
627+
628+You may need to repeat similar steps when you upgrade OpenLP (once per upgrade).
629+
630+If the steps above don't work, you may need to set your GateKeeper settings (under :guilabel:`Security && Privacy`) to
631+"Mac App Store and identified developers", as seen below.
632+
633+.. image:: pics/install-macos-05-system-menu.png
634+
635+.. image:: pics/install-macos-06-settings.png
636+
637+.. image:: pics/install-macos-07-security-and-privacy.png
638
639 .. _OpenLP website: https://openlp.org/
640
641=== added file 'manual/source/pics/dual-monitors-macos-01-system-menu.png'
642Binary files manual/source/pics/dual-monitors-macos-01-system-menu.png 1970-01-01 00:00:00 +0000 and manual/source/pics/dual-monitors-macos-01-system-menu.png 2017-04-20 06:15:33 +0000 differ
643=== added file 'manual/source/pics/dual-monitors-macos-02-settings.png'
644Binary files manual/source/pics/dual-monitors-macos-02-settings.png 1970-01-01 00:00:00 +0000 and manual/source/pics/dual-monitors-macos-02-settings.png 2017-04-20 06:15:33 +0000 differ
645=== added file 'manual/source/pics/dual-monitors-macos-03-display-settings.png'
646Binary files manual/source/pics/dual-monitors-macos-03-display-settings.png 1970-01-01 00:00:00 +0000 and manual/source/pics/dual-monitors-macos-03-display-settings.png 2017-04-20 06:15:33 +0000 differ
647=== added file 'manual/source/pics/install-macos-01-dnd-install.png'
648Binary files manual/source/pics/install-macos-01-dnd-install.png 1970-01-01 00:00:00 +0000 and manual/source/pics/install-macos-01-dnd-install.png 2017-04-20 06:15:33 +0000 differ
649=== added file 'manual/source/pics/install-macos-02-open.png'
650Binary files manual/source/pics/install-macos-02-open.png 1970-01-01 00:00:00 +0000 and manual/source/pics/install-macos-02-open.png 2017-04-20 06:15:33 +0000 differ
651=== added file 'manual/source/pics/install-macos-03-verifying.png'
652Binary files manual/source/pics/install-macos-03-verifying.png 1970-01-01 00:00:00 +0000 and manual/source/pics/install-macos-03-verifying.png 2017-04-20 06:15:33 +0000 differ
653=== added file 'manual/source/pics/install-macos-04-unidentified-developer.png'
654Binary files manual/source/pics/install-macos-04-unidentified-developer.png 1970-01-01 00:00:00 +0000 and manual/source/pics/install-macos-04-unidentified-developer.png 2017-04-20 06:15:33 +0000 differ
655=== added file 'manual/source/pics/install-macos-05-system-menu.png'
656Binary files manual/source/pics/install-macos-05-system-menu.png 1970-01-01 00:00:00 +0000 and manual/source/pics/install-macos-05-system-menu.png 2017-04-20 06:15:33 +0000 differ
657=== added file 'manual/source/pics/install-macos-06-settings.png'
658Binary files manual/source/pics/install-macos-06-settings.png 1970-01-01 00:00:00 +0000 and manual/source/pics/install-macos-06-settings.png 2017-04-20 06:15:33 +0000 differ
659=== added file 'manual/source/pics/install-macos-07-security-and-privacy.png'
660Binary files manual/source/pics/install-macos-07-security-and-privacy.png 1970-01-01 00:00:00 +0000 and manual/source/pics/install-macos-07-security-and-privacy.png 2017-04-20 06:15:33 +0000 differ
661=== removed file 'manual/source/pics/mac-os-x-display-settings.png'
662Binary files manual/source/pics/mac-os-x-display-settings.png 2015-09-21 12:46:53 +0000 and manual/source/pics/mac-os-x-display-settings.png 1970-01-01 00:00:00 +0000 differ
663=== removed file 'manual/source/pics/mac-os-x-dnd-install.png'
664Binary files manual/source/pics/mac-os-x-dnd-install.png 2015-10-16 10:04:13 +0000 and manual/source/pics/mac-os-x-dnd-install.png 1970-01-01 00:00:00 +0000 differ
665=== removed file 'manual/source/pics/mac-os-x-security-and-privacy.png'
666Binary files manual/source/pics/mac-os-x-security-and-privacy.png 2015-10-16 10:04:13 +0000 and manual/source/pics/mac-os-x-security-and-privacy.png 1970-01-01 00:00:00 +0000 differ
667=== removed file 'manual/source/pics/mac-os-x-settings.png'
668Binary files manual/source/pics/mac-os-x-settings.png 2015-09-21 12:46:53 +0000 and manual/source/pics/mac-os-x-settings.png 1970-01-01 00:00:00 +0000 differ
669=== removed file 'manual/source/pics/mac-os-x-system-menu.png'
670Binary files manual/source/pics/mac-os-x-system-menu.png 2015-09-21 12:46:53 +0000 and manual/source/pics/mac-os-x-system-menu.png 1970-01-01 00:00:00 +0000 differ
671=== modified file 'manual/source/system_requirements.rst'
672--- manual/source/system_requirements.rst 2015-09-28 16:21:35 +0000
673+++ manual/source/system_requirements.rst 2017-04-20 06:15:33 +0000
674@@ -9,13 +9,13 @@
675 * 2Ghz CPU
676 * 1GB RAM
677 * 100MB free disk space
678-* Windows Vista/7/8/10, Linux, Mac OS X (10.8 or later), FreeBSD
679+* Windows Vista/7/8/10, Linux, macOS (10.8 or later), FreeBSD
680 * Multiple Monitor Support is highly recommended (not required)
681 * For Presentation support:
682
683 * Windows: PowerPoint XP or later, PowerPoint Viewer 2003 or 2007 (not 2010)
684 or LibreOffice Impress 4 or later (32 bit)
685 * Linux: LibreOffice Impress 4 or later
686- * Mac: Not supported yet
687+ * macOS: Not supported yet due to limitations in Keynote and PowerPoint
688 * The Generic Document/Presentation and Songs of Fellowship song import options
689 require LibreOffice 4 or later
690
691=== modified file 'manual/source/troubleshooting.rst'
692--- manual/source/troubleshooting.rst 2016-02-22 19:27:30 +0000
693+++ manual/source/troubleshooting.rst 2017-04-20 06:15:33 +0000
694@@ -167,12 +167,10 @@
695 different options. What works for some may not for others, so some trial and
696 error may be required.
697
698-Mac
699-^^^
700+macOS
701+^^^^^
702
703-If you are using a Mac. You may wish to play Windows formats. flip4mac enables
704-you to use popular Windows formats such as .wmv on your Mac. You can get it
705-`from here <http://dynamic.telestream.net/downloads/download-flip4macwmv.htm>`_.
706+Most modern Macs should already support most popular formats out of the box.
707
708 Ubuntu Linux (and variants)
709 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
710@@ -365,8 +363,8 @@
711 hoping a future release of the toolkit we are using (QtWebKit) will help improve
712 this, but there is no timeframe at present.
713
714-Why do live backgrounds not work in OpenLP 2.4 on Windows & Mac OS X
715---------------------------------------------------------------------
716+Why do live backgrounds not work in OpenLP 2.4 on Windows and macOS
717+-------------------------------------------------------------------
718
719 Due to issues in one of the underlying frameworks that OpenLP uses (Qt5),
720 live backgrounds do not work in OpenLP 2.4. We aim to fix this in OpenLP 2.6.

Subscribers

People subscribed via source and target branches

to all changes: