fix red.
[kugel-rb/myfork.git] / manual / rockbox_interface / browsing_and_playing.tex
blobbdbb97ef5c11b6767540c1292fa91839d0eb54e6
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.
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.
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.
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}.}
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{}.
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.
45 \subsection{\label{ref:controls}File Browser Controls}
46 \begin{table}
47 \begin{btnmap}{}{}
48 \ActionStdPrev{}/\ActionStdNext{}
49 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev{}/\ActionRCStdNext{}}
50 & Go to previous/next item in list. If you are on the first/last
51 entry, the cursor will wrap to the last/first entry.\\
53 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}
55 \ButtonOn+\ButtonUp{}/ \ButtonDown
56 \opt{HAVEREMOTEKEYMAP}{&
57 \opt{IRIVER_RC_H100_PAD}{\ButtonRCSource{}/ \ButtonRCBitrate}
59 & Move one page up/down in the list.\\
61 \opt{IRIVER_H10_PAD}
63 \ButtonRew{}/ \ButtonFF
64 & Move one page up/down in the list.\\
67 \ActionTreeParentDirectory
68 \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeParentDirectory}
69 & Go to the parent directory.\\
71 \ActionTreeEnter
72 \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeEnter}
73 & Executes the default action on the selected file or enters a
74 directory.\\
76 \ActionTreeWps
77 \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeWps}
78 & If there is an audio file playing, returns to the
79 \setting{While Playing Screen} (WPS) without stopping playback.\\
81 \nopt{player,c200}%
83 \ActionTreeStop
84 \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeStop}
85 & Stops audio playback.\\%
88 \ActionStdContext{}
89 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdContext}
90 & Enter the \setting{Context Menu}\\
92 \ActionStdMenu{}
93 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdMenu}
94 & Enter the \setting{Main Menu}\\
96 \opt{quickscreen}{
97 \ActionStdQuickScreen
98 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdQuickScreen}
99 & Switches to the \setting{Quick Screen}
100 (see \reference{ref:QuickScreen}) \\
102 \opt{RECORDER_PAD}{
103 \ButtonFThree & Switches to the Display Quick Screen \\
107 \opt{SANSA_E200_PAD}{
108 \ActionStdRec & Switches to the Recording screen \\
111 \end{btnmap}
112 \end{table}
114 \opt{RECORDER_PAD}{
115 The functions of the F keys are also summarised on the button bar at the
116 bottom of the screen.
119 \subsection{\label{ref:Contextmenu}\label{ref:PartIISectionFM}Context Menu}
120 \screenshot{rockbox_interface/images/ss-context-menu}{The Context Menu}{}
122 The \setting{Context Menu} allows you to perform certain operations on files or
123 directories. To access the \setting{Context Menu}, position the selector over a file
124 or directory and access the context menu with \ActionStdContext{}.\\
126 \note{The \setting{Context Menu} is a context sensitive menu. If the
127 \setting{Context Menu} is invoked on a file, it will display options available
128 for files. If the \setting{Context Menu} is invoked on a directory,
129 it will display options for directories.\\}
131 The \setting{Context Menu} contains the following options (unless otherwise noted,
132 each option pertains both to files and directories):
134 \begin{description}
135 \item [Playlist.]
136 Enters the \setting{Playlist Submenu} (see \reference{ref:playlist_submenu}).
137 \item [Playlist Catalog.]
138 Enters the \setting{Playlist Catalog Submenu} (see
139 \reference{ref:playlist_catalog}).
140 \item [Rename.]
141 This function lets the user modify the name of a file or directory.
142 \item [Cut.]
143 Copies the name of the currently selected file or directory to the clipboard
144 and marks it to be `cut'.
145 \item [Copy.]
146 Copies the name of the currently selected file or directory to the clipboard
147 and marks it to be `copied'.
148 \item [Paste.]
149 Only visible if a file or directory name is on the clipboard. When selected
150 it will move or copy the clipboard to the current directory.
151 \item [Delete.]
152 Deletes the currently selected file. This option applies only to files, and
153 not to directories. Rockbox will ask for confirmation before deleting a file.
154 Press \ActionYesNoAccept{}
155 to confirm deletion or any other key to cancel.
156 \item [Delete Directory.]
157 Deletes the currently selected directory and all of the files and subdirectories
158 it may contain. Deleted directories cannot be recovered. Use this feature with
159 caution!
160 \opt{lcd_non-mono}{
161 \item [Set As Backdrop.]
162 Set the selected \fname{bmp} file as background image. The bitmaps need to meet the
163 conditions explained in \reference{ref:LoadingBackdrops}.
165 \item [Open with.]
166 Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox,
167 Rockbox automatically detects the file type and runs the appropriate plugin.
168 The \setting{Open With} function can be used to override the default action and
169 select a viewer by hand.
170 For example, this function can be used to view a text file
171 even if the file has a non-standard extension (i.e., the file has an extension
172 of something other than \fname{.txt}). See \reference{ref:Viewersplugins}
173 for more details on viewers.
174 \item [Create Directory.]
175 Create a new directory in the current directory on the disk.
176 \item [Properties.]
177 Shows properties such as size and the time and date of the last modification
178 for the selected file. If used on a directory, the number of files and
179 subdirectories will be shown, as well as the total size.
180 \opt{recording}{
181 \item [Set As Recording Directory.]
182 Save recordings in the selected directory.
184 \item [Add to Shortcuts.]
185 Adds a link to the selected item in the \fname{shortcuts.link} file.
186 If the file does not already exist it will be created in the root directory.
187 Note that if you create a shortcut to a file, Rockbox will not open it upon
188 selecting, but simply bring you to it's location in the \setting{File Browser}.
189 \end{description}
191 \subsection{\label{sec:virtual_keyboard}Virtual Keyboard}
192 \screenshot{rockbox_interface/images/ss-virtual-keyboard}{The virtual keyboard}{}
193 This is the virtual keyboard that is used when entering text in Rockbox, for
194 example when renaming a file or creating a new directory. The virtual keyboard
195 can be easily changed by making a text file with the required layout. More
196 information on how to achieve this can be found on the Rockbox website
197 at \wikilink{LoadableKeyboardLayouts}.
199 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,GIGABEAT_PAD,SANSA_E200_PAD,%
200 SANSA_C200_PAD,MROBE100_PAD}{
201 \begin{table}
202 \begin{btnmap}{}{}
203 \ActionKbdLeft~/ \ActionKbdRight~/ \ActionKbdUp~/ \ActionKbdDown
204 \opt{HAVEREMOTEKEYMAP}{
205 & \ActionRCKbdLeft~/ \ActionRCKbdRight~/ \ActionRCKbdUp~/ \ActionRCKbdDown}
206 & Move about the virtual keyboard (moves the solid cursor) \\
208 \ActionKbdPageFlip
209 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdPageFlip}
210 & Flip to the next page of characters (if there is more than one) \\
212 \ActionKbdCursorLeft{} / \ActionKbdCursorRight
213 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdCursorLeft{} / \ActionRCKbdCursorRight}
214 & Move the line cursor within the text line \\
216 \ActionKbdSelect
217 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdSelect}
218 & Inserts the selected keyboard letter at the current cursor position \\
220 \ActionKbdAbort
221 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdAbort}
222 & Exits the virtual keyboard without saving any changes \\
224 \opt{RECORDER_PAD}{
225 \ButtonFOne
226 & Shifts between the upper case, lower case and accented keyboards \\
229 \ActionKbdDone
230 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdDone}
231 & Exits the virtual keyboard and saves any changes \\
233 \ActionKbdBackSpace
234 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdBackSpace}
235 & Deletes the character before the line cursor \\
237 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,MROBE100_PAD}{
238 \ActionKbdMorseInput
239 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdMorseInput}
240 & Enters Morse input mode \\
241 \ActionKbdMorseSelect
242 \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdMorseSelect}
243 & Tap to select a character in Morse input mode \\
245 \end{btnmap}
246 \end{table}
249 \opt{IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,IAUDIO_X5_PAD}{
250 \textbf{Picker area}
251 \begin{table}
252 \begin{btnmap}{}{}
253 \ActionKbdUp/\ActionKbdDown
254 \opt{HAVEREMOTEKEYMAP}{& }
255 & Move about the virtual keyboard.
256 If you move out of the picker area, you get to the \emph{Line edit mode}. \\
257 \ActionKbdLeft/\ActionKbdRight
258 \opt{HAVEREMOTEKEYMAP}{& }
259 & (moves the solid cursor). \\
260 \ActionKbdSelect
261 \opt{HAVEREMOTEKEYMAP}{& }
262 & Inserts the currently selected keyboard letter at the current
263 filename cursor position \\
264 \ActionKbdDone
265 \opt{HAVEREMOTEKEYMAP}{& }
266 & Exits the virtual keyboard and saves any changes \\
267 \ActionKbdAbort
268 \opt{HAVEREMOTEKEYMAP}{& }
269 & Exits the virtual keyboard without saving any changes\\
270 \opt{IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
271 \ActionKbdMorseInput
272 \opt{HAVEREMOTEKEYMAP}{& }
273 & Enters Morse input mode \\
274 \ActionKbdMorseSelect
275 \opt{HAVEREMOTEKEYMAP}{& }
276 & Tap to select a character in Morse input mode \\
278 \end{btnmap}
279 \end{table}
280 \textbf{Line edit mode}
281 \begin{table}
282 \begin{btnmap}{}{}
283 \ActionKbdLeft/\ActionKbdRight
284 \opt{HAVEREMOTEKEYMAP}{& }
285 & Move left and right\\
286 \ActionKbdSelect
287 \opt{HAVEREMOTEKEYMAP}{& }
288 & Deletes the letter to the left of the cursor\\
289 \ActionKbdUp/\ActionKbdDown
290 \opt{HAVEREMOTEKEYMAP}{& }
291 & Returns to the picker area\\
292 \end{btnmap}
293 \end{table}
295 \opt{ondio}{
296 \begin{table}
297 \begin{btnmap}{Picker area}{}
298 \ButtonUp/\ButtonDown/\ButtonLeft/\ButtonRight
299 & Move about the virtual keyboard (moves the solid cursor).
300 If you move out of the picker area with \ButtonUp/\ButtonDown,
301 you get to the line edit mode. \\
302 \ButtonMenu
303 & Selects the letter underneath the cursor. \\
304 Long \ButtonMenu
305 & Accepts the change and returns to the File Browser.\\
306 \ButtonOff
307 & Quit the virtual keyboard without saving the changes.\\
308 \end{btnmap}
309 \end{table}
310 \begin{table}
311 \begin{btnmap}{Line edit mode}{}
312 \ButtonLeft/\ButtonRight & Move left and right\\
313 \ButtonMenu & Deletes the letter to the left of the cursor\\
314 Long \ButtonMenu & Accepts the deletion\\
315 \ButtonUp/\ButtonDown & Returns to the picker area\\
316 \end{btnmap}
317 \end{table}
320 \opt{player}{
321 The current text line to be entered or edited is always listed on the first
322 line of the display. The second line of the display can contain the character
323 selection bar, as in the screenshot above.
324 \begin{table}
325 \begin{btnmap}{}{}
326 \ButtonOn & Toggle picker- and line edit mode\\
327 \ButtonLeft/\ButtonRight & moves back and forth in the selected \\
328 & line (picker of input line) \\
329 \ButtonPlay & Picks character in character bar, or acts as backspace \\
330 & in the text line.\\
331 Long \ButtonPlay & Accept\\
332 \ButtonStop & Cancel\\
333 \ButtonMenu & Flips picker lines\\
334 \end{btnmap}
335 \end{table}
339 \input{rockbox_interface/tagcache.tex}
340 \input{rockbox_interface/wps.tex}
342 %Include playlist section
343 \input{working_with_playlists/main.tex}