summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Levin <al.le@rockbox.org>2010-05-09 15:46:48 +0000
committerAlexander Levin <al.le@rockbox.org>2010-05-09 15:46:48 +0000
commit38234e2d8012a6591f0183a8b1453cc97c56479d (patch)
treef880a6395b7c66acce33d6acca32b6e4f5daa7d8
parent36568ed0c2998d6ac6857c9eadc6ab0b98f19323 (diff)
downloadrockbox-38234e2d8012a6591f0183a8b1453cc97c56479d.tar.gz
rockbox-38234e2d8012a6591f0183a8b1453cc97c56479d.zip
Manual: Bookmarking update (FS#11227 by Magnus Holmgren)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25915 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/configure_rockbox/bookmarking.tex121
1 files changed, 66 insertions, 55 deletions
diff --git a/manual/configure_rockbox/bookmarking.tex b/manual/configure_rockbox/bookmarking.tex
index d70f4c2704..2ffd940f8d 100644
--- a/manual/configure_rockbox/bookmarking.tex
+++ b/manual/configure_rockbox/bookmarking.tex
@@ -4,71 +4,81 @@
4 you can return to it at a later time. \opt{swcodec}{Bookmarks also store 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 5 rate, pitch and speed information from the \setting{Pitch Screen} (see
6 \reference{sec:pitchscreen}).} Bookmarks are saved on a per directory 6 \reference{sec:pitchscreen}).} Bookmarks are saved on a per directory
7 basis or for individual (saved) playlists. 7 basis or for individual (saved) playlists. You can store multiple bookmarks,
8 They are stored next to the directory/playlist they reference. 8 even for the same track. When there's already a bookmark for a directory or
9 You can store multiple bookmarks for the same track.\\* 9 playlist, new bookmarks are added before existing ones.
10
11 Bookmarks are stored next to the directory or playlist they reference, in a
12 file with the same name as the directory or playlist and a ".bmark"
13 extension. To load a bookmark, select the bookmark file and then select
14 the bookmark to load. There are other ways to load a bookmarks mentioned
15 below.
10 16
11 \note{Bookmarking only works when tracks are launched from the file browser, 17 \note{Bookmarking only works when tracks are launched from the file browser,
12 and does not currently work for tracks launched via the 18 and does not work for tracks launched via the
13 database. In addition, they do not currently work with dynamic 19 database. In addition, they do not work with dynamic
14 playlists.\\*} 20 playlists.}
15 21
16 \begin{description} 22 \begin{description}
17 \item [Bookmark on Stop.] This option controls whether Rockbox writes a 23
18 bookmark to the disk when playback is stopped. Setting this to 24 \item [Bookmark on Stop.]
19 \setting{No} turns automatic bookmarking completely off. In contrast 25 This option controls whether Rockbox creates a bookmark playback is
20 \setting{Yes} turns automatic bookmarking on while \setting{Ask} 26 stopped.
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} 27 \begin{description}
28 \item[No.]
29 Do not create bookmarks.
30 \item[Yes.]
31 Always create bookmarks.
32 \item[Ask.]
33 Ask if a bookmark should be created.
31 \item[Yes -- Recent Only.] 34 \item[Yes -- Recent Only.]
32 Turns on automatic bookmarking -- One bookmark only 35 Always create a bookmark, but only in the recent bookmarks list.
33 \item[Ask -- Recent Only.] 36 \item[Ask -- Recent Only.]
34 Asks if a bookmark should be created when stopping track -- 37 Ask if a bookmark should be created, but only add it to the recent
35 One bookmark only 38 bookmarks list.
36 \end{description} 39 \end{description}
37 With the two \setting{Recent Only} options, nothing is written to the 40 When either \setting{Yes -- Recent Only} or \setting{Ask -- Recent Only}
38 \fname{.bmark} file. If the \setting{Maintain a list of Recently Used Bookmarks} 41 is selected, bookmarks are only created if the \setting{Maintain a List
39 option is enabled, the bookmarking information will however be added to 42 of Recent Bookmarks} is enabled.
40 recent bookmarks list.
41 \note{The \setting{Resume} function remembers your position in the most 43 \note{The \setting{Resume} function remembers your position in the most
42 recently accessed track regardless of how the \setting{Bookmark on Stop} 44 recently accessed track regardless of how the \setting{Bookmark on Stop}
43 option is set.} 45 option is set.}
44 46
45 \item [Load Last Bookmark.] 47 \item [Load Last Bookmark.]
48 This option controls if Rockbox should automatically load a bookmark for
49 a file, when that file is played.
50
51 \begin{description}
52 \item[No]
53 Always start from the beginning of the track or playlist.
54 \item[Yes]
55 Automatically return to the position of the last bookmark. Start
56 from the beginning if there are no bookmarks.
57 \item[Ask]
58 Ask if playback should start from the beginning of the track or
59 from one of the bookmarks.
60 \end{description}
46 61
47 When the \setting{Load Last Bookmark} option is set to \setting{Yes}, Rockbox 62 \item [Maintain a list of Recent Bookmarks.]
48 automatically returns to the position of the last bookmark within a file 63 If this option is enabled, a list of the most recently created bookmarks
49 when that file is played. 64 may be accessed through the \setting{Recent Bookmarks} option in the
50 65 \setting{Main Menu}. This list contains up to ten entries.
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.
54
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.
59 66
60 \item [Maintain a list of Recently Used Bookmarks.] 67 \begin{description}
68 \item[No]
69 Do not keep a list of recently used bookmarks. This also removes
70 the \setting{Recent Bookmarks} from the \setting{Main Menu}.
71 \item[Yes]
72 Keep a list of recently used bookmarks. Each new bookmark is added
73 to the list of recent bookmarks.
74 \item[Unique Only]
75 Add each new bookmark to the list of recently used bookmarks, but
76 only keep one bookmark from the current directory or playlist; any
77 previous entries are removed.
78 \end{description}
79\end{description}
61 80
62 This list of Most Recent Bookmarks (MRB's) may be accessed through the 81The following keys can be used to navigate in any bookmark list.
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.
69
70 \item [Bookmark list keys.] The following keys can be used to navigate in
71 any bookmark list.\\
72\begin{table} 82\begin{table}
73 \begin{btnmap}{}{} 83 \begin{btnmap}{}{}
74 \ActionStdNext 84 \ActionStdNext
@@ -97,9 +107,10 @@
97 \end{btnmap} 107 \end{btnmap}
98\end{table} 108\end{table}
99 109
100There are two options in the context menu:\\* 110There are two options in the context menu:
101 111
102 \setting{Resume} will commence playback of the currently selected bookmark entry. 112\begin{itemize}
103 113 \item \setting{Resume} will commence playback of the currently selected bookmark entry.
104 \setting{Delete} will remove the currently selected bookmark entry from the list. 114 \item \setting{Delete} will remove the currently selected bookmark entry from the list.
105\end{description} 115\end{itemize}
116