diff --git a/manual/source/alert.rst b/manual/source/alert.rst index 40c9162..69f3c5a 100644 --- a/manual/source/alert.rst +++ b/manual/source/alert.rst @@ -12,10 +12,11 @@ which is accessible from the top Menu under :menuselection:`Tools --> Alert`. .. image:: pics/alert.png -:guilabel:`Alert text:` Enter the message you want displayed in this box. +**Alert text:** + Enter the message you want displayed in this box. -:guilabel:`Parameter:` This box is used for words you want to insert into the -alert text. +**Parameter:** + This box is used for words you want to insert into the alert text. You will add the Parameter text into the alert text using “<>” (without quotations). Anywhere in the Alert text that you add these two symbols, <> side diff --git a/manual/source/configure_shortcuts.rst b/manual/source/configure_shortcuts.rst index 82052fa..6dbe53e 100644 --- a/manual/source/configure_shortcuts.rst +++ b/manual/source/configure_shortcuts.rst @@ -16,28 +16,28 @@ The image below shows a partial list of shortcuts you can customize. Across the top of the list are Action, Shortcut and Alternate. -**Action** +**Action:** This is the name of the of the shortcut you can change. It could be part of the menu selection or a toolbar item. -**Shortcut** +**Shortcut:** This is the keyboard shortcut assigned to the action beside it. -**Alternate** +**Alternate:** This is the alternate shortcut you can assign to the action. Each Action can have two different shortcuts assigned to it. Changing a Shortcut ------------------- -|configshortcut| **Capture shortcut.** +|configshortcut| **Capture shortcut:** To change a shortcut click on an Action in the list that you would like to modify. Click on the left |configshortcut| to add or modify the default shortcut and the right |configshortcut| to modify or add an alternate shortcut. After you click on one of the boxes you can type in the key or combination of keys you want to use for your shortcut. -|clearshortcut| **Restore the default shortcut of this action.** +|clearshortcut| **Restore the default shortcut of this action:** If you are not happy with your shortcut selection you can restore it to its default value by clicking the |clearshortcut| icon next to the shortcut. This will set the shortcut to its original state. diff --git a/manual/source/creating_service.rst b/manual/source/creating_service.rst index 1c37ec3..ef5256d 100644 --- a/manual/source/creating_service.rst +++ b/manual/source/creating_service.rst @@ -199,16 +199,16 @@ arrow will give you two options for the use of the timer. .. image:: pics/service_timer_select.png -**Play Slides in Loop** +**Play Slides in Loop:** Selecting this option will continuously loop your slides from beginning to end, and back to the beginning again. The slide loop will continue until you click the timer start and stop button again or move to the next service item. -**Play Slides to End** +**Play Slides to End:** Selecting this option will display your slides through once and stop at the end. -|service_timer| **Timer start and stop** +|service_timer| **Timer start and stop:** Click this button to start or stop the timer function. You can also use the keyboard shortcut :kbd:`L` to start and stop the continuous loop. @@ -221,17 +221,17 @@ you your three options. .. image:: pics/service_blank.png -|slide_blank| **Blank Screen** +|slide_blank| **Blank Screen:** Choosing this option will blank your projector to black as if it were shut off. The shortcut for this option is :kbd:`.` (fullstop/period on your keyboard). -|slide_theme| **Blank to Theme** +|slide_theme| **Blank to Theme:** Choosing this option will show your blank theme only, without lyrics or verses. If you are blanking a song with an assigned theme it will blank to that theme. If no theme is assigned or you are blanking a presentation or image, it will blank to the global theme. The shortcut for this option is :kbd:`T`. -|slide_desktop| **Show Desktop** +|slide_desktop| **Show Desktop:** Choosing this option will show your desktop wallpaper or a program that you have open on the extended monitor or projector. You can seamlessly switch between one program and OpenLP by Blank to Desktop. The shortcut for this option is :kbd:`D`. @@ -255,17 +255,17 @@ New, Open and Saving the Service Three icons at the top of the *Service Manager* will do the following: -|service_new| **Create a new service.** +|service_new| **Create a new service:** This first icon will create a New Service. -|service_open| **Load an existing service.** +|service_open| **Load an existing service:** This second icon will Open an already created service file. **Note:** You can open a saved service by dragging it into the service manager. The service will be opened and the existing service replaced. You will first be prompted to save your previous service if changes were made. -|service_save| **Save this service.** +|service_save| **Save this service:** This icon will Save the service you created, added to, or rearranged. Now that you created your service, tested it and are ready for your worship diff --git a/manual/source/custom_slides.rst b/manual/source/custom_slides.rst index d317df4..8cf5d78 100644 --- a/manual/source/custom_slides.rst +++ b/manual/source/custom_slides.rst @@ -7,18 +7,21 @@ Adding a new custom slide displays the following dialog: .. image:: pics/mediamanager_custom_edit.png -**Title:** Name of your custom slide. +**Title:** + Name of your custom slide. -**Add:** After clicking on Add you will enter your text you want to display in - this box. To create multiple slides, click the Split Slide button. When you - have finished adding your text, click on the Save button. +**Add:** + After clicking on Add you will enter your text you want to display in + this box. To create multiple slides, click the Split Slide button. When you + have finished adding your text, click on the Save button. -**Theme:** Select the theme you want to use for your Custom slide from this drop - down box. +**Theme:** + Select the theme you want to use for your Custom slide from this drop + down box. -**Credits:** Anything typed in this box will be displayed in the footer - information on the display. When you are finished, click the :guilabel:`Save` - button. +**Credits:** + Anything typed in this box will be displayed in the footer information on + the display. When you are finished, click the :guilabel:`Save` button. To Edit your slide, click on :guilabel:`Edit` to edit part of it or :guilabel:`Edit All` if you need to make multiple changes. Use the Up and Down diff --git a/manual/source/export_songs.rst b/manual/source/export_songs.rst index d63fd09..39e7d28 100644 --- a/manual/source/export_songs.rst +++ b/manual/source/export_songs.rst @@ -19,21 +19,25 @@ Click :guilabel:`Next` to continue or :guilabel:`Cancel` if you change your mind You can select the songs you want to export by clicking on each song you want to export. -**Search:** Searches for a song title or keyword in a title. +**Search:** + Searches for a song title or keyword in a title. -**Uncheck All:** If you are not sure of your selections click :guilabel:`Uncheck All` -and start over. +**Uncheck All:** + If you are not sure of your selections click :guilabel:`Uncheck All` and + start over. -**Check All:** Click :guilabel:`Check All` selects all of the songs for export. +**Check All:** + Click :guilabel:`Check All` selects all of the songs for export. When you are finished with your selection click :guilabel:`Next`. .. image:: pics/export_song_directory.png -**Select Directory** Select the directory where you want the songs to be saved. -The list of songs to be exported are shown below. +**Select Directory:** + Select the directory where you want the songs to be saved. The list of songs + to be exported are shown below. -**Note** Exporting songs will create a file for each song, If you export one +**Note:** Exporting songs will create a file for each song, If you export one hundred songs, you will have have one hundred individual files. .. image:: pics/export_song_process.png diff --git a/manual/source/mediamanager.rst b/manual/source/mediamanager.rst index a82d165..a7d323c 100644 --- a/manual/source/mediamanager.rst +++ b/manual/source/mediamanager.rst @@ -24,28 +24,28 @@ item. The songs media item shows a list of all the songs in the songs database. Toolbar ^^^^^^^ -|buttons_new| **Add song** +|buttons_new| **Add song:** Open the song edit dialog to add a new song. -|buttons_edit| **Edit song** +|buttons_edit| **Edit song:** Open the song edit dialog to make changes to the selected song. -|buttons_delete| **Delete song** +|buttons_delete| **Delete song:** Remove the selected song(s) from the song list. -|buttons_preview| **Preview song** +|buttons_preview| **Preview song:** Send the selected song to the :ref:`g-preview-slide-controller`. -|buttons_live| **Send song live** +|buttons_live| **Send song live:** Send the selected song to the :ref:`g-live-slide-controller` to be shown on the display screen. -|buttons_add| **Add song to service** +|buttons_add| **Add song to service:** Add the selected song(s) to the :ref:`g-service-manager`. Songs can also be added to the :ref:`g-service-manager` by means of drag and drop from the :ref:`g-media-manager`. -|buttons_db| **Maintain authors, topics and books** +|buttons_db| **Maintain authors, topics and books:** Open the song maintenance dialog to add, edit or delete authors, topics or song books. @@ -60,19 +60,19 @@ Search Clicking on the icon in the search box displays a list of search options. The following options are available: -|search_song| **Entire Song** +|search_song| **Entire Song:** Search the title, lyrics and comments fields. -|search_title| **Titles** +|search_title| **Titles:** Search the title field only. -|search_text| **Lyrics** +|search_text| **Lyrics:** Search the lyrics field only. -|search_author| **Authors** +|search_author| **Authors:** Search the associated authors. -|search_theme| **Themes** +|search_theme| **Themes:** Search the assigned themes. Click the :guilabel:`Search` button to perform a search and display the results @@ -90,18 +90,18 @@ to find Bible verses and add them to the :ref:`g-service-manager`. Toolbar ^^^^^^^ -|buttons_import| **Import Bible** +|buttons_import| **Import Bible:** Import Bibles from a number of formats. This is discussed in detail on the :ref:`import_bibles` page. -|buttons_preview| **Preview verses** +|buttons_preview| **Preview verses:** Send the selected verses to the :ref:`g-preview-slide-controller`. -|buttons_live| **Send verses live** +|buttons_live| **Send verses live:** Send the selected verses to the :ref:`g-live-slide-controller` to be shown on the display screen. -|buttons_add| **Add verses to service** +|buttons_add| **Add verses to service:** Add the selected verses to the :ref:`g-service-manager`. Verses can also be added to the :ref:`g-service-manager` by means of drag and drop from the :ref:`g-media-manager`. @@ -116,11 +116,11 @@ Quick Search Tab The following options are available on the quick search tab: -**Find** +**Find:** Clicking the icon in the Find box displays a list of search options. The following options are available: - |search_reference| **Scripture Reference** + |search_reference| **Scripture Reference:** Search for a specific verse using a scripture reference format. The following formats are supported: @@ -132,34 +132,34 @@ The following options are available on the quick search tab: * Book Chapter:Verse-Verse, Chapter:Verse-Verse * Book Chapter:Verse-Chapter:Verse - |search_text| **Text Search** + |search_text| **Text Search:** Search by a keyword or words. Use more words to narrow down the list of results. If you search for "Jesus God" it searches sentences which contain both words, Jesus and God. If you search for "Jesus, God" separated by a comma, it searches for sentences which contain at least one of the words, Jesus or God. -**Version** +**Version:** Once a Bible has been imported, it will be displayed in the drop down box. Select a version from the list of the Bibles. -**Second** +**Second:** If :guilabel:`Display second Bible verses` has been selected in the Bibles configuration, this option will be available. This is used to display another version of the Bible for comparison. Both versions will be displayed. If there is not enough space on one slide, the Second verses will be displayed on the next slide. -**Layout Style** +**Layout Style:** The following options are available to set how Bible verses are displayed: - **Verse Per Slide** + **Verse Per Slide:** Display one verse per slide. - **Verse Per Line** + **Verse Per Line:** Start each verse on a new line until the slide is full. - **Continuous** + **Continuous:** Verses flow together, separated by verse number and chapter if chapter is selected to show above. @@ -169,7 +169,7 @@ The following options are available on the quick search tab: **Note:** Changes to layout style do not affect verses already in the :ref:`g-service-manager`. -|buttons_clear_results| |buttons_keep_results| **Keep/Clear Results** +|buttons_clear_results| |buttons_keep_results| **Keep/Clear Results:** Normally, when a search is run, the previous verses are cleared. To retain the previous set of verses, toggle this button. @@ -184,14 +184,14 @@ Advanced Tab The Advanced tab is convenient for selecting Bible verses by book, chapter and verse from a set of drop down boxes. -**Book** +**Book:** Click on the drop down box and select a book from the list. -**Chapter/Verse** +**Chapter/Verse:** Select the *From* chapter and verse, and the *To* chapter and verse. -*Version*, *Second* and *Layout Style* are the same as in the *Quick* search -tab. +**Note** *Version*, *Second* and *Layout Style* are the same as in the *Quick* +search tab. Click the :guilabel:`Search` button to perform a search and display the results in the verse list. @@ -210,22 +210,22 @@ presentations. Toolbar ^^^^^^^ -|buttons_open| **Load presentation** +|buttons_open| **Load presentation:** Import a presentation. Presentations need to be imported in order to control them from within OpenLP. -|buttons_delete| **Delete presentation** +|buttons_delete| **Delete presentation:** Removes the selected presentation from the list. Note that this does not delete the original presentation from the disk. -|buttons_preview| **Preview presentation** +|buttons_preview| **Preview presentation:** Send the selected presentation to the :ref:`g-preview-slide-controller`. -|buttons_live| **Send presentation live** +|buttons_live| **Send presentation live:** Send the selected presentation to the :ref:`g-live-slide-controller` to be shown on the display screen. -|buttons_add| **Add presentation to service** +|buttons_add| **Add presentation to service:** Add the selected presentation to the :ref:`g-service-manager`. Presentations can also be added to the :ref:`g-service-manager` by means of drag and drop from the :ref:`g-media-manager`. @@ -250,27 +250,27 @@ media item. The images media item shows a list of imported images. Toolbar ^^^^^^^ -|buttons_open| **Load image** +|buttons_open| **Load image:** Import one or more images. Images need to be imported in order to be used in OpenLP. -|buttons_delete| **Delete images** +|buttons_delete| **Delete images:** Removes the selected image(s) from the list. Note that this does not delete the original image(s) from the disk. -|buttons_preview| **Preview image** +|buttons_preview| **Preview image:** Send the selected image(s) to the :ref:`g-preview-slide-controller`. -|buttons_live| **Send image live** +|buttons_live| **Send image live:** Send the selected image(s) to the :ref:`g-live-slide-controller` to be shown on the display screen. -|buttons_add| **Add image to service** +|buttons_add| **Add image to service:** Add the selected image(s) to the :ref:`g-service-manager`. Images can also be added to the :ref:`g-service-manager` by means of drag and drop from the :ref:`g-media-manager`. -|buttons_replace_live_background| **Replace live background** +|buttons_replace_live_background| **Replace live background:** Replace the current live theme background with the selected image. This has effect until the theme changes, or the *Remove Backgound* button is clicked. @@ -299,27 +299,27 @@ to resolve these issues. Toolbar ^^^^^^^ -|buttons_open| **Load media** +|buttons_open| **Load media:** Import one or more media files. Media files need to be imported in order to be used in OpenLP. -|buttons_delete| **Delete media** +|buttons_delete| **Delete media:** Removes the selected media file(s) from the list. Note that this does not delete the original media file(s) from the disk. -|buttons_preview| **Preview media** +|buttons_preview| **Preview media:** Send the selected media to the :ref:`g-preview-slide-controller`. -|buttons_live| **Send media live** +|buttons_live| **Send media live:** Send the selected media to the :ref:`g-live-slide-controller` to be shown on the display screen. -|buttons_add| **Add media to service** +|buttons_add| **Add media to service:** Add the selected media to the :ref:`g-service-manager`. Media can also be added to the :ref:`g-service-manager` by means of drag and drop from the :ref:`g-media-manager`. -|buttons_replace_live_background| **Replace live background** +|buttons_replace_live_background| **Replace live background:** Replace the current live theme background with the selected media. This has effect until the theme changes, or the *Remove Background* button is clicked. @@ -346,23 +346,23 @@ such as liturgy or prayers. Toolbar ^^^^^^^ -|buttons_new| **Add custom slide** +|buttons_new| **Add custom slide:** Open the song edit dialog to add a new custom slide. -|buttons_edit| **Edit custom slide** +|buttons_edit| **Edit custom slide:** Open the song edit dialog to make changed to the selected new custom slide. -|buttons_delete| **Delete custom slide** +|buttons_delete| **Delete custom slide:** Remove the selected custom slide(s) from the list. -|buttons_preview| **Preview custom slide** +|buttons_preview| **Preview custom slide:** Send the selected custom slide to the :ref:`g-preview-slide-controller`. -|buttons_live| **Send custom slide live** +|buttons_live| **Send custom slide live:** Send the selected custom slide to the :ref:`g-live-slide-controller` to be shown on the display screen. -|buttons_add| **Add custom slide to service** +|buttons_add| **Add custom slide to service:** Add the selected custom slide(s) to the :ref:`g-service-manager`. Custom slides can also be added to the :ref:`g-service-manager` by means of drag and drop from the :ref:`g-media-manager`. diff --git a/manual/source/menu_items.rst b/manual/source/menu_items.rst index 1035f81..a8c034e 100644 --- a/manual/source/menu_items.rst +++ b/manual/source/menu_items.rst @@ -9,125 +9,161 @@ There is a brief description or link for their intended purpose. File ---- -|buttons_new| **New:** Creates a new service. :ref:`new_service` +|buttons_new| **New:** + Creates a new service. :ref:`new_service` -|buttons_open| **Open:** Load an existing service. :ref:`new_service` +|buttons_open| **Open:** + Load an existing service. :ref:`new_service` -|buttons_save| **Save:** Saves your existing loaded service. +|buttons_save| **Save:** + Saves your existing loaded service. -**Save As:** Saves your newly created service. +**Save As:** + Saves your newly created service. -**Recent Files:** Displays your last files opened configurable here. :ref:`configure_ui` +**Recent Files:** + Displays your last files opened configurable here. :ref:`configure_ui` - **Clear List:** Clears your recent files list. + **Clear List:** + Clears your recent files list. -**Import:** This provides the items you can import. +**Import:** + This provides the items you can import. - **Settings:** Import your configurable settings from another computer. + **Settings:** + Import your configurable settings from another computer. - **Theme:** Import a theme that has been previously exported. :ref:`import_themes` + **Theme:** + Import a theme that has been previously exported. :ref:`import_themes` - **Song:** Import your songs previously exported. :ref:`import_songs` + **Song:** + Import your songs previously exported. :ref:`import_songs` - **Bible:** Import Bibles from another program, the internet or a previously - exported Bible from OpenLP. :ref:`import_bibles` + **Bible:** + Import Bibles from another program, the internet or a previously exported + Bible from OpenLP. :ref:`import_bibles` -**Export:** Provides the items you can export. +**Export:** + Provides the items you can export. - **Settings:** Export your configurable settings to a file to import to another - computer. + **Settings:** + Export your configurable settings to a file to import to another computer. - **Theme:** Export your theme. :ref:`export_themes` + **Theme:** + Export your theme. :ref:`export_themes` - **Song:** Export your songs. :ref:`export_songs` + **Song:** + Export your songs. :ref:`export_songs` -**Print Service:** Gives you the ability to print your service. :ref:`print_service` +**Print Service:** + Gives you the ability to print your service. :ref:`print_service` -|buttons_exit| **Exit:** Closes OpenLP. If there is an open service that has not - been saved you will be prompted to do so. +|buttons_exit| **Exit:** + Closes OpenLP. If there is an open service that has not + been saved you will be prompted to do so. View ---- -**Mode:** These three settings are optimized for setup and live display. +**Mode:** + These three settings are optimized for setup and live display. - **Default:** Displays all of the panels of OpenLP. + **Default:** + Displays all of the panels of OpenLP. - **Setup:** Displays Preview, :ref:`media-manager` and :ref:`creating_service`. + **Setup:** + Displays Preview, :ref:`media-manager` and :ref:`creating_service`. - **Live:** Displays the live panel and :ref:`creating_service` + **Live:** + Displays the live panel and :ref:`creating_service` Clicking on any of the next items will hide or show its respective panel. -|button_mediamanager| **Media Manager:** Hide or show :ref:`media-manager`. +|button_mediamanager| **Media Manager:** + Hide or show :ref:`media-manager`. -|button_servicemanager| **Service Manager:** Hide or show :ref:`creating_service`. +|button_servicemanager| **Service Manager:** + Hide or show :ref:`creating_service`. -|theme_new| **Theme Manager:** Hide or show :ref:`themes`. +|theme_new| **Theme Manager:** + Hide or show :ref:`themes`. -**Preview Panel:** Hide or show the preview panel. +**Preview Panel:** + Hide or show the preview panel. -**Live Panel:** Hide or show the live panel. +**Live Panel:** + Hide or show the live panel. -**Lock Panels:** Using this lock will keep all your panel settings the way they - are when clicked, whether hidden or showing. Click this again to unlock the - panels. +**Lock Panels:** + Using this lock will keep all your panel settings the way they + are when clicked, whether hidden or showing. Click this again to unlock the + panels. Tools ----- -|buttons_open| **Open Data Folder:** You can access your OpenLP data here. - Your Bibles, songs, themes and other items are stored here. +|buttons_open| **Open Data Folder:** + You can access your OpenLP data here. Your Bibles, songs, themes and other + items are stored here. **Note:** It is possible to delete a Bible, theme or another resource you need. If anything is deleted in this folder it is not recoverable through OpenLP. -|button_rerun| **Re-run First Time Wizard:** This will bring up the dialog box - to run the first time wizard again. :ref:`wizard` +|button_rerun| **Re-run First Time Wizard:** + This will bring up the dialog box to run the first time wizard again. :ref:`wizard` -**Update Theme Images:** Changing screen resolution can have an affect on theme - images. Use this to correct the images. +**Update Theme Images:** + Changing screen resolution can have an affect on theme images. Use this to + correct the images. -|plugin_songs| **Re-index Songs:** This rebuilds the internal song indexes to - make them work following code corrections. You would generally use this after - a software upgrade. +|plugin_songs| **Re-index Songs:** + This rebuilds the internal song indexes to make them work following code + corrections. You would generally use this after a software upgrade. -**Song Usage Tracking:** Configure your song usage tracking. :ref:`song_usage` +**Song Usage Tracking:** + Configure your song usage tracking. :ref:`song_usage` - **Toggle Tracking:** Provides the means to turn song usage tracking on or off. - There will be a visible check mark if song usage tracking is on. + **Toggle Tracking:** + Provides the means to turn song usage tracking on or off. There will be a + visible check mark if song usage tracking is on. - **Extract Tracking Data:** Brings up a dialog box to extract song usage data. + **Extract Tracking Data:** + Brings up a dialog box to extract song usage data. - **Delete Tracking Data:** Brings up a dialog box to delete song usage data. + **Delete Tracking Data:** + Brings up a dialog box to delete song usage data. |plugin_alerts| **Alert:** Configure an alert. :ref:`alerts` Settings -------- -|plugin_list| **Plugin List:** Provides the configurable settings to control - your plugin's. :ref:`plugin_list` +|plugin_list| **Plugin List:** + Provides the configurable settings to control your plugin's. :ref:`plugin_list` -**Language:** You can choose another language here or leave it on Autodetect. +**Language:** + You can choose another language here or leave it on Autodetect. -|button_tag| **Configure Formatting Tags:** Provides the configurable settings - for formatting tags. :ref:`formatting-tags` +|button_tag| **Configure Formatting Tags:** + Provides the configurable settings for formatting tags. :ref:`formatting-tags` -|button_settings| **Configure Shortcuts:** Provides the configurable settings - for shortcuts. :ref:`shortcuts` +|button_settings| **Configure Shortcuts:** + Provides the configurable settings for shortcuts. :ref:`shortcuts` -|button_configure| **Configure OpenLP:** Provides the configurable settings - for OpenLP. :ref:`configure` +|button_configure| **Configure OpenLP:** + Provides the configurable settings for OpenLP. :ref:`configure` Help ---- -**Online Help:** This is a direct link to OpenLP's operating manual. +**Online Help:** + This is a direct link to OpenLP's operating manual. -**Web Site:** This is a direct link to OpenLP's web site. +**Web Site:** + This is a direct link to OpenLP's web site. -**About:** Provides information, credits and license for OpenLP. +**About:** + Provides information, credits and license for OpenLP. .. These are all the image templates that are used in this page. diff --git a/manual/source/plugin_list.rst b/manual/source/plugin_list.rst index d6d4f43..fc65189 100644 --- a/manual/source/plugin_list.rst +++ b/manual/source/plugin_list.rst @@ -18,29 +18,32 @@ Plugin Details The left side shows you the list of plugins. Click on a plugin to check its status. -**Status:** Shows if your plugin is Active or Inactive. Click the box to -change the status and click :kbd:`OK` to save your selection. +**Status:** + Shows if your plugin is Active or Inactive. Click the box to change the + status and click :kbd:`OK` to save your selection. -**Version:** Is the version of the plugin. +**Version:** + Is the version of the plugin. -**About:** Describes the use of the plugin. +**About:** + Describes the use of the plugin. For a brief description of what each plugin does, please see below. -|songs| **Songs Plugin** +|songs| **Songs Plugin:** The songs plugin provides the ability to display and manage songs. -|bibles| **Bible Plugin** +|bibles| **Bible Plugin:** The Bible plugin provides the ability to display Bible verses from different sources during the service. -|presentations| **Presentation Plugin** +|presentations| **Presentation Plugin:** The presentation plugin provides the ability to show presentations using a number of different programs. The choice of available presentation programs is available to the user in a drop down box. **Note:** Presentation plugin is disabled on MAC. -|images| **Image Plugin** +|images| **Image Plugin:** The image plugin provides displaying of images. One of the distinguishing features of this plugin is the ability to group a number of images together in the service manager, making the displaying of multiple images easier. @@ -50,22 +53,22 @@ For a brief description of what each plugin does, please see below. text-based items like songs with the selected image as a background instead of the background provided by the theme. See the section on :ref:`adding_images`. -|media| **Media Plugin** +|media| **Media Plugin:** The media plugin provides playback of audio and video. -|custom| **Custom Slide Plugin** +|custom| **Custom Slide Plugin:** The custom slide plugin provides the ability to set up custom text slides that can be displayed on the screen the same way songs are. This plugin provides greater freedom over the songs plugin. -|songusage| **SongUsage Plugin** +|songusage| **SongUsage Plugin:** This plugin tracks the usage of songs in services. -|alerts| **Alerts Plugin** +|alerts| **Alerts Plugin:** The alert plugin controls the displaying of nursery alerts on the display screen. See :ref:`alerts` for more information -|remote| **Remote Plugin** +|remote| **Remote Plugin:** The remote plugin provides the ability to send messages to a running version of OpenLP on a different computer via a web browser or through the remote API. See the section on :ref:`remote_tab`. diff --git a/manual/source/print_service.rst b/manual/source/print_service.rst index 22c7b9f..d5ed157 100644 --- a/manual/source/print_service.rst +++ b/manual/source/print_service.rst @@ -21,30 +21,30 @@ This will bring up a window with the service order for review and printing. Toolbar ------- -|printbutton| **Print** +|printbutton| **Print:** This will print the service bringing up the system's print options. Use this when you are ready to print. -|optionbutton| **Options** +|optionbutton| **Options:** This gives you a series of ways to customize the service order before printing. See the section on :ref:`options` for more information. -|copybutton| **Copy** +|copybutton| **Copy:** Copy the text of the preview window to your clipboard. You can then paste the text into other documents or applications. -|copybutton| **Copy HTML** +|copybutton| **Copy HTML:** Copy html code to your clipboard. You can then paste this in a text editor and save as .html. This can then be used to post your service details on a website or anywhere an html document can be used. -|zoomin| **Zoom in** +|zoomin| **Zoom in:** Zooms in on your preview. -|zoomout| **Zoom out** +|zoomout| **Zoom out:** Zooms out to make more of your preview visible. -|zoomoriginal| **Zoom to original** +|zoomoriginal| **Zoom to original:** Restores the preview to its original size. .. _options: @@ -62,18 +62,18 @@ Options **Other Options** -**Include slide text if available** +**Include slide text if available:** Check this to include all the text from songs or scripture. -**Add page break before each text item** +**Add page break before each text item:** If you have checked *include slide text if available* you can select this option to put each text item (songs, custom slides, scripture) on a separate page. -**Include service item notes** +**Include service item notes:** This option will include any notes you have added to the service items. -**Include play length of media items** +**Include play length of media items:** This option will print the length of media items in the service. Customizing with CSS (Advanced) @@ -306,11 +306,12 @@ The HTML layout should look something like this:: Edit the CSS file to produce the required style. + **Note:** not all CSS properties are supported. See `Qt4 CSS subset `_ for more information. -**Example: Item titles with notes on right hand side** +**Example:** Item titles with notes on right hand side. This service_print.css assumes the slide text will not be included.:: diff --git a/manual/source/songs.rst b/manual/source/songs.rst index 48ff77f..ed268ad 100644 --- a/manual/source/songs.rst +++ b/manual/source/songs.rst @@ -111,45 +111,51 @@ want to edit and rearrange the Title & Lyrics, Author, Topics & Song Book, assign a Theme, or edit Copyright Info & Comments, you will do this through the `Song Editor`. -**Edit:** To edit an existing song you can either click on a song in the -:ref:`media-manager` and then click the button to :guilabel:`Edit the selected song` -or right click a song from either the :ref:`media-manager` or additionally from -the :ref:`creating_service` and click :guilabel:`Edit item`. If you are adding a -new song click :guilabel:`Add a new Song` in the :ref:`media-manager`. +**Edit:** + To edit an existing song you can either click on a song in the + :ref:`media-manager` and then click the button to :guilabel:`Edit the selected song` + or right click a song from either the :ref:`media-manager` or additionally + from the :ref:`creating_service` and click :guilabel:`Edit item`. If you are + adding a new song click :guilabel:`Add a new Song` in the :ref:`media-manager`. .. image:: pics/song_edit_lyrics.png -**Title:** This is where you would name your song or edit a song name. +**Title:** + This is where you would name your song or edit a song name. -**Alternate title:** Alternate Title was for songs with two names -"Lord the Light" - "Shine Jesus Shine". You can also add a name in this box that -will bring up the song in Titles search. **Example:** You could use an alternate -title of "hymn" on all your hymn song titles for grouping. When you search "hymn" -it will show all the hymns that have "hymn" for the Alternate title. +**Alternate title:** + Alternate Title was for songs with two names "Lord the Light" - + "Shine Jesus Shine". You can also add a name in this box that will bring up + the song in Titles search. **Example:** You could use an alternate title of + "hymn" on all your hymn song titles for grouping. When you search "hymn" + it will show all the hymns that have "hymn" for the Alternate title. -**Lyrics:** The *Lyrics* window shows all lyrics imported or added. On the left -side of the lyrics you will see a capital letter followed by a number. A V1 -would represent verse 1, C1 would be Chorus 1. You will use these letters and -numbers for the order to display the lyrics. +**Lyrics:** + The *Lyrics* window shows all lyrics imported or added. On the left side of + the lyrics you will see a capital letter followed by a number. A V1 would + represent verse 1, C1 would be Chorus 1. You will use these letters and + numbers for the order to display the lyrics. -**Verse Order:** After you entered or edited your song, you will want OpenLP to -display the verses in the correct order you want them displayed. On the left side -of your lyrics you will see C1, V1, V2 etc. the way they were imported or added. -To put your lyrics in the correct order is as simple as typing in the -:guilabel:`Verse order box` at the bottom, the correct order you want them -displayed, with only a blank space in between each entry. The correct format will -look like this: V1 C1 V2 C1 V3 C1. If you forget to put a space in between the -order, or if you do not have the corresponding verse number, OpenLP will politely -tell you with a pop-up error message what is wrong so you can correct your -mistake and save it. Verse order is optional and if left blank the verses will -display in the order seen in *Lyrics*. +**Verse Order:** + After you entered or edited your song, you will want OpenLP to display the + verses in the correct order you want them displayed. On the left side of + your lyrics you will see C1, V1, V2 etc. the way they were imported or added. + To put your lyrics in the correct order is as simple as typing in the + :guilabel:`Verse order box` at the bottom, the correct order you want them + displayed, with only a blank space in between each entry. The correct format + will look like this: V1 C1 V2 C1 V3 C1. If you forget to put a space in + between the order, or if you do not have the corresponding verse number, + OpenLP will politely tell you with a pop-up error message what is wrong so + you can correct your mistake and save it. Verse order is optional and if + left blank the verses will display in the order seen in *Lyrics*. .. image:: pics/song_edit_verse_error.png -**Clone:** OpenLP gives you the ability to clone a song. This could be useful if -you use a different version of the song with slightly different lyrics. Instead -of typing in all the lyrics again, you can clone it which makes an identical -copy of the original song. +**Clone:** + OpenLP gives you the ability to clone a song. This could be useful if you + use a different version of the song with slightly different lyrics. Instead + of typing in all the lyrics again, you can clone it which makes an identical + copy of the original song. To *Clone* a song right-click on the song you would like to duplicate and left- click :guilabel:`Clone`. @@ -164,32 +170,37 @@ title. Adding or Editing the Lyrics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -**Add:** To Add a new verse, click on :guilabel:`Add`. The main window is where -you will type your lyrics. OpenLP is packaged with a spell checker for most -languages. If you misspell a word it will be underlined. Right click the -underlined word and left click *Spelling Suggestions* or you can ignore it and -continue typing. You also have the ability to format the font using *Formatting -Tags*. Highlight the word/words you want to format and right click the highlight. -Left click *Formatting Tags* and choose the format you want to apply to the font -and the format tags will be entered with your lyrics. These tags are not visible -when displayed. To remove the format, delete the tag on each end of the word or -sentence. +**Add:** + To Add a new verse, click on :guilabel:`Add`. The main window is where + you will type your lyrics. OpenLP is packaged with a spell checker for most + languages. If you misspell a word it will be underlined. Right click the + underlined word and left click *Spelling Suggestions* or you can ignore it + and continue typing. You also have the ability to format the font using + *Formatting Tags*. Highlight the word/words you want to format and right + click the highlight. Left click *Formatting Tags* and choose the format you + want to apply to the font and the format tags will be entered with your + lyrics. These tags are not visible when displayed. To remove the format, + delete the tag on each end of the word or sentence. -**Edit:** To edit an existing verse, click on the verse you wish to *Edit* then -click on :guilabel:`Edit`, make your changes and click :guilabel:`Save`. +**Edit:** + To edit an existing verse, click on the verse you wish to *Edit* then + click on :guilabel:`Edit`, make your changes and click :guilabel:`Save`. -**Edit All:** To edit the whole song at once, click on :guilabel:`Edit All`. +**Edit All:** + To edit the whole song at once, click on :guilabel:`Edit All`. -**Delete:** To delete a verse, click on the verse you want to delete and it will -highlight, click on the :guilabel:`Delete` button and it will be deleted. +**Delete:** + To delete a verse, click on the verse you want to delete and it will + highlight, click on the :guilabel:`Delete` button and it will be deleted. **Warning:** Once you click the :guilabel:`Delete` button, you will not be asked again, it will be deleted immediately. .. image:: pics/song_edit_verse_type.png -**Verse type:** gives you 7 ways to classify your lyrics. Verse, Chorus, Bridge, -Pre-Chorus, Intro, Ending, Other. +**Verse type:** + Select one of seven ways to classify your lyrics. Verse, Chorus, Bridge, + Pre-Chorus, Intro, Ending, Other. If you have more than one verse, you would number them Verse 1, 2, 3 as needed. If you find the verse has too many lines for your screen, you can edit and @@ -204,28 +215,33 @@ have an author entered. You can add a blank space for the author name. .. image:: pics/song_edit_authors.png -**Authors:** Click the drop down arrow to view all authors or start typing a name -in the box and a list will appear. If the authors name has not been added, type -the authors name in the box and click :guilabel:`Add to Song`. The authors name -will appear below and will also be added to your database. If you accidentally -add the wrong author you can click on the authors name and click :guilabel:`Remove`. +**Authors:** + Click the drop down arrow to view all authors or start typing a name in the + box and a list will appear. If the authors name has not been added, type + the authors name in the box and click :guilabel:`Add to Song`. The authors + name will appear below and will also be added to your database. If you + accidentally add the wrong author you can click on the authors name and click :guilabel:`Remove`. :guilabel:`Manage Authors, Topics, Song Books`: Clicking this button will bring up your complete list of authors. .. image:: pics/song_edit_maintenance.png -**Add:** Clicking the :guilabel:`Add` button will bring up a box where you will -add the Authors First name, Last name and Display name. Click :guilabel:`Save` -when you are finished. +**Add:** + Clicking the :guilabel:`Add` button will bring up a box where you will + add the Authors First name, Last name and Display name. Click :guilabel:`Save` + when you are finished. .. image:: pics/song_edit_author_maintenance.png -**Edit:** The :guilabel:`Edit` button will bring up window where you can edit -the info that is already there. +**Edit:** + The :guilabel:`Edit` button will bring up window where you can edit the info + that is already there. -**Delete:** The :guilabel:`Delete` button will remove the author you have -highlighted. Note: You cannot delete an author that is assigned to a song. +**Delete:** + The :guilabel:`Delete` button will remove the author you have highlighted. + +**Note:** You cannot delete an author that is assigned to a song. Authors names are displayed in the footer. Theme, Copyright Info & Comments @@ -237,21 +253,24 @@ this information will usually be entered. .. image:: pics/song_edit_theme_copyright.png -**Theme:** Click the drop down arrow to display your list of themes or start -typing a theme name in the box and the list will appear. You can also create a -new theme by clicking the :guilabel:`New Theme` button. +**Theme:** + Click the drop down arrow to display your list of themes or start typing a + theme name in the box and the list will appear. You can also create a new + theme by clicking the :guilabel:`New Theme` button. -**Copyright information:** Add or edit the copyright information in this box. If -you would like to use the © symbol click :guilabel:`©` button. This information -is displayed in the footer. +**Copyright information:** + Add or edit the copyright information in this box. If you would like to use + the © symbol click :guilabel:`©` button. This information is displayed in + the footer. -**CCLI number:** Enter the CCLI number in this box. +**CCLI number:** + Enter the CCLI number in this box. -**Note:** this is the CCLI number of the song, not your contract number. This +**Note:** This is the CCLI number of the song, not your contract number. This number is not displayed in the footer. -**Comments:** You can add comments in this box. This information is not -displayed in the footer. +**Comments:** + You can add comments in this box. This information is not displayed in the footer. .. _songs_linked: @@ -263,16 +282,18 @@ the song is displayed live. .. image:: pics/song_edit_linked.png -**Add File(s):** Add an audio file from a folder on your computer by clicking - :guilabel:`Add File(s)`. +**Add File(s):** + Add an audio file from a folder on your computer by clicking :guilabel:`Add File(s)`. -**Add Media:** Add an audio file that is already in the :ref:`media-manager` by - clicking :guilabel:`Add Media`. +**Add Media:** + Add an audio file that is already in the :ref:`media-manager` by clicking + :guilabel:`Add Media`. -**Remove:** Click on a file you want to remove and click :guilabel:`Remove`. +**Remove:** + Click on a file you want to remove and click :guilabel:`Remove`. -**Remove All:** Click on :guilabel:`Remove All` to remove all audio files linked - to the song. +**Remove All:** + Click on :guilabel:`Remove All` to remove all audio files linked to the song. If you added multiple audio files, they will play in the order listed. You can change their position in the order by clicking on an audio file and using the diff --git a/manual/source/themes.rst b/manual/source/themes.rst index ca09193..8dd4175 100644 --- a/manual/source/themes.rst +++ b/manual/source/themes.rst @@ -13,7 +13,8 @@ theme, Delete a theme, Import a theme, and Export a theme. Creating New Themes =================== -|theme_new| **Create a new theme:** This will bring up the *Theme Wizard* +|theme_new| **Create a new theme:** + This will bring up the *Theme Wizard* .. image:: /pics/theme_manager_wizard.png @@ -22,27 +23,31 @@ type: Solid Color, Gradient, or Image. .. image:: /pics/theme_manager_background.png -**Solid color:** Select solid color and click on the black button next to Color. -You have the option of choosing among the colors you see or entering your -own. +**Solid color:** + Select solid color and click on the black button next to Color. You have the + option of choosing among the colors you see or entering your own. .. image:: /pics/theme_manager_selectcolor.png -**Gradient:** Choose the two colors, *Starting* and *Ending* that you want to -fade together and the Gradient drop down will let you determine the directions -of the fade. +**Gradient:** + Choose the two colors, *Starting* and *Ending* that you want to fade + together and the Gradient drop down will let you determine the directions + of the fade. .. image:: /pics/theme_manager_gradient.png -**Image:** You have the ability to use an image for your background. OpenLP -accepts a variety of image types. +**Image:** + You have the ability to use an image for your background. OpenLP accepts a + variety of image types. .. image:: /pics/theme_manager_image.png -**Background color:** Choose the color that will appear on the borders if your -image is smaller than your projector display setting. +**Background color:** + Choose the color that will appear on the borders if your image is smaller + than your projector display setting. -**Image:** Click |buttons_open| to find and select your image. +**Image:** + Click |buttons_open| to find and select your image. **Note:** When possible, try to use the same size image as your projector is displaying unless you want a background color for a border. @@ -58,25 +63,33 @@ the Display text. .. image:: /pics/theme_manager_mainfont.png -**Font:** Choose the font you would like to use from the drop down. +**Font:** + Choose the font you would like to use from the drop down. -**Color:** Choose the color of your font. +**Color:** + Choose the color of your font. -**Size:** The size of your font determines how many lines are shown per slide. -As you change the font size, the lines per slide will change. +**Size:** + The size of your font determines how many lines are shown per slide. + As you change the font size, the lines per slide will change. -**Line Spacing:** This setting determines how much space you want between -lines. This setting will also change the lines per slide. +**Line Spacing:** + This setting determines how much space you want between lines. This setting + will also change the lines per slide. -**Outline:** If you desire an outline around your font, select the Outline box, -choose your color and size of the outline. +**Outline:** + If you desire an outline around your font, select the Outline box, choose + your color and size of the outline. -**Shadow:** If you desire a shadow around your font, select the Shadow box and -choose your color and size of the shadow. +**Shadow:** + If you desire a shadow around your font, select the Shadow box and choose + your color and size of the shadow. -**Bold Display:** Select the box for Bold font +**Bold Display:** + Select the box for Bold font -**Italic Display:** Select the box for Italic font +**Italic Display:** + Select the box for Italic font When you are finished selecting your font details click the :guilabel:`Next` button. @@ -100,13 +113,15 @@ from one slide to the next. .. image:: /pics/theme_manager_textalign.png -**Horizontal Align:** the text to the Left, Right or Center of the screen. +**Horizontal Align:** + This moves the text to the Left, Right or Center of the screen. -**Vertical Align:** the text to the Top, Middle or bottom of the screen. +**Vertical Align:** + This moves the text to the Top, Middle or bottom of the screen. -**Transitions:** When this box is selected, switching slides will fade out from -one and fade in to the next. When the box is not selected, slide changing will -be instant. +**Transitions:** + When this box is selected, switching slides will fade out from one and fade + in to the next. When the box is not selected, slide changing will be instant. When you are finished setting your Text Formatting Details, click :guilabel:`Next`. @@ -132,11 +147,13 @@ Save and Preview .. image:: /pics/theme_manager_save.png -**Theme Name:** Enter your theme name here. +**Theme Name:** + Enter your theme name here. -**Preview:** The Preview shows the choices you made when setting up the previous -pages plus, shows all the edit effects possible so you can see what the impact -is on all possible font colors and characteristics. +**Preview:** + The Preview shows the choices you made when setting up the previous pages + plus, shows all the edit effects possible so you can see what the impact + is on all possible font colors and characteristics. When you are satisfied with your selections, click :guilabel:`Finish`. If you want to make a change, use the :guilabel:`Back` button. @@ -152,11 +169,12 @@ the appropriate action. Deleting Themes =============== -|theme_delete| Delete a selected theme or you can right-click your theme and -select :guilabel:`Delete`. +|theme_delete| **Delete a theme:** + Delete a selected theme or you can right-click your theme and select + :guilabel:`Delete`. -**Note:** Deleting the currently selected global theme or the -default theme is not possible. +**Note:** Deleting the currently selected global theme or the default theme is +not possible. .. _export_themes: