set YOFS to 0 for portrait LCDs.
[kugel-rb.git] / manual / configure_rockbox / bookmarking.tex
blob8c61704e80a4f3d7c24636b87e46269640740648
1 % $Id$ %
2 \section{\label{ref:Bookmarkconfigactual}Bookmarking}
3 Bookmarks allow you to save your current position within a track so that
4 you can return to it at a later time. Bookmarks are saved on a per directory
5 basis (for dynamic playlists) or for individual (saved) playlists. They are
6 stored next to the directory/playlist they reference.
7 You can store multiple bookmarks for the same track.
8 \begin{description}
9 \item [Bookmark on Stop. ]This option controls whether Rockbox writes a
10 bookmark to the disk when playback is stopped. Setting this to
11 \setting{No} turns automatic bookmarking completely off. In contrast
12 \setting{Yes} turns automatic bookmarking on while \setting{Ask}
13 asks on stopping the track if a bookmark should be created.
14 With the above options \setting{Yes} and \setting{Ask} if there is an existing
15 \fname{.bmark} file the current position information will be added to the
16 front of the existing list, up to the maximum number of allowed bookmarks
17 per file (currently 10). If no \fname{.bmark} file exists, one will be
18 created with the new bookmark information. Finally, if the
19 \setting{Maintain a list of Recently Used Bookmarks}
20 option is enabled, the bookmarking
21 information will be added to recent bookmarks list.
22 \begin{description}
23 \item[Yes -- Recent Only.]
24 Turns on automatic bookmarking -- One bookmark only
25 \item[Ask -- Recent Only.]
26 Asks if a bookmark should be created when stopping track --
27 One bookmark only
28 \end{description}
29 With the two \setting{Recent Only} options, nothing is written to the
30 \fname{.bmark} file. If the \setting{Maintain a list of Recently Used Bookmarks}
31 option is enabled, the bookmarking information will however be added to
32 recent bookmarks list.
33 \note{The \setting{Resume} function remembers your position in the most
34 recently accessed track regardless of how the \setting{Bookmark on Stop}
35 option is set.}
37 \item [Load Last Bookmark. ]
39 When the \setting{Load Last Bookmark} option is set to \setting{Yes}, Rockbox
40 automatically returns to the position of the last bookmark within a file
41 when that file is played.
43 When the \setting{Load Last Bookmark} option is set to \setting{Ask}, Rockbox will
44 give the user the option of starting from the beginning of the track
45 of or from the bookmark.
47 When the \setting{Load Last Bookmark} option is set to \setting{No}, playback always
48 starts from the beginning of the track, and the user must play the bookmark
49 or use the \setting{Load Bookmark} function in the Main Menu, while the file
50 is playing, to resume at the bookmarked location.
52 \item [Maintain a list of Recently Used Bookmarks. ]
54 This list of Most Recent Bookmarks (MRB's) may be accessed through the
55 \setting{Recent Bookmarks} option of the \setting{Bookmarks} sub menu of the
56 Main Menu. When set to \setting{Yes} each new bookmark will be added to the
57 MRB list. Setting this to \setting{No} disables the addition of bookmarks to
58 the MRB list. \setting{Unique Only} behaves like the \setting{Yes} setting
59 but in addition all older entries for the current (dynamic) playlist will
60 be removed from the MRB whenever a new entry is added.
62 \item [Bookmark list keys.] The following keys can be used to navigate in
63 any bookmark list.\\
64 \begin{table}
65 \begin{btnmap}{}{}
66 \ActionStdNext
67 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdNext}
68 & Selects the next bookmark.\\
70 \ActionStdPrev
71 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev}
72 & Selects the previous bookmark.\\
74 \ActionStdOk
75 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdOk}
76 & Resumes from the selected bookmark.\\
78 \ActionStdCancel
79 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdCancel}
80 & Exits Recent Bookmark menu\\
82 \nopt{GIGABEAT_S_PAD}{\ActionBmDelete
83 \opt{HAVEREMOTEKEYMAP}{& \ActionRCBmDelete}
84 & Deletes the currently selected bookmark\\}
86 \ActionStdContext
87 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdContext}
88 & Enters the context menu for the selected bookmark.\\
89 \end{btnmap}
90 \end{table}
92 There are two options in the context menu:\\*
94 \setting{Resume} will commence playback of the currently selected bookmark entry.
96 \setting{Delete} will remove the currently selected bookmark entry from the list.
97 \end{description}