summaryrefslogtreecommitdiff
path: root/docs/CUSTOM_WPS_FORMAT
diff options
context:
space:
mode:
Diffstat (limited to 'docs/CUSTOM_WPS_FORMAT')
-rw-r--r--docs/CUSTOM_WPS_FORMAT53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/CUSTOM_WPS_FORMAT b/docs/CUSTOM_WPS_FORMAT
index 9a11c398cd..11d53859a8 100644
--- a/docs/CUSTOM_WPS_FORMAT
+++ b/docs/CUSTOM_WPS_FORMAT
@@ -76,11 +76,64 @@ Conditional Tags (If/Else block):
76 so the text in the if and else part can contain all % 76 so the text in the if and else part can contain all %
77 commands, including conditionals. 77 commands, including conditionals.
78 78
79Alternating Sublines
80--------------------
81It is possible to group items on each line into 2 or more groups or "sublines".
82Each subline will be displayed in succession on the line for a specified time,
83alternating continuously through each defined subline.
84
85Items on a line are broken into sublines with the semicolon ';' character. The
86display time for each subline defaults to 2 seconds unless modified by using
87the '%t' tag to specify an alternate time (in seconds and optional tenths of a
88second) for the subline to be displayed.
89
90Subline related special characters and tags:
91 ; : Split items on a line into separate sublines
92 %t : Set the subline display time. The '%t' is followed by either integer
93 seconds (%t5), or seconds and tenths of a second (%t3.5).
94
95
96Each alternating subline can still be optionally scrolled while it is being
97displayed, and scrollable formats can be displayed on the same line with
98non-scrollable formats (such as track elapsed time) as long as they are
99separated into different sublines.
100
101 Example subline definition:
102
103 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds,
104 Display id3 title for 2 seconds,
105 Display current and remaining track time
106 for 3 seconds,
107 repeat...
108
109Conditionals can be used with sublines to display a different set and/or number
110of sublines on the line depending on the evaluation of the conditional.
111
112 Example subline with conditionals:
113
114 %?it<%t8%s%it|%s%fn>;%?ia<%t3%s%ia|%t0>
115
116 The format above will do two different things depending if ID3
117 tags are present. If the ID3 artist and title are present :
118
119 Display id3 title for 8 seconds,
120 Display id3 artist for 3 seconds,
121 repeat...
122
123 If the ID3 artist and title are not present :
124 Display the filename continuously.
125
126Note that by using a subline display time of 0 in one branch of a conditional,
127a subline can be skipped (not displayed) when that condition is met.
128
129-----------
130
79Other Tags: 131Other Tags:
80 %% : Display a '%' 132 %% : Display a '%'
81 %< : Display a '<' 133 %< : Display a '<'
82 %| : Display a '|' 134 %| : Display a '|'
83 %> : Display a '>' 135 %> : Display a '>'
136 %; : Display a ';'
84 %s : Indicate that the line should scroll. Can occur anywhere in 137 %s : Indicate that the line should scroll. Can occur anywhere in
85 a line (given that the text is displayed; see conditionals 138 a line (given that the text is displayed; see conditionals
86 above). You can specify up to 10 scrolling lines. 139 above). You can specify up to 10 scrolling lines.