summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/shopper.tex48
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
5Shopper is a shopping list plugin which allows you to maintain reusable shopping lists. 5Shopper is a plugin which allows you to maintain reusable shopping lists.
6To create a list, use a text editor to write down a list of items (one per
7line; note that the line length should not exceed 40 characters) and save the
8file as \fname{<name>.shopper}. If you want to separate the items you can do
9so 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}
22Note that it isn't possible to choose exact quantities, but you can create a
23number of entries with different quantities in the name of the item, such as
24for the apples in the above example.
25
26There are two modes, \emph{edit mode} and \emph{view mode}. The edit mode
27shows all the items, and it allows you to select which of the items you want
28to buy. When you have finished selecting the items, use the menu to go to the
29view mode, and you will see only the items you wish to buy. If you `select'
30an item in view mode then that item will be removed from the list.
31
32When you exit Shopper the last view is saved, including which items you have
33selected, so if you re-open the shopping list it will be as you left it. There
34are additional menu options for clearing the list, selecting all items, showing
35and hiding the categories, toggling the categories, and displaying the playback
36menu.
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}