manual/rockbox_interface/browsing_and_playing.tex - rockbox - Gitiles

 % $Id$ %
 \chapter{Browsing and playing}
 \section{\label{ref:file_browser}File Browser}
 \screenshot{rockbox_interface/images/ss-file-browser}{The file browser}{}
 Rockbox lets you browse your music in either of two ways. The
 \setting{File Browser} lets you navigate through the files and directories on
 your \dap, entering directories and executing the default action on each file.
 To help differentiate files, each file format is displayed with an icon.

 The \setting{Database Browser}, on the other hand, allows you to navigate
 through the music on your player using categories like album, artist, genre,
 etc.

 You can select whether to browse using the \setting{File Browser} or the
 \setting{Database Browser} by selecting either \setting{Files} or
 \setting{Database} in the \setting{Main Menu}.
 If you choose the \setting{File Browser}, the \setting{Show Files} setting
 lets you select what types of files you wish to view. See
 \reference{ref:ShowFiles} for more information on the \setting{Show Files}
 setting.

 \note{The \setting{File Browser} allows you to manipulate your files in ways
 that are not available within the \setting{Database Browser}. Read more about
 \setting{Database} in \reference{ref:database}. The remainder of this section
 deals with the \setting{File Browser}.}

 \opt{ondio}{
 Unlike the Archos Firmware, Rockbox provides multivolume support for the
 MultiMediaCard, this means the \dap{} can access both data volumes (internal
 memory and the MMC), thus being able to for instance, build playlists with
 files from both volumes.
 In the \setting{File Browser} a new directory will appear as soon as the device
 has read the content after inserting the card. This new directory's name is
 generated as \fname{<MMC1>}, and will behave exactly as any other directory
 on the \dap{}.
 }

 \opt{h10,h10_5gb}{\note{
 If your \dap{} is a MTP model, the Music directory where all your music is stored
 may be hidden in the \setting{File Browser}. This may be fixed by either
 either changing its properties (on a computer) to not hidden, or by changing
 the \setting{Show Files} setting to all.
 }}

 \subsection{\label{ref:controls}File Browser Controls}
 \begin{table}
     \begin{btnmap}{}{}
       \ActionStdPrev{}/\ActionStdNext{}
          & Go to previous/next item in list. If you are on the first/last
            entry, the cursor will wrap to the last/first entry.\\
       %
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}
         {
           \ButtonOn+\ButtonUp{}/ \ButtonDown
           & Move one page up/down in the list.\\
         }
       \opt{IRIVER_H10_PAD}
         {
           \ButtonRew{}/ \ButtonFF
           & Move one page up/down in the list.\\
         }
       %
       \ActionTreeParentDirectory & Go to the parent directory.\\
       %
       \ActionTreeEnter
       & Executes the default action on the selected file or enters a
         directory.\\
       %
       \ActionTreeWps & If there is an audio file playing, returns to the
          \setting{While Playing Screen} (WPS) without stopping playback.\\
       %
       \nopt{player}%
         {%
           \ActionTreeStop & Stops audio playback.\\%
         }%
       %
       \ActionStdContext{}
       & Enter the \setting{File Menu}\\
       %
       \ActionStdMenu{}
       & Enter the \setting{Main Menu}\\
       %
       \opt{RECORDER_PAD}{
         \ButtonFTwo & Switches to the Browse/Play Quick Menu \\
         %
         \ButtonFThree & Switches to the Display Quick Menu \\
         %
       }
       %
       \opt{SANSA_E200_PAD}{
         \ActionStdRec & Switches to the Recording screen \\
       %
       }
     \end{btnmap}
 \end{table}

 \opt{RECORDER_PAD}{
   The functions of the F keys are also summarised on the button bar at the
   bottom of the screen.
 }

 \subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu}
 \screenshot{rockbox_interface/images/ss-file-menu}{The File Menu}{}

 The \setting{File Menu} allows you to perform certain operations on files or
 directories.  To access the \setting{File Menu}, position the selector over a file
 or directory and access the context menu with \ActionStdContext{}.

 \note{The \setting{File Menu} is a context sensitive menu.  If the
 \setting{File Menu} is invoked on a file, it will display options available
 for files.  If the \setting{File Menu} is invoked on a directory,
 it will display options for directories.}

 The \setting{File Menu} contains the following options (unless otherwise noted,
 each option pertains both to files and directories):

 \begin{description}
 \item [Playlist.]
   Enters the \setting{Playlist Submenu} (see \reference{ref:playlist_submenu}).
 \item [Playlist Catalog.]
   Enters the \setting{Playlist Catalog Submenu} (see
   \reference{ref:playlist_catalog}).
 \item [Rename.]
   This function lets the user modify the name of a file or directory.
 \item [Cut.]
   Copies the name of the currently selected file or directory to the clipboard
   and marks it to be `cut'.
 \item [Copy.]
   Copies the name of the currently selected file or directory to the clipboard
   and marks it to be `copied'.
 \item [Paste.]
   Only visible if a file or directory name is on the clipboard. When selected
   it will move or copy the clipboard to the current directory.
 \item [Delete.]
   Deletes the currently selected file. This option applies only to files, and
   not to directories. Rockbox will ask for confirmation before deleting a file.
   Press \ActionYesNoAccept{}
   to confirm deletion or any other key to cancel.
 \item [Delete Directory.]
   Deletes the currently selected directory and all of the files and subdirectories
   it may contain. Deleted directories cannot be recovered. Use this feature with
   caution!
 \item [Open with.]
   Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox,
   Rockbox automatically detects the file type and runs the appropriate plugin.
   The \setting{Open With} function can be used to override the default action and
   select a viewer by hand.
   For example, this function can be used to view a text file
   even if the file has a non-standard extension (i.e., the file has an extension
   of something other than \fname{.txt}). See \reference{ref:Viewersplugins}
   for more details on viewers.
 \item [Create Directory.]
   Create a new directory in the current directory on the disk.
 \item [Properties.]
   Shows properties such as size and the time and date of the last modification
   for the selected file. If used on a directory, the number of files and
   subdirectories will be shown, as well as the total size.
 \item [Set As Recording Directory.]
   Save recordings in the selected directory.
 \end{description}

 \subsection{\label{sec:virtual_keyboard}Virtual Keyboard}
 \screenshot{rockbox_interface/images/ss-virtual-keyboard}{The virtual keyboard}{}
 This is the virtual keyboard that is used when entering text in Rockbox, for
   example when renaming a file or creating a new directory.

 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,GIGABEAT_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{
   \begin{table}
     \begin{btnmap}{}{}
       \ActionKbdLeft{}/ \ActionKbdRight{}/ \ActionKbdUp{}/ \ActionKbdDown
       & Move about the virtual keyboard (moves the solid cursor) \\
       %
       \ActionKbdCursorLeft{} or \ActionKbdCursorRight
       & Move the line cursor within the text line \\
       %
       \ActionKbdSelect
       & Inserts the selected keyboard letter at the current cursor position \\
       %
       \ActionKbdAbort
       & Exits the virtual keyboard without saving any changes \\
       %
       \opt{RECORDER_PAD}{
         \ButtonFOne
         & Shifts between the upper case, lower case and accented keyboards \\
       }
       %
       \ActionKbdDone
       & Exits the virtual keyboard and saves any changes \\
       \ActionKbdBackSpace
       & Deletes the character before the line cursor \\
       %
       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD}{
         \ActionKbdMorseInput
         & Enters Morse input mode \\
         \ActionKbdMorseSelect
         & Tap to select a character in Morse input mode \\
       }
     \end{btnmap}
   \end{table}
 }

 \opt{IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,IAUDIO_X5_PAD}{
   \textbf{Picker area}
   \begin{table}
     \begin{btnmap}{}{}
       \ActionKbdUp/\ActionKbdDown & Move about the virtual keyboard.
       If you move out of the picker area, you get to the \emph{Line edit mode}. \\
       \ActionKbdLeft/\ActionKbdRight & (moves the solid cursor). \\
       \ActionKbdSelect
       & Inserts the currently selected keyboard letter at the current
       filename cursor position \\
       \ActionKbdDone
       & Exits the virtual keyboard and saves any changes \\
       \ActionKbdAbort
       & Exits the virtual keyboard without saving any changes\\
       \opt{IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
           \ActionKbdMorseInput
           & Enters Morse input mode \\
           \ActionKbdMorseSelect
           & Tap to select a character in Morse input mode \\
       }
     \end{btnmap}
   \end{table}
   \textbf{Line edit mode}
   \begin{table}
     \begin{btnmap}{}{}
       \ActionKbdLeft/\ActionKbdRight & Move left and right\\
       \ActionKbdSelect & Deletes the letter to the left of the cursor\\
       \ActionKbdUp/\ActionKbdDown & Returns to the picker area\\
     \end{btnmap}
   \end{table}
 }
 \opt{ondio}{
     \begin{table}
     \begin{btnmap}{Picker area}{}
       \ButtonUp/\ButtonDown/\ButtonLeft/\ButtonRight
         & Move about the virtual keyboard (moves the solid cursor).
           If you move out of the picker area with \ButtonUp/\ButtonDown,
           you get to the line edit mode. \\
       \ButtonMenu
         & Selects the letter underneath the cursor. \\
       Long \ButtonMenu
        & Accepts the change and returns to the File Browser.\\
       \ButtonOff
        & Quit the virtual keyboard without saving the changes.\\
     \end{btnmap}
   \end{table}
   \begin{table}
     \begin{btnmap}{Line edit mode}{}
       \ButtonLeft/\ButtonRight & Move left and right\\
       \ButtonMenu & Deletes the letter to the left of the cursor\\
       Long \ButtonMenu & Accepts the deletion\\
       \ButtonUp/\ButtonDown & Returns to the picker area\\
     \end{btnmap}
   \end{table}
 }

 \opt{player}{
   The current text line to be entered or edited is always listed on the first
   line of the display. The second line of the display can contain the character
   selection bar, as in the screenshot above.
   \begin{table}
      \begin{btnmap}{}{}
        \ButtonOn & Toggle picker- and line edit mode\\
        \ButtonLeft/\ButtonRight &  moves back and forth in the selected \\
                                 & line (picker of input line) \\
        \ButtonPlay & Picks character in character bar, or acts as backspace \\
                    & in the text line.\\
        Long \ButtonPlay & Accept\\
        \ButtonStop & Cancel\\
        \ButtonMenu & Flips picker lines\\
     \end{btnmap}
   \end{table}

 }

 \input{rockbox_interface/tagcache.tex}
 \input{rockbox_interface/wps.tex}

 %Include playlist section
 \input{working_with_playlists/main.tex}
	% $Id$ %
	\chapter{Browsing and playing}
	\section{\label{ref:file_browser}File Browser}
	\screenshot{rockbox_interface/images/ss-file-browser}{The file browser}{}
	Rockbox lets you browse your music in either of two ways. The
	\setting{File Browser} lets you navigate through the files and directories on
	your \dap, entering directories and executing the default action on each file.
	To help differentiate files, each file format is displayed with an icon.

	The \setting{Database Browser}, on the other hand, allows you to navigate
	through the music on your player using categories like album, artist, genre,
	etc.

	You can select whether to browse using the \setting{File Browser} or the
	\setting{Database Browser} by selecting either \setting{Files} or
	\setting{Database} in the \setting{Main Menu}.
	If you choose the \setting{File Browser}, the \setting{Show Files} setting
	lets you select what types of files you wish to view. See
	\reference{ref:ShowFiles} for more information on the \setting{Show Files}
	setting.

	\note{The \setting{File Browser} allows you to manipulate your files in ways
	that are not available within the \setting{Database Browser}. Read more about
	\setting{Database} in \reference{ref:database}. The remainder of this section
	deals with the \setting{File Browser}.}

	\opt{ondio}{
	Unlike the Archos Firmware, Rockbox provides multivolume support for the
	MultiMediaCard, this means the \dap{} can access both data volumes (internal
	memory and the MMC), thus being able to for instance, build playlists with
	files from both volumes.
	In the \setting{File Browser} a new directory will appear as soon as the device
	has read the content after inserting the card. This new directory's name is
	generated as \fname{<MMC1>}, and will behave exactly as any other directory
	on the \dap{}.
	}

	\opt{h10,h10_5gb}{\note{
	If your \dap{} is a MTP model, the Music directory where all your music is stored
	may be hidden in the \setting{File Browser}. This may be fixed by either
	either changing its properties (on a computer) to not hidden, or by changing
	the \setting{Show Files} setting to all.
	}}

	\subsection{\label{ref:controls}File Browser Controls}
	\begin{table}
	\begin{btnmap}{}{}
	\ActionStdPrev{}/\ActionStdNext{}
	& Go to previous/next item in list. If you are on the first/last
	entry, the cursor will wrap to the last/first entry.\\
	%
	\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}
	{
	\ButtonOn+\ButtonUp{}/ \ButtonDown
	& Move one page up/down in the list.\\
	}
	\opt{IRIVER_H10_PAD}
	{
	\ButtonRew{}/ \ButtonFF
	& Move one page up/down in the list.\\
	}
	%
	\ActionTreeParentDirectory & Go to the parent directory.\\
	%
	\ActionTreeEnter
	& Executes the default action on the selected file or enters a
	directory.\\
	%
	\ActionTreeWps & If there is an audio file playing, returns to the
	\setting{While Playing Screen} (WPS) without stopping playback.\\
	%
	\nopt{player}%
	{%
	\ActionTreeStop & Stops audio playback.\\%
	}%
	%
	\ActionStdContext{}
	& Enter the \setting{File Menu}\\
	%
	\ActionStdMenu{}
	& Enter the \setting{Main Menu}\\
	%
	\opt{RECORDER_PAD}{
	\ButtonFTwo & Switches to the Browse/Play Quick Menu \\
	%
	\ButtonFThree & Switches to the Display Quick Menu \\
	%
	}
	%
	\opt{SANSA_E200_PAD}{
	\ActionStdRec & Switches to the Recording screen \\
	%
	}
	\end{btnmap}
	\end{table}

	\opt{RECORDER_PAD}{
	The functions of the F keys are also summarised on the button bar at the
	bottom of the screen.
	}

	\subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu}
	\screenshot{rockbox_interface/images/ss-file-menu}{The File Menu}{}

	The \setting{File Menu} allows you to perform certain operations on files or
	directories. To access the \setting{File Menu}, position the selector over a file
	or directory and access the context menu with \ActionStdContext{}.

	\note{The \setting{File Menu} is a context sensitive menu. If the
	\setting{File Menu} is invoked on a file, it will display options available
	for files. If the \setting{File Menu} is invoked on a directory,
	it will display options for directories.}

	The \setting{File Menu} contains the following options (unless otherwise noted,
	each option pertains both to files and directories):

	\begin{description}
	\item [Playlist.]
	Enters the \setting{Playlist Submenu} (see \reference{ref:playlist_submenu}).
	\item [Playlist Catalog.]
	Enters the \setting{Playlist Catalog Submenu} (see
	\reference{ref:playlist_catalog}).
	\item [Rename.]
	This function lets the user modify the name of a file or directory.
	\item [Cut.]
	Copies the name of the currently selected file or directory to the clipboard
	and marks it to be `cut'.
	\item [Copy.]
	Copies the name of the currently selected file or directory to the clipboard
	and marks it to be `copied'.
	\item [Paste.]
	Only visible if a file or directory name is on the clipboard. When selected
	it will move or copy the clipboard to the current directory.
	\item [Delete.]
	Deletes the currently selected file. This option applies only to files, and
	not to directories. Rockbox will ask for confirmation before deleting a file.
	Press \ActionYesNoAccept{}
	to confirm deletion or any other key to cancel.
	\item [Delete Directory.]
	Deletes the currently selected directory and all of the files and subdirectories
	it may contain. Deleted directories cannot be recovered. Use this feature with
	caution!
	\item [Open with.]
	Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox,
	Rockbox automatically detects the file type and runs the appropriate plugin.
	The \setting{Open With} function can be used to override the default action and
	select a viewer by hand.
	For example, this function can be used to view a text file
	even if the file has a non-standard extension (i.e., the file has an extension
	of something other than \fname{.txt}). See \reference{ref:Viewersplugins}
	for more details on viewers.
	\item [Create Directory.]
	Create a new directory in the current directory on the disk.
	\item [Properties.]
	Shows properties such as size and the time and date of the last modification
	for the selected file. If used on a directory, the number of files and
	subdirectories will be shown, as well as the total size.
	\item [Set As Recording Directory.]
	Save recordings in the selected directory.
	\end{description}

	\subsection{\label{sec:virtual_keyboard}Virtual Keyboard}
	\screenshot{rockbox_interface/images/ss-virtual-keyboard}{The virtual keyboard}{}
	This is the virtual keyboard that is used when entering text in Rockbox, for
	example when renaming a file or creating a new directory.

	\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,GIGABEAT_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{
	\begin{table}
	\begin{btnmap}{}{}
	\ActionKbdLeft{}/ \ActionKbdRight{}/ \ActionKbdUp{}/ \ActionKbdDown
	& Move about the virtual keyboard (moves the solid cursor) \\
	%
	\ActionKbdCursorLeft{} or \ActionKbdCursorRight
	& Move the line cursor within the text line \\
	%
	\ActionKbdSelect
	& Inserts the selected keyboard letter at the current cursor position \\
	%
	\ActionKbdAbort
	& Exits the virtual keyboard without saving any changes \\
	%
	\opt{RECORDER_PAD}{
	\ButtonFOne
	& Shifts between the upper case, lower case and accented keyboards \\
	}
	%
	\ActionKbdDone
	& Exits the virtual keyboard and saves any changes \\
	\ActionKbdBackSpace
	& Deletes the character before the line cursor \\
	%
	\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD}{
	\ActionKbdMorseInput
	& Enters Morse input mode \\
	\ActionKbdMorseSelect
	& Tap to select a character in Morse input mode \\
	}
	\end{btnmap}
	\end{table}
	}

	\opt{IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,IAUDIO_X5_PAD}{
	\textbf{Picker area}
	\begin{table}
	\begin{btnmap}{}{}
	\ActionKbdUp/\ActionKbdDown & Move about the virtual keyboard.
	If you move out of the picker area, you get to the \emph{Line edit mode}. \\
	\ActionKbdLeft/\ActionKbdRight & (moves the solid cursor). \\
	\ActionKbdSelect
	& Inserts the currently selected keyboard letter at the current
	filename cursor position \\
	\ActionKbdDone
	& Exits the virtual keyboard and saves any changes \\
	\ActionKbdAbort
	& Exits the virtual keyboard without saving any changes\\
	\opt{IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
	\ActionKbdMorseInput
	& Enters Morse input mode \\
	\ActionKbdMorseSelect
	& Tap to select a character in Morse input mode \\
	}
	\end{btnmap}
	\end{table}
	\textbf{Line edit mode}
	\begin{table}
	\begin{btnmap}{}{}
	\ActionKbdLeft/\ActionKbdRight & Move left and right\\
	\ActionKbdSelect & Deletes the letter to the left of the cursor\\
	\ActionKbdUp/\ActionKbdDown & Returns to the picker area\\
	\end{btnmap}
	\end{table}
	}
	\opt{ondio}{
	\begin{table}
	\begin{btnmap}{Picker area}{}
	\ButtonUp/\ButtonDown/\ButtonLeft/\ButtonRight
	& Move about the virtual keyboard (moves the solid cursor).
	If you move out of the picker area with \ButtonUp/\ButtonDown,
	you get to the line edit mode. \\
	\ButtonMenu
	& Selects the letter underneath the cursor. \\
	Long \ButtonMenu
	& Accepts the change and returns to the File Browser.\\
	\ButtonOff
	& Quit the virtual keyboard without saving the changes.\\
	\end{btnmap}
	\end{table}
	\begin{table}
	\begin{btnmap}{Line edit mode}{}
	\ButtonLeft/\ButtonRight & Move left and right\\
	\ButtonMenu & Deletes the letter to the left of the cursor\\
	Long \ButtonMenu & Accepts the deletion\\
	\ButtonUp/\ButtonDown & Returns to the picker area\\
	\end{btnmap}
	\end{table}
	}

	\opt{player}{
	The current text line to be entered or edited is always listed on the first
	line of the display. The second line of the display can contain the character
	selection bar, as in the screenshot above.
	\begin{table}
	\begin{btnmap}{}{}
	\ButtonOn & Toggle picker- and line edit mode\\
	\ButtonLeft/\ButtonRight & moves back and forth in the selected \\
	& line (picker of input line) \\
	\ButtonPlay & Picks character in character bar, or acts as backspace \\
	& in the text line.\\
	Long \ButtonPlay & Accept\\
	\ButtonStop & Cancel\\
	\ButtonMenu & Flips picker lines\\
	\end{btnmap}
	\end{table}

	}

	\input{rockbox_interface/tagcache.tex}
	\input{rockbox_interface/wps.tex}

	%Include playlist section
	\input{working_with_playlists/main.tex}