Updated configuration docs

This commit is contained in:
Tomas Groth 2015-09-16 13:59:01 +01:00
parent c7ce4e3608
commit ece9cbbf4e
15 changed files with 149 additions and 35 deletions

View File

@ -138,6 +138,14 @@ Choose from one of three options for the default use of your theme.
With this level selected, all songs and verses will use the theme selected on With this level selected, all songs and verses will use the theme selected on
the left in the Global Theme drop down. the left in the Global Theme drop down.
Universal Settings
^^^^^^^^^^^^^^^^^^
**Wrap footer text:**
Check this if you want text in the footer to wrap if the lines are too long to
be on one line.
Advanced Advanced
======== ========
@ -205,6 +213,17 @@ time when saving your service file.
technically inclined, there is more information at technically inclined, there is more information at
`Python.org <http://docs.python.org/library/datetime.html#strftime-strptime-behavior>`_. `Python.org <http://docs.python.org/library/datetime.html#strftime-strptime-behavior>`_.
Data Location
^^^^^^^^^^^^^
If you wish to change the default location of where OpenLP stores its data, you
can enter a custom location here.
|buttons_open| **Browse for a custom data location**
|buttons_revert| **Revert:**
Clicking this button will erase your changes and revert to the default data
location.
Default Images Default Images
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
@ -252,8 +271,8 @@ These three settings control
service from start to finish. Using this setting makes it possible to use a service from start to finish. Using this setting makes it possible to use a
presentation remote controller. presentation remote controller.
X11 Display Workarounds
^^^ ^^^^^^^^^^^^^^^^^^^
**Bypass X11 Window Manager:** **Bypass X11 Window Manager:**
Linux and other X users may need to try toggling this flag if the main display Linux and other X users may need to try toggling this flag if the main display
@ -264,10 +283,19 @@ X11
appears to affect different versions and distributions differently, this appears to affect different versions and distributions differently, this
setting has been added, rather than try and work it out programmatically. setting has been added, rather than try and work it out programmatically.
**Use alternating row colours in lists:**
Using alternating row colours in most cases makes it easier for the human eye
to overview a list of items. Uncheck to disable.
Players Players
======= =======
.. image:: pics/configuremedia.png .. image:: pics/configureplayers.png
Background colour
^^^^^^^^^^^^^^^^^
Chose the background colour to be shown as background for videos with different
aspect ratio than the display screen.
Available Media Players Available Media Players
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
@ -287,7 +315,8 @@ players control the following:
reputation of being able to handle almost any video or audio format. reputation of being able to handle almost any video or audio format.
**Note:** You must have `VLC <http://www.videolan.org/vlc/>`_ installed for the **Note:** You must have `VLC <http://www.videolan.org/vlc/>`_ installed for the
VLC option to be available. VLC option to be available. On Windows you must install the 32-bit version of VLC.
On Mac OS X you must install the 64-bit version of VLC.
Player Order Player Order
^^^^^^^^^^^^ ^^^^^^^^^^^^
@ -296,6 +325,34 @@ Determines the preference order of the selected media players. The order is
changed by selecting one of the available players and using the changed by selecting one of the available players and using the
:guilabel:`Down` or :guilabel:`Up` button to change the position of the player. :guilabel:`Down` or :guilabel:`Up` button to change the position of the player.
.. _configure_projectors:
Projectors
==========
.. image:: pics/configureprojectors.png
Communication Options
^^^^^^^^^^^^^^^^^^^^^
The options available are:
**Connect to projectors on startup:**
Check if you want to attempt to connect to all projectors when OpenLP starts.
**Socket timeout (seconds):**
Time in seconds to wait for the projector connection. Available options are 2
to 10 seconds.
**Poll timeout (seconds):**
How often to poll the projector for status information. Available options are
2 to 60 seconds. For quicker response on the status icons, set to a lower
value. If you have network congestion, you may need to use a higher value.
**Source select dialog interface:**
Select whether you want all video source options on one dialog page or to use
tabs to consolidate the inputs based on video group.
.. _config_songs: .. _config_songs:
Songs Songs
@ -321,13 +378,21 @@ Songs Mode
If this box is not selected, your song edit changes will only be available in If this box is not selected, your song edit changes will only be available in
the :ref:`creating_service` if you add it again. the :ref:`creating_service` if you add it again.
**Add missing songs when opening service:** **Import missing songs from service files:**
With this box selected, when you open an order of service created on another With this box selected, when you open a service file created on another
computer, or if one of the songs are no longer in your :ref:`media-manager`, computer, or if one of the songs are no longer in your :ref:`media-manager`,
it will automatically enter the song in your Songs Media Manager. If this box it will automatically enter the song in your Songs Media Manager. If this box
is not checked, the song is available in the service but will not be added to is not checked, the song is available in the service but will not be added to
the :ref:`media-manager`. the :ref:`media-manager`.
**Display songbook in footer:**
With this box selected the songbook name and number for songs (if available)
will be shown in the footer.
**Display "©" symbol before copyright info:**
With this box selected the copyright symbol will be displayed in the footer
before the copyright information.
Bibles Bibles
====== ======
@ -372,6 +437,36 @@ Verse Display
**Note:** Changes do not affect verses already in the service. **Note:** Changes do not affect verses already in the service.
Custom Scripture References
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Here you can change the default separators used in the scripture references.
The default values are shown in grey when the custom separators has not be
enabled and nothing has been entered. Note that the default separators can
change if the language of OpenLP is changed.
**Verse Separators:** Enable to enter a custom verse separator.
**Range Separators:** Enable to enter a custom range separator.
**List Separators:** Enable to enter a custom list separator.
**End Mark:** Enable to enter a custom end marker.
Default Bible Language
^^^^^^^^^^^^^^^^^^^^^^
Choose the language of the bible books. The options are:
**Bible Language:**
The language of the books will be determined by the language of the bible.
**Application Language:**
The language of the books will be determined by the language set for OpenLP.
**English:**
The language of the books will be set to English.
Presentations Presentations
============= =============
@ -387,6 +482,9 @@ feature you will need to have one of the above-mentioned applications installed,
due to the fact that OpenLP uses these application to open and run the due to the fact that OpenLP uses these application to open and run the
presentation. presentation.
Support of PDF is bundled with OpenLP on Mac OS X and Windows. On Linux you will
need to install :file:`mupdf` (recommended) or :file:`ghostscript`.
Advanced Advanced
^^^^^^^^ ^^^^^^^^
@ -395,6 +493,30 @@ Advanced
box on the Presentations toolbar in :ref:`media-manager` which gives you the box on the Presentations toolbar in :ref:`media-manager` which gives you the
option to select the presentation program you want to use. option to select the presentation program you want to use.
PowerPoint options
^^^^^^^^^^^^^^^^^^
These options are only available if PowerPoint has been detected.
**Clicking on a selected slide in the slidecontroller advances to next effect:**
When this is enabled it is possible to go to the next effect of a slide by
clicking the slide in the slidecontroller. The default behaviour is to restart
the slide.
**Let PowerPoint control the size and position of the presentation window (workaround for windows 8 scaling issue):**
Windows 8 and 10 can on computers with multiple monitors use scaling to make
windows look the same size on different monitors. Unfortunately this can
cause issues with how OpenLP places and resizes the PowerPoint presentation
window. Check this box to enable the workaround which let PowerPoint control
the presentation window. When you enable this you must setup PowerPoint to
present to the correct monitor.
PDF options
^^^^^^^^^^^
**Use given full path for mudraw or ghostscript binary:**
Enable this if you want to enter a custom path for mudraw or ghostscript.
Images Images
====== ======
@ -413,6 +535,8 @@ it is resized.
Media Media
===== =====
.. image:: pics/configuremedia.png
Advanced Advanced
^^^^^^^^ ^^^^^^^^
@ -421,6 +545,10 @@ Advanced
dropdown box on the Media tool bar in the :ref:`media-manager` which gives dropdown box on the Media tool bar in the :ref:`media-manager` which gives
you the option to select the media player you want to use. you the option to select the media player you want to use.
**Start Live items automatically:**
With this option selected media items will start to play automatically when
sent live.
Custom Custom
====== ======
@ -438,6 +566,13 @@ Custom Display
**Note:** If you have an entry in the Credits box of your custom slide, title and **Note:** If you have an entry in the Credits box of your custom slide, title and
credits will always be displayed. credits will always be displayed.
**Import missing custom slides from service files:**
With this box selected, when you open a service file created on another
computer, or if one of the custom slides are no longer in your
:ref:`media-manager`, it will automatically enter the custom slide in your
Custom Slide Media Manager. If this box is not checked, the custom slide is
available in the service but will not be added to the :ref:`media-manager`.
.. _configure_alerts: .. _configure_alerts:
Alerts Alerts
@ -464,7 +599,7 @@ Font
This setting will determine how long your :ref:`alerts` will be displayed on This setting will determine how long your :ref:`alerts` will be displayed on
the screen, in seconds. the screen, in seconds.
**Location:** **Vertical Align:**
Choose the location where you want the alert displayed on the Choose the location where you want the alert displayed on the
screen, Top, Middle or Bottom. screen, Top, Middle or Bottom.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 192 KiB

After

Width:  |  Height:  |  Size: 174 KiB

View File

@ -10,32 +10,12 @@ Association (JBMIA) PJLink specification. Available in OpenLP v2.2.
.. _projector_settings: .. _projector_settings:
Projector Settings Projector Configuration
------------------ -----------------------
The available projector options can be changed using the main settings menu by The available projector options can be changed using the main settings menu by
going to :guilabel:`Settings` -> :guilabel:`Configure OpenLP` -> :guilabel:`Projectors` tab. going to :guilabel:`Settings` -> :guilabel:`Configure OpenLP` -> :guilabel:`Projectors` tab.
See :ref:`configure_projectors`.
|projector_settings_tab|
The options available are:
Connect to projectors on startup : Check if you want to attempt to connect
to all projectors when OpenLP starts
Socket timeout (seconds): Time in seconds to wait for the projector connection.
Available options are 2 to 10 seconds.
Poll timeout (seconds): How often to poll the projector for status information.
Available options are 2 to 60 seconds. For quicker response on the status icons,
set to a lower value. If you have network congestion, you may need to use a higher
value.
Source select dialog interface: Select whether you want all video source options
on one dialog page or to use tabs to consolidate the inputs based on video group.
Once you are satisfied with the settings, click on the :guilabel:`OK` button, otherwise click
on the :guilabel:`Cancel` button to ignore changes and close the dialog.
.. _projector_manager: .. _projector_manager:
@ -347,7 +327,6 @@ PJLink defaults.
.. |PROJECTOR_POWER_OFF_TILED| image:: pics/projector_power_off_tiled.png .. |PROJECTOR_POWER_OFF_TILED| image:: pics/projector_power_off_tiled.png
.. |PROJECTOR_POWER_ON| image:: pics/projector_power_on.png .. |PROJECTOR_POWER_ON| image:: pics/projector_power_on.png
.. |PROJECTOR_POWER_ON_TILED| image:: pics/projector_power_on_tiled.png .. |PROJECTOR_POWER_ON_TILED| image:: pics/projector_power_on_tiled.png
.. |PROJECTOR_SETTINGS_TAB| image:: pics/projector_settings_tab.png
.. |PROJECTOR_SHOW| image:: pics/projector_show.png .. |PROJECTOR_SHOW| image:: pics/projector_show.png
.. |PROJECTOR_SHOW_TILED| image:: pics/projector_show_tiled.png .. |PROJECTOR_SHOW_TILED| image:: pics/projector_show_tiled.png
.. |PROJECTOR_SOURCE_EDIT_SINGLE| image:: pics/projector_source_edit_single.png .. |PROJECTOR_SOURCE_EDIT_SINGLE| image:: pics/projector_source_edit_single.png