Small updates to the plugins section. Fix some fixme's in Cofiguration and Main Menu sections. (FS#5171, FS#5176 by Mark Bright)

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9723 a1c6a512-1295-4272-9138-f99709370657

manual/configure_rockbox/system_options.tex

@@ -58,9 +58,9 @@
       pressed and the time Rockbox responds.  Turning this setting ON activates
       the directory cache, and turning it OFF deactivates the directory cache.
       \note{The first time you set the directory cache to ON, Rockbox will
-      take a few minutes to scan the drive and you will need to restart the
+      request a reboot of the \dap\ and upon restarting take a few minutes to 
-      player. Thereafter, the directory cache will work in the background.
+      scan the drive. Thereafter, the directory cache will work in the 
-      (\fixme{Confirm that these last two sentences are true.}}
+      background.}
   \end{description}
 
 \opt{CONFIG_RTC}{
@@ -147,7 +147,7 @@ This submenu relates to limits in the Rockbox operating system.
   \end{description}
 }
 
-\subsection{Manage settings}
+\subsection{\label{ref:ManageSettings}Manage settings}
 This submenu deals with loading and saving settings. 
 \opt{MASCODEC}{This submenu also allows you to load or save different
 firmware versions.}
@@ -156,14 +156,14 @@ firmware versions.}
     \item [Browse .cfg Files: ]Opens the file browser in the 
     \fname{/.rockbox} directory and displays all .cfg (configuration) files.
     Selecting a .cfg file will cause Rockbox to load that the settings
-    contained in that file.  STOP will exit back to the menu. 
+    contained in that file. Pressing \ButtonLeft\ will exit back to the menu. 
-    \fixme{(TODO--proper button configurations for different platforms.)}
     See the \emph{Write .cfg files} option on the Manage Settings menu for
     details of how to save and edit a configuration file.
     %
-    \opt{MASCODEC}{
     \item [Browse Firmwares: ]This displays a list of firmware file in
-    the \fname{/.rockbox} system directory. 
+    the \fname{/.rockbox} system directory. %
+    \opt{SWCODEC}{This is legacy item, and is depreciated.}
+    \opt{MASCODEC}{ 
     \opt{recorder,recorderv2fm}{Firmware files have an extension of .ajz.}
     \opt{player,ondio}{  Firmware files have an extension of .mod}
     Playing a firmware file loads it into memory.  Thus, it is possible to

manual/main_menu/main.tex

@@ -80,8 +80,8 @@ starting on page \pageref{ref:configure_rockbox_general}.
 \section{Manage Settings}
 This option allows the saving and re-loading of user configuration settings, 
 browse the hard drive for alternate firmwares, and finally to reset your 
-\dap\ back to initial configuration.
+\dap\ back to initial configuration. The details of this menu are covered in detail 
-\fixme{TODO: check and enhance the above text}
+starting on page \pageref{ref:ManageSetting}.
 
 \section{Browse Themes}
 This option will display all the currently installed themes on the \dap, 

manual/plugins/bubbles.tex

@@ -25,18 +25,19 @@ fired. Points are awarded depending on how quickly the level was completed.
     \opt{RECORDER_PAD}{\ButtonPlay}
     \opt{ONDIO_PAD}{\ButtonUp}
         & Show high scores\\
-    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp/\ButtonDown}
+    \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp/\ButtonDown}
     \opt{IPOD_4G_PAD}{\ButtonScrollFwd/\ButtonScrollBack}
-    \opt{RECORDER_PAD,ONDIO_PAD}{\fixme{TBC}}
+    \opt{ONDIO_PAD}{\ButtonLeft+\ButtonRight}
         & Select starting level\\
     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
     \opt{IPOD_4G_PAD}{\ButtonMenu}
     \opt{IAUDIO_X5_PAD}{\ButtonPower}
         & Quit\\\hline
     \multicolumn{2}{c}{\textbf{In game}}\\\hline
-    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}{\ButtonOn}
+    \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
-    \opt{IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonPlay} 
+    \opt{IPOD_4G_PAD}{\ButtonPlay} 
     \opt{ONDIO_PAD}{\ButtonMenu} 
+    \opt{IAUDIO_X5_PAD}{\ButtonPower}
         & Pause game\\
     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonLeft/\ButtonRight}
     \opt{IPOD_4G_PAD}{\ButtonScrollFwd/\ButtonScrollBack}
@@ -48,7 +49,8 @@ fired. Points are awarded depending on how quickly the level was completed.
     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
     \opt{IPOD_4G_PAD}{\ButtonLeft+\ButtonRight}
     \opt{IAUDIO_X5_PAD}{\ButtonRec} 
-    \opt{RECORDER_PAD,ONDIO_PAD}{\fixme{TBC}} 
+    \opt{RECORDER_PAD}{\ButtonFOne} 
+    \opt{ONDIO_PAD}{\ButtonDown}
         & Save game\\
     \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
     \opt{IPOD_4G_PAD}{\ButtonMenu}

manual/plugins/chess_clock.tex

@@ -8,15 +8,31 @@ in any kind of game with up to ten players.
 
 \subsubsection{Setup}
 
+\begin{table}
+  \begin{btnmap}{}{}
+    \opt{PLAYER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRight/\ButtonLeft}
+    \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonUp/\ButtonDown}
+    \opt{IPOD_4G_PAD}{\ButtonScrollBack/\ButtonScrollFwd}
+      & Increase / Decrease displayed Value\\
+    \opt{PLAYER_PAD,RECORDER_PAD}{\ButtonPlay}
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
+    \opt{ONDIO_PAD}{\ButtonRight}
+    \opt{IPOD_4G_PAD}{\ButtonSelect}
+      & Move to next screen\\
+    \opt{PLAYER_PAD}{\ButtonStop}
+    \opt{ONDIO_PAD,IPOD_4G_PAD}{\ButtonMenu}
+    \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
+      & Move to next screen\\
+  \end{btnmap}
+\end{table}
+
 \begin{itemize}
-\item First enter the number of players (1{}-10) (press  PLAY to
+  \item First enter the number of players (1--10)
-continue). 
+  \item Then set the total game time in mm:ss
-\item Then set the total game time in mm:ss (press PLAY to continue,
-STOP to go back). 
   \item Then the maximum round time is entered.  For example, this could
   be used to play Scrabble for a maximum of 15 minutes each, with each
-round taking no longer than one minute. (press  PLAY to continue). 
+  round taking no longer than one minute.
-\item Done. Player 1 starts in paused mode. So press PLAY to start.
+  \item Done. Player 1 starts in paused mode.
 \end{itemize}
 
 \subsubsection{While playing}
@@ -28,24 +44,36 @@ Keys are as follows:
 
 \begin{table}
   \begin{btnmap}{}{}
-\opt{player}{On}\opt{recorder,recorderv2fm}{Off}\opt{ondio}{OnOff}
+    \opt{PLAYER_PAD}{\ButtonOn}
-\opt{h1xx,h300,ipodcolor,ipodnano}{Select} 
+    \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
+    \opt{IPOD_4G_PAD}{\ButtonPlay}
       & Exit plugin \\
-\opt{player}{Stop}\opt{recorder,recorderv2fm,Ondio}{Left}
+    \opt{PLAYER_PAD}{\ButtonStop}
-\opt{h1xx,h300,ipodcolor,ipodnano}{Stop} 
+    \opt{RECORDER_PAD,ONDIO_PAD,IPOD_4G_PAD}{\ButtonLeft}
-& Restart round for the player \\
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
-\opt{player,h1xx,h300,ipodcolor,ipodnano,recorder,recorderv2fm}{Play}
+      & Restart round for the current player \\
-\opt{Ondio}{Right} 
+    \opt{PLAYER_PAD,RECORDER_PAD}{\ButtonPlay}
-& Pausing the time (press again to continue) \\
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
-\opt{player,h1xx,h300,ipodcolor,ipodnano}{Right}
+    \opt{ONDIO_PAD}{\ButtonRight}
-\opt{ondio,recorder,recorderv2fm}{Up} 
+    \opt{IPOD_4G_PAD}{\ButtonSelect}
+      & Pause the time (press again to continue) \\
+    \opt{PLAYER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRight}
+    \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonUp}
+    \opt{IPOD_4G_PAD}{\ButtonScrollBack}
       & Switch to next player \\
-\opt{player,h1xx,h300,ipodcolor,ipodnano}{Left}
+    \opt{PLAYER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonLeft}
-\opt{ondio,recorder,recorderv2fm}{Down} 
+    \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonDown}
+    \opt{IPOD_4G_PAD}{\ButtonScrollFwd}
       & Switch to previous player \\
-\opt{player}{Menu}\opt{recorder,recorderv2fm}{F1}
+    \opt{PLAYER_PAD,ONDIO_PAD,IPOD_4G_PAD}{\ButtonMenu}
-\opt{ondio}{Mode}\opt{h1xx,h300,ipodcolor,ipodnano}{Rec} 
+    \opt{RECORDER_PAD}{\ButtonFOne}
-& Exit plugin \\
+    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
+      & Delete current player %
+      \opt{PLAYER_PAD,RECORDER_PAD}{(\ButtonPlay\ to confirm.)}
+      \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{(\ButtonOn\ to confirm.)}
+      \opt{ONDIO_PAD}{(\ButtonRight\ to confirm.)}
+      \opt{IPOD_4G_PAD}{(\ButtonSelect\ to confirm.)}\\
   \end{btnmap}
 \end{table}
 From the menu it is possible to delete a player, modify the round time

manual/plugins/logo.tex

@@ -3,11 +3,12 @@ Demo showing the Rockbox logo bouncing around the screen.
 
 \begin{table}
     \begin{btnmap}{}{}
-    \opt{player}{Plus / Minus, On+Plus / On+Minus}
+    \opt{player}{\ButtonRight / \ButtonLeft, \ButtonOn+\ButtonRight / \ButtonOn+\ButtonLeft}
-    \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano,ipodvideo}{Directions}
+    \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano,ipodvideo}{Direction Keys}
     & Increase / decrease speed in either direction.\\
-    \opt{player,recorder,recorderv2fm,h1xx,h300}{Stop}
+    \opt{player}{\ButtonStop}
-    \opt{ondio}{Off}\opt{ipodcolor,ipodnano,ipodvideo}{Menu}
+    \opt{recorder,ondio,recorderv2fm,h1xx,h300}{\ButtonOff}
+    \opt{IPOD_4G_PAD}{\ButtonMenu}
     & Quit\\
     \end{btnmap}
 \end{table}

manual/plugins/main.tex

@@ -70,7 +70,7 @@ will carry on playing whilst plugins are being run.
 
 {\input{plugins/credits.tex}}
 
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/cube.tex}}
+\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/cube.tex}}
 
 \opt{HAVE_LCD_BITMAP}{\input{plugins/demystify.tex}}
 
@@ -80,13 +80,13 @@ will carry on playing whilst plugins are being run.
 
 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/mandelbrot.tex}}
 
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/mosaic.tex}}
+\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/mosaic.tex}}
 
 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/oscilloscope.tex}}
 
 \opt{HAVE_LCD_BITMAP}{\input{plugins/plasma.tex}}
 
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/snow.tex}}
+\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/snow.tex}}
 
 \opt{HAVE_LCD_BITMAP}{\input{plugins/starfield.tex}}
 
@@ -131,7 +131,7 @@ the associated file.  Viewers are stored in the
 
 \opt{recorder,recorderv2fm,ondio}{\input{plugins/calendar.tex}}
 
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/chess_clock.tex}}
+\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{\input{plugins/chess_clock.tex}}
 
 \opt{recorder,recorderv2fm}{\input{plugins/clock.tex}}
 

manual/plugins/mosaic.tex

@@ -2,4 +2,8 @@
 \screenshot{plugins/images/ss-mosaic}{Mosaic}{img:mosaic}
 
 This simple graphics demo draws a mosaic picture on the screen of the
-Jukebox.  Press STOP to quit.
+Jukebox. %
+\opt{player}{Press \ButtonStop\ to quit.}
+\opt{IPOD_4G_PAD}{Press \ButtonMenu\ to quit.}
+\opt{recorder,recorderv2fm,ondio,h1xx,h300}{Press \ButtonOff\ to quit.}
+

manual/plugins/snow.tex

@@ -2,3 +2,7 @@
 \screenshot{plugins/images/ss-snow}{Have you ever seen snow falling?}{img:snow}
 This demo replicates snow falling on your screen. If you love winter,
 you will love this demo.  Or maybe not.
+
+\opt{player}{Press \ButtonStop\ to quit.}
+\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRVER_H300_PAD}{Press \ButtonOff\ to quit.}
+\opt{IPOD_4G_PAD}{Press \ButtonMenu\ to quit.}