manual/rockbox_interface/browsing_and_playing.tex

   1 % $Id$ %
   2 \chapter{Browsing and playing}
   3 \section{\label{ref:file_browser}File Browser}
   4 \screenshot{rockbox_interface/images/ss-file-browser}{The file browser}{}
   5 Rockbox lets you browse your music in either of two ways. The
   6 \setting{File Browser} lets you navigate through the files and directories on
   7 your \dap, entering directories and executing the default action on each file.
   8 To help differentiate files, each file format is displayed with an icon.
   9
  10 The \setting{Database Browser}, on the other hand, allows you to navigate
  11 through the music on your player using categories like album, artist, genre,
  12 etc.
  13
  14 You can select whether to browse using the \setting{File Browser} or the
  15 \setting{Database Browser} by selecting either \setting{Files} or
  16 \setting{Database} in the \setting{Main Menu}.
  17 If you choose the \setting{File Browser}, the \setting{Show Files} setting
  18 lets you select what types of files you wish to view. See
  19 \reference{ref:ShowFiles} for more information on the \setting{Show Files}
  20 setting.
  21
  22 \note{The \setting{File Browser} allows you to manipulate your files in ways
  23 that are not available within the \setting{Database Browser}. Read more about
  24 \setting{Database} in \reference{ref:database}. The remainder of this section
  25 deals with the \setting{File Browser}.}
  26
  27 \opt{ondio}{
  28 Unlike the Archos Firmware, Rockbox provides multivolume support for the
  29 MultiMediaCard, this means the \dap{} can access both data volumes (internal
  30 memory and the MMC), thus being able to for instance, build playlists with
  31 files from both volumes.
  32 In the \setting{File Browser} a new directory will appear as soon as the device
  33 has read the content after inserting the card. This new directory's name is
  34 generated as \fname{<MMC1>}, and will behave exactly as any other directory
  35 on the \dap{}.
  36 }
  37
  38 \opt{h10,h10_5gb}{\note{
  39 If your \dap{} is a MTP model, the Music directory where all your music is stored
  40 may be hidden in the \setting{File Browser}. This may be fixed by either
  41 either changing its properties (on a computer) to not hidden, or by changing
  42 the \setting{Show Files} setting to all.
  43 }}
  44
  45 \subsection{\label{ref:controls}File Browser Controls}
  46 \begin{btnmap}
  47       \ActionStdPrev{}/\ActionStdNext{}
  48       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev{}/\ActionRCStdNext{}}
  49          & Go to previous/next item in list. If you are on the first/last
  50            entry, the cursor will wrap to the last/first entry.\\
  51       %
  52       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}
  53         {
  54           \ButtonOn+\ButtonUp{}/ \ButtonDown
  55           \opt{HAVEREMOTEKEYMAP}{&
  56             \opt{IRIVER_RC_H100_PAD}{\ButtonRCSource{}/ \ButtonRCBitrate}
  57           }
  58           & Move one page up/down in the list.\\
  59         }
  60       \opt{IRIVER_H10_PAD}
  61         {
  62           \ButtonRew{}/ \ButtonFF
  63           & Move one page up/down in the list.\\
  64         }
  65       %
  66       \ActionTreeParentDirectory
  67       \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeParentDirectory}
  68       & Go to the parent directory.\\
  69       %
  70       \ActionTreeEnter
  71       \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeEnter}
  72       & Execute the default action on the selected file or enter a
  73         directory.\\
  74       %
  75       \ActionTreeWps
  76       \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeWps}
  77          & If there is an audio file playing, return to the
  78          \setting{While Playing Screen} (WPS) without stopping playback.\\
  79       %
  80       \nopt{player,SANSA_C200_PAD}%
  81         {%
  82           \ActionTreeStop
  83           \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeStop}
  84           & Stop audio playback.\\%
  85         }%
  86       %
  87       \ActionStdContext{}
  88       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdContext}
  89       & Enter the \setting{Context Menu}.\\
  90       %
  91       \ActionStdMenu{}
  92       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdMenu}
  93       & Enter the \setting{Main Menu}.\\
  94       %
  95       \opt{quickscreen}{
  96         \ActionStdQuickScreen
  97         \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdQuickScreen}
  98         & Switch to the \setting{Quick Screen}
  99         (see \reference{ref:QuickScreen}). \\
 100       }
 101       \opt{RECORDER_PAD}{
 102         \ButtonFThree & Switch to the \setting{Quick Screen}.\\
 103         %
 104       }
 105       %
 106       \opt{SANSA_E200_PAD}{
 107         \ActionStdRec & Switch to the \setting{Recording Screen}.\\
 108       %
 109       }
 110       \nopt{touchscreen}{\opt{hotkey}{
 111         \ActionTreeHotkey
 112             &
 113         \opt{HAVEREMOTEKEYMAP}{
 114             &}
 115         Activate the \setting{Hotkey} function
 116         (see \reference{ref:Hotkeys}).
 117             \\
 118       }}
 119 \end{btnmap}
 120
 121 \opt{RECORDER_PAD}{
 122   The functions of the F keys are also summarised on the button bar at the
 123   bottom of the screen.
 124 }
 125
 126 \subsection{\label{ref:Contextmenu}\label{ref:PartIISectionFM}Context Menu}
 127 \screenshot{rockbox_interface/images/ss-context-menu}{The Context Menu}{}
 128
 129 The \setting{Context Menu} allows you to perform certain operations on files or
 130 directories.  To access the \setting{Context Menu}, position the selector over a file
 131 or directory and access the context menu with \ActionStdContext{}.\\
 132
 133 \note{The \setting{Context Menu} is a context sensitive menu.  If the
 134 \setting{Context Menu} is invoked on a file, it will display options available
 135 for files.  If the \setting{Context Menu} is invoked on a directory,
 136 it will display options for directories.\\}
 137
 138 The \setting{Context Menu} contains the following options (unless otherwise noted,
 139 each option pertains both to files and directories):
 140
 141 \begin{description}
 142 \item [Playlist.]
 143   Enters the \setting{Playlist Submenu} (see \reference{ref:playlist_submenu}).
 144 \item [Playlist Catalog.]
 145   Enters the \setting{Playlist Catalog Submenu} (see
 146   \reference{ref:playlist_catalog}).
 147 \item [Rename.]
 148   This function lets the user modify the name of a file or directory.
 149 \item [Cut.]
 150   Copies the name of the currently selected file or directory to the clipboard
 151   and marks it to be `cut'.
 152 \item [Copy.]
 153   Copies the name of the currently selected file or directory to the clipboard
 154   and marks it to be `copied'.
 155 \item [Paste.]
 156   Only visible if a file or directory name is on the clipboard. When selected
 157   it will move or copy the clipboard to the current directory.
 158 \item [Delete.]
 159   Deletes the currently selected file. This option applies only to files, and
 160   not to directories. Rockbox will ask for confirmation before deleting a file.
 161   Press \ActionYesNoAccept{}
 162   to confirm deletion or any other key to cancel.
 163 \item [Delete Directory.]
 164   Deletes the currently selected directory and all of the files and subdirectories
 165   it may contain. Deleted directories cannot be recovered. Use this feature with
 166   caution!
 167 \opt{lcd_non-mono}{
 168 \item [Set As Backdrop.]
 169   Set the selected \fname{bmp} file as background image. The bitmaps need to meet the
 170   conditions explained in \reference{ref:LoadingBackdrops}.
 171 }
 172 \item [Open with.]
 173   Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox,
 174   Rockbox automatically detects the file type and runs the appropriate plugin.
 175   The \setting{Open With} function can be used to override the default action and
 176   select a viewer by hand.
 177   For example, this function can be used to view a text file
 178   even if the file has a non-standard extension (i.e., the file has an extension
 179   of something other than \fname{.txt}). See \reference{ref:Viewersplugins}
 180   for more details on viewers.
 181 \item [Create Directory.]
 182   Create a new directory in the current directory on the disk.
 183 \item [Properties.]
 184   Shows properties such as size and the time and date of the last modification
 185   for the selected file. If used on a directory, the number of files and
 186   subdirectories will be shown, as well as the total size.
 187 \opt{recording}{
 188   \item [Set As Recording Directory.]
 189     Save recordings in the selected directory.
 190 }
 191 \item [Add to Shortcuts.]
 192   Adds a link to the selected item in the \fname{shortcuts.link} file.
 193   If the file does not already exist it will be created in the root directory.
 194   Note that if you create a shortcut to a file, Rockbox will not open it upon
 195   selecting, but simply bring you to it's location in the \setting{File Browser}.
 196 \end{description}
 197
 198 \subsection{\label{sec:virtual_keyboard}Virtual Keyboard}
 199 \screenshot{rockbox_interface/images/ss-virtual-keyboard}{The virtual keyboard}{}
 200 This is the virtual keyboard that is used when entering text in Rockbox, for
 201 example when renaming a file or creating a new directory.
 202 \nopt{player}{The virtual keyboard can be easily changed by making a text file
 203  with the required layout. More information on how to achieve this can be found
 204  on the Rockbox website at \wikilink{LoadableKeyboardLayouts}.}
 205
 206 \opt{morse_input}{
 207   Also you can switch to Morse code input mode by changing the
 208   \setting{Use Morse Code Input} setting%
 209   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD%
 210       ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_E200_PAD,PBELL_VIBE500_PAD}%
 211     { or by pressing \ActionKbdMorseInput{} in the virtual keyboard}%
 212   .}
 213
 214 \nopt{player}{% no "Actions" yet in the Player's virtual keyboard
 215
 216 \note{When the cursor is on the input line, \ActionKbdSelect{} deletes the preceding character}
 217
 218 \begin{btnmap}
 219     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
 220         ,MROBE100_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{
 221         \ActionKbdCursorLeft{} / \ActionKbdCursorRight
 222             &
 223         \opt{HAVEREMOTEKEYMAP}{\ActionRCKbdCursorLeft{} / \ActionRCKbdCursorRight
 224             &}
 225         Move the line cursor within the text line.
 226             \\
 227         %
 228         \ActionKbdBackSpace
 229             &
 230         \opt{HAVEREMOTEKEYMAP}{
 231             &}
 232         Delete the character before the line cursor.
 233             \\
 234     }%
 235     \ActionKbdLeft{} / \ActionKbdRight
 236         &
 237     \opt{HAVEREMOTEKEYMAP}{\ActionRCKbdLeft{} / \ActionRCKbdRight
 238         &}
 239     Move the cursor on the virtual keyboard.
 240     If you move out of the picker area, you get the previous/next page of
 241     characters (if there is more than one).
 242         \\
 243     %
 244     \ActionKbdUp{} / \ActionKbdDown
 245         &
 246     \opt{HAVEREMOTEKEYMAP}{\ActionRCKbdUp{} / \ActionRCKbdDown
 247         &}
 248     Move the cursor on the virtual keyboard.
 249     If you move out of the picker area you get to the line edit mode.
 250         \\
 251     %
 252     \nopt{IPOD_3G_PAD,IPOD_4G_PAD,IRIVER_H10_PAD,ONDIO_PAD,PBELL_VIBE500_PAD}{
 253         \ActionKbdPageFlip
 254             &
 255         \opt{HAVEREMOTEKEYMAP}{\ActionRCKbdPageFlip
 256             &}
 257         Flip to the next page of characters (if there is more than one).
 258             \\
 259     }
 260     %
 261     \ActionKbdSelect
 262         &
 263     \opt{HAVEREMOTEKEYMAP}{\ActionRCKbdSelect
 264         &}
 265     Insert the selected keyboard letter at the current line cursor position.
 266         \\
 267     %
 268     \ActionKbdDone
 269         &
 270     \opt{HAVEREMOTEKEYMAP}{\ActionRCKbdDone
 271         &}
 272     Exit the virtual keyboard and save any changes.
 273         \\
 274     %
 275     \ActionKbdAbort
 276         &
 277     \opt{HAVEREMOTEKEYMAP}{\ActionRCKbdAbort
 278         &}
 279     Exit the virtual keyboard without saving any changes.
 280         \\
 281 % to be done - create a separate section for morse imput and update the info
 282       \opt{morse_input}{
 283         \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PADD%
 284             ,SANSA_E200_PA,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{
 285           \ActionKbdMorseInput
 286           \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdMorseInput}
 287           & Toggle keyboard input mode and Morse code input mode. \\}
 288         %
 289         \ActionKbdMorseSelect
 290         \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdMorseSelect}
 291         & Tap to select a character in Morse code input mode. \\
 292       }
 293 \end{btnmap}
 294 }% end of non-Player section
 295
 296 \opt{player}{
 297   The current text line to be entered or edited is always listed on the first
 298   line of the display. The second line of the display can contain the character
 299   selection bar, as in the screenshot above.
 300     \begin{btnmap}
 301       \ButtonOn & Toggle picker- and line edit mode. \\
 302       \ButtonLeft{} / \ButtonRight
 303         & Move back and forth in the selected line (picker of input line). \\
 304       \ButtonPlay
 305         & Pick character in character bar, or act as backspace in the text line. \\
 306       Long \ButtonPlay & Accept \\
 307       \ButtonStop & Cancel \\
 308       \ButtonMenu & Flip picker lines. \\
 309     \end{btnmap}
 310 }
 311
 312 \input{rockbox_interface/tagcache.tex}
 313 \input{rockbox_interface/wps.tex}
 314
 315 %Include playlist section
 316 \input{working_with_playlists/main.tex}
 317 \input{rockbox_interface/hotkeys.tex}