Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Also update bookmarks section to actual style. dos2unix the file.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10033 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Dominik Riebeling 2006-06-02 20:06:26 +00:00
parent b38b85bd17
commit 29028d0a6d
1 changed files with 28 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
manual/configure_rockbox/bookmarking.tex
View file

@ -1,3 +1,4 @@
% $Id$ %
\section{\label{ref:Bookmarkconfigactual}Bookmarking} \section{\label{ref:Bookmarkconfigactual}Bookmarking}
Bookmarks allow you to save your current position within a track so that Bookmarks allow you to save your current position within a track so that
you can return to it at a later time. Bookmarks are saved on a per folder you can return to it at a later time. Bookmarks are saved on a per folder
@ -5,57 +6,58 @@
bookmarks stored together in the folder where the files are located. You bookmarks stored together in the folder where the files are located. You
can store multiple bookmarks for the same track. can store multiple bookmarks for the same track.
\begin{description} \begin{description}
\item [Bookmark on Stop: ]This option controls whether Rockbox writes a \item [Bookmark on Stop. ]This option controls whether Rockbox writes a
bookmark to the disk when the STOP button is pressed. bookmark to the disk when playback is stopped. Setting this to
\emph{No} turns automatic bookmarking completely off. In contrast \setting{No} turns automatic bookmarking completely off. In contrast
\emph{Yes} turns automatic bookmarking on while \emph{Ask} asks on stopping \setting{Yes} turns automatic bookmarking on while \setting{Ask}
the track if a bookmark should be created. asks on stopping the track if a bookmark should be created.
With the above options ``Yes'' and ``Ask'' if there is an existing 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 \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 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 per file (currently 10). If no \fname{.bmark} file exists, one will be
created with the new bookmark information. Finally, if the ``Maintain created with the new bookmark information. Finally, if the
a list of Recently Used Bookmarks'' option is enabled, the bookmarking \setting{Maintain a list of Recently Used Bookmarks}
option is enabled, the bookmarking
information will be added to recent bookmarks list. information will be added to recent bookmarks list.
\begin{description} \begin{description}
\item[Yes -- Recent Only:] \item[Yes -- Recent Only.]
Turns on automatic bookmarking - One bookmark only Turns on automatic bookmarking -- One bookmark only
\item[Ask -- Recent Only:] \item[Ask -- Recent Only.]
Asks if a bookmark should be created when stopping track -- Asks if a bookmark should be created when stopping track --
One bookmark only One bookmark only
\end{description} \end{description}
With the two ``Recent Only'' options, nothing is written to the With the two \setting{Recent Only} options, nothing is written to the
\fname{.bmark} file. if the ``Maintain a list of Recently Used Bookmarks'' \fname{.bmark} file. If the \setting{Maintain a list of Recently Used Bookmarks}
option is enabled, the bookmarking information will however be added to option is enabled, the bookmarking information will however be added to
recent bookmarks list. recent bookmarks list.
\note{The \emph{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 \emph{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. ]
When the \emph{Load Last Bookmark} option is set to YES, Rockbox When the \setting{Load Last Bookmark} option is set to \setting{Yes}, Rockbox
automatically returns to the position of the last bookmark within a file automatically returns to the position of the last bookmark within a file
when that file is played. when that file is played.
When the \emph{Load Last Bookmark} option is set to ASK, Rockbox will 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 give the user the option of starting from the beginning of the track
of or from the bookmark. of or from the bookmark.
When the \emph{Load Last Bookmark} option is set to NO, playback always 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 starts from the beginning of the track, and the user must play the bookmark
or use the \emph{Load Bookmark} function in the Main Menu, while the file or use the \setting{Load Bookmark} function in the Main Menu, while the file
is playing, to resume at the bookmarked location. is playing, to resume at the bookmarked location.
\item [Maintain a list of Recently Used Bookmarks: ] \item [Maintain a list of Recently Used Bookmarks. ]
This list of Most Recent Bookmarks (MRB's) may be accessed through the This list of Most Recent Bookmarks (MRB's) may be accessed through the
\emph{Recent Bookmarks} option of the \emph{Bookmarks} submenu of the \setting{Recent Bookmarks} option of the \setting{Bookmarks} submenu of the
Main Menu. When set to \emph{Yes} each new bookmark will be added to the Main Menu. When set to \setting{Yes} each new bookmark will be added to the
MRB list. Setting this to \emph{No} disables the addition of bookmarks to MRB list. Setting this to \setting{No} disables the addition of bookmarks to
the MRB list. \emph{Unique Only} will remove an old bookmark for the current the MRB list. \setting{Unique Only} will remove an old bookmark for the current
track from the MRB list and replace it with the new one if a bookmark in the track from the MRB list and replace it with the new one if a bookmark in the
MRB list already existed. Otherwise this will behave like the MRB list already existed. Otherwise this will behave like the
\emph{Yes} setting. \setting{Yes} setting.
\fixme{The above information was obtained by reading the source code, but my C is rather rusty...} \fixme{The above information was obtained by reading the source code, but my C is rather rusty...}
\end{description} \end{description}