summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Parker <rockbox@aeparker.com>2010-09-17 19:13:14 +0000
committerAlex Parker <rockbox@aeparker.com>2010-09-17 19:13:14 +0000
commit779f1dbc7aba3f50d0331dc71193dedf9cf4ba3d (patch)
tree65b82ddef9b0583d1eace4ec77fcf9944c39bf82
parentf6912d3bbb9a2f7f46c72a42fc2d7d7b3c3343b3 (diff)
downloadrockbox-779f1dbc7aba3f50d0331dc71193dedf9cf4ba3d.tar.gz
rockbox-779f1dbc7aba3f50d0331dc71193dedf9cf4ba3d.tar.bz2
rockbox-779f1dbc7aba3f50d0331dc71193dedf9cf4ba3d.zip
Manual: Add the %if tag to the manual. Closes bug FS#11555.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28097 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/appendix/wps_tags.tex20
1 files changed, 20 insertions, 0 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 703cded4ba..acaeb18cd6 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -493,8 +493,28 @@ Example: \config{\%ax\%V(\dots)}
& If / Else: Evaluate for true or false case \\
\config{\%?xx<alt1|alt2|\tabnlindent{}alt3|\dots|else>}
& Enumerations: Evaluate for first / second / third / \dots / last condition \\
+\config{\%if(tag, operator, operand, [option count])}
+ & Allows very simple comparisons with other tags.\newline
+ \config{tag}: the tag to check against.\newline
+ \config{operator}: the comparison to perform - possible options are =, !=,
+ >, >=, <, <=\newline
+ \config{operand}: either a second tag, a number, or text.\newline
+ \config{[option count]}: optional parameter used to select which parameter
+ of a tag to use when the tag has multiple options, e.g. \%?pv<a|b|c|d>\\
\end{tagmap}
+Examples of the \%if tag:\\
+
+\config{\%?if(\%pv, >=, 0)<Clipping possible|Volume OK>} will display ``Clipping
+ possible'' if the volume is higher than or equal to 0 dB, ``Volume OK'' if it
+ is lower.\\
+
+\config{\%?if(\%ia, =, \%Ia)<same artist>} -- this artist and the next artist
+ are the same.\\
+
+\note{When performing a comparison against a string tag such as \%ia, only = and
+ != work, and the comparison is not case sensitive.}
+
\section{Subline Tags}
\begin{tagmap}