summaryrefslogtreecommitdiff
path: root/manual/plugins
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-02-21 11:54:53 +0000
committerMartin Arver <martin.arver@gmail.com>2006-02-21 11:54:53 +0000
commitc7fd0fee7ad2581889e84748ab64e10003d9d526 (patch)
treec81cb417787c809732f7126cee8148b3a52881cd /manual/plugins
parentbff84266217d10337e5bb4d643c7bfdb9c4b0d5d (diff)
downloadrockbox-c7fd0fee7ad2581889e84748ab64e10003d9d526.tar.gz
rockbox-c7fd0fee7ad2581889e84748ab64e10003d9d526.zip
Patch[1430311] by Henrico Witvliet. Split plugins to individual files. Proper naming of the targets.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@8763 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/plugins')
-rw-r--r--manual/plugins/battery_test.tex16
-rw-r--r--manual/plugins/bounce.tex12
-rw-r--r--manual/plugins/calculator.tex12
-rw-r--r--manual/plugins/calendar.tex56
-rw-r--r--manual/plugins/chess_clock.tex143
-rw-r--r--manual/plugins/chip8emulator.tex28
-rw-r--r--manual/plugins/clock.tex105
-rw-r--r--manual/plugins/euro_converter.tex14
-rw-r--r--manual/plugins/favorites.tex13
-rw-r--r--manual/plugins/firmware_flash.tex12
-rw-r--r--manual/plugins/jpegviewer.tex7
-rw-r--r--manual/plugins/main.tex1163
-rw-r--r--manual/plugins/metronome.tex125
-rw-r--r--manual/plugins/movieplayer.tex6
-rw-r--r--manual/plugins/rockbox_flash.tex12
-rw-r--r--manual/plugins/search.tex7
-rw-r--r--manual/plugins/sort.tex5
-rw-r--r--manual/plugins/split_editor.tex303
-rw-r--r--manual/plugins/stopwatch.tex104
-rw-r--r--manual/plugins/text_viewer.tex190
-rw-r--r--manual/plugins/vbrfix.tex15
21 files changed, 1200 insertions, 1148 deletions
diff --git a/manual/plugins/battery_test.tex b/manual/plugins/battery_test.tex
new file mode 100644
index 0000000000..65f48e22ec
--- /dev/null
+++ b/manual/plugins/battery_test.tex
@@ -0,0 +1,16 @@
1\subsection{Battery\_test}
2\begin{figure}[h]
3\begin{center}
4%\includegraphics{plugins/images/\platform/ss_battery_test.png}
5\end{center}
6\caption{Battery Test}
7\end{figure}
8
9This plugin simulates normal power drain by spinning up the disk and
10reading a big file once every 90 seconds (or thereabouts). Each
11spin up also writes the battery level to a
12log file. The test stops when battery level reaches 4\% in order to
13avoid being unable to write to the disk. The power usage data is saved
14to a file in the root directory of the Jukebox. This plugin can
15sometimes be useful for diagnosing problems with battery charging.
16
diff --git a/manual/plugins/bounce.tex b/manual/plugins/bounce.tex
index 9589f7b575..fd7a144e56 100644
--- a/manual/plugins/bounce.tex
+++ b/manual/plugins/bounce.tex
@@ -1,10 +1,10 @@
1\subsection{Bounce} 1\subsection{Bounce}
2{\centering\itshape 2\begin{figure}[h]
3 [Warning: Image ignored] % Unhandled or unsupported graphics: 3\begin{center}
4%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img48.png} 4%\includegraphics{plugins/images/\platform/ss_bounce.png}
5 \newline 5\end{center}
6The bounce Demo 6\caption{Bounce}
7\par} 7\end{figure}
8 8
9This demo is of the word ``Rockbox'' bouncing across the screen. There 9This demo is of the word ``Rockbox'' bouncing across the screen. There
10is also an analogue clock on the Recorder platform. (The Ondio does 10is also an analogue clock on the Recorder platform. (The Ondio does
diff --git a/manual/plugins/calculator.tex b/manual/plugins/calculator.tex
new file mode 100644
index 0000000000..e1604a6b72
--- /dev/null
+++ b/manual/plugins/calculator.tex
@@ -0,0 +1,12 @@
1\subsection{Calculator}
2{\centering\itshape
3%\includegraphics{plugins/images/\platform/ss_calculator.png}
4\par}
5
6This is a simple scientific calculator for
7use on the Jukebox. It works like a standard calculator. Move using
8the arrow keys and press PLAY to press a button. Pressing the ``1st''
9button will toggle between other available maths functions on the right
10hand side.
11
12
diff --git a/manual/plugins/calendar.tex b/manual/plugins/calendar.tex
new file mode 100644
index 0000000000..fbb8d77c72
--- /dev/null
+++ b/manual/plugins/calendar.tex
@@ -0,0 +1,56 @@
1\subsection{Calendar}
2{\centering\itshape
3 [Warning: Image ignored] % Unhandled or unsupported graphics:
4%\includegraphics[width=3.9cm,height=2.23cm]{images/rockbox-manual-img61.png}
5 \newline
6Calendar
7\par}
8
9This is a small and simple calendar application with memo saving function.
10
11Dots indicate dates with memos. To add a new memo press PLAY on the
12date. Includes one off, annual, monthly, and weekly memos:
13
14\begin{tabular}[c]{|p{2.6469998cm}|p{3.95cm}|}
15\hline
16{\centering\bfseries\itshape
17KEY
18\par}
19&
20{\centering\bfseries\itshape
21ACTION
22\par}
23\\\hline
24{\centering
25PLAY
26\par}
27&
28monthly
29\\\hline
30{\centering
31LEFT
32\par}
33&
34weekly
35\\\hline
36{\centering
37RIGHT
38\par}
39&
40annually
41\\\hline
42{\centering
43ON
44\par}
45&
46one off
47\\\hline
48{\centering
49STOP
50\par}
51&
52exit
53\\\hline
54\end{tabular}
55
56
diff --git a/manual/plugins/chess_clock.tex b/manual/plugins/chess_clock.tex
new file mode 100644
index 0000000000..00de8e8cb0
--- /dev/null
+++ b/manual/plugins/chess_clock.tex
@@ -0,0 +1,143 @@
1\subsection{Chess Clock}
2\begin{figure}[h]
3\begin{center}
4%\includegraphics{plugins/images/\platform/ss_chessclock.png}
5\end{center}
6\caption{Chess Clock}
7\end{figure}
8
9The chess clock plugin is designed to
10simulate a chess clock, but it can be used
11in any kind of game with up to ten players.
12
13\subsubsection{Setup}
14
15\begin{itemize}
16\item First enter the number of players (1{}-10) (press PLAY to
17continue).
18\item Then set the total game time in mm:ss (press PLAY to continue,
19STOP to go back).
20\item Then the maximum round time is entered. For example, this could
21be used to play Scrabble for a maximum of 15 minutes each, with each
22round taking no longer than one minute. (press PLAY to continue).
23\item Done. Player 1 starts in paused mode. So press PLAY to start.
24\end{itemize}
25
26\subsubsection{While playing}
27The number of the current player is displayed on the top line. The time
28below is the time remaining for that round (and possibly also the total
29time left if different).
30
31Keys are as follows:
32
33\begin{center}\begin{tabular}{|p{1.917cm}|p{2.7649999cm}|p{1.7049999cm}|p{9.433001cm}|}
34\hline
35{\centering\bfseries\itshape
36PLAYER
37\par}
38&
39{\centering\bfseries\itshape
40RECORDER
41\par}
42&
43{\centering\bfseries\itshape
44ONDIO
45\par}
46&
47{\centering\bfseries\itshape
48FUNCTION
49\par}
50\\\hline
51{\centering
52ON
53\par}
54&
55{\centering
56OFF
57\par}
58&
59{\centering
60ONOFF
61\par}
62&
63Exit plugin
64\\\hline
65{\centering
66STOP
67\par}
68&
69{\centering
70LEFT
71\par}
72&
73{\centering
74LEFT
75\par}
76&
77Restart round for the player
78\\\hline
79{\centering
80PLAY
81\par}
82&
83{\centering
84PLAY
85\par}
86&
87{\centering
88RIGHT
89\par}
90&
91Pausing the time (press again to continue)
92\\\hline
93{\centering
94RIGHT
95\par}
96&
97{\centering
98UP
99\par}
100&
101{\centering
102UP
103\par}
104&
105Switch to next player
106\\\hline
107{\centering
108LEFT
109\par}
110&
111{\centering
112DOWN
113\par}
114&
115{\centering
116DOWN
117\par}
118&
119Switch to previous player
120\\\hline
121{\centering
122MENU
123\par}
124&
125{\centering
126F1
127\par}
128&
129{\centering
130MODE
131\par}
132&
133Enter a simple menu
134\\\hline
135\end{tabular}\end{center}
136From the menu it is possible to delete a player, modify the round time
137for the current player or set the total time for the game.
138
139When the round time is up for a player the message ``ROUND UP!'' is shown (press NEXT to continue).
140
141When the total time is up for a player the message ``TIME UP!''is shown. Then player will then be removed from the timer.
142
143
diff --git a/manual/plugins/chip8emulator.tex b/manual/plugins/chip8emulator.tex
new file mode 100644
index 0000000000..1c8575b687
--- /dev/null
+++ b/manual/plugins/chip8emulator.tex
@@ -0,0 +1,28 @@
1\subsection{\label{ref:Chip8emulator}Chip{}-8 Emulator}
2The Chip{}-8 Emulator allows you to play many old chip8 games found on
3the Net. It modifies Rockbox, so file extensions .ch8 will be
4recognised as chip8 games. Just press PLAY on a .ch8 file to start a
5game.
6
7There are lots of tiny Chip8 games (usually only about 256 bytes to a
8couple of KB) which were made popular by the HP48
9calculator's emulator for them. The original Chip8 had
1064x32 pixel graphics, and the new superchip emulator supports 128x64
11graphics, which almost fits on the Recorder's display.
12The only problem is they are based on a 4x4 keyboard, but since most
13games do not use all of the buttons, this can easily be worked around.
14
15Some places where can you can find .ch8 files:
16
17\begin{itemize}
18\item The original chip8 patch had several attached:
19\url{http://sourceforge.net/tracker/index.php?func=detail&aid=628509&group_id=44306&atid=439120}
20\item Check out the HP48 chip games section:
21\url{http://www.hpcalc.org/hp48/games/chip/}
22\item Check out the PC emulator by the guy who wrote the HP48 emulator:
23\url{http://www.pdc.kth.se/~lfo/chip8/CHIP8.htm}
24\item Links to other chip8 emulators:
25\url{http://www.zophar.net/chip8.html}
26\end{itemize}
27
28
diff --git a/manual/plugins/clock.tex b/manual/plugins/clock.tex
new file mode 100644
index 0000000000..58371cde08
--- /dev/null
+++ b/manual/plugins/clock.tex
@@ -0,0 +1,105 @@
1\subsection{Clock}
2{\centering\itshape
3 [Warning: Image ignored] % Unhandled or unsupported graphics:
4%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img63.png}
5 \newline
6Clock
7\par}
8
9This is a fully featured analogue and digital clock program.
10
11\subsubsection{Key configuration}
12
13\begin{center}\begin{tabular}{|p{2.411cm}|p{6.012cm}|}
14\hline
15{\centering\bfseries\itshape
16KEY
17\par}
18&
19{\centering\bfseries\itshape
20ACTION
21\par}
22\\\hline
23{\centering
24F1
25\par}
26&
27Help
28\\\hline
29{\centering
30F2
31\par}
32&
33Start / Stop stopwatch
34\\\hline
35{\centering
36F2 (Hold)
37\par}
38&
39Reset stopwatch
40\\\hline
41{\centering
42F3
43\par}
44&
45Options
46\\\hline
47{\centering
48Play
49\par}
50&
51Select clock mode
52\\\hline
53{\centering
54UP
55\par}
56&
57Enable idle power off
58\\\hline
59{\centering
60DOWN
61\par}
62&
63Disable idle power off
64\\\hline
65{\centering
66RIGHT
67\par}
68&
69Enable backlight
70\\\hline
71{\centering
72LEFT
73\par}
74&
75Disable backlight
76\\\hline
77{\centering
78OFF
79\par}
80&
81Save settings to disk and exit
82\\\hline
83\end{tabular}\end{center}
84
85\subsubsection{Backlight configuration}
86If RIGHT or LEFT is not pressed during clock operation (with the
87exception of at the Help/Options/Mode Selector/Credit screens) then the
88backlight timeout will remain your Rockbox default setting (example, 15
89seconds). If RIGHT or LEFT is pressed, Clock will set the backlight to
90ON or OFF, respectively. When Clock is exited, your default Rockbox
91setting for Backlight will be restored.
92
93\subsubsection{Saving Settings}
94Settings are saved to disk when Clock is exited. They are saved to
95\textbf{/.rockbox/rocks/.clock\_settings''}. To reset your settings
96back to the defaults, simply navigate to this file using Rockbox,
97highlight it, and press the ON+PLAY keys to get the Delete option. This way you can feel free to experiment with the settings {}- and you could even load
98separate settings, say, one for your desk at home and one for in the car {}- by keeping two files in your \textbf{/.rockbox/rocks} folder such as
99``h.clock\_settings'' and ``c.clock\_settings''. Simply remove the
100``h'' for your home settings to go into effect, or add the ``h'' back and take off the ``c'' for your car settings.
101
102In the future, loading different settings will probably be made easier
103through a built{}-in settings file loader in Clock.
104
105
diff --git a/manual/plugins/euro_converter.tex b/manual/plugins/euro_converter.tex
new file mode 100644
index 0000000000..7158722863
--- /dev/null
+++ b/manual/plugins/euro_converter.tex
@@ -0,0 +1,14 @@
1\subsection{Euro Converter}
2{\centering\itshape
3 [Warning: Image ignored] % Unhandled or unsupported graphics:
4%\includegraphics[width=4.671cm,height=2cm]{images/rockbox-manual-img64.png}
5 \newline
6Euro converter
7\par}
8
9This plugin converts euros back into pre{}-euro currency. The country for which is does this is selectable by pressing the MENU key. The MINUS and
10PLUS keys move the cursor between the digits and the PLAY and STOP keys
11increase and decrease the current digit. The amount in the old
12currency is displayed on the second line.
13
14
diff --git a/manual/plugins/favorites.tex b/manual/plugins/favorites.tex
new file mode 100644
index 0000000000..ae58e1a707
--- /dev/null
+++ b/manual/plugins/favorites.tex
@@ -0,0 +1,13 @@
1\subsection{Favorites}
2{\centering\itshape
3 [Warning: Image ignored] % Unhandled or unsupported graphics:
4%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img65.png}
5 \newline
6Favorites
7\par}
8
9When listening to any song you can open it with this plugin and it will
10add the current song to a special playlist of all songs you selected in
11\textbf{/favorites.m3u}.
12
13
diff --git a/manual/plugins/firmware_flash.tex b/manual/plugins/firmware_flash.tex
new file mode 100644
index 0000000000..9361cc3cce
--- /dev/null
+++ b/manual/plugins/firmware_flash.tex
@@ -0,0 +1,12 @@
1\subsection{Firmware\_flash}
2{\centering\mdseries\itshape
3 [Warning: Image ignored] % Unhandled or unsupported graphics:
4%\includegraphics[width=3.634cm,height=2.076cm]{images/rockbox-manual-img66.png}
5 \newline
6Firmware\_flash
7\par}
8
9Use when flashing Rockbox (see page \pageref{ref:FlashingRockboxReal}.
10In the ideal case, you'll need this tool only once. For safety reasons you may wish to delete \textbf{firmware\_flash.rock} from \textbf{/.rockbox/rocks} once flashing is complete.
11
12
diff --git a/manual/plugins/jpegviewer.tex b/manual/plugins/jpegviewer.tex
new file mode 100644
index 0000000000..71a38de49c
--- /dev/null
+++ b/manual/plugins/jpegviewer.tex
@@ -0,0 +1,7 @@
1\subsection{JPEG viewer}
2Press PLAY on a .jpg file in order to view the contents using Rockbox's greyscale library. Use the arrow keys to move around the image, PLAY to zoom in
3and ON to zoom out. Press OFF to exit the viewer.
4
5Note: JPEGs that use progressive scan encoding are not supported and will produce an error.
6
7
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 2a53337a6b..e258cab8b9 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -36,7 +36,7 @@ See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}.
36 36
37\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/sliding.tex}} 37\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/sliding.tex}}
38 38
39\opt{recorder,recorderv2fm,ondio}{\input{plugins/snake.tex}} 39\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/snake.tex}}
40 40
41\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/snake2.tex}} 41\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/snake2.tex}}
42 42
@@ -44,7 +44,7 @@ See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}.
44 44
45\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/solitaire.tex}} 45\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/solitaire.tex}}
46 46
47\opt{recorder,recorderv2fm,ondio}{\input{plugins/star.tex}} 47\opt{recorder,recorderv2fm,ondio,h1xx}{\input{plugins/star.tex}}
48 48
49\opt{recorder,recorderv2fm}{\input{plugins/wormlet.tex}} 49\opt{recorder,recorderv2fm}{\input{plugins/wormlet.tex}}
50 50
@@ -75,1169 +75,48 @@ They cannot be run directly but are started by ``playing''
75the associated file. Viewers are stored in the 75the associated file. Viewers are stored in the
76\textbf{/.rockbox/viewers/ }directory. 76\textbf{/.rockbox/viewers/ }directory.
77 77
78\subsection{\label{ref:Chip8emulator}Chip{}-8 Emulator (Recorder, Ondio)}
79The Chip{}-8 Emulator allows you to play many old chip8 games found on
80the Net. It modifies Rockbox, so file extensions .ch8 will be
81recognised as chip8 games. Just press PLAY on a .ch8 file to start a
82game.
83 78
84There are lots of tiny Chip8 games (usually only about 256 bytes to a 79\opt{recorder,recorderv2fm,ondio}{\input{plugins/chip8emulator.tex}}
85couple of KB) which were made popular by the HP48
86calculator's emulator for them. The original Chip8 had
8764x32 pixel graphics, and the new superchip emulator supports 128x64
88graphics, which almost fits on the Recorder's display.
89The only problem is they are based on a 4x4 keyboard, but since most
90games do not use all of the buttons, this can easily be worked around.
91 80
92Some places where can you can find .ch8 files: 81\opt{recorder,recorderv2fm,ondio,h1xx}{\input{plugins/jpegviewer.tex}}
93 82
94\begin{itemize} 83\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
95\item The original chip8 patch had several attached:
96\url{http://sourceforge.net/tracker/index.php?func=detail&aid=628509&group_id=44306&atid=439120}
97\item Check out the HP48 chip games section:
98\url{http://www.hpcalc.org/hp48/games/chip/}
99\item Check out the PC emulator by the guy who wrote the HP48 emulator:
100\url{http://www.pdc.kth.se/~lfo/chip8/CHIP8.htm}
101\item Links to other chip8 emulators:
102\url{http://www.zophar.net/chip8.html}
103\end{itemize}
104 84
105\subsection{JPEG viewer (Recorder, Ondio)} 85\opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}}
106Press PLAY on a .jpg file in order to view the contents using Rockbox's greyscale library. Use the arrow keys to move around the image, PLAY to zoom in
107and ON to zoom out. Press OFF to exit the viewer.
108 86
109Note: JPEGs that use progressive scan encoding are not supported and will produce an error. 87\input{plugins/search.tex}
110 88
111\subsection{Movie Player (Recorder, Ondio)} 89\input{plugins/sort.tex}
112Play movies on your Jukebox! In order to do
113this, movies must be in AVI format, and then converted to .RVF,
114Rockbox's own video format. For more details on how to use this plugin, please see \url{http://www.rockbox.org/twiki/bin/view/Main/VideoTutorial}.
115 90
116\subsection{Rockbox\_flash (Recorder, Ondio)} 91\input{plugins/text_viewer.tex}
117{\centering\itshape
118 [Warning: Image ignored] % Unhandled or unsupported graphics:
119%\includegraphics[width=4.059cm,height=2.32cm]{images/rockbox-manual-img57.png}
120 \newline
121Rockbox flash
122\par}
123 92
124For ``playing'' .UCL files on flashed Jukeboxes. Reprograms the flash memory of 93\input{plugins/vbrfix.tex}
125the Jukebox unit (see page \pageref{ref:Rockboxinflash} for details).
126 94
127\subsection{Search}
128This plugin can be used on playlists. It searches through the playlist
129that it is opened on looking for any occurrences of the string entered by the
130user. The results of this search are saved to a new playlist,
131\textbf{search\_results.m3u}, within the same directory as the
132original playlist.
133 95
134\subsection{Sort}
135This plugin takes a file and sorts it in forward alphabetical order. Case is
136ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see page \pageref{ref:Playlistsubmenu}).
137
138\subsection{Text Viewer}
139This is a Viewer for text files with word wrap. Just press PLAY on a
140.txt file to display it. Has controls to handle various styles of text
141formatting. Has top{}-of{}-file and bottom{}-of{}-file buttons. You
142can view files without a .txt extension by using \textbf{Open with ..}
143from the Play Screen menu
144
145\subsubsection{Controls}
146
147\begin{itemize}
148\item \textbf{F1 (Recorder) / ON{}-MINUS (Player): }
149toggles Word mode between Wrap and Chop:
150
151\begin{itemize}
152\item Wrap breaks lines at white space or hyphen.
153\item Chop breaks lines at the maximum column limit.
154\end{itemize}
155
156\item \textbf{F2 (Recorder) / ON{}-MENU{}-PLUS (Player): }
157cycles Line mode through Normal, Join and Expand:
158
159\begin{itemize}
160\item Normal breaks lines at newline characters.
161\item Join ignores unpaired newline characters (i.e., joins lines). Useful for
162adopting the orphans that occur with e{}-mail style (i.e.,pre{}-wrapped) text files.
163\item Expand doubles unpaired newlines (i.e., adds a blank line). Useful
164for making the paragraphs clearer in some book style text files.
165\end{itemize}
166
167\item \textbf{F3 (Recorder) / ON{}-PLUS (Player):}
168toggles View mode between Narrow and Wide:
169
170\begin{itemize}
171\item Narrow sets maximum column to the screen width.
172\item Wide sets maximum column to 114. Useful for navigating large
173files. (Currently, Wide and Join cannot be selected together.)
174\end{itemize}
175
176\item \textbf{ON{}-F1 (Recorder):}
177toggles Page mode between Normal and Overlap:
178
179\begin{itemize}
180\item Normal sets page{}-down/page{}-up to one full screen.
181\item Overlap tells page{}-down/page{}-up to retain one line from
182previous screen.
183\end{itemize}
184
185\item \textbf{ON{}-F3 (Recorder):}
186toggles Scrollbar mode, for the current View mode.
187
188\begin{itemize}
189\item Narrow mode has no scrollbar by default, until toggled.
190\item Wide mode has a scrollbar by default, until toggled.
191\item If file fits on one screen, there is no scrollbar and ON{}-F3 has
192no effect.
193\end{itemize}
194\end{itemize}
195
196Settings are not remembered after the viewer has been exited.
197Keys are as follows:
198
199\subsubsection{Recorder}
200
201\begin{tabular}[c]{|p{3.317cm}|p{7.104cm}|}
202\hline
203{\centering\bfseries\itshape
204KEY
205\par}
206&
207{\centering\bfseries\itshape
208ACTION
209\par}
210\\\hline
211{\centering
212UP
213\par}
214&
215Page{}-up (one screen up)
216\\\hline
217{\centering
218DOWN
219\par}
220&
221Page{}-down (one screen down)
222\\\hline
223{\centering
224LEFT
225\par}
226&
227Top of file (Narrow mode)\newline
228One screen left (Wide mode)
229\\\hline
230{\centering
231RIGHT
232\par}
233&
234Bottom of file (Narrow mode)\newline
235One screen right (Wide mode)
236\\\hline
237{\centering
238ON{}-UP
239\par}
240&
241One line up
242\\\hline
243{\centering
244ON{}-DOWN
245\par}
246&
247One line down
248\\\hline
249{\centering
250ON{}-LEFT
251\par}
252&
253One column left
254\\\hline
255{\centering
256ON{}-RIGHT
257\par}
258&
259One column right
260\\\hline
261{\centering
262OFF
263\par}
264&
265Exit text viewer
266\\\hline
267\end{tabular}
268
269\subsubsection{Player}
270
271\begin{tabular}[c]{|p{3.291cm}|p{7.131cm}|}
272\hline
273{\centering\bfseries\itshape
274KEY
275\par}
276&
277{\centering\bfseries\itshape
278ACTION
279\par}
280\\\hline
281{\centering
282MINUS
283\par}
284&
285Page{}-up (one screen up)
286\\\hline
287{\centering
288PLUS
289\par}
290&
291Page{}-down (one screen down)
292\\\hline
293{\centering
294MENU MINUS
295\par}
296&
297Top of file (Narrow mode)\newline
298One screen left (Wide mode)
299\\\hline
300{\centering
301MENU PLUS
302\par}
303&
304Bottom of file (Narrow mode)\newline
305One screen right (Wide mode)
306\\\hline
307{\centering
308STOP
309\par}
310&
311Exit text viewer
312\\\hline
313\end{tabular}
314
315\subsubsection{Compatibility}
316
317\begin{itemize}
318\item Correctly reads plain text files in Unix, Win/DOS, or Macintosh
319format. Latin{}-alphabet Unicode files are a l m o s t r e a d a b l
320e.
321\item Currently prefers fixed{}-width fonts. With proportional fonts,
322pretends all characters are the width of a lower{}-case 'o'.
323\item Currently messages are in English
324\item Does not currently support right{}-to{}-left languages.
325\end{itemize}
326
327\subsection{VBRfix}
328This function scans a VBR (Variable Bitrate)
329MP3 file and updates/creates the Xing VBR header. The Xing header
330contains information about the VBR stream used to calculate average bit
331rate, time information and to more accurately fwd/rew in the stream.
332
333This function is especially useful when the playback of a file skips,
334fwd/rew does not work correctly or the time display is incorrect. Run
335VBRfix on files you record with your Jukebox. The header is not present
336in the recorded files and VBRfix adds this header.
337
338Note: VBRfix can only run when music is
339turned off (since it uses the same memory as the player) and can take a
340while to complete if run on big files.
341 96
342\section{Applications} 97\section{Applications}
343 98
344\subsection{Battery\_test} 99\input{plugins/battery_test.tex}
345{\centering\itshape
346 [Warning: Image ignored] % Unhandled or unsupported graphics:
347%\includegraphics[width=3.704cm,height=2.117cm]{images/rockbox-manual-img58.png}
348 \textmd{ } [Warning: Image ignored]
349% Unhandled or unsupported graphics:
350%\includegraphics[width=4.598cm,height=1.976cm]{images/rockbox-manual-img59.png}
351 \newline
352 Recorder battery test Player battery test
353\par}
354
355This plugin simulates normal power drain by spinning up the disk and
356reading a big file once every 90 seconds (or thereabouts). Each
357spin up also writes the battery level to a
358log file. The test stops when battery level reaches 4\% in order to
359avoid being unable to write to the disk. The power usage data is saved
360to a file in the root directory of the Jukebox. This plugin can
361sometimes be useful for diagnosing problems with battery charging.
362
363\subsection{Calculator (Recorder, Ondio)}
364{\centering\itshape
365 [Warning: Image ignored] % Unhandled or unsupported graphics:
366%\includegraphics[width=3.889cm,height=2.223cm]{images/rockbox-manual-img60.png}
367 \newline
368Calculator
369\par}
370
371This is a simple scientific calculator for
372use on the Jukebox. It works like a standard calculator. Move using
373the arrow keys and press PLAY to press a button. Pressing the ``1st''
374button will toggle between other available maths functions on the right
375hand side.
376
377\subsection{Calendar (Recorder, Ondio)}
378{\centering\itshape
379 [Warning: Image ignored] % Unhandled or unsupported graphics:
380%\includegraphics[width=3.9cm,height=2.23cm]{images/rockbox-manual-img61.png}
381 \newline
382Calendar
383\par}
384
385This is a small and simple calendar application with memo saving function.
386
387Dots indicate dates with memos. To add a new memo press PLAY on the
388date. Includes one off, annual, monthly, and weekly memos:
389
390\begin{tabular}[c]{|p{2.6469998cm}|p{3.95cm}|}
391\hline
392{\centering\bfseries\itshape
393KEY
394\par}
395&
396{\centering\bfseries\itshape
397ACTION
398\par}
399\\\hline
400{\centering
401PLAY
402\par}
403&
404monthly
405\\\hline
406{\centering
407LEFT
408\par}
409&
410weekly
411\\\hline
412{\centering
413RIGHT
414\par}
415&
416annually
417\\\hline
418{\centering
419ON
420\par}
421&
422one off
423\\\hline
424{\centering
425STOP
426\par}
427&
428exit
429\\\hline
430\end{tabular}
431
432\subsection{Chess Clock}
433{\centering\itshape
434 [Warning: Image ignored] % Unhandled or unsupported graphics:
435%\includegraphics[width=4.634cm,height=1.984cm]{images/rockbox-manual-img62.png}
436 \newline
437Chess Clock
438\par}
439
440The chess clock plugin is designed to
441simulate a chess clock, but it can be used
442in any kind of game with up to ten players.
443
444\subsubsection{Setup}
445
446\begin{itemize}
447\item First enter the number of players (1{}-10) (press PLAY to
448continue).
449\item Then set the total game time in mm:ss (press PLAY to continue,
450STOP to go back).
451\item Then the maximum round time is entered. For example, this could
452be used to play Scrabble for a maximum of 15 minutes each, with each
453round taking no longer than one minute. (press PLAY to continue).
454\item Done. Player 1 starts in paused mode. So press PLAY to start.
455\end{itemize}
456
457\subsubsection{While playing}
458The number of the current player is displayed on the top line. The time
459below is the time remaining for that round (and possibly also the total
460time left if different).
461
462Keys are as follows:
463
464\begin{center}\begin{tabular}{|p{1.917cm}|p{2.7649999cm}|p{1.7049999cm}|p{9.433001cm}|}
465\hline
466{\centering\bfseries\itshape
467PLAYER
468\par}
469&
470{\centering\bfseries\itshape
471RECORDER
472\par}
473&
474{\centering\bfseries\itshape
475ONDIO
476\par}
477&
478{\centering\bfseries\itshape
479FUNCTION
480\par}
481\\\hline
482{\centering
483ON
484\par}
485&
486{\centering
487OFF
488\par}
489&
490{\centering
491ONOFF
492\par}
493&
494Exit plugin
495\\\hline
496{\centering
497STOP
498\par}
499&
500{\centering
501LEFT
502\par}
503&
504{\centering
505LEFT
506\par}
507&
508Restart round for the player
509\\\hline
510{\centering
511PLAY
512\par}
513&
514{\centering
515PLAY
516\par}
517&
518{\centering
519RIGHT
520\par}
521&
522Pausing the time (press again to continue)
523\\\hline
524{\centering
525RIGHT
526\par}
527&
528{\centering
529UP
530\par}
531&
532{\centering
533UP
534\par}
535&
536Switch to next player
537\\\hline
538{\centering
539LEFT
540\par}
541&
542{\centering
543DOWN
544\par}
545&
546{\centering
547DOWN
548\par}
549&
550Switch to previous player
551\\\hline
552{\centering
553MENU
554\par}
555&
556{\centering
557F1
558\par}
559&
560{\centering
561MODE
562\par}
563&
564Enter a simple menu
565\\\hline
566\end{tabular}\end{center}
567From the menu it is possible to delete a player, modify the round time
568for the current player or set the total time for the game.
569
570When the round time is up for a player the message ``ROUND UP!'' is shown (press NEXT to continue).
571
572When the total time is up for a player the message ``TIME UP!''is shown. Then player will then be removed from the timer.
573
574\subsection{Clock (Recorder)}
575{\centering\itshape
576 [Warning: Image ignored] % Unhandled or unsupported graphics:
577%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img63.png}
578 \newline
579Clock
580\par}
581
582This is a fully featured analogue and digital clock program.
583
584\subsubsection{Key configuration}
585
586\begin{center}\begin{tabular}{|p{2.411cm}|p{6.012cm}|}
587\hline
588{\centering\bfseries\itshape
589KEY
590\par}
591&
592{\centering\bfseries\itshape
593ACTION
594\par}
595\\\hline
596{\centering
597F1
598\par}
599&
600Help
601\\\hline
602{\centering
603F2
604\par}
605&
606Start / Stop stopwatch
607\\\hline
608{\centering
609F2 (Hold)
610\par}
611&
612Reset stopwatch
613\\\hline
614{\centering
615F3
616\par}
617&
618Options
619\\\hline
620{\centering
621Play
622\par}
623&
624Select clock mode
625\\\hline
626{\centering
627UP
628\par}
629&
630Enable idle power off
631\\\hline
632{\centering
633DOWN
634\par}
635&
636Disable idle power off
637\\\hline
638{\centering
639RIGHT
640\par}
641&
642Enable backlight
643\\\hline
644{\centering
645LEFT
646\par}
647&
648Disable backlight
649\\\hline
650{\centering
651OFF
652\par}
653&
654Save settings to disk and exit
655\\\hline
656\end{tabular}\end{center}
657
658\subsubsection{Backlight configuration}
659If RIGHT or LEFT is not pressed during clock operation (with the
660exception of at the Help/Options/Mode Selector/Credit screens) then the
661backlight timeout will remain your Rockbox default setting (example, 15
662seconds). If RIGHT or LEFT is pressed, Clock will set the backlight to
663ON or OFF, respectively. When Clock is exited, your default Rockbox
664setting for Backlight will be restored.
665
666\subsubsection{Saving Settings}
667Settings are saved to disk when Clock is exited. They are saved to
668\textbf{/.rockbox/rocks/.clock\_settings''}. To reset your settings
669back to the defaults, simply navigate to this file using Rockbox,
670highlight it, and press the ON+PLAY keys to get the Delete option. This way you can feel free to experiment with the settings {}- and you could even load
671separate settings, say, one for your desk at home and one for in the car {}- by keeping two files in your \textbf{/.rockbox/rocks} folder such as
672``h.clock\_settings'' and ``c.clock\_settings''. Simply remove the
673``h'' for your home settings to go into effect, or add the ``h'' back and take off the ``c'' for your car settings.
674
675In the future, loading different settings will probably be made easier
676through a built{}-in settings file loader in Clock.
677
678\subsection{Euro Converter (Player)}
679{\centering\itshape
680 [Warning: Image ignored] % Unhandled or unsupported graphics:
681%\includegraphics[width=4.671cm,height=2cm]{images/rockbox-manual-img64.png}
682 \newline
683Euro converter
684\par}
685
686This plugin converts euros back into pre{}-euro currency. The country for which is does this is selectable by pressing the MENU key. The MINUS and
687PLUS keys move the cursor between the digits and the PLAY and STOP keys
688increase and decrease the current digit. The amount in the old
689currency is displayed on the second line.
690
691\subsection{Favorites}
692{\centering\itshape
693 [Warning: Image ignored] % Unhandled or unsupported graphics:
694%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img65.png}
695 \newline
696Favorites
697\par}
698
699When listening to any song you can open it with this plugin and it will
700add the current song to a special playlist of all songs you selected in
701\textbf{/favorites.m3u}.
702
703\subsection{Firmware\_flash (Recorder, Ondio)}
704{\centering\mdseries\itshape
705 [Warning: Image ignored] % Unhandled or unsupported graphics:
706%\includegraphics[width=3.634cm,height=2.076cm]{images/rockbox-manual-img66.png}
707 \newline
708Firmware\_flash
709\par}
710
711Use when flashing Rockbox (see page \pageref{ref:FlashingRockboxReal}.
712In the ideal case, you'll need this tool only once. For safety reasons you may wish to delete \textbf{firmware\_flash.rock} from \textbf{/.rockbox/rocks} once flashing is complete.
713
714\subsection{Metronome}
715This plugin can be used as a metronome to keep time during music
716practice. Adjust the tempo though the interface or by tapping it out
717on the appropriate button.
718
719\begin{tabular}[c]{|p{2.587cm}|p{2.55cm}|p{2.62cm}|p{4.952cm}|}
720\hline
721{\centering\bfseries\itshape
722PLAYER
723\par}
724&
725{\centering\bfseries\itshape
726RECORDER
727\par}
728&
729{\centering\bfseries\itshape
730ONDIO
731\par}
732&
733{\centering\bfseries\itshape
734FUNCTION
735\par}
736\\\hline
737{\centering
738STOP
739\par}
740&
741{\centering
742OFF
743\par}
744&
745{\centering
746ONOFF
747\par}
748&
749Exit plugin
750\\\hline
751{\centering
752PLAY
753\par}
754&
755{\centering
756PLAY
757\par}
758&
759{\centering
760~
761\par}
762&
763Start / Stop
764\\\hline
765{\centering
766ON
767\par}
768&
769{\centering
770ON
771\par}
772&
773{\centering
774~
775\par}
776&
777Tap tempo
778\\\hline
779{\centering
780~
781\par}
782&
783{\centering
784~
785\par}
786&
787{\centering
788MODE
789\par}
790&
791Start / Tap tempo
792\\\hline
793{\centering
794~
795\par}
796&
797{\centering
798~
799\par}
800&
801{\centering
802HOLD MODE
803\par}
804&
805Stop
806\\\hline
807{\centering
808MINUS/PLUS
809\par}
810&
811{\centering
812LEFT/RIGHT
813\par}
814&
815{\centering
816LEFT/RIGHT
817\par}
818&
819Adjust tempo
820\\\hline
821{\centering
822ON+MINUS/\newline
823ON+PLUS
824\par}
825&
826{\centering
827UP/DOWN
828\par}
829&
830{\centering
831UP/DOWN
832\par}
833&
834Adjust volume
835\\\hline
836\end{tabular}
837
838\subsection{Split Editor (Recorder, Ondio)}
839When recording an mp3 file, it is common practice to start the recording
840a little bit early and stop it a little bit late to ensure all the
841desired sound is recorded. This results in recordings that contain
842extra snippets of sound and the beginning and end. Unfortunately these
843snippets can not be deleted easily because they are stored in the same
844file as the desired recording. The purpose of the split editor is to
845split a mp3 file (the input file) at a point in time (split point). Two
846new files can be generated from the input file. The first file contains
847the part before the split point and the second file contains the part
848after the split point. Once this process has been successful the
849original file can be deleted or kept as a backup.
850
851The whole process of splitting a mp3 file consists of three steps:
852
853\begin{enumerate}
854\item defining the split point
855\item generating the result files.
856\item if desired delete the input file (with the browser, not the split
857editor)
858\end{enumerate}
859
860\subsubsection{How to use the Split Editor}
861
862\begin{itemize}
863\item \textbf{Pause near the split point}
864When the device plays the song just hit the PAUSE button, when playback
865has roughly reached the split point. This need not be very precise as
866the split point can be fine tuned later.
867\item \textbf{Open the split editor}
868
869Open the plugin. A screen similar to the one below will appear.
870
871{\centering\itshape
872 [Warning: Image ignored] % Unhandled or unsupported graphics:
873%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img67.gif}
874 \newline
875The Split Editor
876\par}
877
878{\centering\upshape
879Here is an explanation of the areas marked in red on the screenshot.
880\par}
881 100
882\begin{enumerate} 101\opt{recorder,recorderv2fm,ondio,h1xx}{\input{plugins/calculator.tex}}
883\item The waveform \newline
884\newline
885The waveform displays the volume of the song over time. It will appear
886as the song plays and help to visually identify the point in time where
887the split is desired
888\item The split point indicator\newline
889\newline
890The split point indicator is a vertical line with a small triangle at
891the top end. It is the most important control element of the split
892editor. It can be moved with the LEFT and RIGHT buttons. Later, when
893you have fine tuned the split point, the song will be split at this
894position.
895\item The split time\newline
896\newline
897At the top of the window a time value is displayed. This is the point in
898time within the song at which the split point indicator is positioned.
899\item The locator\newline
900\newline
901Another vertical bar represents the position locator. It moves along as
902the song plays. In contrast to the split point indicator it has no
903triangles at the ends.
904\item The time bar\newline
905\newline
906The time bar displays the current position within the song relative to
907the whole song. The entire length of the time bar represents the song
908length. The length of the solid part of the time bar represents the position and length
909of the displayed part of the song.
910\item The scale mode\newline
911\newline
912Directly above the F3 button the scale mode is displayed. The waveform
913can be scaled either logarithmically or linearly. In logarithmic scale
914mode the letters ``dB'' are displayed, in linear mode ``\%''. Use F3 to
915switch between these modes. Linear mode usually gives better optical
916hints with commercially recorded music. For quiet recordings,
917especially of human speech, the logarithmic scale often is preferable.
918\item The loop mode \newline
919\newline
920Directly above the F2 button the loop mode icon is displayed. There are
9214 different loop modes. Pressing F2 changes to the next loop mode.
922 102
923\begin{itemize} 103\opt{recorder,recorderv2fm,ondio}{\input{plugins/calendar.tex}}
924\item [Warning: Image ignored] % Unhandled or unsupported graphics:
925%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img68.gif}
926 Playback loops around the split point indicator. This mode is best
927used when searching and zooming for the desired point at which to split
928the recording.
929\item [Warning: Image ignored] % Unhandled or unsupported graphics:
930%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img69.gif}
931 Playback loops from the split point indicator to the end of the
932visible area. This mode is best used when fine tuning the split
933indicator position at the beginning of a recording.
934\item [Warning: Image ignored] % Unhandled or unsupported graphics:
935%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img70.gif}
936 Playback loops from the beginning of the
937visible area to the split point. This mode is best used when fine
938tuning the split indicator position at the end of a recording.
939\item [Warning: Image ignored] % Unhandled or unsupported graphics:
940%\includegraphics[width=0.688cm,height=0.476cm]{images/rockbox-manual-img71.gif}
941 Playback doesn't loop, the borders of the visible
942area as well as the split point indicator are ignored. This mode is
943best used when playing the song outside of the borders of the displayed
944region.
945\end{itemize}
946 104
947\item Perform the split \newline
948\newline
949The icon directly above the F1 button indicates its function to execute
950the split. When split positioning is complete open the save dialogue with F1.
951\end{enumerate}
952 105
953{\bfseries 106\input{plugins/chess_clock.tex}
954Controls in the split editor }
955\end{itemize}
956 107
957\begin{tabular}[c]{|p{2.975cm}|p{3.047cm}|p{6.649cm}|} 108\opt{recorder,recorderv2fm}{\input{plugins/clock.tex}}
958\hline
959{\centering\bfseries\itshape
960Recorder
961\par}
962&
963{\centering\bfseries\itshape
964Ondio
965\par}
966&
967{\centering\bfseries\itshape
968Function
969\par}
970\\\hline
971{\centering
972Off
973\par}
974&
975{\centering
976On/Off
977\par}
978&
979Quit plugin
980\\\hline
981{\centering
982Left/Right
983\par}
984&
985{\centering
986Left/Right
987\par}
988&
989Move the split point indicator
990\\\hline
991{\centering
992Up/Down
993\par}
994&
995{\centering
996Up/Down
997\par}
998&
999Zoom in / out
1000\\\hline
1001{\centering
1002Play
1003\par}
1004&
1005{\centering
1006Mode
1007\par}
1008&
1009Play from the split position
1010\\\hline
1011{\centering
1012F1
1013\par}
1014&
1015{\centering
1016Mode+Left
1017\par}
1018&
1019Enter the save dialogue
1020\\\hline
1021{\centering
1022F2
1023\par}
1024&
1025{\centering
1026Mode+Up
1027\par}
1028&
1029Toggle loop modes
1030\\\hline
1031{\centering
1032F3
1033\par}
1034&
1035{\centering
1036Mode+Right
1037\par}
1038&
1039Toggle logarithmic / linear scaling
1040\\\hline
1041{\centering
1042On+Left
1043\par}
1044&
1045{\centering
1046~
1047\par}
1048&
1049Play half speed
1050\\\hline
1051{\centering
1052On+Right
1053\par}
1054&
1055{\centering
1056~
1057\par}
1058&
1059Play 150\% speed
1060\\\hline
1061{\centering
1062On+Play
1063\par}
1064&
1065{\centering
1066~
1067\par}
1068&
1069Play normal speed
1070\\\hline
1071\end{tabular}
1072 109
1073\subsubsection{Save the files} 110\opt{recorder,recorderv2fm}{\input{plugins/euro_converter.tex}}
1074In the save dialogue it is possible to specify which of the files you
1075want to save and their names. When finished, select
1076``Save'' and the files will be written to
1077disk. Note that files can not be overwritten, so filenames that
1078don't exist yet must be chosen. If unsure whether the
1079file already exists simply try to save it. If another file with this
1080name exists the dialogue will return and you can choose another
1081filename
1082 111
1083{\centering\itshape 112\input{plugins/favorites.tex}
1084 [Warning: Image ignored] % Unhandled or unsupported graphics:
1085%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img72.gif}
1086 \newline
1087Save dialogue
1088\par}
1089 113
1090Controls in the save dialogue 114\opt{recorder,recorderv2fm,ondio}{\input{plugins/firmware_flash.tex}}
1091\begin{tabular}[c]{|p{2.62cm}|p{2.266cm}|p{3.965cm}|}
1092\hline
1093{\centering\bfseries\itshape
1094RECORDER
1095\par}
1096&
1097{\centering\bfseries\itshape
1098ONDIO
1099\par}
1100&
1101{\centering\bfseries\itshape
1102FUNCTION
1103\par}
1104\\\hline
1105{\centering
1106UP/DOWN
1107\par}
1108&
1109{\centering
1110UP/DOWN
1111\par}
1112&
1113Select item
1114\\\hline
1115{\centering
1116PLAY
1117\par}
1118&
1119{\centering
1120RIGHT
1121\par}
1122&
1123Toggle / edit item
1124\\\hline
1125\end{tabular}
1126 115
1127\subsubsection{Scale} 116\input{plugins/metronome.tex}
1128The values in the waveform are scaled according to the settings of the
1129peak meter. These can be altered in the menu
1130\textbf{General Settings {}-{\textgreater} Display{}-{\textgreater} Peak Meter}. If extreme minimum /
1131maximum values are set the waveform might be cut off. A minimum
1132setting of {}-60 dB and a maximum setting of 0 dB are recommended.
1133These settings should be capable of producing useful waveforms for very
1134soft sounds in logarithmic mode (dB). When the editor is used on loud
1135sounds (such as commercial rock or pop music) switching to the linear
1136scale may prove more effective since the logarithmic scale compresses
1137loud noises and makes it more difficult to identify characteristic
1138shapes. Note that it is always possible to toggle the scale with F3.
1139 117
1140\subsection{Stopwatch} 118\opt{recorder,recorderv2fm,ondio}{\input{plugins/split_editor.tex}}
1141{\centering\itshape
1142 [Warning: Image ignored] % Unhandled or unsupported graphics:
1143%\includegraphics[width=3.704cm,height=2.117cm]{images/rockbox-manual-img73.png}
1144 \textmd{ } [Warning: Image ignored]
1145% Unhandled or unsupported graphics:
1146%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img74.png}
1147 \newline
1148Recorder stopwatch Player stopwatch
1149\par}
1150 119
1151A simple stopwatch program with support for saving times. 120\input{plugins/stopwatch.tex}
1152 121
1153\subsubsection{Keys are as follows:}
1154 122
1155\begin{tabular}[c]{|p{2.9029999cm}|p{2.763cm}|p{2.199cm}|p{5.235cm}|}
1156\hline
1157{\centering\bfseries\itshape
1158PLAYER
1159\par}
1160&
1161{\centering\bfseries\itshape
1162RECORDER
1163\par}
1164&
1165{\centering\bfseries\itshape
1166ONDIO
1167\par}
1168&
1169{\centering\bfseries\itshape
1170FUNCTION
1171\par}
1172\\\hline
1173{\centering
1174MENU
1175\par}
1176&
1177{\centering
1178OFF
1179\par}
1180&
1181{\centering
1182ONOFF
1183\par}
1184&
1185Quit Plugin
1186\\\hline
1187{\centering
1188PLAY
1189\par}
1190&
1191{\centering
1192PLAY
1193\par}
1194&
1195{\centering
1196RIGHT
1197\par}
1198&
1199Start / stop
1200\\\hline
1201{\centering
1202STOP
1203\par}
1204&
1205{\centering
1206LEFT
1207\par}
1208&
1209{\centering
1210LEFT
1211\par}
1212&
1213Reset timer
1214\\\hline
1215{\centering
1216ON
1217\par}
1218&
1219{\centering
1220ON
1221\par}
1222&
1223{\centering
1224MODE
1225\par}
1226&
1227Take lap time
1228\\\hline
1229{\centering
1230MINUS/PLUS
1231\par}
1232&
1233{\centering
1234DOWN/UP
1235\par}
1236&
1237{\centering
1238DOWN/UP
1239\par}
1240&
1241Scroll through lap times
1242\\\hline
1243\end{tabular}
diff --git a/manual/plugins/metronome.tex b/manual/plugins/metronome.tex
new file mode 100644
index 0000000000..965b5e88b6
--- /dev/null
+++ b/manual/plugins/metronome.tex
@@ -0,0 +1,125 @@
1\subsection{Metronome}
2This plugin can be used as a metronome to keep time during music
3practice. Adjust the tempo though the interface or by tapping it out
4on the appropriate button.
5
6\begin{tabular}[c]{|p{2.587cm}|p{2.55cm}|p{2.62cm}|p{4.952cm}|}
7\hline
8{\centering\bfseries\itshape
9PLAYER
10\par}
11&
12{\centering\bfseries\itshape
13RECORDER
14\par}
15&
16{\centering\bfseries\itshape
17ONDIO
18\par}
19&
20{\centering\bfseries\itshape
21FUNCTION
22\par}
23\\\hline
24{\centering
25STOP
26\par}
27&
28{\centering
29OFF
30\par}
31&
32{\centering
33ONOFF
34\par}
35&
36Exit plugin
37\\\hline
38{\centering
39PLAY
40\par}
41&
42{\centering
43PLAY
44\par}
45&
46{\centering
47~
48\par}
49&
50Start / Stop
51\\\hline
52{\centering
53ON
54\par}
55&
56{\centering
57ON
58\par}
59&
60{\centering
61~
62\par}
63&
64Tap tempo
65\\\hline
66{\centering
67~
68\par}
69&
70{\centering
71~
72\par}
73&
74{\centering
75MODE
76\par}
77&
78Start / Tap tempo
79\\\hline
80{\centering
81~
82\par}
83&
84{\centering
85~
86\par}
87&
88{\centering
89HOLD MODE
90\par}
91&
92Stop
93\\\hline
94{\centering
95MINUS/PLUS
96\par}
97&
98{\centering
99LEFT/RIGHT
100\par}
101&
102{\centering
103LEFT/RIGHT
104\par}
105&
106Adjust tempo
107\\\hline
108{\centering
109ON+MINUS/\newline
110ON+PLUS
111\par}
112&
113{\centering
114UP/DOWN
115\par}
116&
117{\centering
118UP/DOWN
119\par}
120&
121Adjust volume
122\\\hline
123\end{tabular}
124
125
diff --git a/manual/plugins/movieplayer.tex b/manual/plugins/movieplayer.tex
new file mode 100644
index 0000000000..c17e86cc69
--- /dev/null
+++ b/manual/plugins/movieplayer.tex
@@ -0,0 +1,6 @@
1\subsection{Movie Player}
2Play movies on your Jukebox! In order to do
3this, movies must be in AVI format, and then converted to .RVF,
4Rockbox's own video format. For more details on how to use this plugin, please see \url{http://www.rockbox.org/twiki/bin/view/Main/VideoTutorial}.
5
6
diff --git a/manual/plugins/rockbox_flash.tex b/manual/plugins/rockbox_flash.tex
new file mode 100644
index 0000000000..bd3b8feaf3
--- /dev/null
+++ b/manual/plugins/rockbox_flash.tex
@@ -0,0 +1,12 @@
1\subsection{Rockbox\_flash}
2{\centering\itshape
3 [Warning: Image ignored] % Unhandled or unsupported graphics:
4%\includegraphics[width=4.059cm,height=2.32cm]{images/rockbox-manual-img57.png}
5 \newline
6Rockbox flash
7\par}
8
9For ``playing'' .UCL files on flashed Jukeboxes. Reprograms the flash memory of
10the Jukebox unit (see page \pageref{ref:Rockboxinflash} for details).
11
12
diff --git a/manual/plugins/search.tex b/manual/plugins/search.tex
new file mode 100644
index 0000000000..e224f3fdb0
--- /dev/null
+++ b/manual/plugins/search.tex
@@ -0,0 +1,7 @@
1\subsection{Search}
2This plugin can be used on playlists. It searches through the playlist
3that it is opened on looking for any occurrences of the string entered by the
4user. The results of this search are saved to a new playlist,
5\textbf{search\_results.m3u}, within the same directory as the
6original playlist.
7
diff --git a/manual/plugins/sort.tex b/manual/plugins/sort.tex
new file mode 100644
index 0000000000..940f86ff40
--- /dev/null
+++ b/manual/plugins/sort.tex
@@ -0,0 +1,5 @@
1\subsection{Sort}
2This plugin takes a file and sorts it in forward alphabetical order. Case is
3ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see page \pageref{ref:Playlistsubmenu}).
4
5
diff --git a/manual/plugins/split_editor.tex b/manual/plugins/split_editor.tex
new file mode 100644
index 0000000000..d0656e62ee
--- /dev/null
+++ b/manual/plugins/split_editor.tex
@@ -0,0 +1,303 @@
1\subsection{Split Editor}
2When recording an mp3 file, it is common practice to start the recording
3a little bit early and stop it a little bit late to ensure all the
4desired sound is recorded. This results in recordings that contain
5extra snippets of sound and the beginning and end. Unfortunately these
6snippets can not be deleted easily because they are stored in the same
7file as the desired recording. The purpose of the split editor is to
8split a mp3 file (the input file) at a point in time (split point). Two
9new files can be generated from the input file. The first file contains
10the part before the split point and the second file contains the part
11after the split point. Once this process has been successful the
12original file can be deleted or kept as a backup.
13
14The whole process of splitting a mp3 file consists of three steps:
15
16\begin{enumerate}
17\item defining the split point
18\item generating the result files.
19\item if desired delete the input file (with the browser, not the split
20editor)
21\end{enumerate}
22
23\subsubsection{How to use the Split Editor}
24
25\begin{itemize}
26\item \textbf{Pause near the split point}
27When the device plays the song just hit the PAUSE button, when playback
28has roughly reached the split point. This need not be very precise as
29the split point can be fine tuned later.
30\item \textbf{Open the split editor}
31
32Open the plugin. A screen similar to the one below will appear.
33
34{\centering\itshape
35 [Warning: Image ignored] % Unhandled or unsupported graphics:
36%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img67.gif}
37 \newline
38The Split Editor
39\par}
40
41{\centering\upshape
42Here is an explanation of the areas marked in red on the screenshot.
43\par}
44
45\begin{enumerate}
46\item The waveform \newline
47\newline
48The waveform displays the volume of the song over time. It will appear
49as the song plays and help to visually identify the point in time where
50the split is desired
51\item The split point indicator\newline
52\newline
53The split point indicator is a vertical line with a small triangle at
54the top end. It is the most important control element of the split
55editor. It can be moved with the LEFT and RIGHT buttons. Later, when
56you have fine tuned the split point, the song will be split at this
57position.
58\item The split time\newline
59\newline
60At the top of the window a time value is displayed. This is the point in
61time within the song at which the split point indicator is positioned.
62\item The locator\newline
63\newline
64Another vertical bar represents the position locator. It moves along as
65the song plays. In contrast to the split point indicator it has no
66triangles at the ends.
67\item The time bar\newline
68\newline
69The time bar displays the current position within the song relative to
70the whole song. The entire length of the time bar represents the song
71length. The length of the solid part of the time bar represents the position and length
72of the displayed part of the song.
73\item The scale mode\newline
74\newline
75Directly above the F3 button the scale mode is displayed. The waveform
76can be scaled either logarithmically or linearly. In logarithmic scale
77mode the letters ``dB'' are displayed, in linear mode ``\%''. Use F3 to
78switch between these modes. Linear mode usually gives better optical
79hints with commercially recorded music. For quiet recordings,
80especially of human speech, the logarithmic scale often is preferable.
81\item The loop mode \newline
82\newline
83Directly above the F2 button the loop mode icon is displayed. There are
844 different loop modes. Pressing F2 changes to the next loop mode.
85
86\begin{itemize}
87\item [Warning: Image ignored] % Unhandled or unsupported graphics:
88%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img68.gif}
89 Playback loops around the split point indicator. This mode is best
90used when searching and zooming for the desired point at which to split
91the recording.
92\item [Warning: Image ignored] % Unhandled or unsupported graphics:
93%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img69.gif}
94 Playback loops from the split point indicator to the end of the
95visible area. This mode is best used when fine tuning the split
96indicator position at the beginning of a recording.
97\item [Warning: Image ignored] % Unhandled or unsupported graphics:
98%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img70.gif}
99 Playback loops from the beginning of the
100visible area to the split point. This mode is best used when fine
101tuning the split indicator position at the end of a recording.
102\item [Warning: Image ignored] % Unhandled or unsupported graphics:
103%\includegraphics[width=0.688cm,height=0.476cm]{images/rockbox-manual-img71.gif}
104 Playback doesn't loop, the borders of the visible
105area as well as the split point indicator are ignored. This mode is
106best used when playing the song outside of the borders of the displayed
107region.
108\end{itemize}
109
110\item Perform the split \newline
111\newline
112The icon directly above the F1 button indicates its function to execute
113the split. When split positioning is complete open the save dialogue with F1.
114\end{enumerate}
115
116{\bfseries
117Controls in the split editor }
118\end{itemize}
119
120\begin{tabular}[c]{|p{2.975cm}|p{3.047cm}|p{6.649cm}|}
121\hline
122{\centering\bfseries\itshape
123Recorder
124\par}
125&
126{\centering\bfseries\itshape
127Ondio
128\par}
129&
130{\centering\bfseries\itshape
131Function
132\par}
133\\\hline
134{\centering
135Off
136\par}
137&
138{\centering
139On/Off
140\par}
141&
142Quit plugin
143\\\hline
144{\centering
145Left/Right
146\par}
147&
148{\centering
149Left/Right
150\par}
151&
152Move the split point indicator
153\\\hline
154{\centering
155Up/Down
156\par}
157&
158{\centering
159Up/Down
160\par}
161&
162Zoom in / out
163\\\hline
164{\centering
165Play
166\par}
167&
168{\centering
169Mode
170\par}
171&
172Play from the split position
173\\\hline
174{\centering
175F1
176\par}
177&
178{\centering
179Mode+Left
180\par}
181&
182Enter the save dialogue
183\\\hline
184{\centering
185F2
186\par}
187&
188{\centering
189Mode+Up
190\par}
191&
192Toggle loop modes
193\\\hline
194{\centering
195F3
196\par}
197&
198{\centering
199Mode+Right
200\par}
201&
202Toggle logarithmic / linear scaling
203\\\hline
204{\centering
205On+Left
206\par}
207&
208{\centering
209~
210\par}
211&
212Play half speed
213\\\hline
214{\centering
215On+Right
216\par}
217&
218{\centering
219~
220\par}
221&
222Play 150\% speed
223\\\hline
224{\centering
225On+Play
226\par}
227&
228{\centering
229~
230\par}
231&
232Play normal speed
233\\\hline
234\end{tabular}
235
236\subsubsection{Save the files}
237In the save dialogue it is possible to specify which of the files you
238want to save and their names. When finished, select
239``Save'' and the files will be written to
240disk. Note that files can not be overwritten, so filenames that
241don't exist yet must be chosen. If unsure whether the
242file already exists simply try to save it. If another file with this
243name exists the dialogue will return and you can choose another
244filename
245
246{\centering\itshape
247 [Warning: Image ignored] % Unhandled or unsupported graphics:
248%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img72.gif}
249 \newline
250Save dialogue
251\par}
252
253Controls in the save dialogue
254\begin{tabular}[c]{|p{2.62cm}|p{2.266cm}|p{3.965cm}|}
255\hline
256{\centering\bfseries\itshape
257RECORDER
258\par}
259&
260{\centering\bfseries\itshape
261ONDIO
262\par}
263&
264{\centering\bfseries\itshape
265FUNCTION
266\par}
267\\\hline
268{\centering
269UP/DOWN
270\par}
271&
272{\centering
273UP/DOWN
274\par}
275&
276Select item
277\\\hline
278{\centering
279PLAY
280\par}
281&
282{\centering
283RIGHT
284\par}
285&
286Toggle / edit item
287\\\hline
288\end{tabular}
289
290\subsubsection{Scale}
291The values in the waveform are scaled according to the settings of the
292peak meter. These can be altered in the menu
293\textbf{General Settings {}-{\textgreater} Display{}-{\textgreater} Peak Meter}. If extreme minimum /
294maximum values are set the waveform might be cut off. A minimum
295setting of {}-60 dB and a maximum setting of 0 dB are recommended.
296These settings should be capable of producing useful waveforms for very
297soft sounds in logarithmic mode (dB). When the editor is used on loud
298sounds (such as commercial rock or pop music) switching to the linear
299scale may prove more effective since the logarithmic scale compresses
300loud noises and makes it more difficult to identify characteristic
301shapes. Note that it is always possible to toggle the scale with F3.
302
303
diff --git a/manual/plugins/stopwatch.tex b/manual/plugins/stopwatch.tex
new file mode 100644
index 0000000000..e765ad3f57
--- /dev/null
+++ b/manual/plugins/stopwatch.tex
@@ -0,0 +1,104 @@
1\subsection{Stopwatch}
2{\centering\itshape
3 [Warning: Image ignored] % Unhandled or unsupported graphics:
4%\includegraphics[width=3.704cm,height=2.117cm]{images/rockbox-manual-img73.png}
5 \textmd{ } [Warning: Image ignored]
6% Unhandled or unsupported graphics:
7%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img74.png}
8 \newline
9Recorder stopwatch Player stopwatch
10\par}
11
12A simple stopwatch program with support for saving times.
13
14\subsubsection{Keys are as follows:}
15
16\begin{tabular}[c]{|p{2.9029999cm}|p{2.763cm}|p{2.199cm}|p{5.235cm}|}
17\hline
18{\centering\bfseries\itshape
19PLAYER
20\par}
21&
22{\centering\bfseries\itshape
23RECORDER
24\par}
25&
26{\centering\bfseries\itshape
27ONDIO
28\par}
29&
30{\centering\bfseries\itshape
31FUNCTION
32\par}
33\\\hline
34{\centering
35MENU
36\par}
37&
38{\centering
39OFF
40\par}
41&
42{\centering
43ONOFF
44\par}
45&
46Quit Plugin
47\\\hline
48{\centering
49PLAY
50\par}
51&
52{\centering
53PLAY
54\par}
55&
56{\centering
57RIGHT
58\par}
59&
60Start / stop
61\\\hline
62{\centering
63STOP
64\par}
65&
66{\centering
67LEFT
68\par}
69&
70{\centering
71LEFT
72\par}
73&
74Reset timer
75\\\hline
76{\centering
77ON
78\par}
79&
80{\centering
81ON
82\par}
83&
84{\centering
85MODE
86\par}
87&
88Take lap time
89\\\hline
90{\centering
91MINUS/PLUS
92\par}
93&
94{\centering
95DOWN/UP
96\par}
97&
98{\centering
99DOWN/UP
100\par}
101&
102Scroll through lap times
103\\\hline
104\end{tabular}
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex
new file mode 100644
index 0000000000..f5d43944e1
--- /dev/null
+++ b/manual/plugins/text_viewer.tex
@@ -0,0 +1,190 @@
1\subsection{Text Viewer}
2This is a Viewer for text files with word wrap. Just press PLAY on a
3.txt file to display it. Has controls to handle various styles of text
4formatting. Has top{}-of{}-file and bottom{}-of{}-file buttons. You
5can view files without a .txt extension by using \textbf{Open with ..}
6from the Play Screen menu
7
8\subsubsection{Controls}
9
10\begin{itemize}
11\item \textbf{F1 (Recorder) / ON{}-MINUS (Player): }
12toggles Word mode between Wrap and Chop:
13
14\begin{itemize}
15\item Wrap breaks lines at white space or hyphen.
16\item Chop breaks lines at the maximum column limit.
17\end{itemize}
18
19\item \textbf{F2 (Recorder) / ON{}-MENU{}-PLUS (Player): }
20cycles Line mode through Normal, Join and Expand:
21
22\begin{itemize}
23\item Normal breaks lines at newline characters.
24\item Join ignores unpaired newline characters (i.e., joins lines). Useful for
25adopting the orphans that occur with e{}-mail style (i.e.,pre{}-wrapped) text files.
26\item Expand doubles unpaired newlines (i.e., adds a blank line). Useful
27for making the paragraphs clearer in some book style text files.
28\end{itemize}
29
30\item \textbf{F3 (Recorder) / ON{}-PLUS (Player):}
31toggles View mode between Narrow and Wide:
32
33\begin{itemize}
34\item Narrow sets maximum column to the screen width.
35\item Wide sets maximum column to 114. Useful for navigating large
36files. (Currently, Wide and Join cannot be selected together.)
37\end{itemize}
38
39\item \textbf{ON{}-F1 (Recorder):}
40toggles Page mode between Normal and Overlap:
41
42\begin{itemize}
43\item Normal sets page{}-down/page{}-up to one full screen.
44\item Overlap tells page{}-down/page{}-up to retain one line from
45previous screen.
46\end{itemize}
47
48\item \textbf{ON{}-F3 (Recorder):}
49toggles Scrollbar mode, for the current View mode.
50
51\begin{itemize}
52\item Narrow mode has no scrollbar by default, until toggled.
53\item Wide mode has a scrollbar by default, until toggled.
54\item If file fits on one screen, there is no scrollbar and ON{}-F3 has
55no effect.
56\end{itemize}
57\end{itemize}
58
59Settings are not remembered after the viewer has been exited.
60Keys are as follows:
61
62\subsubsection{Recorder}
63
64\begin{tabular}[c]{|p{3.317cm}|p{7.104cm}|}
65\hline
66{\centering\bfseries\itshape
67KEY
68\par}
69&
70{\centering\bfseries\itshape
71ACTION
72\par}
73\\\hline
74{\centering
75UP
76\par}
77&
78Page{}-up (one screen up)
79\\\hline
80{\centering
81DOWN
82\par}
83&
84Page{}-down (one screen down)
85\\\hline
86{\centering
87LEFT
88\par}
89&
90Top of file (Narrow mode)\newline
91One screen left (Wide mode)
92\\\hline
93{\centering
94RIGHT
95\par}
96&
97Bottom of file (Narrow mode)\newline
98One screen right (Wide mode)
99\\\hline
100{\centering
101ON{}-UP
102\par}
103&
104One line up
105\\\hline
106{\centering
107ON{}-DOWN
108\par}
109&
110One line down
111\\\hline
112{\centering
113ON{}-LEFT
114\par}
115&
116One column left
117\\\hline
118{\centering
119ON{}-RIGHT
120\par}
121&
122One column right
123\\\hline
124{\centering
125OFF
126\par}
127&
128Exit text viewer
129\\\hline
130\end{tabular}
131
132\subsubsection{Player}
133
134\begin{tabular}[c]{|p{3.291cm}|p{7.131cm}|}
135\hline
136{\centering\bfseries\itshape
137KEY
138\par}
139&
140{\centering\bfseries\itshape
141ACTION
142\par}
143\\\hline
144{\centering
145MINUS
146\par}
147&
148Page{}-up (one screen up)
149\\\hline
150{\centering
151PLUS
152\par}
153&
154Page{}-down (one screen down)
155\\\hline
156{\centering
157MENU MINUS
158\par}
159&
160Top of file (Narrow mode)\newline
161One screen left (Wide mode)
162\\\hline
163{\centering
164MENU PLUS
165\par}
166&
167Bottom of file (Narrow mode)\newline
168One screen right (Wide mode)
169\\\hline
170{\centering
171STOP
172\par}
173&
174Exit text viewer
175\\\hline
176\end{tabular}
177
178\subsubsection{Compatibility}
179
180\begin{itemize}
181\item Correctly reads plain text files in Unix, Win/DOS, or Macintosh
182format. Latin{}-alphabet Unicode files are a l m o s t r e a d a b l
183e.
184\item Currently prefers fixed{}-width fonts. With proportional fonts,
185pretends all characters are the width of a lower{}-case 'o'.
186\item Currently messages are in English
187\item Does not currently support right{}-to{}-left languages.
188\end{itemize}
189
190
diff --git a/manual/plugins/vbrfix.tex b/manual/plugins/vbrfix.tex
new file mode 100644
index 0000000000..267b9663ab
--- /dev/null
+++ b/manual/plugins/vbrfix.tex
@@ -0,0 +1,15 @@
1\subsection{VBRfix}
2This function scans a VBR (Variable Bitrate)
3MP3 file and updates/creates the Xing VBR header. The Xing header
4contains information about the VBR stream used to calculate average bit
5rate, time information and to more accurately fwd/rew in the stream.
6
7This function is especially useful when the playback of a file skips,
8fwd/rew does not work correctly or the time display is incorrect. Run
9VBRfix on files you record with your Jukebox. The header is not present
10in the recorded files and VBRfix adds this header.
11
12Note: VBRfix can only run when music is
13turned off (since it uses the same memory as the player) and can take a
14while to complete if run on big files.
15