summaryrefslogtreecommitdiffstats
path: root/manual/platform
diff options
context:
space:
mode:
authorMarianne Arnold <pixelma@rockbox.org>2009-07-04 23:51:06 +0000
committerMarianne Arnold <pixelma@rockbox.org>2009-07-04 23:51:06 +0000
commit2aabdbfeb843763664783223fa1f7fd83d21a6f6 (patch)
treefe021ff99b9686ef7d954dbdfac8e00ec606eac8 /manual/platform
parentff8f681f03e83321f2fae716ec9de80918f2a253 (diff)
downloadrockbox-2aabdbfeb843763664783223fa1f7fd83d21a6f6.tar.gz
rockbox-2aabdbfeb843763664783223fa1f7fd83d21a6f6.zip
Start of an Iaudio M3 manual: add the necessary platform files (name the remote keymap file 'iaudio' because the keymap is shared with M5 and X5 and could be reused there), add pictures of the remote with labels and place it below the player image, already fill out some installation instructions which are very similar to the other Iaudios. The manual still needs a way to mention main unit and remote control buttons in text descriptions, the second column in the button tables needs to be filled out (using IAUDIO_RC_PAD and adding this to the M5 and X5 platform files) - and screenshots are needed too...
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21645 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/platform')
-rw-r--r--manual/platform/keymap-m3.tex93
-rw-r--r--manual/platform/m3.tex26
-rw-r--r--manual/platform/remote-keymap-iaudio.tex95
3 files changed, 214 insertions, 0 deletions
diff --git a/manual/platform/keymap-m3.tex b/manual/platform/keymap-m3.tex
new file mode 100644
index 0000000000..098422b21d
--- /dev/null
+++ b/manual/platform/keymap-m3.tex
@@ -0,0 +1,93 @@
+% $Id$ %
+\newcommand{\ButtonLeft}{\btnfnt{Rewind}}
+\newcommand{\ButtonRight}{\btnfnt{Forward}}
+\newcommand{\ButtonUp}{\btnfnt{Volume Up}}
+\newcommand{\ButtonDown}{\btnfnt{Volume Down}}
+\newcommand{\ButtonRec}{\btnfnt{Rec}}
+\newcommand{\ButtonPlay}{\btnfnt{Play}}
+\newcommand{\ButtonMode}{\btnfnt{Mode}}
+\newcommand{\ButtonHold}{\btnfnt{Hold}}
+
+%Button actions, standard context
+\newcommand{\ActionStdPrev}{\ButtonUp}
+\newcommand{\ActionStdPrevRepeat}{Long \ButtonUp}
+\newcommand{\ActionStdNext}{\ButtonDown}
+\newcommand{\ActionStdNextRepeat}{Long \ButtonDown}
+\newcommand{\ActionStdCancel}{\ButtonLeft}
+\newcommand{\ActionStdContext}{Long \ButtonMode}
+\newcommand{\ActionStdQuickScreen}{Long \ButtonRec}
+\newcommand{\ActionQuickScreenExit}{\ButtonRec}
+\newcommand{\ActionStdMenu}{\ButtonRec}
+\newcommand{\ActionStdOk}{\ButtonPlay{} or \ButtonRight}
+
+%Button actions, wps context
+\newcommand{\ActionWpsPlay}{\ButtonPlay}
+\newcommand{\ActionWpsStop}{Long \ButtonPlay}
+\newcommand{\ActionWpsSkipNext}{\ButtonRight}
+\newcommand{\ActionWpsSkipPrev}{\ButtonLeft}
+\newcommand{\ActionWpsSeekBack}{Long \ButtonLeft}
+\newcommand{\ActionWpsSeekFwd}{Long \ButtonRight}
+\newcommand{\ActionWpsVolDown}{\ButtonDown}
+\newcommand{\ActionWpsVolUp}{\ButtonUp}
+\newcommand{\ActionWpsQuickScreen}{Long \ButtonRec}
+\newcommand{\ActionWpsMenu}{\ButtonRec}
+\newcommand{\ActionWpsContext}{Long \ButtonMode}
+\newcommand{\ActionWpsBrowse}{\ButtonMode}
+
+%Button actions, tree context
+\newcommand{\ActionTreeWps}{\ButtonPlay}
+\newcommand{\ActionTreeStop}{Long \ButtonPlay}
+\newcommand{\ActionTreeEnter}{\ButtonPlay{} or \ButtonRight}
+\newcommand{\ActionTreeParentDirectory}{\ButtonLeft}
+
+%Button actions, YesNo context
+\newcommand{\ActionYesNoAccept}{\ButtonPlay}
+
+%Button actions, Setting context
+\newcommand{\ActionSettingInc}{\ButtonUp}
+\newcommand{\ActionSettingDec}{\ButtonDown}
+
+%Button actions, Virtual Keyboard Context
+\newcommand{\ActionKbdLeft}{\ButtonLeft}
+\newcommand{\ActionKbdRight}{\ButtonRight}
+\newcommand{\ActionKbdUp}{\ButtonUp}
+\newcommand{\ActionKbdDown}{\ButtonDown}
+\newcommand{\ActionKbdSelect}{\ButtonPlay}
+\newcommand{\ActionKbdDone}{Long \ButtonPlay}
+\newcommand{\ActionKbdAbort}{\ButtonRec}
+
+%Button actions, Pitch Screen context
+\newcommand{\ActionPsToggleMode}{\ButtonMode}
+\newcommand{\ActionPsIncSmall}{\ButtonUp}
+\newcommand{\ActionPsIncBig}{Long \ButtonUp}
+\newcommand{\ActionPsDecSmall}{\ButtonDown}
+\newcommand{\ActionPsDecBig}{Long \ButtonDown}
+\newcommand{\ActionPsNudgeLeft}{\ButtonLeft}
+\newcommand{\ActionPsNudgeRight}{\ButtonRight}
+\newcommand{\ActionPsReset}{\ButtonRec}
+\newcommand{\ActionPsExit}{\ButtonPlay}
+
+%Button actions, Recording screen context
+\newcommand{\ActionRecPause}{\ButtonPlay}
+\newcommand{\ActionRecNewfile}{\ButtonRec}
+\newcommand{\ActionRecSettingsInc}{\ButtonRight}
+\newcommand{\ActionRecSettingsDec}{\ButtonLeft}
+\newcommand{\ActionRecPrev}{\ButtonUp}
+\newcommand{\ActionRecNext}{\ButtonDown}
+\newcommand{\ActionRecMenu}{Long \ButtonRec}
+\newcommand{\ActionRecExit}{Long \ButtonPlay}
+
+%Button actions, FM radio context
+\newcommand{\ActionFMPreset}{\ButtonMode}
+\newcommand{\ActionFMMenu}{Long \ButtonMode}
+\newcommand{\ActionFMMode}{Long \ButtonRec}
+\newcommand{\ActionFMStop}{Long \ButtonPlay}
+\newcommand{\ActionFMExit}{\ButtonRec}
+\newcommand{\ActionFMPlay}{\ButtonPlay}
+\newcommand{\ActionFMSettingsInc}{\ActionSettingInc}
+\newcommand{\ActionFMSettingsDec}{\ActionSettingDec}
+\newcommand{\ActionFMPrev}{\ButtonLeft}
+\newcommand{\ActionFMNext}{\ButtonRight}
+
+%Button actions, Bookmark screen context
+\newcommand{\ActionBmDelete}{Long \ButtonRec}
diff --git a/manual/platform/m3.tex b/manual/platform/m3.tex
new file mode 100644
index 0000000000..bbdd255299
--- /dev/null
+++ b/manual/platform/m3.tex
@@ -0,0 +1,26 @@
+% $Id$ %
+\def\UseOption{m3}
+\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
+\edef\UseOption{\UseOption,IAUDIO_M3_PAD}
+\edef\UseOption{\UseOption,IAUDIO_RC_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
+\edef\UseOption{\UseOption,iaudio}
+\edef\UseOption{\UseOption,HAVEREMOTEKEYMAP}
+
+\newcommand{\playerman}{Iaudio}
+\newcommand{\playertype}{M3}
+\newcommand{\playerlongtype}{\playertype}
+\newcommand{\genericimg}{128x96x2}
+\newcommand{\specimg}{m3}
+%Used to name the player, e.g. ...to the \dap
+\newcommand{\dap}{player}
+%For use when referring to the player. E.g. the \daps\ capacity ...
+\newcommand{\daps}{player's}
+\newcommand{\firmwarefilename}{\fname{rockbox.iaudio}}
+\newcommand{\screenshotsize}{4cm}
+\newcommand{\disk}{hard disk}
+
+% link external keymap files
+\input{platform/keymap-m3.tex}
+\input{platform/remote-keymap-iaudio.tex}
diff --git a/manual/platform/remote-keymap-iaudio.tex b/manual/platform/remote-keymap-iaudio.tex
new file mode 100644
index 0000000000..3cf4d77c3f
--- /dev/null
+++ b/manual/platform/remote-keymap-iaudio.tex
@@ -0,0 +1,95 @@
+% $Id$ %
+
+\newcommand{\ButtonRCLeft}{\btnfnt{Rewind}}
+\newcommand{\ButtonRCRight}{\btnfnt{Forward}}
+\newcommand{\ButtonRCUp}{\btnfnt{Volume Up}}
+\newcommand{\ButtonRCDown}{\btnfnt{Volume Down}}
+\newcommand{\ButtonRCRec}{\btnfnt{Rec}}
+\newcommand{\ButtonRCPlay}{\btnfnt{Play}}
+\newcommand{\ButtonRCMode}{\btnfnt{Mode}}
+\newcommand{\ButtonRCMenu}{\btnfnt{Menu}}
+\newcommand{\ButtonRCHold}{\btnfnt{Hold}}
+
+%Button actions, standard context
+\newcommand{\ActionRCStdPrev}{\ButtonRCUp}
+\newcommand{\ActionRCStdPrevRepeat}{Long \ButtonRCUp}
+\newcommand{\ActionRCStdNext}{\ButtonRCDown}
+\newcommand{\ActionRCStdNextRepeat}{Long \ButtonRCDown}
+\newcommand{\ActionRCStdCancel}{\ButtonLeft}
+\newcommand{\ActionRCStdContext}{Long \ButtonRCMode}
+\newcommand{\ActionRCStdQuickScreen}{Long \ButtonRCRec}
+\newcommand{\ActionRCQuickScreenExit}{\ButtonRCRec}
+\newcommand{\ActionRCStdMenu}{\ButtonRCRec}
+\newcommand{\ActionRCStdOk}{\ButtonRCPlay{} or \ButtonRCRight}
+
+%Button actions, wps context
+\newcommand{\ActionRCWpsPlay}{\ButtonRCPlay}
+\newcommand{\ActionRCWpsStop}{Long \ButtonRCPlay}
+\newcommand{\ActionRCWpsSkipNext}{\ButtonRCRight}
+\newcommand{\ActionRCWpsSkipPrev}{\ButtonRCLeft}
+\newcommand{\ActionRCWpsSeekBack}{Long \ButtonRCLeft}
+\newcommand{\ActionRCWpsSeekFwd}{Long \ButtonRCRight}
+\newcommand{\ActionRCWpsVolDown}{\ButtonRCDown}
+\newcommand{\ActionRCWpsVolUp}{\ButtonRCUp}
+\newcommand{\ActionRCWpsQuickScreen}{Long \ButtonRCMenu{} (Main: Long \ButtonRec}
+\newcommand{\ActionRCWpsMenu}{\ButtonRCMenu{} (Main: \ButtonRec)}
+\newcommand{\ActionRCWpsContext}{Long \ButtonRCMode}
+\newcommand{\ActionRCWpsBrowse}{\ButtonRCMode}
+
+%Button actions, tree context
+\newcommand{\ActionRCTreeWps}{\ButtonRCPlay}
+\newcommand{\ActionRCTreeStop}{Long \ButtonRCPlay}
+\newcommand{\ActionRCTreeEnter}{\ButtonRCPlay{} or \ButtonRCRight}
+\newcommand{\ActionRCTreeParentDirectory}{\ButtonRCLeft}
+
+%Button actions, YesNo context
+\newcommand{\ActionRCYesNoAccept}{\ButtonRCPlay}
+
+%Button actions, Setting context
+\newcommand{\ActionRCSettingInc}{\ButtonRCUp}
+\newcommand{\ActionRCSettingDec}{\ButtonRCDown}
+
+%Button actions, Virtual Keyboard Context
+\newcommand{\ActionRCKbdLeft}{\ButtonRCLeft}
+\newcommand{\ActionRCKbdRight}{\ButtonRCRight}
+\newcommand{\ActionRCKbdUp}{\ButtonRCUp}
+\newcommand{\ActionRCKbdDown}{\ButtonRCDown}
+\newcommand{\ActionRCKbdSelect}{\ButtonRCPlay}
+\newcommand{\ActionRCKbdDone}{Long \ButtonRCPlay}
+\newcommand{\ActionRCKbdAbort}{\ButtonRec}
+
+%Button actions, Pitch Screen context
+\newcommand{\ActionRCPsToggleMode}{\ButtonRCMode}
+\newcommand{\ActionRCPsIncSmall}{\ButtonRCUp}
+\newcommand{\ActionRCPsIncBig}{Long \ButtonRCUp}
+\newcommand{\ActionRCPsDecSmall}{\ButtonRCDown}
+\newcommand{\ActionRCPsDecBig}{Long \ButtonRCDown}
+\newcommand{\ActionRCPsNudgeLeft}{\ButtonRCLeft}
+\newcommand{\ActionRCPsNudgeRight}{\ButtonRCRight}
+\newcommand{\ActionRCPsReset}{\ButtonRCRec}
+\newcommand{\ActionRCPsExit}{\ButtonRCPlay}
+
+%Button actions, Recording screen context
+\newcommand{\ActionRCRecPause}{\ButtonRCPlay}
+\newcommand{\ActionRCRecNewfile}{\ButtonRCRec}
+\newcommand{\ActionRCRecSettingsInc}{\ButtonRCRight}
+\newcommand{\ActionRCRecSettingsDec}{\ButtonRCLeft}
+\newcommand{\ActionRCRecPrev}{\ButtonRCUp}
+\newcommand{\ActionRCRecNext}{\ButtonRCDown}
+\newcommand{\ActionRCRecMenu}{\ButtonRCMenu{} (Main: Long \ButtonRec)}
+\newcommand{\ActionRCRecExit}{Long \ButtonRCPlay}
+
+%Button actions, FM radio context
+\newcommand{\ActionRCFMPreset}{\ButtonRCMode}
+\newcommand{\ActionRCFMMenu}{Long \ButtonRCMode}
+\newcommand{\ActionRCFMMode}{Long \ButtonRCRec}
+\newcommand{\ActionRCFMStop}{Long \ButtonPlay}
+\newcommand{\ActionRCFMExit}{\ButtonRCMenu{} (Main: \ButtonRec)}
+\newcommand{\ActionRCFMPlay}{\ButtonPlay}
+\newcommand{\ActionRCFMSettingsInc}{\ActionRCSettingInc}
+\newcommand{\ActionRCFMSettingsDec}{\ActionRCSettingDec}
+\newcommand{\ActionRCFMPrev}{\ButtonRCLeft}
+\newcommand{\ActionRCFMNext}{\ButtonRCRight}
+
+%Button actions, Bookmark screen context
+\newcommand{\ActionRCBmDelete}{Long \ButtonRec}