diff options
author | Osborne Jacobs <ozziejacks@gmail.com> | 2012-03-13 02:28:12 -0400 |
---|---|---|
committer | Jonathan Gordon <rockbox@jdgordon.info> | 2012-03-13 08:54:28 +0100 |
commit | 67b4b2af7c46a64047397ef97aa3de7e21063ffd (patch) | |
tree | f0cfbf4f4e4d4b883e65ce3141da08164c0f76b1 | |
parent | 595427c095df06ad0560dfbaa96710034a51d9c8 (diff) | |
download | rockbox-67b4b2af7c46a64047397ef97aa3de7e21063ffd.tar.gz rockbox-67b4b2af7c46a64047397ef97aa3de7e21063ffd.zip |
Update manual for %cs and %T tags
Added missing %T actions and %cs states.
Change-Id: Id7ec897c84141ac3d604e23b41e1138bbadc5c77
Reviewed-on: http://gerrit.rockbox.org/180
Reviewed-by: Jonathan Gordon <rockbox@jdgordon.info>
-rw-r--r-- | manual/appendix/wps_tags.tex | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 7a37f899a5..f1a661c2da 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -275,7 +275,7 @@ Example: \config{\%?mp<Stop|Play|Pause|Ffwd|Rew|Rec|Rec pause|FM|FM pause>} | |||
275 | 275 | ||
276 | \section{Current Screen} | 276 | \section{Current Screen} |
277 | \begin{tagmap} | 277 | \begin{tagmap} |
278 | \config{\%cs} & The current screen, 1-18, in the order shown below\\ | 278 | \config{\%cs} & The current screen, 1-20, in the order shown below\\ |
279 | \end{tagmap} | 279 | \end{tagmap} |
280 | 280 | ||
281 | \begin{table} | 281 | \begin{table} |
@@ -300,6 +300,7 @@ Example: \config{\%?mp<Stop|Play|Pause|Ffwd|Rew|Rec|Rec pause|FM|FM pause>} | |||
300 | 17 & Time and Date Screen \\ | 300 | 17 & Time and Date Screen \\ |
301 | 18 & Bookmark browser \\ | 301 | 18 & Bookmark browser \\ |
302 | 19 & Shortcuts menu \\ | 302 | 19 & Shortcuts menu \\ |
303 | 20 & Track Info screen \\ | ||
303 | \end{rbtabular} | 304 | \end{rbtabular} |
304 | \end{table} | 305 | \end{table} |
305 | 306 | ||
@@ -649,6 +650,7 @@ display cycling round the defined sublines. See | |||
649 | Possible actions are: | 650 | Possible actions are: |
650 | 651 | ||
651 | \begin{description} | 652 | \begin{description} |
653 | \item[none] -- Do nothing. | ||
652 | \item[play] -- Play/pause playback. | 654 | \item[play] -- Play/pause playback. |
653 | \item[stop] -- Stop playback and exit the WPS. | 655 | \item[stop] -- Stop playback and exit the WPS. |
654 | \item[prev] -- Previous track/item. | 656 | \item[prev] -- Previous track/item. |
@@ -665,8 +667,10 @@ display cycling round the defined sublines. See | |||
665 | \item[volup] -- Increase the volume by one step. | 667 | \item[volup] -- Increase the volume by one step. |
666 | \item[mute] -- Un/Mute playback. | 668 | \item[mute] -- Un/Mute playback. |
667 | \item[createbookmark] -- Create a bookmark in the currently-playing track. | 669 | \item[createbookmark] -- Create a bookmark in the currently-playing track. |
670 | \item[hotkey] -- Performs the action assigned to the hotkey (see Hotkeys section). | ||
668 | \item[menu] -- Go to the main menu. | 671 | \item[menu] -- Go to the main menu. |
669 | \item[browse] -- Go back to the file browser or database. | 672 | \item[browse] -- Go back to the file browser or database. |
673 | \item[resumeplayback] -- Go back to the last music screen (WPS or radio screen). | ||
670 | \item[quickscreen] -- Go to the quickscreen. | 674 | \item[quickscreen] -- Go to the quickscreen. |
671 | \item[contextmenu] -- Open the context menu. | 675 | \item[contextmenu] -- Open the context menu. |
672 | \item[playlist] -- Go to the playlist viewer. | 676 | \item[playlist] -- Go to the playlist viewer. |
@@ -674,17 +678,21 @@ display cycling round the defined sublines. See | |||
674 | \item[trackinfo] -- Open the track info viewer. | 678 | \item[trackinfo] -- Open the track info viewer. |
675 | \item[pitch] -- Open the pitchscreen. | 679 | \item[pitch] -- Open the pitchscreen. |
676 | \item[setting\_inc] -- Increment the subsequently specified setting (e.g | 680 | \item[setting\_inc] -- Increment the subsequently specified setting (e.g |
677 | \config{\%T(0,0, setting\_inc, volume)} increases the volume by one step). | 681 | \config{\%T(0,0,32,32, setting\_inc, volume)} increases the volume by one step). |
678 | \item[setting\_dec] -- Decrement the subsequently specified setting (e.g | 682 | \item[setting\_dec] -- Decrement the subsequently specified setting (e.g |
679 | \config{\%T(0,0, setting\_dec, volume)} decreases the volume by one step). | 683 | \config{\%T(0,0,32,32, setting\_dec, volume)} decreases the volume by one step). |
684 | \item[setting\_set] -- Set the subsequently specified setting to a specific value (e.g | ||
685 | \config{\%T(0,0,32,32, setting\_set, volume, 0)} sets the volume to 0). | ||
686 | \item[lock] -- Soft locks the touchscreen. All touch areas are disabled except for | ||
687 | areas with the lock action or ones that have the allow_while_locked option (see below). | ||
680 | \end{description} | 688 | \end{description} |
681 | Any (or muliple) of the following options can be used after the action is specified | 689 | Any (or muliple) of the following options can be used after the action is specified |
682 | \subsection{Options} | 690 | \subsection{Options} |
683 | \begin{description} | 691 | \begin{description} |
684 | \item[repeat_press] -- This region will trigger mulitple times when held (i.e for seeking) | 692 | \item[repeat\_press] -- This area will trigger mulitple times when held (i.e for seeking) |
685 | \item[long_press] -- This region will trigger once after it is held for a long press | 693 | \item[long\_press] -- This area will trigger once after it is held for a long press |
686 | \item[reverse_bar] -- Reverse the bars touch direction (i.e seek right to left) | 694 | \item[reverse\_bar] -- Reverse the bars touch direction (i.e seek right to left) |
687 | \item[allow_while_locked] -- Allows the region to be pressable when the | 695 | \item[allow\_while\_locked] -- Allows the area to be pressable when the |
688 | skin is locked by the lock touch action | 696 | skin is locked by the lock touch action |
689 | \end{description} | 697 | \end{description} |
690 | 698 | ||