openlp-core team mailing list archive

[Raoul Snyman <raoul.snyman@xxxxxxxxxxxxxxxxxxxxxxxx>]

Raoul Snyman has proposed merging lp:~raoul-snyman/openlp/documentation into lp:openlp.

Requested reviews:
  OpenLP Core (openlp-core)

For more details, see:
https://code.launchpad.net/~raoul-snyman/openlp/documentation/+merge/56085

Fixed up formatting and reworded a few things in the FAQ.
-- 
https://code.launchpad.net/~raoul-snyman/openlp/documentation/+merge/56085
Your team OpenLP Core is requested to review the proposed merge of lp:~raoul-snyman/openlp/documentation into lp:openlp.

=== modified file 'documentation/manual/source/faq.rst'
--- documentation/manual/source/faq.rst	2011-04-03 00:14:38 +0000
+++ documentation/manual/source/faq.rst	2011-04-03 18:21:12 +0000
@@ -24,17 +24,17 @@
 capability allows the worship leader to change songs, or for alert messages to 
 be sent from anywhere on the network, even via a phone.
 
-Being free, this software can be installed on as many PC's as required, even on 
-the home PC's of worship leaders without additional cost. Compared to the 
-expensive site licenses or restrictions of commercial software we believe OpenLP 
-cannot be beaten for value.  Still in active development by a growing team of 
-enthusiastic developers, features are being added all the time, meaning the 
+Being free, this software can be installed on as many computers as required,
+even on the home computers of worship leaders without additional cost. Compared
+to the expensive site licenses or restrictions of commercial software we believe
+OpenLP cannot be beaten for value. Still in active development by a growing team
+of enthusiastic developers, features are being added all the time, meaning the 
 software just improves all the time.
 
 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 
+*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 
@@ -55,11 +55,16 @@
 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.
+* 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?
 ===============================================
@@ -153,31 +158,31 @@
 How do I transfer my 1.2 song database?
 ---------------------------------------
 
-In OpenLP v2, go to the :menuselection:`File --> Import --> Song` menu.
+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
+    %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).`
+*(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 v2, go to the :menuselection:`File --> Import --> Bible` menu.
+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
+    %ALLUSERSPROFILE%\Application Data\openlp.org\Data\Bibles
 
-`(This must be in the popup file chooser dialog. Don't enter it directly into 
-the wizard).`
+*(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.
@@ -264,27 +269,33 @@
 The Bible plugin has a much improved `Import Wizard` which can import Bibles 
 from a variety of sources. The following sources are supported:
 
-* CSV (in the same format as `openlp.org 1.x <http://www.openlp.org/en/documentation/importing_exporting_data/bibles/importing_comma_delimited_files.html>`_)
-
-* OSIS (export from the `Sword Project <http://www.crosswire.org/sword/software/>`_ using the mod2osis tool)
-
- * After using the Sword software Media Manager to download the required bible.
-
- * From the command line (works on Windows and Linux):<br /><code>modernist <name>  > name.osis</code><br />`Note the <name> is case sensitive on all environments and should be the name of your bible, e.g. ESV.`
-
- * 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 
-
- * `Crosswalk <http://biblestudy.crosswalk.com/bibles/>`_
-
- * `BibleGateway <http://www.biblegateway.com/versions/>`_
-
- * `BibleServer <http://www.bibleserver.com>`_
+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?
 ------------------------------------------------
@@ -301,8 +312,8 @@
 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! 
+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?
@@ -314,19 +325,22 @@
 If your distribution supports the XDG standard, you'll find OpenLP's 
 configuration file in::
 
- /home/<user>/.config/OpenLP/OpenLP.conf
+    /home/<user>/.config/OpenLP/OpenLP.conf
 
 If that file and/or directory does not exist, look for::
 
- /home/<user>/.openlp/openlp.conf
+    /home/<user>/.openlp/openlp.conf
+
+``<user>`` is your username.
 
 OS X
 ----
 
 You'll find your configuration file here::
 
- /Users/<user>/Library/Preferences/com.openlp.OpenLP.plist
- /Users/<user>/Library/Preferences/org.openlp.OpenLP.plist
+    /Users/<user>/Library/Preferences/org.openlp.OpenLP.plist
+
+``<user>`` is your username.
 
 Windows
 -------
@@ -334,7 +348,7 @@
 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
+    HKEY_CURRENT_USER\Software\OpenLP\OpenLP
 
 Troubleshooting
 ===============
@@ -354,24 +368,46 @@
 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.
+#. 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?
 ==================================================
 
-* Operating System
- 
- * Version
- * Distribution - Ubuntu, Fedora, etc (if you're using Linux)
- * Edition \- Home, Basic, Business, etc (if you're using Windows)
-
-* Version of OpenLP (:menuselection:`Help --> About`)
-* The exact steps to take in order to reproduce the error
-* Version of MS Office or OpenOffice (if you're using the song imports or the presentation plugin)
-* What Bible translation and type you are importing (if you're using the Bible importer)
-* `Any` other information that might remotely be related or useful.
+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.
 
@@ -382,7 +418,7 @@
 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: <code>-l debug</code>. Please note, that is a lowercase **L**.
+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 
@@ -391,7 +427,7 @@
 the link to the page that is created.
 
 Windows
--------
+^^^^^^^
 
 Find the OpenLP 2.0 folder in your Start menu. Choose the "OpenLP (Debug)" option.
 
@@ -403,49 +439,51 @@
 and then close down OpenLP. 
 
 In the Explorer window you left open, navigate up one level into the openlp 
-folder. You will see the <code>openlp.log</code> file. This is the file to e-mail.
+folder. You will see the ``openlp.log`` file. This is the file to e-mail.
 
-Linux
------
+Linux/FreeBSD
+^^^^^^^^^^^^^
 
 If you installed OpenLP from a package::
 
- @:~$ openlp -l debug
+    @:~$ openlp -l debug
 
 Alternately, if you're running OpenLP from source::
 
- @:~$ ./openlp.pyw -l debug
+    @:~$ ./openlp.pyw -l debug
 
 If your Linux distribution supports the XDG standard, you'll find the log in::
 
- ~/.cache/openlp/openlp.log
+    ~/.cache/openlp/openlp.log
 
 Otherwise, you'll find the log file in::
 
- ~/.openlp/openlp.log
+    ~/.openlp/openlp.log
 
 Mac OS X
---------
+^^^^^^^^
 
 Open Terminal.app and navigate to where you installed OpenLP, usually 
-<code>/Applications</code>::
+``/Applications``::
 
- @:~$ cd /Applications
+    @:~$ cd /Applications
 
 Then go into the OpenLP.app directory, down to the OpenLP executable::
 
- @:~$ cd OpenLP.app/Contents/MacOS
+    @:~$ cd OpenLP.app/Contents/MacOS
 
 And then run OpenLP in debug mode::
 
- @:~$ ./openlp -l debug
+    @:~$ ./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
+    /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
 ------------------------------------------------------------------------------
@@ -457,29 +495,27 @@
 
 When running OpenLP from the command line, you might get something like this::
 
- Logging to: /home/<User>/.config/openlp/openlp.log
-
-* 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
+    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 <code>phonon-backend-gstreamer</code> package::
+Ubuntu you would install the ```phonon-backend-gstreamer``` package::
 
- @:~$ sudo aptitude install phonon-backend-gstreamer
+    @:~$ 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 <code>phonon-backend-xine</code> package::
+you would install the ```phonon-backend-xine``` package::
 
- @:~$ sudo aptitude install phonon-backend-xine
+    @:~$ sudo aptitude install phonon-backend-xine
 
 If you know which audiovisual system you're using, then install the appropriate 
 backend.
@@ -487,30 +523,30 @@
 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 at start
-----------------------------------------------------------------------------
+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.
+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 the :menuselection:`Tools --> Re-index Songs`.
+You need to run :menuselection:`Tools --> Re-index Songs`.
 
 There are no menu icons in OpenLP
 ---------------------------------
 
-This may affect (only) linux users with xfce. To solve the problem, follow the 
-description `here <https://bugs.launchpad.net/ubuntu/+source/qt4-x11/+bug/501468/comments/3>`_.
+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>`_.
 
-JPG images don't work
----------------------
+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 
@@ -525,30 +561,31 @@
 Videos can be slow or pixelated. Background Videos are very slow
 ----------------------------------------------------------------
 
-If playing video by themselves, try selecting the 
-:menuselection:`Settings --> Configure OpenLP --> Media`, Use Phonon for Video 
-playback option. As for text over video, we have no solution for speeding these 
-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.
+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 v2?
-------------------------------------
+What new features will I find in 2.0?
+-------------------------------------
 
-Since v2 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 v1.2 features are included. 
+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>`_.
+`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 v1.2 features, before going wild on new 
+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 v2 would not 
+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?
@@ -558,6 +595,4 @@
 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.
-
-`Help <http://wiki.openlp.org/Help:Contents>`_
\ No newline at end of file
+and post the idea there.
\ No newline at end of file