diff options
author | Sebastian Leonhardt <sebastian.leonhardt@web.de> | 2015-07-14 01:52:56 +0200 |
---|---|---|
committer | Gerrit Rockbox <gerrit@rockbox.org> | 2015-09-24 23:15:24 +0200 |
commit | 59928e6cf5b42fda923559a1e232abe8bf0eddd3 (patch) | |
tree | c5f252c0781948945cb14406f4f684d791eccfb7 /manual/plugins | |
parent | 399904a916f3b17d2d6ee5817d5f1a53ffe62d30 (diff) | |
download | rockbox-59928e6cf5b42fda923559a1e232abe8bf0eddd3.tar.gz rockbox-59928e6cf5b42fda923559a1e232abe8bf0eddd3.zip |
Shopper: slightly improve plugin and manual
* improve manual (hopefully fixes fs#11988). Parts of the
description are taken from fs#10820.
* move ACTION_STD_CONTEXT from alternate select to alternate
menu action, as not all targets have ACTION_STD_MENU
* add menu entries for "Quit" and "Quit without saving"
Change-Id: Iec86a1608756a899f9f9d7ec7d479838dfd1d95f
Diffstat (limited to 'manual/plugins')
-rw-r--r-- | manual/plugins/shopper.tex | 48 |
1 files changed, 47 insertions, 1 deletions
diff --git a/manual/plugins/shopper.tex b/manual/plugins/shopper.tex index 0abd185dda..b2e23e46ee 100644 --- a/manual/plugins/shopper.tex +++ b/manual/plugins/shopper.tex | |||
@@ -2,4 +2,50 @@ | |||
2 | \subsection{Shopper} | 2 | \subsection{Shopper} |
3 | \label{ref:Shopperplugin} | 3 | \label{ref:Shopperplugin} |
4 | 4 | ||
5 | Shopper is a shopping list plugin which allows you to maintain reusable shopping lists. | 5 | Shopper is a plugin which allows you to maintain reusable shopping lists. |
6 | To create a list, use a text editor to write down a list of items (one per | ||
7 | line; note that the line length should not exceed 40 characters) and save the | ||
8 | file as \fname{<name>.shopper}. If you want to separate the items you can do | ||
9 | so by creating categories, which are prepended with `\#'. To open a | ||
10 | \fname{.shopper} file just ``play'' it from the file browser. | ||
11 | |||
12 | \begin{example} | ||
13 | #groceries | ||
14 | bananas | ||
15 | cucumber | ||
16 | 4 apples | ||
17 | 6 apples | ||
18 | #dairy | ||
19 | milk | ||
20 | cheese | ||
21 | \end{example} | ||
22 | Note that it isn't possible to choose exact quantities, but you can create a | ||
23 | number of entries with different quantities in the name of the item, such as | ||
24 | for the apples in the above example. | ||
25 | |||
26 | There are two modes, \emph{edit mode} and \emph{view mode}. The edit mode | ||
27 | shows all the items, and it allows you to select which of the items you want | ||
28 | to buy. When you have finished selecting the items, use the menu to go to the | ||
29 | view mode, and you will see only the items you wish to buy. If you `select' | ||
30 | an item in view mode then that item will be removed from the list. | ||
31 | |||
32 | When you exit Shopper the last view is saved, including which items you have | ||
33 | selected, so if you re-open the shopping list it will be as you left it. There | ||
34 | are additional menu options for clearing the list, selecting all items, showing | ||
35 | and hiding the categories, toggling the categories, and displaying the playback | ||
36 | menu. | ||
37 | |||
38 | \subsubsection{Shopper Keys} | ||
39 | \begin{btnmap} | ||
40 | \ActionStdOk{} | ||
41 | \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdOk} | ||
42 | & Select or clear an item\\ | ||
43 | |||
44 | \ActionStdMenu{} or \ActionStdContext{} | ||
45 | \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdMenu{} or \ActionRCStdContext} | ||
46 | & Show menu\\ | ||
47 | |||
48 | \ActionStdCancel{} | ||
49 | \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdCancel} | ||
50 | & Exit\\ | ||
51 | \end{btnmap} | ||