manual: update browsing, playlists, bookmarking, ipod keymap

Change-Id: I7f3fd66fc973d3ed8d41cf24fba6aa4a44256354
This commit is contained in:
Christian Soffke 2023-01-08 16:11:39 +01:00
parent e8816552f6
commit b501788629
8 changed files with 88 additions and 104 deletions

View file

@ -14,14 +14,14 @@
the bookmark to load. There are other ways to load a bookmarks mentioned the bookmark to load. There are other ways to load a bookmarks mentioned
below. below.
\note{Bookmarking only works when tracks are launched from the file browser, \note{Bookmarking does not work with dynamic (i.e. modified but not saved)
and does not work for tracks launched via the playlists, such as when playing tracks from the \setting{Database} instead of
database. In addition, they do not work with dynamic (i.e. modified but not saved) the \setting{File Browser}.
playlists. If making a bookmark is not available, saving the playlist If you do not see the option to create a bookmark in the \setting{WPS Context Menu},
is sufficient to allow a bookmark to be made. Queued tracks, which are automatically try saving the current playlist first.
removed after playback, do not get stored to the playlist file and must Queued tracks (see \reference{ref:queuing}) do not get saved to the playlist file.
not be part of the current playlist. You need to confirm the removal of such tracks You're asked to confirm their removal when saving, so that the current playlist
when saving, or bookmarking will not be possible.} can be bookmarked. }
\begin{description} \begin{description}

View file

@ -53,10 +53,9 @@ If the \setting{Save a list of recently created bookmarks} option is enabled
then you can view a list of several recent bookmarks here and select one to then you can view a list of several recent bookmarks here and select one to
jump straight to that track.\\* jump straight to that track.\\*
\note{Bookmarking only works when tracks are launched from the file browser, \note{A track launched from the file browser can be bookmarked as is. If
and does not currently work for tracks launched via the tracks are launched via the database, or the current playlist has been modified,
database. In addition, they do not currently work with dynamic creating a bookmark requires that you save the playlist first.\\*}
playlists.\\*}
\begin{btnmap} \begin{btnmap}
\ActionStdNext \ActionStdNext
@ -319,7 +318,7 @@ Available types are:
\item[file] \config{data} is the name of the file to ``run'' \item[file] \config{data} is the name of the file to ``run''
\item[browse] \config{data} is the file or the folder to open the file browser at \item[browse] \config{data} is the file or the folder to open the file browser at
\item[playlist menu] \config{data} is the file or the folder to open the \item[playlist menu] \config{data} is the file or the folder to open the
``Current Playlist'' context menu item on ``Playing Next...'' context menu item on (see \reference{ref:playingnext_submenu})
\item[setting] \config{data} is the config name of the setting you want to change \item[setting] \config{data} is the config name of the setting you want to change
(see \reference{ref:config_file_options} for the list of the possible settings) (see \reference{ref:config_file_options} for the list of the possible settings)
\item[debug] \config{data} is the name of the debug menu item to display \item[debug] \config{data} is the name of the debug menu item to display

View file

@ -46,7 +46,7 @@
\newcommand{\ActionTreeHotkey}{\ButtonSelect + \ButtonPlay} \newcommand{\ActionTreeHotkey}{\ButtonSelect + \ButtonPlay}
%Button actions, YesNo context %Button actions, YesNo context
\newcommand{\ActionYesNoAccept}{\ButtonPlay} \newcommand{\ActionYesNoAccept}{\ButtonSelect}
%Button actions, Setting context %Button actions, Setting context
\newcommand{\ActionSettingInc}{\ButtonScrollFwd} \newcommand{\ActionSettingInc}{\ButtonScrollFwd}

View file

@ -46,7 +46,7 @@
\newcommand{\ActionTreeHotkey}{\ButtonSelect + \ButtonPlay} \newcommand{\ActionTreeHotkey}{\ButtonSelect + \ButtonPlay}
%Button actions, YesNo context %Button actions, YesNo context
\newcommand{\ActionYesNoAccept}{\ButtonPlay} \newcommand{\ActionYesNoAccept}{\ButtonSelect}
%Button actions, Setting context %Button actions, Setting context
\newcommand{\ActionSettingInc}{\ButtonScrollFwd} \newcommand{\ActionSettingInc}{\ButtonScrollFwd}

View file

@ -47,7 +47,7 @@
\newcommand{\ActionTreeHotkey}{\ButtonSelect + \ButtonPlay} \newcommand{\ActionTreeHotkey}{\ButtonSelect + \ButtonPlay}
%Button actions, YesNo context %Button actions, YesNo context
\newcommand{\ActionYesNoAccept}{\ButtonPlay} \newcommand{\ActionYesNoAccept}{\ButtonSelect}
%Button actions, Setting context %Button actions, Setting context
\newcommand{\ActionSettingInc}{\ButtonScrollFwd} \newcommand{\ActionSettingInc}{\ButtonScrollFwd}

View file

@ -159,18 +159,20 @@ each option pertains both to files and directories):
for more details on viewers. for more details on viewers.
\item [Create Directory.] \item [Create Directory.]
Create a new directory in the current directory on the disk. Create a new directory in the current directory on the disk.
\item [Properties.] \item [Properties / Show Track Info.]
Shows properties such as size and the time and date of the last modification 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 for the selected file. If used on a directory, the number of files and
subdirectories will be shown, as well as the total size. subdirectories will be shown, as well as the total size. If used on a supported
audio file, its metadata will be displayed.
\opt{lcd_non-mono}{ \opt{lcd_non-mono}{
\item [Set As Backdrop.] \item [Set As Backdrop.]
Set the selected \fname{bmp} file as background image. The bitmaps need to meet the Set the selected \fname{bmp} file as background image. The bitmaps need to meet the
conditions explained in \reference{ref:LoadingBackdrops}. conditions explained in \reference{ref:LoadingBackdrops}.
} }
\item [Add to Shortcuts.] \item [Add to Shortcuts.]
Adds a link to the selected item in the \fname{shortcuts.link} file. Adds a link to the selected item in the \fname{shortcuts.txt} file
If the file does not already exist it will be created in the root directory. (see \reference{ref:MainMenuShortcuts}).
If the file does not already exist it will be created in your Rockbox directory.
Note that if you create a shortcut to a file, Rockbox will not open it upon Note that if you create a shortcut to a file, Rockbox will not open it upon
selecting, but simply bring you to its location in the \setting{File Browser}. selecting, but simply bring you to its location in the \setting{File Browser}.
\end{description} \end{description}

View file

@ -224,19 +224,24 @@ to a track which can be displayed in the WPS and used in the Database
browser. The value wraps at 10. browser. The value wraps at 10.
\subsubsection{\label{ref:createbookmark}Bookmarks} \subsubsection{\label{ref:createbookmark}Bookmarks}
This allows you to create a bookmark in the currently-playing track. Note that bookmarks Create a bookmark in the currently playing track, or display existing entries.
can only be created for directories, or for playlists stored on disk. Unsaved or modified Bookmarks can only be used with directories, or playlists stored on
lists must be saved first. Queued tracks, which are automatically removed after playback, disk. If you don't see the option to create a bookmark, try saving the
do not get stored to the playlist file. When saving, Rockbox will offer to purge the current playlist first.
current playlist of such tracks, so that you'll be able to create bookmarks afterwards.
See \reference{ref:Bookmarkconfigactual} for more information on bookmarks. \note{If you've enabled options for queuing tracks (see \reference{ref:queuing}), keep
in mind that those are not saved to a playlist file.
When saving, Rockbox will offer to remove queued tracks, so that bookmarking the
current playlist becomes possible.}
Refer to \reference{ref:Bookmarkconfigactual} for more information on bookmarks.
\subsubsection{\label{ref:trackinfoviewer}Show Track Info} \subsubsection{\label{ref:trackinfoviewer}Show Track Info}
\screenshot{rockbox_interface/images/ss-id3-viewer}{The track info viewer}{} \screenshot{rockbox_interface/images/ss-id3-viewer}{The track info viewer}{}
This screen is accessible from the WPS screen, and provides a detailed view of Provides a detailed view of all the identity information about the current
all the identity information about the current track. This info is known as or selected track. This info is known as meta data and is stored in audio
meta data and is stored in audio file formats to keep information on artist, file formats to keep information on artist, album etc. To get to this screen
album etc. To access this screen, % from the WPS, %
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,% \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,%
SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_FUZEPLUS_PAD}{ SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_FUZEPLUS_PAD}{
press \ActionWpsIdThreeScreen. }% press \ActionWpsIdThreeScreen. }%
@ -244,7 +249,8 @@ album etc. To access this screen, %
GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_CLIP_PAD,PBELL_VIBE500_PAD,% GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_CLIP_PAD,PBELL_VIBE500_PAD,%
MPIO_HD200_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD,XDUOO_X3_PAD}% MPIO_HD200_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD,XDUOO_X3_PAD}%
{press \ActionWpsContext{} to access the {press \ActionWpsContext{} to access the
\setting{WPS Context Menu} and select \setting{Show Track Info}. } \setting{Context Menu}. Then select \setting{Show Track Info}. The same steps
work in the Playlist Viewer as well.}
\subsubsection{Open With...} \subsubsection{Open With...}
This \setting{Open With} function is the same as the \setting{Open With} This \setting{Open With} function is the same as the \setting{Open With}

View file

@ -2,85 +2,66 @@
\section{\label{ref:working_with_playlists}Working with Playlists} \section{\label{ref:working_with_playlists}Working with Playlists}
\subsection{Playlist terminology} \subsection{Playlist terminology}
Some common terms that are used in Rockbox when referring to
playlists:
\begin{description} \begin{description}
\item[Directory.] A playlist! One of the keys to getting the most out of \item[Directory.] Rockbox always considers the song that is playing to be part of
Rockbox is understanding that Rockbox \emph{always} considers the song that a playlist, and will create a playlist automatically when you are playing the
it is playing to be part of a playlist, and in some situations, Rockbox will contents of a directory. Meaning, just about anything that is described in this
create a playlist automatically. For example, if you are playing the chapter with respect to playlists also applies to directories.
contents of a directory, Rockbox will automatically create a playlist
containing all songs in it. This means that just about anything
that is described in this chapter with respect to playlists also applies to
directories.
\item[Dynamic playlist.] A dynamic playlist is a playlist that is created \item[Dynamic playlist.] A dynamic playlist is a playlist created
``On the fly.'' Any time you insert or queue tracks using the ``on the fly.'' Any time you use the \setting{Playing Next...} menu
\setting{Playing Next Submenu} (see \reference{ref:playingnext_submenu}), you are (see \reference{ref:playingnext_submenu}), or play something
creating (or adding to) a dynamic playlist. from the database, you are creating or adding to a dynamic playlist.
\item[Play/Add.] In Rockbox, to \setting{Play} or \setting{Add} an item means \item[Play / Add.] \setting{Play} or \setting{Add} a track to
putting it into a playlist and leaving it there, even after it is put it into the current (dynamic) playlist.
played.
\item[Queue.] To \setting{Queue} a song means to put it into a playlist, but then \item[Queue.] \setting{Queued} tracks are also put into the dynamic playlist,
to remove the song from the playlist once it has been played. but removed again as soon as they've been played.
Note: Options for queuing tracks are hidden by default (see \reference{ref:queuing} for more details).
\end{description} \end{description}
\subsection{Creating playlists} \subsection{Creating playlists}
Rockbox can create playlists in four different ways. \subsubsection{By selecting a song for playback}
When a song is selected from the \setting{File Browser} or \setting{Database} by pressing
\ActionTreeEnter, Rockbox will automatically create a playlist containing all of the
listed songs and will start playback.
\subsubsection{By selecting (``playing'') a song from the File Browser} \note{Playing a new song will erase the existing dynamic playlist
Whenever a song is selected from the \setting{File Browser} with and create a new one. If you want to \emph{add} a song to it instead,
\ActionTreeEnter, Rockbox will automatically create a playlist containing see \reference{ref:playingnext_submenu} on how to choose what's playing next.}
all of the songs in that directory and start playback with the selected
song.
\note{If you already have created a dynamic playlist, playing a new \subsubsection{By choosing ``Play`` or ``Play Shuffled`` from ``Playing Next...``}
song will \emph{erase} the current dynamic playlist and create a new one. Replaces an existing dynamic playlist with the selected tracks.
If you want to add a song to the current playlist
rather than erasing the current
playlist, see the section below on how to add music to a playlist.}
\subsubsection{By using the Play or Play Shuffled functions} \subsubsection{\label{ref:addtoplaylist_submenu}By choosing ``Add to Playlist...``}
The \setting{Play} function as described in \ref{ref:playingnext_submenu} Choose \setting{Add to Playlist...} from the \setting{Context Menu} to
will replace the dynamic playlist with the selected tracks. The \setting{Play add selected track(s) or directory to a new or existing playlist that is not currently
Shuffled} function is similar, except the selected tracks will be added to the playing.
playlist in a random order.
\subsubsection{\label{ref:addtoplaylist_submenu}By using the Add to Playlist submenu}
The \setting{Add to Playlist submenu} makes it possible to modify and create
playlists that are not currently playing. To do this select \setting{Add to Playlist...}
in the \setting{Context Menu}. There you will have two choices,
\setting{Add to Existing Playlist} adds the selected track or directory to an existing
playlist and \setting{Add to New Playlist} creates a new playlist containing
the selected track or directory.
\note{All playlists in the \setting{Playlist catalogue} are stored by default \note{All playlists in the \setting{Playlist catalogue} are stored by default
in the \fname{/Playlists} directory in the root of your \daps{} disk and in the \fname{/Playlists} directory in the root of your \daps{} disk and
playlists stored in other locations are not included in the catalogue. It is playlists stored in other locations are not included in the catalogue. It is
however possible to move existing playlists there (see however possible to move existing playlists there or change the default playlist
\reference{ref:Contextmenu}).} directory (see \reference{ref:Contextmenu}).}
\subsubsection{By using the Main Menu} \subsubsection{By using the Main Menu}
To create a playlist containing some or all of the music on your \dap{}, you can use the To create a playlist containing some or all of the music on your \dap{}, you can use the
\setting{Create Playlist} command in the \setting{Playlist Catalogue Context Menu} \setting{Create Playlist} command in the \setting{Playlist Catalogue Context Menu}
(see \reference{ref:playlistcatalogue_contextmenu}). (see \reference{ref:playlistcatalogue_contextmenu}).
\subsection{Adding music to playlists} \subsection{Choosing what's playing next}
\subsubsection{\label{ref:playingnext_submenu}Adding music to a dynamic playlist} \subsubsection{\label{ref:playingnext_submenu}Adding music to a dynamic playlist}
\screenshot{rockbox_interface/images/ss-playlist-menu}{The Playing Next Submenu}{} \screenshot{rockbox_interface/images/ss-playlist-menu}{Playing Next...}{}
The \setting{Playing Next Submenu} is a submenu in the \setting{Context Menu} (see \setting{Playing Next...} is a submenu in the \setting{Context Menu} (see
\reference{ref:Contextmenu}), it allows you to put tracks into a \reference{ref:Contextmenu}) that can be invoked on a selection of tracks in various
``dynamic playlist''. The place in which the newly places, such as the File Browser, Database, or even PictureFlow:
selected tracks are added to the playlist is determined by these
options:
\begin{description} \begin{description}
\item [Play Next.] Play track(s) immediately after the currently playing track. \item [Play Next.] Track(s) will play immediately after the currently playing track.
\item [Add.] Add track(s) after the most recently added tracks or, if tracks \item [Add.] Add track(s) after the most recently added tracks or, if tracks
have not been added yet, immediately after the currently playing track. have not been added yet, immediately after the currently playing track.
@ -92,8 +73,7 @@ have not been added yet, immediately after the currently playing track.
\item [Play Last Shuffled.] Add tracks in a random order to the end of the playlist. \item [Play Last Shuffled.] Add tracks in a random order to the end of the playlist.
\end{description} \end{description}
If you'd like to replace the current playlist with the new selection, the To replace the current dynamic playlist with your selection, choose:
following two options will achieve that effect.
\begin{description} \begin{description}
\item [Play.] Replace all entries in the dynamic playlist with the selected \item [Play.] Replace all entries in the dynamic playlist with the selected
@ -106,10 +86,12 @@ following two options will achieve that effect.
playlist in random order. playlist in random order.
\end{description} \end{description}
Another possibility is to add tracks \emph{temporarily} to the dynamic playlist. \label{ref:queuing}The following options are hidden by default, due to their
In Rockboxs parlance, this is called queuing. Queued tracks are automatically more complicated behavior. Queued tracks are temporarily added to the dynamic
removed from the playlist after they have been played. They are also not saved playlist, but are automatically removed as soon as the tracks have been played.
to the playlist file (see \reference{ref:playlistoptions}). Queued tracks will not be saved to a playlist file.
A current playlist containing queued tracks can not be bookmarked, even after saving it,
unless you confirm the tracks' removal first (see \reference{ref:createbookmark}).
\begin{description} \begin{description}
\item [Queue Next.] Corresponds to \setting{Play Next}. \item [Queue Next.] Corresponds to \setting{Play Next}.
@ -128,12 +110,8 @@ to the playlist file (see \reference{ref:playlistoptions}).
$\rightarrow$ \setting{Current Playlist}. Select either \setting{Show Shuffled Adding Options} $\rightarrow$ \setting{Current Playlist}. Select either \setting{Show Shuffled Adding Options}
or \setting{Show Queue Options} to customize the displayed set of options.} or \setting{Show Queue Options} to customize the displayed set of options.}
The \setting{Playing Next Submenu} can be used to add either single tracks or If \setting{Playing Next...} is invoked on a directory, Rockbox adds all of the tracks in
entire directories to a playlist. If the \setting{Playing Next Submenu} is that directory to the playlist.
invoked on a single track, it will put only that track into the playlist.
On the other hand, if the \setting{Playing Next Submenu} is invoked on a
directory, Rockbox adds all of the tracks in that directory to the
playlist.
\note{You can control whether or not Rockbox includes the contents of \note{You can control whether or not Rockbox includes the contents of
subdirectories when adding an entire directory to a playlist. Set the subdirectories when adding an entire directory to a playlist. Set the
@ -142,23 +120,22 @@ playlist.
you would like Rockbox to include tracks in subdirectories as well as tracks you would like Rockbox to include tracks in subdirectories as well as tracks
in the currently-selected directory.} in the currently-selected directory.}
Dynamic playlists are saved so resume will restore them exactly as they Dynamic playlists are saved, so resume will restore them exactly as they
were before shutdown. were before shutdown.
\note{To view, save, reshuffle, or display the play time of the current \note{To view, save, reshuffle, or display the play time of the current
dynamic playlist use the dynamic playlist use the
\setting{Playlist} sub menu in the WPS context menu or in the \setting{Current Playlist} sub menu in the WPS context menu.}
\setting{Main Menu}.}
\subsection{Modifying playlists} \subsection{Modifying playlists}
\subsubsection{Reshuffling} \subsubsection{Reshuffling}
Reshuffling the current playlist is easily done from the \setting{Current Playlist} Reshuffling the current playlist is easily done from the \setting{Current Playlist}
sub menu in the WPS, just select \setting{Reshuffle}. sub menu in the WPS.
\subsubsection{Moving and removing tracks} \subsubsection{Moving and removing tracks}
To move or remove a track from the current playlist enter the To move or remove a track from the current playlist, enter the
\setting{Playlist Viewer} by selecting \setting{View Current Playlist} in the \setting{Playlist Viewer} by selecting \setting{View Current Playlist} in the
\setting{Current Playlist} submenu in the WPS context menu or the \setting{Main Menu}. \setting{Current Playlist} submenu in the WPS context menu.
Once in the \setting{Playlist Viewer} open the context menu on the track you Once in the \setting{Playlist Viewer} open the context menu on the track you
want to move or remove. If you want to move the track, select \setting{Move} in want to move or remove. If you want to move the track, select \setting{Move} in
the context menu and then move the blinking cursor to the place where you want the context menu and then move the blinking cursor to the place where you want
@ -166,9 +143,9 @@ the track to be moved and confirm with \ActionStdOk. To remove a track, simply
select \setting{Remove} in the context menu. select \setting{Remove} in the context menu.
\subsection{Saving playlists} \subsection{Saving playlists}
To save the current playlist either enter the \setting{Current Playlist} submenu To save the current playlist, either enter the \setting{Current Playlist} submenu
in the \setting{WPS Context Menu} (see \reference{sec:contextmenu}) and in the \setting{WPS Context Menu} (see \reference{sec:contextmenu}) and
select \setting{Save Current Playlist} or enter the context menu for the select \setting{Save Current Playlist}, or enter the context menu for the
\setting{Playlist catalogue} in the \setting{Main Menu} and select \setting{Playlist catalogue} in the \setting{Main Menu} and select
\setting{Save Current Playlist}. \setting{Save Current Playlist}.
Either method will bring you to the \setting{Virtual Keyboard} (see Either method will bring you to the \setting{Virtual Keyboard} (see