John Cegalis has proposed merging lp:~jseagull1/openlp/documentation into lp:openlp.
Requested reviews: Raoul Snyman (raoul-snyman) Andreas Preikschat (googol-hush) Jon Tibble (meths) John Cegalis (jseagull1) For more details, see: https://code.launchpad.net/~jseagull1/openlp/documentation/+merge/55987 First Run Wizard changed wording around fixed Alert -- https://code.launchpad.net/~jseagull1/openlp/documentation/+merge/55987 Your team OpenLP Core is subscribed to branch lp:openlp.
=== added file 'documentation/manual/source/alert.rst' --- documentation/manual/source/alert.rst 1970-01-01 00:00:00 +0000 +++ documentation/manual/source/alert.rst 2011-04-01 18:44:27 +0000 @@ -0,0 +1,59 @@ +===== +Alert +===== + +:menuselection:`Tools --> Alert` +-------------------------------- + +You may find it necessary to display an Alert on your screen, ie: car headlights +left on, parent needed in nursery, or anything else somebody may need notified +about. This is easily accomplished using the Alert, 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. + +:guilabel:`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 +by side, will insert any text you have in the parameter box into the Alert +message. + +Examples of use +--------------- + +:guilabel:`Alert text:` The owner of the vehicle with license plate number <> +your lights are on. + +:guilabel:`Parameter:` HNN432 + +These two settings will display like this: + +The owner of the vehicle with the license plate number HNN432 your lights are on. + +You could also reverse this example: + +:guilabel:`Alert text:` HNN432 <> + +:guilabel:`Parameter:` left their lights on. + +`Will display like this:` HNN432 left their lights on. + +If you use the same alerts on a regular basis, Save your Alert and you will have +access to the alert with a click of the mouse. You may also click on New for a +new alert or Delete an alert you do not need. + +When you are ready to Display your Alert you have two options. Clicking on +Display will display the Alert and the Alert Message window will remain open. +Clicking Display & Close will display the alert and close the Alert Message +window. + +All details of the display, font, color, size and position are adjusted from the +top Menu item :menuselection:`Settings --> Configure OpenLP`, Alert tab and the +instructions here. :doc:`configure` + +**Please note:** Alert Message is a Plugin that needs to be Active in the Plugin +List for use. \ No newline at end of file === modified file 'documentation/manual/source/index.rst' --- documentation/manual/source/index.rst 2011-03-28 21:54:49 +0000 +++ documentation/manual/source/index.rst 2011-04-01 18:44:27 +0000 @@ -13,10 +13,12 @@ introduction glossary + wizard dualmonitors configure bibles themes mediamanager songs + alert troubleshooting === removed file 'documentation/manual/source/mediamanager.rst' --- documentation/manual/source/mediamanager.rst 2011-03-31 14:44:42 +0000 +++ documentation/manual/source/mediamanager.rst 1970-01-01 00:00:00 +0000 @@ -1,250 +0,0 @@ -============= -Media Manager -============= - -Once you get your system set up for OpenLP you will be ready to add content to -your Service Manager. This will all happen through the **Media Manager**. The -`Media Manager` contains all the Bibles, Songs, Presentations, Media, and -everything else that you will project through OpenLP. - -Enabling the Plugins --------------------- - -You may need to enable the plugins that came with OpenLP. As you can see below -this is what the `Media Manager` looks like with all the plugins enabled. - -.. image:: pics/mediamanager.png - -To enable the plugins navigate to :menuselection:`Settings --> Plugins` or -press :kbd:`Alt+F7`. You will want to click on the plugin to the left that you -would like to enable and select **active** from the drop down box to the right. - -.. image:: pics/plugins.png - - -You are now ready to add content for your service. - -Adding Media Content --------------------- - -This section will describe how to add the different types of media OpenLP is -capable of displaying. - -Songs -^^^^^ -Clicking on Songs in the Media Manager will display all of the songs you have -added by Title and Author/Authors. - -Using the buttons you can: - -`Add a song:` Brings up the dialog box to add a new song - -`Edit the selected song:` Brings up the dialog box to make changes to the song - -`Delete the selected song:` Removes the song from your song list - -`Preview the selected song:` Lets you see what your song will look like -displayed live - -`Send the selected song live:` This option will immediately display your song -live. - -`Add the selected Song to the service:` This will enter your song in the Service -Manager. You may also drag your song over to the Service Manager. - -`Maintain the list of authors, topics and books:` Brings up a dialog box to edit -Authors, Topics or Song Books. -Note: Right clicking on a song file will bring up some of the same options. - -Bibles -^^^^^^ -Clicking on Bibles in the Media Manager will display your options for searching -and adding chapters and verses to the Service Manager. - -Using the buttons you can: - -`Import a Bible:` This is discussed in detail on the Bible Importer page in the -manual. - -`Preview the selected Bible:` Sends your selected verses to the Preview window - -`Send the selected Bible live:` This option will immediately display your -selected verses live. - -`Add the selected Bible to the service:` This will enter your verses into the -Service Manager. You may also click and drag your verses over to the Service -Manager. - -**Quick tab** - -`Version:` Once you have imported a Bible, it will be displayed in the Version -drop down box. Select the version of the Bible you want to use here. - -**Second** - -If you have âDisplay second Bible versesâ selected in Configure OpenLP, Bibles -tab, this choice will be visible. This option is for displaying another version -of the Bible for comparison. Both versions will be displayed. If there is not -enough space on one slide, the Second version will be displayed on the next -slide. - -Use the `Search` button to display your results in the box below. - -**Find** - -You will type your search query in this box for the following two searches. - -`Search type:` You may search for a specific verse using this format below. - -Book Chapter -Book Chapter-Chapter -Book Chapter:Verse-Verse -Book Chapter:Verse-Verse, Verse-Verse -Book Chapter:Verse-Verse,Chapter:Verse-Verse -Book Chapter: Verse-Chapter:Verse - -`Text Search:` - -You may also search by a keyword or words. The more words you use for the -search, the more you will narrow down your results. - -**Results** `Clear and Keep.` - -Each search you make will display your verses below. If you would like to -display verses that are out of sequence you may select `Keep` in the drop down -box and continue your search for the next verse or verses. All searches will be -shown and kept below. -If you select `Clear` from the drop down box, each new search clears the -previous search from the list below. - -**Advanced tab** - -This tab is convenient for selecting book, chapter and verse by name and number. -Version and Second are the same as in Quick tab above. Click on each box and -select the version you wish to display and Second version if you wish to display -an alternative version. - -Use the `Search` button to display your results in the box below. - -`Book:` Click on the drop down box and select the book you want to display. -`Chapter: Verse:` Select your chapter From and To and Verse From and To - -Results will work the same as the Quick tab above. - -Presentations -^^^^^^^^^^^^^ -Using the buttons you can: - -`Load a new presentation:` This brings up a dialog box to find your presentation -and list it in OpenLP. - -`Delete the selected Presentation:` This removes your Presentation from the list. -Please note: this will not delete the presentation from your computer, only from -the OpenLP list. - -`Preview the selected Presentation:` Sends your selected Presentation to the -Preview window - -`Send the selected Presentation live:` This option will immediately display your -selected Presentation live. - -`Add the selected Presentation to the service:` This will enter your -Presentation into the Service Manager. You may also click and drag your -Presentation over to the Service Manager. - -Right clicking on a Presentation file will bring up some of the same options. - -Images -^^^^^^ -Using the buttons you can: - -`Load a new Image:` This brings up a dialog box to find your Image and list it -in OpenLP. - -`Delete the selected Image:` This removes your Image from the list. Please note: -this will not delete the Image from your computer, just the OpenLP list. - -`Preview the selected Image:` Sends your selected Image to the Preview window - -`Send the selected Image live:` This option will immediately display your -selected Image live. - -`Add the selected Image to the service:` This will enter your Image into the -Service Manager. You may also click and drag your Image over to the Service -Manager. - -`Replace Live Background:` With an Image selected, clicking this button will -immediately replace the live background being displayed with your selection. -The Image will replace the theme background until the theme changes or the -"Remove Background" button is pressed. - - -Right clicking on an Image file will bring up some of the same options. - -Media -^^^^^ - -Media is an audio or video file. Generally if you can play or view your media -on your computer without OpenLP, you can also play it in OpenLP. - -Using the buttons you can: -`Load a new Media:` This brings up a dialog box to find your Media and list it -in OpenLP. - -`Delete the selected Media:` This removes your Media from the list. Please note: -this will not delete the Media from your computer, just the OpenLP list. - -`Preview the selected Media:` Sends your selected Media to the Preview window - -`Send the selected Media live:` This option will immediately display your -selected Media live. - -`Add the selected Media to the service:` This will enter your Media into the -Service Manager. You may also click and drag your Media over to the Service -Manager. - -`Replace Live Background:` With a Media file selected, clicking this button will -immediately replace the live background being displayed with your selection. - -Right clicking on a Media file will bring up some of the same options. - -Custom -^^^^^^ - -Custom gives you the option of creating your own slide. This could be useful for -displaying readings, liturgy or any text that may not be found in Songs or -Bibles. - -`Add a new Custom:` Brings up the dialog box to add a new Custom display. -`Edit the selected Custom:` Brings up the dialog box to make changes to the -Custom display. - -`Delete the selected Custom:` Remove the Custom from your list - -`Preview the selected Custom:` Lets you see what your Custom will look like -displayed live - -`Send the selected Custom live:` This option will immediately display your -Custom live - -`Add the selected Custom to the service:` This will enter your Custom in the -Service Manager. You may also drag your Custom over to the Service Manager. - -Right clicking on a Custom file will bring up some of the same options. - -When you Add a new Custom slide a dialog box will appear. - -`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. - -`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 Save button. - -To Edit your slide, click on the Edit button to edit part of it or the Edit All -if you need to make multiple changes. Use the Up and Down arrows to change the -arrangement of your Custom slide. === added file 'documentation/manual/source/pics/001-first-time-language.png' Binary files documentation/manual/source/pics/001-first-time-language.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/001-first-time-language.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/002-first-time-wizard-welcome.png' Binary files documentation/manual/source/pics/002-first-time-wizard-welcome.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/002-first-time-wizard-welcome.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/003-first-time-wizard-plugins.png' Binary files documentation/manual/source/pics/003-first-time-wizard-plugins.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/003-first-time-wizard-plugins.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/004-first-time-wizard-songs.png' Binary files documentation/manual/source/pics/004-first-time-wizard-songs.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/004-first-time-wizard-songs.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/005-first-time-wizard-bibles.png' Binary files documentation/manual/source/pics/005-first-time-wizard-bibles.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/005-first-time-wizard-bibles.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/006-first-time-wizard-themes.png' Binary files documentation/manual/source/pics/006-first-time-wizard-themes.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/006-first-time-wizard-themes.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/007-first-time-wizard-settings.png' Binary files documentation/manual/source/pics/007-first-time-wizard-settings.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/007-first-time-wizard-settings.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/009-first-time-wizard-progress.png' Binary files documentation/manual/source/pics/009-first-time-wizard-progress.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/009-first-time-wizard-progress.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/010-first-time-wizard-finished.png' Binary files documentation/manual/source/pics/010-first-time-wizard-finished.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/010-first-time-wizard-finished.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/011-first-time-wizard-song-import.png' Binary files documentation/manual/source/pics/011-first-time-wizard-song-import.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/011-first-time-wizard-song-import.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/012-openlp-main-window.png' Binary files documentation/manual/source/pics/012-openlp-main-window.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/012-openlp-main-window.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/pics/alert.png' Binary files documentation/manual/source/pics/alert.png 1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/alert.png 2011-04-01 18:44:27 +0000 differ === added file 'documentation/manual/source/wizard.rst' --- documentation/manual/source/wizard.rst 1970-01-01 00:00:00 +0000 +++ documentation/manual/source/wizard.rst 2011-04-01 18:44:27 +0000 @@ -0,0 +1,102 @@ +================ +First Run Wizard +================ + +When using OpenLP for the first time, the **First Run Wizard** will help you +with setting up your installation. This wizard is not intended to be a +comprehensive setup but will help you with the basics. + +Select Translation +------------------ + +.. image:: pics/001-first-time-language.png + +You can choose the translation you want to use or let OpenLP +automatically select it based on your operating system locale. Click +:guilabel:`OK` to continue. + +The "Welcome to the First Time Wizard" dialog box will appear next. Click +:guilabel:`Next`. + +.. image:: pics/002-first-time-wizard-welcome.png + +Activate required Plugins +------------------------- + +.. image:: pics/003-first-time-wizard-plugins.png + +OpenLP has several plugins to choose from. By default, all plugins are enabled, +except the *Remote Access* plugin. For more information on these plugins, please +read the :doc:`mediamanager` section in the manual. If you are not sure of which +plugins to enable or disable, leave the selection as-is. You can easily activate +or deactivate plugins later, when OpenLP is running, by going to +:menuselection:`Settings --> Plugin List`. Click :guilabel:`Next` to continue. + +Sample Songs +------------ + +.. image:: pics/004-first-time-wizard-songs.png + +OpenLP provides some sample songs in a few languages for downloading and +importing into your new song database. This is convenient for new users who do +not have any songs yet. If you already have songs in your database, OpenLP will +simply add these sample songs to your database, leaving your existing songs +intact. Once you are happy with which songs you'd like, click :guilabel:`Next`. + +Sample Bibles +------------- + +.. image:: pics/005-first-time-wizard-bibles.png + +There are also a number of free Bibles that you can download and install. Using +the check box next to each Bible, select each Bible that you would like +installed. If you do not wish to install any Bibles, simply leave them all +unchecked. Once you are happy with your selection, click :guilabel:`Next` to +continue. + +Sample Themes +------------- + +.. image:: pics/006-first-time-wizard-themes.png + +Some sample themes are also available for download and installation into OpenLP. +As with the Bibles, simply check the check box next to each theme to select it. +If you are a new user, these themes can help you understand how themes work. If +you are happy with your selected themes, click :guilabel:`Next` to continue. + +Default Settings +---------------- + +.. image:: pics/007-first-time-wizard-settings.png + +Default Display Monitor +^^^^^^^^^^^^^^^^^^^^^^^ + +Screen 2. If you are installing OpenLP but are not connected to a second output +at the time, you can set this up later by going to +:menuselection:`Settings --> Configure OpenLP`. + +Default Theme +^^^^^^^^^^^^^ + +If you have selected one or more themes on the themes page of the wizard, you +can select which theme you'd like to be the default theme. + +If you are happy with the selections you have made, click :guilabel:`Next` to +continue to the next page. + +.. image:: pics/009-first-time-wizard-progress.png + +Making progress. + +.. image:: pics/010-first-time-wizard-finished.png + +On the last page of the wizard, OpenLP will download the sample songs, Bibles +and themes, and set up OpenLP for you. Click :guilabel:`Finish` and OpenLP will +start. + +.. image:: pics/011-first-time-wizard-song-import.png + +The main window. + +.. image:: pics/012-openlp-main-window.png
_______________________________________________ Mailing list: https://launchpad.net/~openlp-core Post to : openlp-core@lists.launchpad.net Unsubscribe : https://launchpad.net/~openlp-core More help : https://help.launchpad.net/ListHelp