Documentation: Editing songs

bzr-revno: 1473

documentation/manual/source/songs.rst

@@ -99,4 +99,134 @@ completed.
 Press :guilabel:`Finish` and OpenLP will be ready to use your songs imported
 from CCLI SongSelect.
 
+Creating or editing a song slide
+================================
 
+If you want to create a new song slide or, once you have a song imported, you 
+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 
+`Media Manager` and then click the button to :guilabel:`Edit the selected song` 
+or right click a song from either the `Media Manager` or additionally from the 
+`Service Manager` and click :guilabel:`Edit item`. If you are adding a new song 
+click :guilabel:`Add a new Song` in the `Media Manager`.
+
+.. image:: pics/song_edit_lyrics.png
+
+**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. 
+
+**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*.
+
+.. image:: pics/song_edit_verse_error.png
+
+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. 
+
+**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`.
+ 
+**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. 
+
+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 
+shorten the verse and :guilabel:`Add` another slide. 
+
+Authors, Topics & Song Book
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Once your *Title & Lyrics* are added or edited the way you want them you must 
+add or enter the author or authors of the song. OpenLP requires all songs to 
+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 accidently 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.
+
+.. 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.
+
+**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
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+On this tab you can assign a *Theme* to a song, enter the *Copyright information*
+and add the *CCLI number*. If you imported a song from SongSelect 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. 
+
+**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. 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 
+dispayed in the footer.