summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Parker <rockbox@aeparker.com>2010-09-17 19:13:20 +0000
committerAlex Parker <rockbox@aeparker.com>2010-09-17 19:13:20 +0000
commit15258e0a5b7a5e86728611261aa1c2ac8da7e34e (patch)
treef0bc58e81ea9c81f9e86d38b864a06b65687c8e8
parent779f1dbc7aba3f50d0331dc71193dedf9cf4ba3d (diff)
downloadrockbox-15258e0a5b7a5e86728611261aa1c2ac8da7e34e.tar.gz
rockbox-15258e0a5b7a5e86728611261aa1c2ac8da7e34e.tar.bz2
rockbox-15258e0a5b7a5e86728611261aa1c2ac8da7e34e.zip
Manual: add the bar tag themeing possibilites to the manual. Closes bug FS#11543.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28098 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/appendix/wps_tags.tex35
1 files changed, 35 insertions, 0 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index acaeb18cd6..0bb25dea91 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -3,6 +3,9 @@
Themeing is discussed in detail in section \reference{ref:ConfiguringtheWPS},
what follows is a list of the available tags.
+\note{The ``bar-type tags'' (such as \%pb, \%pv, \%bl etc.) can be further
+ themed -- see \reference{ref:bar_tags}.}
+
\section{Status Bar}
\begin{tagmap}
\config{\%we} & Display Status Bar\\
@@ -625,6 +628,38 @@ Example:
used with conditional viewports.
}
+\section{\label{ref:bar_tags}Bar Tags}
+ Some tags can be used to display a bar which draws according to the value of
+ the tag. To use these tags like a bar you need to use the following parameters
+ (\%XX should be replaced with the actual tag).
+
+\begin{tagmap}
+ \config{\%XX(x, y, width, filename, [options])}
+ & Draw the specified tag as a bar\newline
+ \config{x}: x co-ordinate at which to start drawing the bar.\newline
+ \config{y}: y co-ordinate at which to start drawing the bar.\newline
+ \config{width}: width of the bar (- for the full viewport width).\newline
+ \config{height}: height of the bar (- to set to the font height for
+ horizontal bars and to the viewport height for vertical bars).\newline
+ \config{options}: any of the options set out below.\\
+\end{tagmap}
+
+\subsection{Options}
+\begin{description}
+ \item[horizontal] -- force the bar to be drawn horizontally.
+ \item[vertical] -- force the bar to be drawn vertically.
+ \item[invert] -- invert the draw direction (i.e. right to left, or top to
+ bottom).
+ \item[slider] -- draw an preloaded image over the top of the bar. This must be
+ followed by the label of the desired image.
+ \item[nofill] -- don't draw the fill bar, only the empty image (for the
+ desired effect use with the ``slider'' option).
+\end{description}
+
+Example: \config{\%pb(0,0,-,-,-,nofill, slider, slider\_image, invert)} -- draw
+a horizontal progressbar which doesn't fill and draws the image
+``slider\_image'' which moves right to left.
+
\section{Other Tags}
\begin{tagmap}
\config{\%(} & The character `('\\