devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Manual: Bookmarking update (FS#11227 by Magnus Holmgren)

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25915 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Alexander Levin 2010-05-09 15:46:48 +00:00
parent 36568ed0c2
commit 38234e2d80
1 changed files with 67 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

123
manual/configure_rockbox/bookmarking.tex
View file

@ -4,71 +4,81 @@
you can return to it at a later time. \opt{swcodec}{Bookmarks also store you can return to it at a later time. \opt{swcodec}{Bookmarks also store
rate, pitch and speed information from the \setting{Pitch Screen} (see rate, pitch and speed information from the \setting{Pitch Screen} (see
\reference{sec:pitchscreen}).} Bookmarks are saved on a per directory \reference{sec:pitchscreen}).} Bookmarks are saved on a per directory
basis or for individual (saved) playlists. basis or for individual (saved) playlists. You can store multiple bookmarks,
They are stored next to the directory/playlist they reference. even for the same track. When there's already a bookmark for a directory or
You can store multiple bookmarks for the same track.\\* playlist, new bookmarks are added before existing ones.
Bookmarks are stored next to the directory or playlist they reference, in a
file with the same name as the directory or playlist and a ".bmark"
extension. To load a bookmark, select the bookmark file and then select
the bookmark to load. There are other ways to load a bookmarks mentioned
below.
\note{Bookmarking only works when tracks are launched from the file browser, \note{Bookmarking only works when tracks are launched from the file browser,
and does not currently work for tracks launched via the and does not work for tracks launched via the
database. In addition, they do not currently work with dynamic database. In addition, they do not work with dynamic
playlists.\\*} playlists.}
\begin{description} \begin{description}
\item [Bookmark on Stop.] This option controls whether Rockbox writes a
bookmark to the disk when playback is stopped. Setting this to \item [Bookmark on Stop.]
\setting{No} turns automatic bookmarking completely off. In contrast This option controls whether Rockbox creates a bookmark playback is
\setting{Yes} turns automatic bookmarking on while \setting{Ask} stopped.
asks on stopping the track if a bookmark should be created.
With the above options \setting{Yes} and \setting{Ask} if there is an existing
\fname{.bmark} file the current position information will be added to the
front of the existing list, up to the maximum number of allowed bookmarks
per file (currently 10). If no \fname{.bmark} file exists, one will be
created with the new bookmark information. Finally, if the
\setting{Maintain a list of Recently Used Bookmarks}
option is enabled, the bookmarking
information will be added to recent bookmarks list.
\begin{description} \begin{description}
\item[No.]
Do not create bookmarks.
\item[Yes.]
Always create bookmarks.
\item[Ask.]
Ask if a bookmark should be created.
\item[Yes -- Recent Only.] \item[Yes -- Recent Only.]
Turns on automatic bookmarking -- One bookmark only Always create a bookmark, but only in the recent bookmarks list.
\item[Ask -- Recent Only.] \item[Ask -- Recent Only.]
Asks if a bookmark should be created when stopping track -- Ask if a bookmark should be created, but only add it to the recent
One bookmark only bookmarks list.
\end{description} \end{description}
With the two \setting{Recent Only} options, nothing is written to the When either \setting{Yes -- Recent Only} or \setting{Ask -- Recent Only}
\fname{.bmark} file. If the \setting{Maintain a list of Recently Used Bookmarks} is selected, bookmarks are only created if the \setting{Maintain a List
option is enabled, the bookmarking information will however be added to of Recent Bookmarks} is enabled.
recent bookmarks list.
\note{The \setting{Resume} function remembers your position in the most \note{The \setting{Resume} function remembers your position in the most
recently accessed track regardless of how the \setting{Bookmark on Stop} recently accessed track regardless of how the \setting{Bookmark on Stop}
option is set.} option is set.}
\item [Load Last Bookmark.] \item [Load Last Bookmark.]
This option controls if Rockbox should automatically load a bookmark for
When the \setting{Load Last Bookmark} option is set to \setting{Yes}, Rockbox a file, when that file is played.
automatically returns to the position of the last bookmark within a file
when that file is played.
When the \setting{Load Last Bookmark} option is set to \setting{Ask}, Rockbox will
give the user the option of starting from the beginning of the track
of or from the bookmark.
When the \setting{Load Last Bookmark} option is set to \setting{No}, playback always
starts from the beginning of the track, and the user must play the bookmark
or use the \setting{Load Bookmark} function in the Main Menu, while the file
is playing, to resume at the bookmarked location.
\item [Maintain a list of Recently Used Bookmarks.] \begin{description}
\item[No]
Always start from the beginning of the track or playlist.
\item[Yes]
Automatically return to the position of the last bookmark. Start
from the beginning if there are no bookmarks.
\item[Ask]
Ask if playback should start from the beginning of the track or
from one of the bookmarks.
\end{description}
This list of Most Recent Bookmarks (MRB's) may be accessed through the \item [Maintain a list of Recent Bookmarks.]
\setting{Recent Bookmarks} option of the \setting{Bookmarks} sub menu of the If this option is enabled, a list of the most recently created bookmarks
Main Menu. When set to \setting{Yes} each new bookmark will be added to the may be accessed through the \setting{Recent Bookmarks} option in the
MRB list. Setting this to \setting{No} disables the addition of bookmarks to \setting{Main Menu}. This list contains up to ten entries.
the MRB list. \setting{Unique Only} behaves like the \setting{Yes} setting
but in addition all older entries for the current (dynamic) playlist will \begin{description}
be removed from the MRB whenever a new entry is added. \item[No]
Do not keep a list of recently used bookmarks. This also removes
\item [Bookmark list keys.] The following keys can be used to navigate in the \setting{Recent Bookmarks} from the \setting{Main Menu}.
any bookmark list.\\ \item[Yes]
Keep a list of recently used bookmarks. Each new bookmark is added
to the list of recent bookmarks.
\item[Unique Only]
Add each new bookmark to the list of recently used bookmarks, but
only keep one bookmark from the current directory or playlist; any
previous entries are removed.
\end{description}
\end{description}
The following keys can be used to navigate in any bookmark list.
\begin{table} \begin{table}
\begin{btnmap}{}{} \begin{btnmap}{}{}
\ActionStdNext \ActionStdNext
@ -97,9 +107,10 @@
\end{btnmap} \end{btnmap}
\end{table} \end{table}
There are two options in the context menu:\\* There are two options in the context menu:
\setting{Resume} will commence playback of the currently selected bookmark entry. \begin{itemize}
\item \setting{Resume} will commence playback of the currently selected bookmark entry.
\setting{Delete} will remove the currently selected bookmark entry from the list. \item \setting{Delete} will remove the currently selected bookmark entry from the list.
\end{description} \end{itemize}