Move firmware/target/sdl under firmware/target/hosted
[kugel-rb.git] / manual / configure_rockbox / bookmarking.tex
blobd70f4c27049b3195c3bd366f6470395c1f0f895a
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. \opt{swcodec}{Bookmarks also store
5 rate, pitch and speed information from the \setting{Pitch Screen} (see
6 \reference{sec:pitchscreen}).} Bookmarks are saved on a per directory
7 basis or for individual (saved) playlists.
8 They are stored next to the directory/playlist they reference.
9 You can store multiple bookmarks for the same track.\\*
11 \note{Bookmarking only works when tracks are launched from the file browser,
12 and does not currently work for tracks launched via the
13 database. In addition, they do not currently work with dynamic
14 playlists.\\*}
16 \begin{description}
17 \item [Bookmark on Stop.] This option controls whether Rockbox writes a
18 bookmark to the disk when playback is stopped. Setting this to
19 \setting{No} turns automatic bookmarking completely off. In contrast
20 \setting{Yes} turns automatic bookmarking on while \setting{Ask}
21 asks on stopping the track if a bookmark should be created.
22 With the above options \setting{Yes} and \setting{Ask} if there is an existing
23 \fname{.bmark} file the current position information will be added to the
24 front of the existing list, up to the maximum number of allowed bookmarks
25 per file (currently 10). If no \fname{.bmark} file exists, one will be
26 created with the new bookmark information. Finally, if the
27 \setting{Maintain a list of Recently Used Bookmarks}
28 option is enabled, the bookmarking
29 information will be added to recent bookmarks list.
30 \begin{description}
31 \item[Yes -- Recent Only.]
32 Turns on automatic bookmarking -- One bookmark only
33 \item[Ask -- Recent Only.]
34 Asks if a bookmark should be created when stopping track --
35 One bookmark only
36 \end{description}
37 With the two \setting{Recent Only} options, nothing is written to the
38 \fname{.bmark} file. If the \setting{Maintain a list of Recently Used Bookmarks}
39 option is enabled, the bookmarking information will however be added to
40 recent bookmarks list.
41 \note{The \setting{Resume} function remembers your position in the most
42 recently accessed track regardless of how the \setting{Bookmark on Stop}
43 option is set.}
45 \item [Load Last Bookmark.]
47 When the \setting{Load Last Bookmark} option is set to \setting{Yes}, Rockbox
48 automatically returns to the position of the last bookmark within a file
49 when that file is played.
51 When the \setting{Load Last Bookmark} option is set to \setting{Ask}, Rockbox will
52 give the user the option of starting from the beginning of the track
53 of or from the bookmark.
55 When the \setting{Load Last Bookmark} option is set to \setting{No}, playback always
56 starts from the beginning of the track, and the user must play the bookmark
57 or use the \setting{Load Bookmark} function in the Main Menu, while the file
58 is playing, to resume at the bookmarked location.
60 \item [Maintain a list of Recently Used Bookmarks.]
62 This list of Most Recent Bookmarks (MRB's) may be accessed through the
63 \setting{Recent Bookmarks} option of the \setting{Bookmarks} sub menu of the
64 Main Menu. When set to \setting{Yes} each new bookmark will be added to the
65 MRB list. Setting this to \setting{No} disables the addition of bookmarks to
66 the MRB list. \setting{Unique Only} behaves like the \setting{Yes} setting
67 but in addition all older entries for the current (dynamic) playlist will
68 be removed from the MRB whenever a new entry is added.
70 \item [Bookmark list keys.] The following keys can be used to navigate in
71 any bookmark list.\\
72 \begin{table}
73 \begin{btnmap}{}{}
74 \ActionStdNext
75 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdNext}
76 & Selects the next bookmark.\\
78 \ActionStdPrev
79 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev}
80 & Selects the previous bookmark.\\
82 \ActionStdOk
83 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdOk}
84 & Resumes from the selected bookmark.\\
86 \ActionStdCancel
87 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdCancel}
88 & Exits Recent Bookmark menu\\
90 \nopt{GIGABEAT_S_PAD}{\ActionBmDelete
91 \opt{HAVEREMOTEKEYMAP}{& \ActionRCBmDelete}
92 & Deletes the currently selected bookmark\\}
94 \ActionStdContext
95 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdContext}
96 & Enters the context menu for the selected bookmark.\\
97 \end{btnmap}
98 \end{table}
100 There are two options in the context menu:\\*
102 \setting{Resume} will commence playback of the currently selected bookmark entry.
104 \setting{Delete} will remove the currently selected bookmark entry from the list.
105 \end{description}