manual/rockbox_interface/main.tex

   1 % $Id$ %
   2 \chapter{\label{ref:rockbox_interface}Quick Start}
   3 \section{Basic overview}
   4 \subsection{The \daps{} controls}
   5
   6 \begin{center}
   7 % include the front image. Using \specimg makes this fairly easy,
   8 % but requires to use the exact value of \specimg in the filename!
   9 % The extension is selected in the preamble, so no further \ifpdfoutput
  10 % is necessary.
  11 \includegraphics[height=8cm]{rockbox_interface/images/\specimg-front}
  12
  13 \end{center}
  14
  15 Throughout this manual, the buttons on the \dap{} are labelled according to the
  16 picture above. In detail the buttons are described in the following paragraph.
  17
  18 \blind{
  19   %
  20   \opt{h1xx}{
  21   If you lay the \dap{} on the table with the joystick pointing
  22   towards you, and the curved sides at the top, you will find the following
  23   if you start from the top-right corner and follow the side of the \dap{} in a
  24   clockwise direction:
  25   On the right side the buttons \ButtonOn{}, \ButtonOff{}, \ButtonMode{} and
  26   the hold switch. Next comes on the bottom the USB port,
  27   a small hole for resetting the \dap{}, charger plug. On the left side located
  28   is the button \ButtonRec{}. At least the top has headphone mini-jack plug,
  29   remote port, optical/line in and optical/line out.
  30   The joystick in the middle of the \dap{} is
  31   used to navigate menus by pressing it up, down, left and right. Pressing the
  32   joystick down is labelled \ButtonSelect{} throughout this manual. Its
  33   directions are labelled \ButtonRight{}, \ButtonDown{}, \ButtonLeft{} and
  34   \ButtonUp{}.}
  35   %
  36   \opt{h300}{
  37   Hold or lay the \dap{} so that the side with the button pad and
  38   LCD is facing towards you.  The buttons on the button pad are as follows:  top
  39   left corner: \ButtonOn{}, bottom left corner: \ButtonOff{}, top right corner:
  40   \ButtonRec, bottom right corner: \ButtonMode{}.  In the center of the button pad
  41   is a button labelled \ButtonSelect{}.  Surrounding the \ButtonSelect{} button are
  42   four directional buttons used to navigate up, down, left and right.
  43
  44   On the top panel of the \dap{}, from left to right, you can find the
  45   following: headphone mini jack plug, remote port, Line-in, Line-out.
  46
  47   On the bottom panel of the \dap{}, from left to right, you can find the
  48   following:  power jack and two USB ports.  The USB port on the right is used
  49   to connect your \dap{} to your computer.  The USB port on the left is not
  50   used in Rockbox.
  51   }
  52   %
  53   \opt{ipod4g, ipod3g,ipodcolor,ipodvideo,ipodmini}
  54   {
  55   The main controls on the \dap{} are a slightly indented scroll wheel
  56   with a flat round button in the center. Hold the \dap{} with these controls
  57   facing you.
  58
  59   The top of the player will have the following, from left to
  60   right:
  61   \opt{ipod4g, ipod3g ,ipodcolor}{remote connector, headphone jack, hold
  62     switch.}
  63   \opt{ipodvideo}{hold switch, headphone jack.}
  64   \opt{ipodmini}{hold switch, remote connector, headphone jack.}
  65
  66   The dock connector that is used to connect your \dap{} to your computer is on
  67   the bottom panel of the \dap{}.
  68
  69   The button in the middle of the wheel is called \ButtonSelect{}. You can
  70   operate the wheel by pressing the top, bottom, left or right sections,
  71   or by sliding your finger around it.  The top is \ButtonMenu{}, the bottom is
  72   \ButtonPlay{}, the left is \ButtonLeft{}, and the right is \ButtonRight{}.
  73   When the manual says to \ButtonScrollFwd{}, it means to slide your finger
  74   clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
  75   counterclockwise. Note that the wheel is sensitive, so you will need to move
  76   slowly at first and get a feel for how it works.
  77
  78   Note that when the hold switch is pushed toward the center of the \dap{},
  79   ``hold'' is on, and none of the other controls do anything.  Be sure ``hold''
  80   is off before trying to use your player.
  81   }
  82   %
  83   \opt{ipodnano}{
  84   The main controls on the \dap{} are a slightly indented wheel with a
  85   flat round button in the center. Hold the \dap{} with these controls on the
  86   top surface. There is a Hold switch at one end, and headphone and USB jacks
  87   at the other; be sure the end with the switch is facing away from you.
  88
  89   The button in the middle of the wheel is called \ButtonSelect{}. You can
  90   operate the wheel by pressing the top, bottom, left or right sections,
  91   or by sliding your finger around it.  The top is \ButtonMenu{}, the bottom is
  92   \ButtonPlay, the left is \ButtonLeft, and the right is \ButtonRight{}.
  93   When the manual says to \ButtonScrollFwd{}, it means to slide your finger
  94   clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
  95   counterclockwise. Note that the wheel is sensitive, so you will need to move
  96   slowly at first and get a feel for how it works.
  97
  98   Note that when the Hold switch is pushed toward the center of the \dap{},
  99   Hold is on, and none of the other controls do anything; be sure Hold is
 100   off before trying to use your player.
 101   }
 102   %
 103   \opt{ondio}{
 104   The main characteristic of the Ondio case is the dent on its lower right side
 105   which is the MMC slot. Holding the \dap{} with this slot in the described position
 106   you'll find the following:
 107
 108   On the curved top it has the headphone jack to the left,
 109   the \ButtonOff{} button is in the middle%
 110   \opt{HAVE_RECORDING}{ and the line in jack to the right}.
 111   Apart from the already mentioned MMC slot you will find the USB connector on
 112   the \daps{} right side. Placed on the upper side of the device right below
 113   the flat display there is the main button pad of the \dap{}. A strong deepening
 114   marks the center of it and helps to operate the directional keys from there.
 115   \ButtonLeft{} and \ButtonRight{} form some sort of a strip and divide \ButtonUp{}
 116   and \ButtonDown{}. The raised button positioned in the lower left of this round
 117   crosspad is labelled \ButtonMenu{}.}
 118   %
 119   \nopt{h1xx,h300,ipodnano,ipodvideo,ipodmini,ipod4g,ipod3g,ipodcolor,ondio}
 120   {
 121     \fixme{Write a section describing the \dap{} for blind users.}
 122   }
 123 }
 124
 125 \subsection{Turning the \dap{} on and off}
 126 To turn on and off your Rockbox enabled \dap{} use the following keys:
 127 \begin{table}
 128     \begin{btnmap}{}{}
 129       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}%
 130       \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu{} / \ButtonSelect}%
 131       \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}%
 132         {Hold \ButtonOn\ for 2--3s}%
 133       \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPower}%
 134       & Start Rockbox\\
 135       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Hold \ButtonOff}%
 136       \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Hold \ButtonPlay}%
 137       \opt{ONDIO_PAD,recorderv2fm}{Hold \ButtonOff}%
 138       \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}%
 139       \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}%
 140       \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{Hold \ButtonPower}%
 141       & Shutdown Rockbox\\
 142     \end{btnmap}
 143 \end{table}
 144
 145 \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings.
 146 \opt{PLAYER_PAD,RECORDER_PAD,ONDIO_PAD}{%
 147   In the unlikely event of a software failure, a hardware power off can be
 148   performed by holding down
 149   \opt{PLAYER_PAD}{\ButtonStop}%
 150   \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
 151   until the \nopt{ondiosp,ondiofm}{\dap{} power light}%
 152   \opt{ondiosp,ondiofm}{\daps{} display} goes off.%
 153 }
 154 \subsection{The first contact}
 155
 156 After you have  first started the \dap{} you'll be presented by the
 157 \setting{File Browser}. With the default settings only supported files are
 158 shown. Rockbox' default view is the \setting{File Browser}, similar to Windows'
 159 Explorer. If you don't have audio files on your \dap{}, or created folders you
 160 will only see a blank screen with the statusbar at the top. If this is your
 161 case, now is a good time to connect your \dap{} to a computer and transfer some
 162 audio files to it.
 163
 164 When you have files on your \dap{} you'll see the supported ones now. Of
 165 course you can change this view later. You can also completely switch to
 166 a view that is based on the meta-data\footnote{ID3 Tags, Vorbis comments, etc.}
 167 of your audio files. This view is called Database (see
 168 \reference{ref:database}). Now you can start browsing the folder structure of
 169 your \dap{}.
 170
 171 \subsection{Basic controls}
 172 When browsing files and moving through menus you usually get a list view
 173 presented. The navigation in these lists are usually the same and should be
 174 pretty intuitive.
 175 In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around
 176 the selection. Use \ActionStdOk{} to select an item. When browsing the file
 177 system selecting an audio file plays it. The view switches to the ``While
 178 playing screen'', usually abbreviated as ``WPS'' (see \reference{ref:WPS}. The
 179 dynamic playlist gets replaced with the contents of the current folder. This
 180 way you can easily treat folders as playlists. The created dynamic playlist can
 181 be extended or modified while playing. This is also known as
 182 ``on-the-fly playlist''.
 183 To go back to the \setting{File Browser} stop the playback with the
 184 \ActionWpsStop{} button or return to the file browser while keeping playback
 185 running using \ActionWpsBrowse{}.
 186 In list views you can go back one step with \ActionStdCancel{}. The file
 187 browser is a bit different in this case as pressing \ActionWpsStop{}
 188 stops the playback instead of going up a level.
 189
 190 \subsection{Basic concepts}
 191 \subsubsection{Main Screen}
 192 Rockbox' main screen is the \setting{File Browser}. This is pretty different to
 193 most other players that use the ``While Playing Screen'' as their main screen.
 194 In Rockbox' view this doesn't make any sense as when you are not playing a
 195 file, information about the currently playing file isn't available and therefore
 196 useless. Because of this the \dap{} switches to the \setting{File Browser} when
 197 playback gets stopped. There is no point showing the WPS when playback is
 198 stopped, so this is not and will not be possible.
 199
 200 \subsubsection{Playlists}
 201 Rockbox is playlist oriented. This means that every time you play an audio file,
 202 a so-called ``dynamic playlist'' is generated, unless you play a saved
 203 playlist. You can modify the dynamic playlist while playing and also save
 204 it to a file. If you don't want to use playlists you can simply play your
 205 files folder based.
 206 Playlists are covered in detail in \reference{ref:working_with_playlists}.
 207
 208 \subsubsection{Menu}
 209 From the menu you can customise Rockbox. Rockbox itself is very customisable.
 210 Also there are some special menus for quick access to frequently used
 211 functions.
 212
 213 \subsubsection{Context Menu}
 214 Some views, especially the file browser and the WPS have a context menu.
 215 From the file browser this can be accessed with \ActionStdContext{}.
 216 The contents of the context menu vary, depending on the situation it gets
 217 called. The context menu itself presents you with some operations you can
 218 perform with the currently highlighted file. In the file browser this is
 219 the file (or folder) that is highlighted by the cursor. From the WPS this is
 220 the currently playing file. Also there are some actions that don't apply
 221 to the current file but refer to the screen from which the context menu
 222 gets called. One example is the playback menu, which can be called using
 223 the context menu from within the WPS.
 224
 225 \section{Customising Rockbox}
 226 Rockbox' User Interface can be customised using ``Themes''. Themes usually
 227 only affect the visual appearance, but an advanced user can create a theme
 228 that also changes various other settings like file view, LCD settings and
 229 all other settings that can be modified using \fname{.cfg} files. This topic
 230 is discussed in more detail in \reference{ref:manage_settings}.
 231 The Rockbox distribution comes with some themes that should look nice on
 232 your \dap{}. \note{Some of the themes shipped with Rockbox need additional
 233 fonts from the fonts package, so make sure you installed them.
 234 Also, if you downloaded additional themes from the Internet make sure you
 235 have the needed fonts installed as otherwise the theme may get displayed
 236 garbled.}
 237
 238 \section{Menu overview}
 239 \fixme{include an overview of the menu structure here}
 240 %\input{rockbox_interface/menu_structure.tex}
 241
 242 \input{rockbox_interface/playback.tex}