Document %mv wps tag (FS#9482 by Alexander Levin).

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18779 a1c6a512-1295-4272-9138-f99709370657

1 files changed, 22 insertions, 0 deletions

diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index a1d4689..016bf28 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -170,6 +170,28 @@ Example: \config{\%?mm{\textless}Off{\textbar}All{\textbar}One{\textbar}Shuffle%
 Example: \config{\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}%
 Ffwd{\textbar}Rew{\textgreater}}
 
+\section{Changing Volume}
+\begin{table}
+  \begin{tagmap}{}{}
+    \config{\%mv[t]} & ``v'' if the volume is being changed\\
+  \end{tagmap}
+\end{table}
+
+The tag produces the letter ``v'' while the volume is being changed and some
+amount of time after that, i.e. after the volume button has been released. The
+optional parameter \config{t} specifies that amout of time. If it is not
+specified, 1 sec is assumed.
+
+The tag can be used as the switch in a conditional tag to display different things
+depending on whether the volume is being changed. It can produce neat effects
+when used with conditional viewports.
+
+Example: \config{\%?mv2.5{\textless}Volume changing{\textbar}\%pv{\textgreater}}
+
+The example above will display the text ``Volume changing'' if the volume is
+being changed and 2.5 secs after the volume button has been released. After
+that, it will display the volume value.
+
 \section{Images}
 \begin{table}
   \begin{tagmap}{}{}