summaryrefslogtreecommitdiff
path: root/www/manual
diff options
context:
space:
mode:
Diffstat (limited to 'www/manual')
-rw-r--r--www/manual/Makefile9
-rw-r--r--www/manual/dir.t98
-rw-r--r--www/manual/general.t87
-rw-r--r--www/manual/index.t46
-rw-r--r--www/manual/manual.t2
-rw-r--r--www/manual/menu-buttons.t8
-rw-r--r--www/manual/menu.t26
-rw-r--r--www/manual/play-boot.pngbin182 -> 0 bytes
-rw-r--r--www/manual/play-keyboard-Naentered.pngbin4408 -> 0 bytes
-rw-r--r--www/manual/play-keyboard-Nselected.pngbin4348 -> 0 bytes
-rw-r--r--www/manual/play-keyboard-accept.pngbin4293 -> 0 bytes
-rw-r--r--www/manual/play-keyboard-initial.pngbin4379 -> 0 bytes
-rw-r--r--www/manual/play-keyboard.t94
-rw-r--r--www/manual/rec-boot.pngbin519 -> 0 bytes
-rw-r--r--www/manual/rec-dir.pngbin595 -> 0 bytes
-rw-r--r--www/manual/rec-folder.pngbin232 -> 0 bytes
-rw-r--r--www/manual/rec-generalsettings.pngbin1095 -> 0 bytes
-rw-r--r--www/manual/rec-logo.pngbin1146 -> 0 bytes
-rw-r--r--www/manual/rec-m3u.pngbin218 -> 0 bytes
-rw-r--r--www/manual/rec-menu.pngbin477 -> 0 bytes
-rw-r--r--www/manual/rec-mp3.pngbin219 -> 0 bytes
-rw-r--r--www/manual/rec-soundsettings.pngbin582 -> 0 bytes
-rw-r--r--www/manual/rec-volume.pngbin495 -> 0 bytes
-rw-r--r--www/manual/rec-wps.pngbin620 -> 0 bytes
-rw-r--r--www/manual/settings-buttons.t7
-rw-r--r--www/manual/sound.t41
-rw-r--r--www/manual/textreader.t29
-rw-r--r--www/manual/wormlet.t259
-rw-r--r--www/manual/wps.t78
29 files changed, 0 insertions, 784 deletions
diff --git a/www/manual/Makefile b/www/manual/Makefile
deleted file mode 100644
index 751a62f256..0000000000
--- a/www/manual/Makefile
+++ /dev/null
@@ -1,9 +0,0 @@
1ACTION=@echo preprocessing $@; rm -f $@; $(HOME)/bin/fcpp -WWW -I.. -Uunix -H -C -V -LL >$@
2
3SRC := $(wildcard *.t)
4OBJS := $(SRC:%.t=%.html)
5
6all: $(OBJS)
7
8%.html : %.t
9 $(ACTION) $<
diff --git a/www/manual/dir.t b/www/manual/dir.t
deleted file mode 100644
index e41530ce84..0000000000
--- a/www/manual/dir.t
+++ /dev/null
@@ -1,98 +0,0 @@
1#define _PAGE_ Manual - Directory Browser
2#include "head.t"
3#include "manual.t"
4
5<p>
6<table>
7<tr valign=top><td>
8<img src="rec-dir.png" width=120 height=68 alt="Dir browser">
9<br><small>Recorder screenshot</small>
10</td>
11</tr></table>
12
13
14<p>
15In the dir browser, you navigate your way around the harddisk.
16There are icons on the left side of each file that shows what file type it is.
17
18<p>
19The list of files you see is affected by the
20<a href="general.html">"Show files" setting</a>.
21
22<h2>Button bindings</h2>
23
24<table class=buttontable>
25<tr><th>Button</th><th>Function</th>
26<tr valign=top>
27<td nowrap> UP/DOWN (r) <br> LEFT/RIGHT (p)</td>
28<td>
29 Go to previous/next item in list. If you are on the first/last entry,
30 the cursor will wrap to the last/first entry.
31</td></tr>
32<tr valign=top>
33<td nowrap> ON + UP/DOWN </td>
34<td>
35 (Recorder only:) Move one page up/down in list.
36</td></tr>
37<tr valign=top>
38<td> LEFT (r) <br> STOP (p)</td>
39<td> Go to the parent directory.
40</td></tr>
41<tr valign=top>
42<td> PLAY </td>
43<td>Action depends on the file type the cursor points at:
44<dl>
45<dt><b>Directory</b>
46<dd>The browser enters that directory.
47
48<dt><b>.mp3 file</b>
49<dd>You will be taken to the <a href="wps.html">WPS</a>
50and start playing the file.
51
52<dt><b>.m3u file</b>
53<dd>The playlist will be loaded and started and you will then be taken to the WPS.
54
55<dt><b>.ajz (recorder) or .mod (player) file</b>
56<dd>The firmware file will be loaded and executed.
57
58<dt><b>.wps file</b>
59<dd>The file will be loaded and used for the wps display.
60 Look <a href="/docs/custom_wps_format.html">here</a> for information about
61 the .wps file format.
62
63<dt><b>.cfg file</b>
64<dd>The file will be loaded and the sound settings will be set accordingly.
65 Look <a href="/docs/custom_cfg_format.html">here</a> for information about
66 the .cfg file format.
67
68<dt><b>.lng file</b>
69<dd>The language file will be loaded and replace the current language.
70 Look <a href="/lang/">here</a> for downloadable language files.
71
72<dt><b>.txt file</b>
73<dd> The text file will be displayed in the <a href="textreader.html">Text Reader</a>.
74
75<dt><b>.fnt file</b>
76<dd> (Recorder only:) The font will be loaded and used in place of the
77 default font.
78 Look <a href="/fonts/">here</a> for downloadable fonts.
79
80</dl>
81</td></tr>
82<tr><td>
83 ON
84</td><td>
85 If there is an mp3 playing, this will go back to the WPS.
86</td></tr>
87<tr><td>
88 OFF (r)
89</td><td>
90 If there is an mp3 playing, this stops playback.
91</td></tr>
92<tr><td>F1 (r) <br>MENU (p)</td>
93<td>Switches to the <a href="menu.html">main menu</a>.</td></tr>
94<tr><td>F2 (r)</td><td>(Recorder only) Show browse/play settings screen. A quick press will leave the screen up (press F2 again to exit), while holding it will close the screen when you release it.</td></tr>
95<tr><td>F3 (r)</td><td>(Recorder only) Show display settings screen. Quick/hold works as for F2.</td></tr>
96</table>
97
98#include "foot.t"
diff --git a/www/manual/general.t b/www/manual/general.t
deleted file mode 100644
index 54622ed607..0000000000
--- a/www/manual/general.t
+++ /dev/null
@@ -1,87 +0,0 @@
1#define _PAGE_ Manual - General Settings
2#include "head.t"
3#include "manual.t"
4
5<h2>Playback</h2>
6 <ul>
7 <li><b>Shuffle</b> - Select shuffle ON/OFF. This alters how Rockbox will
8 select which next song to play.
9
10 <li><b>Repeat</b> - Repeat modes are Off/One/All.
11 "Off" means no repeat. "One" means repeat one track over and over.
12 "All" means repeat playlist/directory.
13
14 <li><b>Play selected first</b> - This setting controls what happens when you
15 press PLAY on a file in a directory and shuffle mode is on.
16 If this setting is Yes, the file you selected will be played first.
17 If this setting is No, a random file in the directory will be played first.
18
19 <li><b>Resume</b> - Sets whether Rockbox will resume playing at the point where you shut off. Options are: Ask/Yes/No.
20 "Ask" means it will ask at boot time.
21 "Yes" means it will unconditionally try to resume.
22 "No" means it will not resume.
23
24 <li><b>FF/RW Min Step</b> - The smallest step you want to fast forward or rewind in a track.
25
26 <li><b>FF/RW Accel</b> - How fast you want search (ffwd/rew) to accellerate when you hold down the button. "Off" means no accelleration. "2x/1s" means double the search speed once every second the button is held. "2x/5s" means double the search speed once every 5 seconds the button is held.
27 </ul>
28
29<h2>File View</h2>
30 <ul>
31 <li><b>Sort mode</b> - How directories are sorted.
32 Case sensitivity ON makes uppercase and lowercase differences matter.
33 Having it OFF makes them get treated the same.
34
35 <li><b>Show files</b> - Controls which files are displayed in the dir browser:
36 <ul>
37 <li><b>Music</b>: Only directories, .mp3, .mp2, .mpa and .m3u files are shown. Extensions are stripped. Files and directories starting with . or has the "hidden" flag set are hidden.
38
39 <li><b>Supported</b>: All directories and files Rockbox can load (including .fnt, .wps, .cfg, .txt, .ajz/.mod) are shown. Extensions are shown. Files and directories starting with . or has the "hidden" flag set are hidden.
40
41 <li><b>All</b>: All files and directories are shown. Extensions are shown. No files or dirs are hidden.
42 </ul>
43
44 <li><b>Follow Playlist</b> - Do you want the dir browser to follow your playlist? If Follow Playlist is set to "Yes", you will find yourself in the same directory as the currently playing file if you go to the Dir Browser from the WPS. If set to "No", you will stay in the same directory as you last were in.
45 </ul>
46
47<h2>Display</h2>
48<ul>
49<li><b>Scroll speed</b> - Controls the speed of scrolling text.
50
51<li><b>Backlight timer</b> - How long time the backlight shines after a keypress. Set to OFF to never light it, set to ON to never shut it off or set a prefered timeout period.
52
53<li><b>Backlight on when plugged</b> - Do you want the backlight to be constantly on while the charger cable is connected?
54
55<li><b>Contrast</b> - Changes the contrast of your LCD display.
56
57<li><b>Peak meter</b> (Recorder only)
58 <ul>
59 <li><b>Peak release</b>: How fast should the peak meter shrink after a peak?
60 <li><b>Peak hold</b>: How long should the peak meter hold before shrinking?
61 <li><b>Clip hold</b>: How long should the clipping indicator be visible after clipping was detected?
62 </ul>
63</ul>
64
65<h2>System</h2>
66<ul>
67<li><b>Disk Spindown</b> - Rockbox has a timer that makes it spin down the
68harddisk after being idle for a certain time. You can modify this timeout here.
69
70<li><b>Deep discharge</b> (Recorder only) -
71 Set this to ON if you intend to keep your charger
72connected for a long period of time. It lets the batteries go down to 10%
73before starting to charge again. Setting this to OFF will cause the charging
74to restart on 95%.
75
76<li><b>Set Time/Date</b> (Recorder only) - Set current time and date.
77
78<li><b>Idle poweroff</b> - After how long period of idle time should the unit power off?
79
80<li><b>Reset settings</b> - Reset all settings to default values. Some settings may need a reboot for the reset to take effect.
81
82</ul>
83
84#include "settings-buttons.t"
85
86#include "foot.t"
87
diff --git a/www/manual/index.t b/www/manual/index.t
deleted file mode 100644
index 86613e2e0f..0000000000
--- a/www/manual/index.t
+++ /dev/null
@@ -1,46 +0,0 @@
1#define _PAGE_ User Manual
2#include "head.t"
3
4<h2>General concept</h2>
5<p>
6The Rockbox user interface consists of three main screens:
7<ul>
8<li>The Directory Browser
9<li>The While Playing Screen (WPS)
10<li>The Menu
11</ul>
12
13<p>The <a href="dir.html">Directory Browser</a> is where you find yourself
14immediately after boot. It is used for exploring your harddisk and selecting files for playing or other functions. <a href="dir.html">Click here</a> for more information.
15
16<p>The <a href="wps.html">While Playing Screen</a> is the screen displayed while you are playing mp3 files. It contains information about the track you are playing. <a href="wps.html">Click here</a> for more information.
17
18<p>The <a href="menu.html">Menu</a> is where you can access all settings and auxiliary functions of the Rockbox software. <a href="menu.html">Click here</a> for more information.
19
20<h2>Configuration</h2>
21
22<p>Apart from all the <a href="menu.html">settings</a>, the major points
23of configuration are:
24
25<ul>
26<li><a href="/fonts/">Loadable fonts</a>
27<li><a href="/lang/">Loadable languages</a>
28<li><a href="/docs/custom_wps_format.html">Loadable WPS template</a>
29<li><a href="/docs/custom_cfg_format.html">Loadable CFG format</a>
30</ul>
31
32<h2>Button notation</h2>
33<p>
34Since the Players and the Recorders provide mostly the same functions, this manual describes them both in the same pages. However, the key bindings differ for various features. This will be noted by a a (p) or (r) suffix to the key, like this:
35
36<p><table class=buttontable>
37<tr><th>Button</th><th>Function</th>
38<tr valign=top>
39<td> UP (r) <br> LEFT (p) </td>
40<td> Go to previous item in list.
41</td></tr>
42</table>
43
44<p>In the above example: Recorders use the UP button while players use the LEFT button.
45
46#include "foot.t"
diff --git a/www/manual/manual.t b/www/manual/manual.t
deleted file mode 100644
index 8de599ddd3..0000000000
--- a/www/manual/manual.t
+++ /dev/null
@@ -1,2 +0,0 @@
1<div align=right><a href="/manual/">User Manual Front Page</a></div>
2
diff --git a/www/manual/menu-buttons.t b/www/manual/menu-buttons.t
deleted file mode 100644
index 654bc881b9..0000000000
--- a/www/manual/menu-buttons.t
+++ /dev/null
@@ -1,8 +0,0 @@
1<h2>Button bindings</h2>
2<table class=buttontable>
3<tr><th>Button</th><th>Function</th>
4<tr><td>UP (r) <br>LEFT (p)</td><td>Move up in menu</td></tr>
5<tr><td>DOWN (r) <br>RIGHT (p)</td><td>Move down in menu</td></tr>
6<tr><td>PLAY</td><td>Select item</td></tr>
7<tr><td>LEFT (r) <br>STOP (p)</td><td>Exit menu</td></tr>
8</table>
diff --git a/www/manual/menu.t b/www/manual/menu.t
deleted file mode 100644
index 5f3a7ad595..0000000000
--- a/www/manual/menu.t
+++ /dev/null
@@ -1,26 +0,0 @@
1#define _PAGE_ Manual - Main Menu
2#include "head.t"
3#include "manual.t"
4<p>
5<img src="rec-menu.png" width=120 height=68 alt="Main menu">
6<br><small>Recorder screenshot</small>
7
8<p>The main menu offers:
9<ul>
10<li> <b><a href="sound.html">Sound Settings</a></b> - Vol, bass, treble etc.
11<li> <b><a href="general.html">General Settings</a></b> - Scroll, display, filters etc.
12
13<li> <b>Games</b> - (Recorder only) Pick a game to play! Tetris, Sokoban and <a href=wormlet.html>Wormlet</a> are available.
14
15<li> <b>Demos</b> - (Recorder only) Some silly little toys. <i>Bounce</i> will show a bouncing text (try the buttons), <i>Snow</i> will simulate falling snow and <i>Oscillograph</i> will give you a nice animated graph of the currently playing music (try the buttons here too).
16
17<li> <b>Info</b> - Shows MP3 ram buffer size and battery voltage level info.
18
19<li> <b>Version</b> - Software version and credits display.
20
21<li> <b>Debug (keep out)</b> - Various informational displays for development purposes.
22</ul>
23
24#include "menu-buttons.t"
25
26#include "foot.t"
diff --git a/www/manual/play-boot.png b/www/manual/play-boot.png
deleted file mode 100644
index ab6d76a563..0000000000
--- a/www/manual/play-boot.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/play-keyboard-Naentered.png b/www/manual/play-keyboard-Naentered.png
deleted file mode 100644
index 088aa0e605..0000000000
--- a/www/manual/play-keyboard-Naentered.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/play-keyboard-Nselected.png b/www/manual/play-keyboard-Nselected.png
deleted file mode 100644
index 8fd7cc473d..0000000000
--- a/www/manual/play-keyboard-Nselected.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/play-keyboard-accept.png b/www/manual/play-keyboard-accept.png
deleted file mode 100644
index cebdfa6f45..0000000000
--- a/www/manual/play-keyboard-accept.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/play-keyboard-initial.png b/www/manual/play-keyboard-initial.png
deleted file mode 100644
index df1e453e4d..0000000000
--- a/www/manual/play-keyboard-initial.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/play-keyboard.t b/www/manual/play-keyboard.t
deleted file mode 100644
index bda482b6fd..0000000000
--- a/www/manual/play-keyboard.t
+++ /dev/null
@@ -1,94 +0,0 @@
1#define _PAGE_ Manual - Player keyboard
2#include "head.t"
3#include "manual.t"
4
5 <p>
6 The keyboard allows you to edit text. The first line holds the
7 text being edited and the second line is a combined menu line
8 where you both can select characters for insertion and the
9 operations; backspace, delete, accept and abort.
10 </p>
11
12 <p>
13 You move between the lines using the normal LEFT and RIGHT
14 buttons. An arrow to the left indicate what line is selected. The
15 second line will scroll. This is like like in most menus except
16 that the first line will always show the text being edited.
17 </p>
18
19 <h2>Button bindings and functionality</h2>
20
21 <table class=buttontable>
22 <tr><th>Line</th><th>Function and key bindings</th>
23 <tr><td>First</td><td>Text - Use UP and DOWN to move the cursor</td></tr>
24 <tr><td>Second</td>
25 <td>
26 <table>
27 <tr>
28 <td>Characters</td><td>Chars selectable for
29 input. With ON insert the char between the
30 arrows. Select another character by using UP and
31 DOWN. Finally change the character subset with
32 MENU. There are three subsets to choose from:
33 capital letters, small letters and others.</td>
34 </tr>
35 <tr>
36 <td>Backspace</td><td>Use UP to delete the char to the
37 left the cursor.</td>
38 </tr>
39 <tr><td>Delete</td><td>Use UP to delete char under the
40 cursor</td>
41 </tr>
42 <tr><td>Accept</td><td>UP accepts the text and returns
43 to the application</td>
44 </tr>
45 <tr><td>Abort</td><td>UP returns to the application
46 without any change</td>
47 </tr>
48 </table>
49 </td>
50 </tr>
51 </table>
52
53 <h2>Example</h2>
54
55 <p>Supposed we want edit the text "file.mp3" and change it to
56 "fileName.mp3". Maybe as a part of doing a rename operation. This
57 is how the screen will look:</p>
58
59 <img src="play-keyboard-initial.png">
60
61 <p>Note how the arrow points to the first line. This means that UP
62 and DOWN will move the cursor on the first line so that you can
63 select where to insert a char or where to delete chars.</p>
64
65 <p>Now we press DOWN three times to move the cursor so it will be
66 above the dot. The we move down to the second line by pressing
67 RIGHT. Finally we select the character N by pressing UP a few
68 times. You will se that the second line will scroll to the left
69 placing a new character between the arrows each time you press
70 UP. We continue doing this until we have N between the arrows. The
71 screen will look something like this then.</p>
72
73 <img src="play-keyboard-Nselected.png">
74
75 <p>We are now ready to insert out first character. Press ON and N
76 will be inserted at the place of the cursor.</p>
77
78 <p>To get to the small letters we press MENU, move to 'a' by using
79 UP and DOWN, insert it by pressing ON.</p>
80
81 <img src="play-keyboard-Naentered.png">
82
83 <p>Finally to feed our new text back to the application requesting
84 this we move further down by pressing RIGHT. This will scroll the
85 second line vertically, move away the character insertion line and
86 another menu line will be visible. We continue pressing RIGHT until
87 the menu choice Accept is visible.</p>
88
89 <img src="play-keyboard-accept.png">
90
91 <p>We acknowledge this by pressing UP. We are done. We will now be
92 taken back to where we were before entering the keyboard.</p>
93
94#include "foot.t"
diff --git a/www/manual/rec-boot.png b/www/manual/rec-boot.png
deleted file mode 100644
index 6aca22b879..0000000000
--- a/www/manual/rec-boot.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-dir.png b/www/manual/rec-dir.png
deleted file mode 100644
index 2c211a83d9..0000000000
--- a/www/manual/rec-dir.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-folder.png b/www/manual/rec-folder.png
deleted file mode 100644
index 92095368ad..0000000000
--- a/www/manual/rec-folder.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-generalsettings.png b/www/manual/rec-generalsettings.png
deleted file mode 100644
index acfa2a7c70..0000000000
--- a/www/manual/rec-generalsettings.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-logo.png b/www/manual/rec-logo.png
deleted file mode 100644
index d79f0b2dc0..0000000000
--- a/www/manual/rec-logo.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-m3u.png b/www/manual/rec-m3u.png
deleted file mode 100644
index c1940c8bf5..0000000000
--- a/www/manual/rec-m3u.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-menu.png b/www/manual/rec-menu.png
deleted file mode 100644
index e3cfea5735..0000000000
--- a/www/manual/rec-menu.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-mp3.png b/www/manual/rec-mp3.png
deleted file mode 100644
index 6ea793f6ce..0000000000
--- a/www/manual/rec-mp3.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-soundsettings.png b/www/manual/rec-soundsettings.png
deleted file mode 100644
index 46e67aa28f..0000000000
--- a/www/manual/rec-soundsettings.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-volume.png b/www/manual/rec-volume.png
deleted file mode 100644
index bb5c873508..0000000000
--- a/www/manual/rec-volume.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/rec-wps.png b/www/manual/rec-wps.png
deleted file mode 100644
index 5f9b16ce40..0000000000
--- a/www/manual/rec-wps.png
+++ /dev/null
Binary files differ
diff --git a/www/manual/settings-buttons.t b/www/manual/settings-buttons.t
deleted file mode 100644
index 1fb24c850b..0000000000
--- a/www/manual/settings-buttons.t
+++ /dev/null
@@ -1,7 +0,0 @@
1<h2>Button bindings</h2>
2<table class=buttontable>
3<tr><th>Button</th><th>Function</th>
4<tr><td>UP (r) <br>LEFT (p)</td><td>Decrease value / choose previous</td></tr>
5<tr><td>DOWN (r) <br>RIGHT (p)</td><td>Increase value / choose next</td></tr>
6<tr><td>LEFT (r) <br>STOP (p)</td><td>Exit setting</td></tr>
7</table>
diff --git a/www/manual/sound.t b/www/manual/sound.t
deleted file mode 100644
index 292bbed133..0000000000
--- a/www/manual/sound.t
+++ /dev/null
@@ -1,41 +0,0 @@
1#define _PAGE_ Manual - Sound Settings
2#include "head.t"
3#include "manual.t"
4
5<p>
6 This menu offers a selection of sound properties you may change
7 to improve your sound experience.
8
9<dl>
10<dt><b>Volume</b>
11<dd>The sound volume your music is played at. Although settable range is 0-100%, many units don't produce audible output below 40%.
12
13<dt><b>Bass</b>
14<dd>Bass emphasis or suppression. 0 is flat.
15
16<dt><b>Treble</b>
17<dd>Treble emphasis or suppression. 0 is flat.
18
19<dt><b>Balance</b>
20<dd>Adjusts left/right channel balance. - is left, + is right.
21
22<dt><b>Channels</b>
23<dd>Select which channels to hear: Left, Right, Stereo (both, separated) or Mono (both, mixed).
24
25<dt><b>Loudness (Recorder only)</b>
26<dd>Loudness is an effect which emphasises bass and treble.
27
28<dt><b>Bass Boost (Recorder only)</b>
29<dd>Bass Boost exploits the psychoacoustic phenomenon of the "missing fundamental" by creating harmonics of the frequencies below the center frequency of the bandpass filter. This enables a loudspeaker to display frequencies that are below its cutoff frequency.
30
31<dt><b>Auto Volume (Recorder only)</b>
32<dd>Auto volume is a feature that automaticly lowers the volume on loud parts,
33and then slowly restores the volume to the previous level during N seconds.
34That N time is configurable here.
35
36</dl>
37
38#include "settings-buttons.t"
39
40#include "foot.t"
41
diff --git a/www/manual/textreader.t b/www/manual/textreader.t
deleted file mode 100644
index 88c3ec4710..0000000000
--- a/www/manual/textreader.t
+++ /dev/null
@@ -1,29 +0,0 @@
1#define _PAGE_ Manual - Text Reader
2#include "head.t"
3#include "manual.t"
4
5<img src="rec-reader.png">
6
7<p>The text reader is a rather primitive tool to view plain text files.
8
9<h2>Button bindings</h2>
10
11<p>
12<table class=buttontable>
13<tr><th>Key</th><th>Function</th></tr>
14<tr><td nowrap> UP/DOWN (r) <br>LEFT/RIGHT (p)</td>
15<td> Move one line up/down </td></tr>
16
17<tr><td> LEFT/RIGHT (r) <br>MENU + LEFT/RIGHT (p)</td>
18<td> Move one column left/right </td></tr>
19
20<tr><td> ON + UP/DOWN (r)</td>
21<td> (Recorder only) Move one page up/down</td></tr>
22
23<tr><td> ON + LEFT/RIGHT (r)</td>
24<td> (Recorder only) Move one screen left/right</td></tr>
25
26<tr><td>OFF (r) <br>STOP (p)</td><td> Exit </td></tr>
27</table>
28
29#include "foot.t"
diff --git a/www/manual/wormlet.t b/www/manual/wormlet.t
deleted file mode 100644
index 7d56a6e556..0000000000
--- a/www/manual/wormlet.t
+++ /dev/null
@@ -1,259 +0,0 @@
1#define _PAGE_ Manual - Wormlet
2#include "head.t"
3#include "manual.t"
4
5<h2>Overview</h2>
6<p> Wormlet is a multi-user multi-worm game on a multi-threaded multi-functional
7rockbox console. You navigate a humgry little worm. Help
8your worm to find food and to avoid poisoned argh-tiles. The goal
9is to turn your tiny worm into a big worm as long as possible.</p>
10
11<h2>System requirements</h2>
12<p>To play Wormlet you need an Archos Jukebox Recorder upgraded with Rockbox open
13source jukebox firmware. Ensure that your version of Rockbox has games complied
14in. Note that not all Rockbox versions contain Wormlet as the games are a
15optional at compile time.</p>
16<p>For 2-player games a remote control is not necessary but recommended. If you
17try to hold the Jukebox in the four hands of two players you'll find out why.
18Games with three players are only possible using a remote control.</p>
19
20<h2>Start the game</h2>
21<p>Hit F1 on the jukebox to enter the menu. Use the arrow keys to select the
22entry 'Games' and then 'Wormlet'.</p>
23
24<h2>Game Options</h2>
25<p>Before the game starts a configuration panel appears. Here you select the
26number of players, the number of worms and the control mode of the game.</p>
27<h3>Players</h3>
28<p>With the up and down keys of the Jukebox you can adjust the number of
29players that take part in the game. To each player a worm will be assigned.
30If there are more worms than players in the game those worms will be
31steered by the Jukebox with artificial stupidity. This enables you to play
32against opponents if you lack of friends. If you are smart: maybe you should
33put away Wormlet every now and then to make new friends that can steer the
34worms more intelligently than artificial stupidity. Although: sometimes human
35stipidity outstupids artificial stupidity... But that doesn't apply to _your_
36friends.</p>
37<p>By specifying 0 players you enter the couch-potato-mode. All worms are
38controlled by artificial stupidity and thus out of control. Grab some popcorn
39and watch the worms fight each other. Maybe you feel like supporting a worm
40of your choice loudly.</p>
41
42<h3>Worms</h3>
43Adjust the number of worms that take part in the game. Note that you can have
44more worms than players but not more players than worms. Worms without a player
45are controlled by artificial stupidity.
46
47<h3>Control</h3>
48Using the F1 key you can select the control mode. The available control modes
49depend on the number of players taking part in the game. Only in single player
50games the 4 Key control is available. It would be unfair if you had to
51distinguish four keys while your opponent is already busy with only two ....
52<table border=1>
53 <tr>
54 <td>Players</td>
55 <td>Modes</td>
56 <td>Player 1</td>
57 <td>Player 2</td>
58 <td>Player 3</td>
59 </tr>
60 <tr>
61 <td>0</td>
62 <td>Out of control</td>
63 <th colspan=3>
64 With no player taking part in the game all worms are out of control and
65 steered by artificial stupidity.
66 </th>
67 </tr>
68 <tr>
69 <td rowspan=2>1</td>
70 <td>2 Key control</td>
71 <td>
72 on Jukebox<br>
73 left: turn worm left<br>
74 right: turn worm right
75 </td>
76 <td>-</td>
77 <td>-</td>
78 </tr>
79 <tr>
80 <td>4 Key control</td>
81 <td>
82 on Jukebox<br>
83 left: make worm creep left<br>
84 up: make worm creep up<br>
85 right: make worm creep right<br>
86 down: make worm creep down
87 </td>
88 <td>-</td>
89 <td>-</td>
90 </tr>
91 <tr>
92 <td rowspan=2>2</td>
93 <td>Remote Control</td>
94 <td>
95 on Jukebox<br>
96 left: turn worm left<br>
97 right: turn worm right<br>
98 </td>
99 <td>
100 on remote control<br>
101 Volume down: turn worm left</br>
102 Volume up: turn worm right<br>
103 </td>
104 <td>-</td>
105 </tr>
106 <tr>
107 <td>No rem. control</td>
108 <td>
109 on Jukebox<br>
110 left: turn worm left<br>
111 right: turn worm right<br>
112 </td>
113 <td>
114 on Jukebox<br>
115 F2: turn worm left</br>
116 F3: turn worm right<br>
117 </td>
118 <td>-</td>
119 </tr>
120 <tr>
121 <td>3</td>
122 <td>Remote control</td>
123 <td>
124 on Jukebox<br>
125 left: turn worm left<br>
126 right: turn worm right<br>
127 </td>
128 <td>
129 on remote control<br>
130 Volume down: turn worm left</br>
131 Volume up: turn worm right<br>
132 </td>
133 <td>
134 on Jukebox<br>
135 F2: turn worm left</br>
136 F3: turn worm right<br>
137 </td>
138
139 </tr>
140</table>
141
142<h3>Start the game</h3>
143<p>When you have finished selecting the game options you start the game by
144pressing the 'play' or 'on' button. The field is populated with food,
145argh tiles and of course the worms. According to your selectin up to
146three worms appear. All worms start creeping to the right.
147The worm of player 1 is the top most worm, player 2 controls the worm in
148the middle, the third worm is driven by player 3. </p>
149
150<h2>The game</h2>
151<p>Use the control keys of your worm to navigate around obstacles and find
152food. Worms can not stop creeping besides when dead. Dead worms are no fun.
153Be careful as your worm will try to eat anything that you steer it
154across. It doesn't distinguish wether it's eatable or not.</p>
155
156<h3>Food</h3>
157<p>The small quadratical hollow pieces are food. By creeping your worm over a
158food tile you make it eat. After you ate your worm grows. Each time a piece
159of food has been eaten a new piece of food will pop up somewhere.
160Unfortunately for each new food that appears two new argh pieces will appear,
161too.</p>
162
163<h3>Argh</h3>
164You surely wondered what the heaven an argh might be. An argh is a
165black quadratical poisoned piece - slightly bigger than food - that makes a
166worm say "Argh!" when creeping against. A worm that tried to eat an argh is
167dead. Thus you must avoid eating argh under any circumstances. Arghs have
168the annoying tendency to accumulate.
169
170<h3>Worms</h3>
171Thou shall not eat worms. Neither other worms nor yourself. Eating worms is
172plasphemic canibalism, not healthy and causes instant death. And it doesn't
173help you anyway: you can't hurt the other worm by biting it. It will go
174on creeping happily and eat all the food you left on the table.
175
176<h3>Walls</h3>
177Don't creep against the walls. Walls are not eatable. Creeping a worm against
178a wall causes it a headache it doesn't survive.
179
180<h3>Game over</h3>
181The game is over when all worms are dead. The longest worm wins the game.
182
183<h3>Pause the game</h3>
184Press the play key to pause the game. Hit play again to resume the game.
185
186<h3>Stop the game</h3>
187There are two ways to stop a running game.
188<ul>
189<li>If you want to quit Wormlet entirely
190simply hit the off button. The game will stop immediately and you will return
191to the game menu.
192<li>If you want to stop the game and still see the screen hit the on button. This
193freezes the game. If you hit the on button again a new game starts with the same
194configuration. To return to the games menu you can hit the stop button.
195A stopped game can not be resumed.
196</ul>
197
198<h2>The score board</h2>
199On the right side of the game field you can see the score board. For each worm
200it displays its status and its length. The top most entry displays the state of
201worm 1, the second worm 3 and the third worm 3. When a worm dies it's entry on the
202score board turns black.
203
204<h3>Len:</h3>
205Here the current length of the worm is displayed. When a worm is on food it
206grows by one pixel for each step it creeps.
207
208<h3>Hungry</h3>
209That's the normal state of a worm. Worms are always hungry and want to eat.
210It's good to have a hungry worm since it means that your worm is alive. But
211it's better to get your worm growing.
212
213<h3>Growing</h3>
214When your worm has eaten a piece of food it starts growing. For each step
215it creeps it can grow by one pixel. One piece of food lasts for 7 steps.
216After your worm has crept 7 steps the food is used up. If you encounter
217another piece of food while growing don't hesitate to eat it. It will increase
218your growing state for another 7 steps.
219
220<h3>Crashed</h3>
221This indicats that you crashed your poor worm against a wall. That was evil.
222Go and find something hard and smash it against your forehead so you feel
223what you did to your worm. And don't use your Jukebox. You might damage it and
224with its soft blue rubber edges that wouldn't hurt enough anyway.
225
226<h3>Argh</h3>
227If your score board entry displays "Argh" it means your worm is dead because of
228trying to eat an argh. Until we can make the worm say "Argh!" it's your
229job to say "Argh!" aloud.
230
231<h3>Wormed</h3>
232Your worm tried to eat another worm or even itself. That's why it's dead now.
233Maybe your opponent has managed to build a trap with his worm. Try to
234do the same with him in the next game.
235
236<h2>Hints</h2>
237<ul>
238<li>During the first games you will be busy with controlling your worm. Try to
239avoid other worms and creep far away from them. Wait until they curled up
240themselves and collect the food afterwards. Don't bother if the other worms
241grow longer than yours - you can catch up after they've died.
242<li>When you are more experienced watch the tactics of other worms. Especially
243those worms controlled by artificial stupidity head straight for the nearest
244piece of food. Let the other worm have it's next piece of food and head for
245the food it would probably want next. Try to put yourself between the opponent
246and that food. From now on you can 'control' the other worm by blocking it.
247You could trap it
248by making a 1 pixel wide U-turn. You also could move from food to food and make
249sure you keep between your opponent and the food. So you can always reach it
250before your opponent.
251<li>While playing the game the Jukebox still can play music. For single player
252game use any music you like. For berzerk games with 2 players use hard rock and
253for 3 player games use heavy metal or X-Phobie
254(<a href="http://www.x-phobie.de">http://www.x-phobie.de</a>).
255<li>Play fair and don't kick your opponent on the big toe or poke him in the eye.
256That's wouldn't be bad manners.
257</ul>
258
259#include "foot.t"
diff --git a/www/manual/wps.t b/www/manual/wps.t
deleted file mode 100644
index 4ae73c8afc..0000000000
--- a/www/manual/wps.t
+++ /dev/null
@@ -1,78 +0,0 @@
1#define _PAGE_ Manual - While Playing Screen
2#include "head.t"
3#include "manual.t"
4<p>
5<img src="rec-wps.png">
6<br><small>Recorder screenshot</small>
7
8<p>
9The While Playing Screen shows info about what is currently played and can
10only be seen while there is actual music playback.
11
12<h2>Screen contents</h2>
13
14<p>
15The screen lines by default contain the following information:
16
17<h3>Recorder</h3>
18<ol>
19<li>Status bar: Battery level, charger status, volume, play mode, repeat mode, shuffle mode and clock
20<li>Scrolling path+filename of the current song.
21<li>The ID3 track name
22<li>The ID3 album name
23<li>The ID3 artist namn
24<li>Bit rate. VBR files display average bitrate and "(avg)".
25<li>Elapsed and total time
26<li>A slidebar progress meter representing where in the song you are
27<li>Peak meter
28</ol>
29
30<p>Notes:
31<li>The number of lines shown depends on the size of the font used.
32<li>The peak meter is normally only visible if you turn off the status bar.
33
34<h3>Player</h3>
35<ol>
36<li> Playlist index/Playlist size: Artist - Title
37<li> Current-time Progress-indicator Left
38</ol>
39
40<h2>Configuration</h2>
41
42<p>You can configure the WPS contents by creating a .wps file and "playing" it.
43The <a href="/docs/custom_wps_format.html">custom wps format</a> supports a wide variety of configurations.
44
45<h2>Button bindings</h2>
46
47<p>
48<table class=buttontable>
49<tr><th>Key</th><th>Function</th></tr>
50<tr><td nowrap> UP (r) <br>MENU + RIGHT (p)</td>
51<td> Increase volume </td></tr>
52<tr><td> DOWN (r) <br>MENU + LEFT (p)</td>
53<td> Decrease volume </td></tr>
54
55<tr><td> LEFT </td><td> Quick press = Go to beginning of track, or if
56pressed while in the first seconds of a track, go to previous track.<br>
57Hold = Rewind in track. </td></tr>
58
59<tr><td> RIGHT </td><td> Quick press = Go to next track. <br>
60Hold = Fast-forward in track. </td></tr>
61<tr><td> PLAY </td><td> Toggle play/pause.</td></tr>
62<tr><td>ON</td>
63<td> Quick press = Go to <a href="dir.html">dir browser</a> <br>
64(Recorder only:) Hold = Show pitch setting screen </td></tr>
65<tr><td>OFF (r) <br>STOP (p)</td><td> Stop playback </td></tr>
66<tr><td>F1 (r) <br>MENU (p)</td>
67<td> Go to <a href="menu.html">main menu</a></td></tr>
68<tr><td nowrap>F1 + DOWN (r) <br>MENU + DOWN (p)</td>
69<td> Key lock on/off </td></tr>
70<tr><td nowrap>F1 + PLAY (r) <br>MENU + PLAY (p)</td>
71<td> Mute on/off </td></tr>
72<tr><td nowrap>F1 + ON (r) <br>MENU + ON (p)</td>
73<td> Enter ID3 viewer </td></tr>
74<tr><td>F2 (r)</td><td>(Recorder only:) Show browse/play settings screen</td></tr>
75<tr><td>F3 (r)</td><td>(Recorder only:) Show display settings screen</td></tr>
76</table>
77
78#include "foot.t"
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-24 02:16:07 +0000