Manual updates

- Reverse order of prev/next buttons in html manual
- Rename "Playlist Catalogue" to "Playlists"
- Update order of menu items in "Playlists" context menu section
- Add "View Album Art" to "WPS Context Menu" section
- Adjust wording in "Playlists", "Basic Controls/Concepts" and
  "Database" section
- Fix: Playlists are saved to root directory (not cwd) if no path
  provided
- Fix: "Recursively Insert Directories" applies to all playlists,
  not just the current one
- Fix: Update description of "Create Playlist" option
- Generally refer to "current playlist" instead of
  "dynamic playlist" and remove reference to "on-the-fly playlist"

Change-Id: I200d19c5fb10f1f0ddb7d993827c90be4a7402b9

manual/configure_rockbox/playback_options.tex

@@ -92,7 +92,7 @@ you to configure settings related to audio playback.
 
 \section{Party Mode}
   Enables unstoppable music playback. When new songs are
-  selected, they are queued at the end of the current dynamic playlist
+  selected, they are queued at the end of the current playlist
   instead of being played immediately. Pausing and stopping playback is
   disabled as well as skipping songs and launching plugins.
 

manual/configure_rockbox/playlist_options.tex

@@ -19,17 +19,18 @@ related to playlists.
   \end{description}
 
 \item[Recursively Insert Directories.]
-  If set to \setting{On}, then when a directory is inserted or queued into a
+  If set to \setting{On}, then when a directory is added to a playlist,
-  dynamic playlist, all subdirectories will also be inserted. If set to \setting{Ask},
+  all subdirectories will also be added. If set to \setting{Ask},
   Rockbox will prompt the user about whether to include sub-directories.
 
 \item[Current Playlist.]
-  This submenu contains settings related to the current dynamic playlist.
+  This submenu contains settings related to the current playlist.
   \begin{description}
 
   \item[Warn When Erasing Dynamic Playlist.]
   If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
-  take an action that will cause Rockbox to erase the current dynamic playlist.
+  take an action that will cause Rockbox to erase a current playlist that has been
+  modified.
 
   \item[Keep Current Track When Replacing Playlist.]
   If set to \setting{Yes}, then \setting{Play} and \setting{Play Shuffled} in

manual/configure_rockbox/wps.tex

@@ -4,7 +4,7 @@
   \begin{description}
   \item[Default Browser.]
   Decide if you want the \setting{File Browser}, \setting{Database}, or
-  \setting{Playlist Catalogue} to launch after pressing \ActionWpsBrowse{}
+  \setting{Playlists} to launch after pressing \ActionWpsBrowse{}
   on the WPS, when no other browser has recently been used.
   \opt{hotkey}{
     \item[WPS Hotkey.] Sets the hotkey function for

manual/main_menu/main.tex

@@ -153,38 +153,38 @@ The details of this menu are covered in
 
 \opt{radio}{\input{main_menu/fmradio.tex}}
 
-\section{\label{ref:playlistoptions}Playlist Catalogue}
+\section{\label{ref:playlistoptions}Playlists}
-  This menu provides a simple interface to maintain
+  This menu provides easy access to the playlists residing in \fname{/Playlists} (or another
-  several playlists (see \reference{ref:working_with_playlists}). Playlists can be created in
+  directory of your choice). Selecting a playlist will display its contents.
-  three ways. Playing a file in a directory causes all the files in it
+  Playlists can be created, or the playlist directory can be changed, from the
-  to be placed in a playlist. Playlists can be created manually by
+  \setting{Context Menu} (see \reference{ref:Contextmenu}).
-  either using the  \setting{Context Menu} (see \reference{ref:Contextmenu}) or using
+  To create a new playlist, you can also use the \setting{Save} option from the
-  the \setting{Current Playlist} menu. Both automatically and manually created
+  \setting{Current Playlist} menu (see \reference{ref:WPS}).
-  playlists can be edited using this menu.
 
-\subsection{\label{ref:playlistcatalogue_contextmenu}The Playlist Catalogue Context Menu}
+\subsection{\label{ref:playlistcatalogue_contextmenu}Playlists Context Menu}
 
 \begin{description}
-\item[Create Playlist:]
-  Rockbox will create a playlist with all tracks from the directory that is
-currently selected in the \setting{File Browser}, including
-all of its sub-directories. If you have selected the root level or your Playlist Catalogue directory,
-Rockbox will instead create a playlist with all tracks from all directories. The playlist
-will be saved in the Playlist Catalogue directory.
-
 \item[View Current Playlist:]
-  Displays the contents of the current dynamic playlist.
+  Displays the contents of the current playlist.
 
 \item[Save Current Playlist:]
-  Saves the current dynamic playlist, excluding queued tracks, to the
+  Saves the current playlist, excluding queued tracks, to the
 specified file. Asks for confirmation whether to remove queued tracks
 from the current playlist, so that bookmarks can be created
 (see \reference{ref:createbookmark}).
-If no path is provided then playlist is saved to the current directory.
+If no path is provided, playlist is saved to the root directory.
+
+\item[Create Playlist:]
+  Rockbox will create a playlist with all tracks from the directory that is
+currently selected in the \setting{File Browser}.
+If you have selected the root level, or your Playlist directory, Rockbox
+will create a playlist with tracks from the root directory.
+Sub-directories will be included, unless the option to recursively insert
+directories has been turned off, see \reference{ref:PlaylistOptions}.
 
 \item[Reset Playlist Catalogue Directory:]
   Will reset the default location for playlists to the \fname{/Playlists}
-directory. Playlists stored in other locations are not included in the catalogue.
+directory.
 
 \end{description}
 

manual/rockbox-html.cfg

@@ -19,7 +19,7 @@ hr { display:none; }
 \Configure{Link}{a}{href=}{name=}{}
 \Configure{@HEAD}{\HCode{<script type="text/javascript" src="gsearch.js"></script>}}
 \Configure{BODY}{\HCode{<body onload="gsearch();">}}{\HCode{</body>}}
-\Configure{crosslinks*}{next}{up}{prev}{}
+\Configure{crosslinks*}{prev}{up}{next}{}
 \Configure{crosslinks+}%
 {\HCode{<div style='float:left;'><a href='https://www.rockbox.org'><img src='https://www.rockbox.org/rockbox100.png'/></a></div><div id='gsearch' style='float:right;'>Enable JavaScript to show search field.</div><div style='clear:both;' class='crosslinks'>}}%
 {\HCode{</div>}}%

manual/rockbox_interface/browsing_and_playing.tex

@@ -180,7 +180,9 @@ each option pertains both to files and directories):
 \subsubsection{Set As...}
 \begin{description}
   \item [Playlist Directory.]
-     Set as default directory for the Playlist Catalogue.
+     Set as default playlist directory. Playlists from this directory will appear
+     when you select \setting{Playlists} from the main menu
+     (see \reference{ref:playlistoptions}).
   \opt{tagcache}{
   \item [Database Directory.]
      Rockbox usually stores database files in the \fname{/.rockbox} folder.

manual/rockbox_interface/main.tex

@@ -794,57 +794,47 @@ The default directory structure that is assumed by some parts of Rockbox
 
 \subsection{The first contact}
 
-After you have first started the \dap{}, you'll be presented by the
+After you have first started the \dap{}, you'll be presented with the
-\setting{Main Menu}. From this menu you can reach every function of Rockbox,
+\setting{Main Menu}. From this menu you can reach every function of Rockbox.
-for more information (see \reference{ref:main_menu}). To browse the files
+For more information, see \reference{ref:main_menu}. To browse the files
 on your \dap{}, select \setting{Files} (see \reference{ref:file_browser}), and to
-browse in a view that is based on the meta-data\footnote{ID3 Tags, Vorbis
+browse based on the meta-data\footnote{ID3 Tags, Vorbis
 comments, etc.} of your audio files, select \setting{Database} (see
 \reference{ref:database}).
 
 \subsection{Basic controls}
-When browsing files and moving through menus you usually get a list view
+Use \ActionStdNext{} and \ActionStdPrev{} to adjust the selection when browsing
-presented. The navigation in these lists are usually the same and should be
+through menus. \opt{wheel_acceleration}{
-pretty intuitive.
+Note that scroll speed accelerates, the faster you rotate the wheel.}
-In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around
+Press \ActionStdOk{} to select an item. Selecting an audio file in the File Browser
-the selection. Use \ActionStdOk{} to select an item. \opt{wheel_acceleration}{
+will play it. The ``While playing screen'' (``WPS'', see \reference{ref:WPS}) will
-Note that the scroll speed is accelerating the faster you rotate the wheel.}
+be displayed, and the current playlist will be replaced with tracks from the current
-When browsing the file system selecting an audio file plays it. The view
+directory. To go back to the bowser, either stop playback using the
-switches to the ``While playing screen'', usually abbreviated as ``WPS'' (see
+\ActionWpsStop{} button, or press \ActionWpsBrowse{}, which keeps playback
-\reference{ref:WPS}. The dynamic playlist gets replaced with the contents of
+running.
-the current directory. This way you can easily treat directories as playlists.
+When browsing files, return to parent directories with \ActionTreeParentDirectory.
-The created dynamic playlist can be extended or modified while playing. This is
-also known as ``on-the-fly playlist''.
-To go back to the \setting{File Browser} stop the playback with the
-\ActionWpsStop{} button or return to the file browser while keeping playback
-running using \ActionWpsBrowse{}.
-In list views you can go back one step with \ActionTreeParentDirectory.
 
 \subsection{Basic concepts}
 \subsubsection{Playlists}
-Rockbox is playlist oriented. This means that every time you play an audio file,
+Rockbox is playlist-oriented. This means that every time you play an audio file,
-a so-called ``dynamic playlist'' is generated, unless you play a saved
+a current playlist is generated.
-playlist. You can modify the dynamic playlist while playing and also save
+You can modify the current playlist in many ways while playing, and also save
-it to a file. If you do not want to use playlists you can simply play your
+it to a file. But you are not forced to do so.
-files directory based.
 Playlists are covered in detail in \reference{ref:working_with_playlists}.
 
 \subsubsection{Menu}
-From the menu you can customise Rockbox. Rockbox itself is very customisable.
+Menus are the primary way of interacting with Rockbox and offer quick access
-Also there are some special menus for quick access to frequently used
+to frequently-used functions.
-functions.
 
 \subsubsection{Context Menu}
-Some views, especially the file browser and the WPS have a context menu.
+In many places, a context menu can be accessed by pressing \ActionStdContext{}.
-From the file browser this can be accessed with \ActionStdContext{}.
+A context menu allows you to perform actions relevant to your current selection, and may
-The contents of the context menu vary, depending on the situation it gets
+include more advanced commands.
-called. The context menu itself presents you with some operations you can
+In the file browser, the relevant selection may be a file (or directory).
-perform with the currently highlighted file. In the file browser this is
+On the WPS, it is the currently playing track. Some actions do not apply
-the file (or directory) that is highlighted by the cursor. From the WPS this is
+to the selection, but relate to the screen itself, from which the context menu
-the currently playing file. Also there are some actions that do not apply
+was accessed. Playback settings accessible from the “While playing screen” are one such
-to the current file but refer to the screen from which the context menu
+example.
-gets called. One example is the playback menu, which can be called using
-the context menu from within the WPS.
 
 \section{Customising Rockbox}
 Rockbox' User Interface can be customised using ``Themes''. Themes usually

manual/rockbox_interface/tagcache.tex

@@ -133,20 +133,14 @@ Browser} setting (\setting{Settings $\rightarrow$ General Settings
 $\rightarrow$ System $\rightarrow$ Limits}) in order to view long lists of
 tracks in the ID3 database browser.\\
 
-There is no option to turn off database completely. If you do not want
+To "turn off" the database, do not initialize it, and do not load it to RAM.}%
-to use it just do not do the initial build of the database and do not load it
-to RAM.}%
 
-If your total amount of music tracks exceeds the value of the
+If the number of tracks you are attempting to play exceeds the value of the
 \setting{Max Playlist Size} setting (\setting{Settings $\rightarrow$ General
-Settings $\rightarrow$ System $\rightarrow$ Limits}), using the database
+Settings $\rightarrow$ System $\rightarrow$ Limits}), a randomly chosen
-will be your only way to shuffle between all songs from your music library.
+subset of tracks is added to the current playlist instead. This allows you
-Any view on the database browser that exceeds the maximum value of this option
+to play random tracks from your whole library without having to increase any
-will be automatically adjusted and randomized to fit into the available space
+limits that may degrade performance.
-when you will create a dynamic playlist from the view.
-Using the database browser is recommended if you shuffle regularly between a lot of
-songs rather than increasing your limit, so you will get the best possible performance
-on this action.
 
 \note{For your convenience, a shortcut button "Shuffle Songs" is available directly
 from the \setting{Database} menu to create and start a mix with all of your

manual/rockbox_interface/wps.tex

@@ -61,7 +61,7 @@ your WPS (While Playing Screen).
       %
       \ActionWpsBrowse
       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsBrowse}
-      & Return to the \setting{File Browser} / \setting{Database} / \setting{Playlist Catalogue}.\\
+      & Return to the \setting{File Browser} / \setting{Database} / \setting{Playlists}.\\
       %
       \ActionWpsContext
       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext}
@@ -177,7 +177,7 @@ several indicators.
 
 \subsection{\label{sec:contextmenu}The WPS Context Menu}
 Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu}
-allows you quick access to some often used functions.
+allows you quick access to some often-used functions.
 
 \subsubsection{Current Playlist}
 The \setting{Current Playlist} submenu allows you to view, save, search, reshuffle,
@@ -328,3 +328,6 @@ This may even be the whole track.
   \end{btnmap}
 
 }
+
+\subsubsection{View Album Art}
+Display artwork for the currently playing track.

manual/working_with_playlists/main.tex

@@ -1,27 +1,6 @@
 % $Id$ %
 \section{\label{ref:working_with_playlists}Working with Playlists}
 
-\subsection{Playlist terminology}
-
-\begin{description}
-\item[Directory.] Rockbox always considers the song that is playing to be part of
-  a playlist, and will create a playlist automatically when you are playing the
-  contents of a directory. Meaning, 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 created
-  ``on the fly.'' Any time you use the \setting{Playing Next...} menu
-  (see \reference{ref:playingnext_submenu}), or play something
-  from the database, you are creating or adding to a dynamic playlist.
-
-\item[Play / Add.] \setting{Play} or \setting{Add} a track to
-  put it into the current (dynamic) playlist.
-
-\item[Queue.] \setting{Queued} tracks are also put into the dynamic playlist,
-  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}
-
 \subsection{Creating playlists}
 
 \subsubsection{By selecting a song for playback}
@@ -29,32 +8,29 @@ When a song is selected from the \setting{File Browser} or \setting{Database} by
 \ActionTreeEnter, Rockbox will automatically create a playlist containing all of the
 listed songs and will start playback.
 
-\note{Playing a new song will erase the existing dynamic playlist
+\note{Playing a new song will clear the current playlist. If you want to \emph{add}
-  and create a new one. If you want to \emph{add} a song to it instead,
+      a song to it instead, see \reference{ref:playingnext_submenu} on how to choose
-  see \reference{ref:playingnext_submenu} on how to choose what's playing next.}
+      what's playing next.}
 
 \subsubsection{By choosing ``Play`` or ``Play Shuffled`` from ``Playing Next...``}
-Replaces an existing dynamic playlist with the selected tracks.
+Replaces current playlist with the selected tracks.
 
 \subsubsection{\label{ref:addtoplaylist_submenu}By choosing  ``Add to Playlist...``}
 Choose \setting{Add to Playlist...} from the \setting{Context Menu} to
 add selected track(s) or directory to a new or existing playlist that is not currently
 playing.
 
-\note{All playlists in the \setting{Playlist catalogue} are stored by default
+\note{Playlists are stored in \fname{/Playlists} by default.
-  in the \fname{/Playlists} directory in the root of your \daps{} disk and
+  The default playlist directory can be changed (see \reference{ref:Contextmenu}).}
-  playlists stored in other locations are not included in the catalogue. It is
-  however possible to move existing playlists there or change the default playlist
-  directory (see \reference{ref:Contextmenu}).}
 
 \subsubsection{By using the Main Menu}
 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{Playlists Context Menu}
 (see \reference{ref:playlistcatalogue_contextmenu}).
 
 \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 the current playlist}
 \screenshot{rockbox_interface/images/ss-playlist-menu}{Playing Next...}{}
 \setting{Playing Next...} is a submenu in the \setting{Context Menu} (see
 \reference{ref:Contextmenu}) that can be invoked on a selection of tracks in various
@@ -73,10 +49,10 @@ 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.
 \end{description}
 
-To replace the current dynamic playlist with your selection, choose:
+To replace the current playlist with your selection, choose:
 
 \begin{description}
-\item [Play.] Replace all entries in the dynamic playlist with the selected
+\item [Play.] Replace all entries in the current playlist with the selected
   tracks. If \setting{Keep Current Track When Replacing Playlist} is set to
   \setting{Yes}, the new tracks will play after the current track finishes
   playing; if no track is playing or the setting is \setting{No}, the new
@@ -87,7 +63,7 @@ To replace the current dynamic playlist with your selection, choose:
 \end{description}
 
 \label{ref:queuing}The following options are hidden by default, due to their
-more complicated behavior. Queued tracks are temporarily added to the dynamic
+more complicated behavior. Queued tracks are temporarily added to the current
 playlist, but are automatically removed as soon as the tracks have been played.
 Queued tracks will not be saved to a playlist file.
 A current playlist containing queued tracks can not be bookmarked, even after saving it,
@@ -120,11 +96,11 @@ that directory to the playlist.
   you would like Rockbox to include tracks in subdirectories as well as tracks
   in the currently-selected directory.}
 
-Dynamic playlists are saved, so resume will restore them exactly as they
+The Current playlist is saved, so resume will restore it exactly as it
-were before shutdown.
+was before shutdown.
 
 \note{To view, save, reshuffle, or display the play time of the current
-  dynamic playlist use the
+  playlist use the
   \setting{Current Playlist} sub menu in the WPS context menu.}
 
 \subsection{Modifying playlists}
@@ -145,8 +121,8 @@ select \setting{Remove} in the context menu.
 \subsection{Saving playlists}
 To save the current playlist, either enter the \setting{Current Playlist} submenu
 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
-\setting{Playlist catalogue} in the \setting{Main Menu} and select
+\setting{Playlists} in the \setting{Main Menu} and select
 \setting{Save Current Playlist}.
 Either method will bring you to the \setting{Virtual Keyboard} (see
 \reference{sec:virtual_keyboard}), enter a filename for your playlist and
@@ -158,12 +134,12 @@ asked whether to remove them, as a prerequisiste for creating bookmarks
 \subsubsection{Through the \setting{File Browser}}
 Playlist files, like regular music tracks, can be selected through the
 \setting{File Browser}. When loading a playlist from disk it will replace
-the current dynamic playlist. If you want to look at a playlist's
+the current playlist. If you want to look at a playlist's
 content without starting playback immediately, access the \setting{Context Menu} (see
 \reference{ref:Contextmenu}) with \ActionStdContext{} and choose \setting{View}.
 
-\subsubsection{Through the \setting{Playlist catalogue}}
+\subsubsection{Through \setting{Playlists}}
-The \setting{Playlist catalogue} offers a shortcut to all playlists in your
+\setting{Playlists} offers a shortcut to all playlists in your
 \daps{} specified playlist directory.
 It can be used like the \setting{File Browser} but will display
 the content of a playlist when one is selected.