summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarianne Arnold <pixelma@rockbox.org>2010-10-29 17:52:20 +0000
committerMarianne Arnold <pixelma@rockbox.org>2010-10-29 17:52:20 +0000
commitfa6321114958d3114cb74cc835c92cfe8a9b0239 (patch)
treef5c553566056591c376264b7161f803351a4940c
parent5e28b18df9f29c877c79217ad8ed45f4b084a3dd (diff)
downloadrockbox-fa6321114958d3114cb74cc835c92cfe8a9b0239.tar.gz
rockbox-fa6321114958d3114cb74cc835c92cfe8a9b0239.zip
Manual, theme tag chapter: add a 'Hardware Capabilities' section for tags that test hardware capabilities of a target and move the 'radio/clock/touchscreen detected' tags there. Fixes inconsistencies in handling these.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28380 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/appendix/wps_tags.tex42
1 files changed, 19 insertions, 23 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 4ee7d4e820..c990f24cc8 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -15,6 +15,23 @@ what follows is a list of the available tags.
15These tags override the player setting for the display of the status bar. 15These tags override the player setting for the display of the status bar.
16They must be noted on their own line (which will not be shown in the WPS). 16They must be noted on their own line (which will not be shown in the WPS).
17 17
18\section{Hardware Capabilities}
19\begin{tagmap}
20 \config{\%cc} & Check for presence of a real time clock, returns ``c''
21 when used unconditionally\\
22 \config{\%tp} & Does this target have a radio?\\
23 \config{\%Tp} & Indicates that the target has a touchscreen\\
24\end{tagmap}
25With the above tags it is possible to find out about the presence of certain
26hardware and make the theme adapt to it. This can be very useful for designing
27a theme that works on multiple targets with differing hardware capabilities, e.g.
28targets that do and do not have a clock. When used conditionally, the ``true''
29branch is completely ignored if it does not apply.
30
31Example:
32\config{\%?cc<\%cH:\%cM|No clock detected>}
33
34
18\section{Information from the track tags} 35\section{Information from the track tags}
19 \begin{tagmap} 36 \begin{tagmap}
20 \config{\%ia} & Artist\\ 37 \config{\%ia} & Artist\\
@@ -440,9 +457,6 @@ Examples:
440\opt{radio}{ 457\opt{radio}{
441\section{FM Radio} 458\section{FM Radio}
442 \begin{tagmap} 459 \begin{tagmap}
443 \config{\%tp} & Does this target have a radio? If it doesn't, the ``true''
444 branch of this conditional is completly ignored so you don't need to
445 worry about tags which are not recognized on non radio targets.\\
446 \config{\%tt} & Is the tuner tuned?\\ 460 \config{\%tt} & Is the tuner tuned?\\
447 \config{\%tm} & Scan or preset mode? Scan is ``true'', preset is ``false''.\\ 461 \config{\%tm} & Scan or preset mode? Scan is ``true'', preset is ``false''.\\
448 \config{\%ts} & Is the station in stereo?\\ 462 \config{\%ts} & Is the station in stereo?\\
@@ -531,10 +545,9 @@ Allows grouping of several items (sublines) onto one line, with the
531display cycling round the defined sublines. See 545display cycling round the defined sublines. See
532\reference{ref:AlternatingSublines} for details. 546\reference{ref:AlternatingSublines} for details.
533 547
534 548\opt{rtc}{
535\section{Time and Date} 549\section{Time and Date}
536 \begin{tagmap} 550 \begin{tagmap}
537 \opt{rtc}{
538 \config{\%cd} & Day of month from 01 to 31\\ 551 \config{\%cd} & Day of month from 01 to 31\\
539 \config{\%ce} & Zero padded day of month from 1 to 31\\ 552 \config{\%ce} & Zero padded day of month from 1 to 31\\
540 \config{\%cf} & A conditional for 12/24 hour format.\newline 553 \config{\%cf} & A conditional for 12/24 hour format.\newline
@@ -554,21 +567,8 @@ display cycling round the defined sublines. See
554 \config{\%cb} & Month name\\ 567 \config{\%cb} & Month name\\
555 \config{\%cu} & Day of week from 1 to 7, 1 is Monday\\ 568 \config{\%cu} & Day of week from 1 to 7, 1 is Monday\\
556 \config{\%cw} & Day of week from 0 to 6, 0 is Sunday\\ 569 \config{\%cw} & Day of week from 0 to 6, 0 is Sunday\\
557 }
558 \config{\%cc} & Check for presence of the clock hardware\\
559 \end{tagmap} 570 \end{tagmap}
560The \%cc tag returns ``c'' if the necessary hardware is present and can also be 571}
561used as a conditional. This can be very useful for designing a WPS that works on
562multiple targets, some with and some without a clock. By using this tag as a
563conditional it is possible to display current date and time on those targets that
564support this
565\opt{rtc}{ (like the \playertype)},
566or alternate information on those that do not
567\nopt{rtc}{ (like the \playertype)}%
568.
569
570Example:
571\config{\%?cc<\%cH:\%cM|No clock detected>}
572 572
573\section{Text Translation} 573\section{Text Translation}
574 \begin{tagmap} 574 \begin{tagmap}
@@ -586,10 +586,6 @@ Example:
586 586
587 587
588\opt{touchscreen}{ 588\opt{touchscreen}{
589 \section{Target Has A Touchscreen?}
590 \begin{tagmap}
591 \config{\%Tp} & Indicates that the target has a touchscreen.\\
592 \end{tagmap}
593 \section{Touchscreen Areas} 589 \section{Touchscreen Areas}
594 \begin{tagmap} 590 \begin{tagmap}
595 \config{\%T(x,y,[width],\tabnlindent[height],action)} 591 \config{\%T(x,y,[width],\tabnlindent[height],action)}