initial user docs templates

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

9 files changed, 140 insertions, 0 deletions

diff --git a/www/manual/index.t b/www/manual/index.t
new file mode 100644
index 0000000..7a427c8
--- /dev/null
+++ b/www/manual/index.t
@@ -0,0 +1,4 @@
+
+Rockbox Users Manual
+
+<a href="rec-boot.html">Recorder</a> <a href="play-boot.html">Player</a>
diff --git a/www/manual/play-boot.t b/www/manual/play-boot.t
new file mode 100644
index 0000000..9c567c4
--- /dev/null
+++ b/www/manual/play-boot.t
@@ -0,0 +1,6 @@
+
+When Rockbox boots up, it'll display the text "Rockbox" for a short time, and
+then it'll jump right into the <a href="play-dir.html">dir browser</a> showing
+the root (toplevel) directory of your Archos.
+
+[screen dump of boot] [screen dump of toplevel dir]
diff --git a/www/manual/play-dir.t b/www/manual/play-dir.t
new file mode 100644
index 0000000..1eb0ebe
--- /dev/null
+++ b/www/manual/play-dir.t
@@ -0,0 +1,28 @@
+In the dir browser, you will see the files and directories that are put in the
+directory you are currently browsing.
+
+[screen dump]
+
+If you have enabled 'mp3/m3u filter' in the global settings, only files ending
+with .mp3 or .m3u will be displayed in the browser.
+
+Buttons:
+
+ -      Move upwards in the list, if it already is on the topmost entry, you'll
+        see the cursor moved to the last entry in the list.
+ +      Move downwards in the list, if it already is on the last entry, you'll
+        see the cursor moved to the first entry in the list.
+ STOP   Move "up" one directory level to the parent directory.
+ PLAY   If the cursor is now on a line of a directory, the browser will switch
+        into browsing that directory. If the cursor is on a line with a file,
+        special actions are peformed depending on the file type. If the file
+        is an mp3 file, it'll jump into the <a href="play-wps.html">WPS</a>
+        and start playing this file.
+        If the file is an m3u file (playlist), the list will first be loaded
+        and then pop up the WPS showing the first file that gets played from
+        the list. If you have 'shuffle' selected in the global settings, the
+        playlist will be shuffled directly after having been loaded, otherwise
+        it'll be played in a straight top-to-bottom fashion.
+ ON     If there is an mp3 playing, this'll switch back the
+        <a href="play-wps.html">WPS</a>.
+ MENU   Switches to the <a href="play-menu.html">main menu</a>.
diff --git a/www/manual/play-menu.t b/www/manual/play-menu.t
new file mode 100644
index 0000000..d18062a
--- /dev/null
+++ b/www/manual/play-menu.t
@@ -0,0 +1,13 @@
+The main menu offers:
+
+[screen dump]
+
+Sound Settings -
+
+General Settings -
+
+Info -
+
+Version -
+
+(Debug? -)
diff --git a/www/manual/play-wps.t b/www/manual/play-wps.t
new file mode 100644
index 0000000..4dea445
--- /dev/null
+++ b/www/manual/play-wps.t
@@ -0,0 +1,12 @@
+The While Playing Screen shows info about what is currently played and can
+only be seen while there is actual music playback.
+
+[screen dump]
+
+[explain screen info]
+
+ MENU+STOP Toggle key lock ON/OFF
+ PLAY   Toggle PAUSE/PLAY
+ ON     Switch to the <a href="rec-dir.html">dir browser</a>.
+ STOP   Stop playback
+ MENU   Switches to the <a href="rec-menu.html">main menu</a>.
diff --git a/www/manual/rec-boot.t b/www/manual/rec-boot.t
new file mode 100644
index 0000000..024d164
--- /dev/null
+++ b/www/manual/rec-boot.t
@@ -0,0 +1,6 @@
+
+When Rockbox boots up, it'll display the Rockbox logo for a short time, and
+then it'll jump right into the <a href="rec-dir.html">dir browser</a> showing
+the root (toplevel) directory of your Archos.
+
+[screen dump of boot] [screen dump of toplevel dir]
diff --git a/www/manual/rec-dir.t b/www/manual/rec-dir.t
new file mode 100644
index 0000000..ef8a2bb
--- /dev/null
+++ b/www/manual/rec-dir.t
@@ -0,0 +1,36 @@
+In the dir browser, you will see the files and directories that are put in the
+directory you are currently browsing. You will see tiny symbols on the left
+side of each entry that shows what kind of entry it is.
+
+[screen dump]
+
+[ ] = mp3 file
+
+[ ] = m3u file
+
+If you have enabled 'mp3/m3u filter' in the global settings, only files ending
+with .mp3 or .m3u will be displayed in the browser.
+
+Buttons:
+
+ UP     Move upwards in the list, if it already is on the topmost entry, you'll
+        see the cursor moved to the last entry in the list.
+ DOWN   Move downwards in the list, if it already is on the last entry, you'll
+        see the cursor moved to the first entry in the list.
+ LEFT   Move "up" one directory level to the parent directory.
+ RIGHT  If the cursor is now on a line of a directory, the browser will switch
+        into browsing that directory. If the cursor is on a line with a file,
+        special actions are peformed depending on the file type. If the file
+        is an mp3 file, it'll jump into the <a href="rec-wps.html">WPS</a> and
+        start playing this file.
+        If the file is an m3u file (playlist), the list will first be loaded
+        and then pop up the WPS showing the first file that gets played from
+        the list. If you have 'shuffle' selected in the global settings, the
+        playlist will be shuffled directly after having been loaded, otherwise
+        it'll be played in a straight top-to-bottom fashion.
+ PLAY   The same as RIGHT
+ ON     If there is an mp3 playing, this'll switch back the WPS.
+ OFF    If there is an mp3 playing, this stops playback.
+ F1     Switches to the <a href="rec-menu.html">main menu</a>.
+ F2
+ F3
diff --git a/www/manual/rec-menu.t b/www/manual/rec-menu.t
new file mode 100644
index 0000000..66d2542
--- /dev/null
+++ b/www/manual/rec-menu.t
@@ -0,0 +1,17 @@
+The main menu offers:
+
+[screen dump]
+
+Sound Settings -
+
+General Settings -
+
+Games -
+
+Screensavers -
+
+Info -
+
+Version -
+
+(Debug? -)
diff --git a/www/manual/rec-wps.t b/www/manual/rec-wps.t
new file mode 100644
index 0000000..9faac1a
--- /dev/null
+++ b/www/manual/rec-wps.t
@@ -0,0 +1,18 @@
+The While Playing Screen shows info about what is currently played and can
+only be seen while there is actual music playback.
+
+[screen dump]
+
+[explain screen info]
+
+ F1 + DOWN  Toggle key lock ON/OFF
+ UP     Increase volume
+ DOWN   Decrease volume
+ LEFT   Move to previous song
+ RIGHT  Move to next song
+ PLAY   Toggle PAUSE/PLAY
+ ON     Switch to the <a href="rec-dir.html">dir browser</a>.
+ OFF    Stop playback
+ F1     Switches to the <a href="rec-menu.html">main menu</a>.
+ F2
+ F3