Merge branch 'master', remote-tracking branch 'home/master'
[gmpc.git] / doc / Markup.txt
blobacf0d796b8f6ec030db1562cb92ee8ef5373f983
1 This is the song markup that can be used:
3 All this info is read from the id3tags.
4 %name%          -Name of the playing stream.
5 %artist%        -Artist name
6 %album%         -Album name
7 %title%         -Song Title 
8 %track%"        -Track. (as defined in the tag, this can be a single value but also a string.)
9 "%time%"        -Total song time
10 %date%          -The date of the song
11 "%file%".       -Filename (includes path and extension)
12 %shortfile%     -filename without path and extension.
14 The [] operator  is  used  to  group  output  such  that if no metadata delimiters are found or matched between '[' and ']',  then  none of the  characters between '[' and ']' are output.  
15 '&' and '|' are logical operators for and and or.  '#'  is  used  to  escape characters.   
16 Some  useful examples for format are: "%shortfile%" and "[[%name% - ][%artist% - ]%title%]|[%shortfile]"
18 Gmpc also supports breaklines, so you can display the info like:
19 ---------------------------------
20 |Stevie Wonder                  |
21 |Superstitious                  |
22 |The Very Best off (track: 9)   |
23 ---------------------------------
25 Example markup for this could be:
26 [%name%: 
27 &[%artist% - ]%title%]|%name%|[%artist% 
28 &%title%
29 &%album%]|[%artist%
30 &%title%]|%shortfile%
32 The markup editor in version 0.12 allows you to preview your markup format. 
33 The markup's aren't instant apply. 
34 In the playlist songs use the new markup when added later, or the id3 info has changed.
35 In the file/artist/search browser the new markup is used when the data in the right pane is changed.
36 In the player the new markup is used after song change.