steida / songary

TODO: Back up songary/firebase/export.js
MIT License
35 stars 7 forks source link

make help page from #17

Open steida opened 9 years ago

steida commented 9 years ago
Chordpro Format

SongBook stores songs in the chordpro format, a simple format for notation of lyrics together with chords. Using your Internet search engine you can find huge collections of songs in chordpro format in the Word Wide Web.

In the chordpro format chords are denoted in square brackets [] in the text, e.g.

[Em]Alas, my [G]love, you [D]do me [Bm]wrong,

SongBook will render this as

Em       G         D     Bm
Alas, my love, you do me wrong,

In addition to the chords in square brackets, the chordpro format defines several control sequences in curly brackets {}. Songbook understands the following control statements:

{title: ...} or {t: ...}    
Song title. This is displayed in the song list screen and in the title bar.

{subtitle: ...} or {st: ...}    Song subtitle, typically the interpret or composer. This is displayed in the song list screen and in the title bar.
{c: ...}    Comment, e.g. Repeat 2x or Chorus. Comments are rendered inverse.
{soc} and {eoc} Start and end of chorus. Chorus is indicated by a black line to the left.
{sot} and {eot} Start and end of tab. A tab (tablature) section is rendered in a fixed width font.
{soh} and {eoh} Start and end of highlight marker. Use {soh #rrggbb} for highlighting in arbitrary web colors (e.g. {soh #00FF00} to highlight with green background).
{define ...}    Used to define a special chord for this song. The chord format is
<chord name> <base fret> <string 6> ...<string 1>, i.e. 
G 1 3 2 0 0 0 3
#   Lines starting with # are comment lines and are ignored in the song view.
SongBook specific controls
{tempo: ...}    Defines scroll speed used for auto-scrolling. Device-specific as tempo-iphone, tempo-ipad or tempo-android. The value is 1 to 400, with 1=1s/pixel and 400 = 0.025s/pixel
{time: mm:ss}   (Android only) Total playing time of song, used for auto-scrolling independent of zoom-factor. Supersedes tempo.
{pause: ...}    (iOS/Android/Mac) If this line reaches the top of the screen, auto-scrolling will pause for the specified number of seconds (also works on beginning of song)
{metronome: ...}    Defines the metronome tempo for this song (beats per minute)
{key: ...}  Key of the current song, used e.g. for transposition. If not set, SongBook uses the first [chord] in the song as key.
{zoom: ...} Zoom size for current song. Device-specific as zoom-iphone, zoom-ipad, zoom-android. 1 is original size (depending on font preferences).
{tag: ...}  (iOS/Android/Mac) an arbitrary tag for a song, can be used multiple times
{instrument: ...}   (iOS/Android) Load specific instrument only for this song
SongBook will also recognize hyperlinks in the song text, e.g. www.linkesoft.com, http://linkesoft.com, file://path/to/file etc.

http://linkesoft.com/songbook/chordproformat.html