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 minijack 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 the 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 minijack 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   \nopt{h1xx,h300,ipodnano,ipodvideo,ipodmini,ipod4g,ipod3g,ipodcolor}
 104   {
 105     \fixme{Write a section describing the \dap{} for blind users.}
 106   }
 107 }
 108
 109 \subsection{Turning the \dap{} on and off}
 110 To turn on and off your Rockbox enabled \dap{} use the following keys:
 111 \begin{table}
 112     \begin{btnmap}{}{}
 113       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}%
 114       \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu{} / \ButtonSelect}%
 115       \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}%
 116         {Hold \ButtonOn\ for 2--3s}%
 117       \opt{IAUDIO_X5_PAD}{\ButtonPower}%
 118       & Start Rockbox\\
 119       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Hold \ButtonOff}%
 120       \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Hold \ButtonPlay}%
 121       \opt{ONDIO_PAD,recorderv2fm}{Hold \ButtonOff}%
 122       \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}%
 123       \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}%
 124       \opt{IAUDIO_X5_PAD}{Hold \ButtonPower}%
 125       & Shutdown Rockbox\\
 126     \end{btnmap}
 127 \end{table}
 128
 129 \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings.
 130 \opt{PLAYER_PAD,RECORDER_PAD,ONDIO_PAD}{%
 131   In the unlikely event of a software failure, a hardware power off can be
 132   performed by holding down
 133   \opt{PLAYER_PAD}{\ButtonStop}%
 134   \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
 135   until the \nopt{ondiosp,ondiofm}{\dap{} power light}%
 136   \opt{ondiosp,ondiofm}{\daps{} display} goes off.%
 137 }
 138 \subsection{The first contact}
 139
 140 After you have  first started the \dap{} you'll be presented by the
 141 \setting{File Browser}. With the default settings only supported files are
 142 shown. Rockbox' default view is the \setting{File Browser}, similar to Windows'
 143 Explorer. If you don't have audio files on your \dap{}, or created folders you
 144 will only see a blank screen with the statusbar at the top. If this is your
 145 case, now is a good time to connect your \dap{} to a computer and transfer some
 146 audio files to it.
 147
 148 When you have files on your \dap{} you'll see the supported ones now. Of
 149 course you can change this view later. You can also completely switch to
 150 a view that is based on the metadata\footnote{ID3 Tags, Vorbis comments, etc.}
 151 of your audio files. This view is called TagCache (see
 152 \reference{ref:tagcache}). Now you can start browsing the folder structure of
 153 your \dap{}.
 154
 155 \subsection{Basic controls}
 156 When browsing files and moving through menus you usually get a list view
 157 presented. The navigation in these lists are usually the same and should be
 158 pretty intuitive.
 159 In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around
 160 the selection. Use \ActionStdOk{} to select an item. When browsing the file
 161 system selecting an audio file plays it. The view switches to the ``While
 162 playing screen'', usually abbreviated as ``WPS'' (see \reference{ref:WPS}. The
 163 dynamic playlist gets replaced with the contents of the current folder. This
 164 way you can easily treat folders as playlists. The created dynamic playlist can
 165 be extended or modified while playing. This is also known as
 166 ``on-the-fly playlist''.
 167 To go back to the \setting{File Browser} stop the playback with the
 168 \ActionWpsStop{} button or return to the file browser while keeping playback
 169 running using \ActionWpsBrowse{}.
 170 In list views you can go back one step with \ActionStdCancel{}. The file
 171 browser is a bit different in this case as pressing \ActionWpsStop{}
 172 stops the playback instead of going up a level.
 173
 174 \subsection{Basic concepts}
 175 \subsubsection{Main Screen}
 176 Rockbox' main screen is the \setting{File Browser}. This is pretty different to
 177 most other players that use the ``While Playing Screen'' as their main screen.
 178 In Rockbox' view this doesn't make any sense as when you are not playing a
 179 file, information about the currently playing file isn't available and therfore
 180 useless. Because of this the \dap{} switches to the \setting{File Browser} when
 181 playback gets stopped. There is no point showing the WPS when playback is
 182 stopped, so this is not and will not be possible.
 183
 184 \subsubsection{Playlists}
 185 Rockbox is playlist oriented. This means that every time you play an audio file,
 186 a so-called ``dynamic playlist'' is generated,  unless you play a saved
 187 playlist. You can modify the dynamic playlist while playing and also save
 188 it to a file. If you don't want to use playlists you can simply play your
 189 files folder based.
 190 Playlists are covered in detail in \ref{ref:working_with_playlists}.
 191
 192 \subsubsection{Menu}
 193 From the menu you can customise Rockbox. Rockbox itself is very customisable.
 194 Also there are some special menus for quick access to frequently used
 195 functions.
 196
 197 \subsubsection{Context Menu}
 198 Some views, especially the file browser and the WPS have a context menu.
 199 From the file browser this can be accessed with \ActionStdContext{}.
 200 The contents of the context menu vary, depending on the situation it gets
 201 called. The context menu itself presents you with some operations you can
 202 perform with the currently hightlighted file. In the file browser this is
 203 the file (or folder) that is highlighted by the cursor. From the WPS this is
 204 the currently playing file. Also there are some actions that don't apply
 205 to the current file but refer to the screen from which the context menu
 206 gets called. One example is the playback menu, which can be called using
 207 the context menu from within the WPS.
 208
 209 \section{Customizing Rockbox}
 210 Rockbox' User Interface can be customized using ``Themes''. Themes usually
 211 only affect the visual apperance, but an advanced user can create a theme
 212 that also changes various other settings like file view, LCD settings and
 213 all other settings that can be modified using \fname{.cfg} files. This topic
 214 is discussed in more detail in \reference{ref:manage_settings}.
 215 The Rockbox distribution comes with some themes that should look nice on
 216 your \dap{}. \note{Some of the themes shipped with Rockbox need additional
 217 fonts from the fonts package, so make sure you installed them.
 218 Also, if you downloaded additional themes from the internet make sure you
 219 have the needed fonts installed as otherwise the theme may get displayed
 220 garbled.}
 221
 222 \section{Menu overview}
 223 \fixme{include an overview of the menu structure here}
 224 %\input{rockbox_interface/menu_structure.tex}
 225
 226 \input{rockbox_interface/playback.tex}