summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2006-04-16 20:05:01 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2006-04-16 20:05:01 +0000
commit6cc8c40e6bd77a7c753b417d36c4cc386cd1a1bd (patch)
tree9c08d52d0ddd25c0d69a053b8cf565ea41832504 /manual
parent6c92d131c0a1796811d2bd923be49570c06a2052 (diff)
downloadrockbox-6cc8c40e6bd77a7c753b417d36c4cc386cd1a1bd.tar.gz
rockbox-6cc8c40e6bd77a7c753b417d36c4cc386cd1a1bd.zip
Update and cleanup of Bookmarking Section (FS#5120 by Mark Bright). Fix a glitch from my last commit.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9688 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rwxr-xr-xmanual/configure_rockbox/bookmarking.tex76
-rwxr-xr-xmanual/configure_rockbox/system_options.tex4
2 files changed, 60 insertions, 20 deletions
diff --git a/manual/configure_rockbox/bookmarking.tex b/manual/configure_rockbox/bookmarking.tex
index 36ae7cd82f..8681fdd727 100755
--- a/manual/configure_rockbox/bookmarking.tex
+++ b/manual/configure_rockbox/bookmarking.tex
@@ -1,21 +1,61 @@
\section{\label{ref:Bookmarkconfigactual}Bookmarking}
- Bookmarks allow you to save your current position within a track so that you can return to it at a later time.
+ 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
+ basis. In other words, all of the files in the same folder have their
+ bookmarks stored together in the folder where the files are located. You
+ can store multiple bookmarks for the same track.
+ \begin{description}
+ \item [Bookmark on Stop: ]This option controls whether Rockbox writes a
+ bookmark to the disk when the STOP button is pressed.
+ \emph{No} turns automatic bookmarking completely off. In contrast
+ \emph{Yes} turns automatic bookmarking on while \emph{Ask} asks on stopping
+ the track if a bookmark should be created.
+ With the above options ``Yes'' and ``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 ``Maintain
+ a list of Recently Used Bookmarks'' option is enabled, the bookmarking
+ information will be added to recent bookmarks list.
+ \begin{description}
+ \item[Yes -- Recent Only:]
+ Turns on automatic bookmarking - One bookmark only
+ \item[Ask -- Recent Only:]
+ Asks if a bookmark should be created when stopping track --
+ One bookmark only
+ \end{description}
+ With the two ``Recent Only'' options, nothing is written to the
+ \fname{.bmark} file. if the ``Maintain a list of Recently Used Bookmarks''
+ option is enabled, the bookmarking information will however be added to
+ recent bookmarks list.
+ \note{The \emph{Resume} function remembers your position in the most
+ recently accessed track regardless of how the \emph{Bookmark on Stop}
+ option is set.}
+
+ \item [Load Last Bookmark: ]
+
+ When the \emph{Load Last Bookmark} option is set to YES, Rockbox
+ automatically returns to the position of the last bookmark within a file
+ when that file is played.
- Bookmarks are saved on a per folder basis. In other words, all of the files in the same folder have their bookmarks stored together in the folder where the files are located. You can store multiple bookmarks for the same track.
- \begin{itemize}
- \item \textbf{Bookmark on Stop: }
- This option controls whether Rockbox writes a bookmark to the disk when the STOP button is pressed. The options are:
- \begin{itemize}
- \item \textbf{Ask: }Causes a prompt to be displayed whenever you press STOP, asking if you wish to 'Create a bookmark?'
- \item \textbf{Yes: }Turns on automatic bookmarking.
- \item \textbf{No: }Turns off automatic bookmarking.
- \item \textbf{Ask - Recent Only: }TODO
- \item \textbf{Yes - Recent Only: }TODO
- \end{itemize}
- \textbf{Note: }The \textbf{Resume} function remembers your position in the most recently accessed track regardless of how the \textbf{Bookmark on Stop} option is set.
+ When the \emph{Load Last Bookmark} option is set to ASK, Rockbox will
+ give the user the option of starting from the beginning of the track
+ of or from the bookmark.
+
+ When the \emph{Load Last Bookmark} option is set to NO, playback always
+ 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
+ is playing, to resume at the bookmarked location.
- \item \textbf{Load Last Bookmark:}
- When the \textbf{Load Last Bookmark} option is set to YES, Rockbox automatically returns to the position of the last bookmark within a file when that file is played. When the \textbf{Load Last Bookmark} option is set to ASK, Rockbox will give the user the option of starting from the beginning of the track of or from the bookmark. When the \textbf{Load Last Bookmark} option is set to NO, playback always starts from the beginning of the track, and the user must play the bookmark or use the \textbf{Load Bookmark} function in the Main Menu, while the file is playing, to resume at the bookmarked location.
- \item \textbf{Maintain a list of Recently Used Bookmarks:}
- If this option is set to YES, Rockbox will store a list of bookmarks that have been accessed recently. This list of bookmarks may be accessed through the \textbf{Recent Bookmarks} option of the \textbf{Bookmarks} submenu of the Main Menu. If this option is set to UNIQUTE ONLY, (TODO--what does this mean?). If this option is set to NO, Rockbox will not store a list of recent bookmarks; instead, the user must navigate to the folder containing the bookmark and play the bookmark to load it.
- \end{itemize} \ No newline at end of file
+ \item [Maintain a list of Recently Used Bookmarks: ]
+
+ This list of Most Recent Bookmarks (MRB's) may be accessed through the
+ \emph{Recent Bookmarks} option of the \emph{Bookmarks} submenu of the
+ Main Menu. When set to \emph{Yes} each new bookmark will be added to the
+ MRB list. Setting this to \emph{No} disables the addition of bookmarks to
+ the MRB list. \emph{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
+ MRB list already existed. Otherwise this will behave like the
+ \emph{Yes} setting.
+ \fixme{The above information was obtained by reading the source code, but my C is rather rusty...}
+ \end{description}
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index 01829687fd..3c46a0aab2 100755
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -117,7 +117,7 @@ This submenu relates to limits in the Rockbox operating system.
\opt{player,recorder,recorderv2fm}{
\subsection{Car Adapter Mode}
This option turns on and off the car ignition auto stop function.
- \begin{itemize}
+ \begin{description}
\item [Car Adaptor Mode: ]When using the \dap\ in a car, car adapter mode
automatically stops playback on the \dap\ when power (i.e. from cigarette
lighter power adapter) to the external DC in jack is turned off. If the Car
@@ -128,7 +128,7 @@ This submenu relates to limits in the Rockbox operating system.
function has shut the \dap\ off, playback will be resumed 5 seconds after
the power is applied. This delay is to allow for the time while the car
engine is being started.
- \end{itemize}
+ \end{description}
Once the \dap\ is shut off either manually, or automatically with the
\emph{Idle Poweroff} function, it must be powered up manually to resume