Song Tools Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Song Manager: Editing a song file ======
To edit a song file, you can simply type or copy your text, chords and tabs into the [[songmanager:overview|editor section (12)]].\\
Or you can open any text file and edit it.

===== New file =====
To create a new file, click [[songmanager:overview|{{:songmanager:sm-new.png|New button (1)}}]].\\
All contents of the [[songmanager:overview|editor (12)]] and the [[songmanager:overview|song information section (11)]] will be deleted or set to defaults.

===== Open a file =====
To open a file, click [[songmanager:overview|{{:songmanager:sm-open.png|Open button (2)}}]].\\
You can open any text file whether it was created with Song Manager or not.

===== Save a file =====
To save your edited file, click [[songmanager:overview|{{:songmanager:sm-save.png|Save button (3)}}]].\\
As long as the file was not saved before, it will open a dialog to choose where you want to save the file.\\
The suggested file name will be "//artist// - //title//.txt", where //artist// and //title// will have the values you entered into the corresponding [[songmanager:overview|song information fields (11)]].

===== Song information section =====
The [[songmanager:overview|song information section (11)]] can be seen as part of the file.\\
In this section you can enter important information which will be saved as part of the song file and help you to play the song always the same way. Part of it are:
  * **Title:** The song title (also second part of the suggested filename)
  * **Artist:** The artist or band name (also first part of the suggested filename)
  * **Tuning:** Tuning information for string instruments (lowest to highest string)
  * **Capo:** Capo position on fret //1-12// or //NO// capo.
  * **Key:** The key in which the song is played
  * **StSL:** The song ID from the matching song in your StreamerSonglist.com account

==== Title and Artist ====
It is strongly recommended to always enter this information (at least the title). The songs will be sorted by it in the lists later and will not show up, if it is missing.

==== Tuning ====
This information is optional. The initial value is __E A D G B E__ (guitar standard tuning). It describes the tuning of the strings from the lowest to highest. If your guitar is tuned a half step down for this song, it could be __Eb Ab Db Gb Bb Eb__. If the song is for ukulele, the standard tuning will be __g C E A__.

==== Capo ====
You can select on which fret a capo has to be set for the song. The initial value is //NO//. The selection only goes from 1 to 12, because a higher fret is nearly never needed. But if you want, you can change it manually in the text file later. If you only capo single strings, you should set this to //NO// and add a comment to your file which describes your setting.

==== Key ====
The initial value is -, for no key selected.\\
You can select the key, the song is played in, to always have this information on hand for sessions with other musicians, your band (e.g. if you shared the file with them), etc.

==== StSL button ====
This button just opens another input field for the **StreamerSonglist.com song ID**. The name was just so long, it did not fit in.\\
You can find this ID if you go to your StreamerSonglist.com page, select the song and click on **i**(Details). It opens the details page of the song and if you look at the URL it will show something like ...streamersonglist.com/t///streamername///songs/**123456**\\
This number is the song ID of the selected song.

By the way: You don't have to set the song ID manually. It can also be read automatically from your account, if the title and artist of the song match. [[songmanager:account#get_song_ids_from_stsl|Learn how.]]

===== The Convert button =====
(or where the magic happens)

**Before saving your file, you should always click [[songmanager:overview|{{:songmanager:sm-convert.png|Convert button (8)}}]], if you changed any song information!**

==== What it does ====
If you click this button, the [[filesyntax:start#information_line|song information line]] is generated or updated with the values you entered into the [[songmanager:overview|song information section (11)]].

Also, all chords are recognized and if there's nothing else than chords in the same line, the line is marked with **>** at the beginning.

Last but not least, the convert options selected in the [[songmanager:overview|convert options section (9)]] will be applied to the file.

As an example, copy the following text to your [[songmanager:overview|editor section (12)]]
<code>
;This is a comment.

[Verse]
C       D/F#             G
This is just some sample Text
Cadd9              Em7                      G
To show you how to format your chord sheets correctly


[Chorus]
G    Cadd9     D     Dsus4
Here comes the chorus
</code>

Fill the fields **Title** and **Artist** with //Some Title//, //Some Artist// and select **Capo** //3// and set the key to //Bb//.\\
Now click [[songmanager:overview|{{:songmanager:sm-convert.png|Convert button (8)}}]] and see, what happens to our file.

===== Convert options =====
{{:songmanager:sm-convopt.png|}}

**Remove Double Breaks**: Removes duplicated line breaks and leaves only one.\\
If you take the example from before, check this box and click [[songmanager:overview|{{:songmanager:sm-convert.png|Convert button (8)}}]] again, the two breaks between verse and chorus should only be one now.

**Remove Empty Lines**: Removes lines which are completely empty.\\
Check this option, uncheck the other one, and click [[songmanager:overview|{{:songmanager:sm-convert.png|Convert button (8)}}]] again. Now all empty lines are gone.

Normally, you won't need this option that often. But if you copy from some websites, it sometimes leaves empty lines in between all your lines and your files look like this

<code>
 
[Verse]

C       D/F#             G

This is just some sample Text

Cadd9              Em7                      G

To show you how to format your chord sheets correctly

 
[Chorus]

G    Cadd9     D     Dsus4

Here comes the chorus

</code>

If you use the **Remove Empty Lines** option on this example, it will come out well formatted.\\

__But be careful:__ There's a reason, the option unchecks itself after use. If you use it twice, there will be no empty lines left!


===== Additional information =====
In some chord sheets you will find lines like
<code>Cadd9   D    G x2</code>
Technically, this is not correct and those lines won't be automatically marked as chord lines.

There are two options you have.
  - Simply add the **>** symbol before this line manually. It will not affect any functions.
  - This is the preferred and well-formed option: Make two lines out of it, as shown below.

<code>
;2x
>Cadd9   D    G
</code>

or 

<code>
>Cadd9   D    G
;x2
</code>