manual/configure_rockbox/bookmarking.tex

   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. You can store multiple bookmarks,
   8   even for the same track. When there's already a bookmark for a directory or
   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.
  16
  17   \note{Bookmarking only works when tracks are launched from the file browser,
  18         and does not work for tracks launched via the
  19         database. In addition, they do not work with dynamic
  20         playlists.}
  21
  22   \begin{description}
  23
  24   \item [Bookmark on Stop.]
  25     This option controls whether Rockbox creates a bookmark when playback is
  26     stopped manually.
  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.
  34       \item[Yes -- Recent Only.]
  35             Always create a bookmark, but only in the recent bookmarks list.
  36       \item[Ask -- Recent Only.]
  37             Ask if a bookmark should be created, but only add it to the recent
  38             bookmarks list.
  39     \end{description}
  40     When either \setting{Yes -- Recent Only} or \setting{Ask -- Recent Only}
  41     is selected, bookmarks are only created if the \setting{Maintain a List
  42     of Recent Bookmarks} is enabled.
  43     \note{The \setting{Resume} function remembers your position in the most
  44       recently accessed track regardless of how the \setting{Bookmark on Stop}
  45       option is set.}
  46
  47   \item [Update on Stop.]
  48     If set to ``No'', this setting has no effect and does not affect any other settings.
  49     If set to ``Yes'', and the file
  50     to which a new bookmark would be added already exists, this option overrides
  51     the previous setting (\setting{Bookmark on Stop}) and unconditionally creates a
  52     bookmark. This is useful if you don't generally want to create bookmarks but
  53     only want to add them to already existing bookmark files. In this case you
  54     should set the setting \setting{Bookmark on Stop} to ``No'' and the setting
  55     \setting{Update on Stop} to ``Yes''.
  56
  57   \item [Load Last Bookmark.]
  58     This option controls if Rockbox should automatically load a bookmark for
  59     a file, when that file is played.
  60
  61     \begin{description}
  62       \item[No]
  63             Always start from the beginning of the track or playlist.
  64       \item[Yes]
  65             Automatically return to the position of the last bookmark. Start
  66             from the beginning if there are no bookmarks.
  67       \item[Ask]
  68             Ask if playback should start from the beginning of the track or
  69             from one of the bookmarks.
  70     \end{description}
  71
  72   \item [Maintain a list of Recent Bookmarks.]
  73     If this option is enabled, a list of the most recently created bookmarks
  74     may be accessed through the \setting{Recent Bookmarks} option in the
  75     \setting{Main Menu}. This list contains up to ten entries.
  76
  77     \begin{description}
  78       \item[No]
  79             Do not keep a list of recently used bookmarks. This also removes
  80             the \setting{Recent Bookmarks} from the \setting{Main Menu}.
  81       \item[Yes]
  82             Keep a list of recently used bookmarks. Each new bookmark is added
  83             to the list of recent bookmarks.
  84       \item[Unique Only]
  85             Add each new bookmark to the list of recently used bookmarks, but
  86             only keep one bookmark from the current directory or playlist; any
  87             previous entries are removed.
  88     \end{description}
  89 \end{description}
  90
  91 The following keys can be used to navigate in any bookmark list.
  92   \begin{btnmap}
  93       \ActionStdNext
  94       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdNext}
  95       & Selects the next bookmark.\\
  96       %
  97       \ActionStdPrev
  98       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev}
  99       & Selects the previous bookmark.\\
 100       %
 101       \ActionStdOk
 102       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdOk}
 103       & Resumes from the selected bookmark.\\
 104       %
 105       \ActionStdCancel
 106       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdCancel}
 107       & Exits Recent Bookmark menu\\
 108       %
 109       \nopt{GIGABEAT_S_PAD}{\ActionBmDelete
 110       \opt{HAVEREMOTEKEYMAP}{& \ActionRCBmDelete}
 111       & Deletes the currently selected bookmark\\}
 112       %
 113       \ActionStdContext
 114       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdContext}
 115       & Enters the context menu for the selected bookmark.\\
 116   \end{btnmap}
 117
 118 There are two options in the context menu:
 119
 120 \begin{itemize}
 121   \item \setting{Resume} will commence playback of the currently selected bookmark entry.
 122   \item \setting{Delete} will remove the currently selected bookmark entry from the list.
 123 \end{itemize}
 124