chiark / gitweb /
Start a window layout chapter
authorRichard Kettlewell <rjk@greenend.org.uk>
Thu, 26 Nov 2009 15:43:58 +0000 (15:43 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Thu, 26 Nov 2009 15:43:58 +0000 (15:43 +0000)
16 files changed:
disobedience/manual/button-pause.png [new file with mode: 0644]
disobedience/manual/button-playing.png [new file with mode: 0644]
disobedience/manual/button-random.png [new file with mode: 0644]
disobedience/manual/button-rtp.png [new file with mode: 0644]
disobedience/manual/button-scratch.png [new file with mode: 0644]
disobedience/manual/disobedience.css
disobedience/manual/index.html
disobedience/manual/intro.html
disobedience/manual/menu-control.png [new file with mode: 0644]
disobedience/manual/menu-edit.png [new file with mode: 0644]
disobedience/manual/menu-help.png [new file with mode: 0644]
disobedience/manual/menu-server.png [new file with mode: 0644]
disobedience/manual/queue.png [new file with mode: 0644]
disobedience/manual/queue2.png [new file with mode: 0644]
disobedience/manual/volume-slider.png [new file with mode: 0644]
disobedience/manual/window.html [new file with mode: 0644]

diff --git a/disobedience/manual/button-pause.png b/disobedience/manual/button-pause.png
new file mode 100644 (file)
index 0000000..0aa2f57
Binary files /dev/null and b/disobedience/manual/button-pause.png differ
diff --git a/disobedience/manual/button-playing.png b/disobedience/manual/button-playing.png
new file mode 100644 (file)
index 0000000..dd64963
Binary files /dev/null and b/disobedience/manual/button-playing.png differ
diff --git a/disobedience/manual/button-random.png b/disobedience/manual/button-random.png
new file mode 100644 (file)
index 0000000..38f9783
Binary files /dev/null and b/disobedience/manual/button-random.png differ
diff --git a/disobedience/manual/button-rtp.png b/disobedience/manual/button-rtp.png
new file mode 100644 (file)
index 0000000..00fde8e
Binary files /dev/null and b/disobedience/manual/button-rtp.png differ
diff --git a/disobedience/manual/button-scratch.png b/disobedience/manual/button-scratch.png
new file mode 100644 (file)
index 0000000..e8a74f7
Binary files /dev/null and b/disobedience/manual/button-scratch.png differ
index 7a0f198..605d81e 100644 (file)
@@ -61,3 +61,16 @@ h2 {
   font-variant: normal;
   display: block
 }
+
+td {
+  vertical-align: top;
+  padding: 8px
+}
+
+table {
+  margin-left: 2em
+}
+
+p.image {
+  text-align: center
+}
index 34d476b..6810c4e 100644 (file)
@@ -36,5 +36,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
      <li>How to start Disobedience</li>
    </ul>
 
+   <p><a href="window.html">2. Window Layout</a></p>
+
+   <ul>
+     <li>What the various elements of the main window mean and do</li>
+   </ul>
+
  </body>
 </html>
index aeefe60..1230ec5 100644 (file)
@@ -61,7 +61,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    <p>This diagram shows an overview of one possible setup.</p>
 
-   <p align=middle><img src="arch-simple.png"></p>
+   <p class=image><img src="arch-simple.png"></p>
 
    <p>The server and web interface run on one computer.  Disobedience
    runs on a desktop computer and accesses the server via the network.
@@ -123,7 +123,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    installed.  You should then be able to select the <b>Login</b>
    option at the top of the screen.</p>
 
-   <p align=middle><img src="disorder-web-login.png"></p>
+   <p class=image><img src="disorder-web-login.png"></p>
 
    <p>Go to the <b>New Users</b> form and enter the username you want
    to use, your email address, and a password.  The password must be
@@ -131,7 +131,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    displayed on the screen).  When you press <b>Register</b>, you will
    be sent an email requiring you to confirm your registration.</p>
 
-   <p align=middle><img src="disorder-email-confirm.png"></p>
+   <p class=image><img src="disorder-email-confirm.png"></p>
 
    <p>Your login won't be active until you click on this URL.</p>
 
@@ -149,13 +149,13 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    <p>On Debian systems it should be possible to find Disobedience in
    the menu system:</p>
 
-   <p align=middle><img src="disobedience-debian-menu.png"></p>
+   <p class=image><img src="disobedience-debian-menu.png"></p>
 
    <p>On other systems you will have to start it from the command line
    by typing its name at a command prompt.  You can (optionally) use
    an <tt>&amp;</tt> suffix to stop it tying up your terminal.</p>
 
-   <p align=middle><img src="disobedience-terminal.png"></p>
+   <p class=image><img src="disobedience-terminal.png"></p>
 
    <p>(Please note that Disobedience shouldn't write any messages to
    the terminal.  If it does that probably indicates a bug, which
@@ -168,7 +168,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    connect to, your username or your password, and will therefore
    display a login box.</p>
 
-   <p align=middle><img src="login.png"></p>
+   <p class=image><img src="login.png"></p>
 
    <p>If Disobedience is running on a different computer to the
    server, then you should make sure the <b>Remote</b> box is ticked
diff --git a/disobedience/manual/menu-control.png b/disobedience/manual/menu-control.png
new file mode 100644 (file)
index 0000000..a76ec69
Binary files /dev/null and b/disobedience/manual/menu-control.png differ
diff --git a/disobedience/manual/menu-edit.png b/disobedience/manual/menu-edit.png
new file mode 100644 (file)
index 0000000..7cdb83b
Binary files /dev/null and b/disobedience/manual/menu-edit.png differ
diff --git a/disobedience/manual/menu-help.png b/disobedience/manual/menu-help.png
new file mode 100644 (file)
index 0000000..4ecc391
Binary files /dev/null and b/disobedience/manual/menu-help.png differ
diff --git a/disobedience/manual/menu-server.png b/disobedience/manual/menu-server.png
new file mode 100644 (file)
index 0000000..5502bf5
Binary files /dev/null and b/disobedience/manual/menu-server.png differ
diff --git a/disobedience/manual/queue.png b/disobedience/manual/queue.png
new file mode 100644 (file)
index 0000000..bced68f
Binary files /dev/null and b/disobedience/manual/queue.png differ
diff --git a/disobedience/manual/queue2.png b/disobedience/manual/queue2.png
new file mode 100644 (file)
index 0000000..536c253
Binary files /dev/null and b/disobedience/manual/queue2.png differ
diff --git a/disobedience/manual/volume-slider.png b/disobedience/manual/volume-slider.png
new file mode 100644 (file)
index 0000000..c7e25c5
Binary files /dev/null and b/disobedience/manual/volume-slider.png differ
diff --git a/disobedience/manual/window.html b/disobedience/manual/window.html
new file mode 100644 (file)
index 0000000..92a6d5d
--- /dev/null
@@ -0,0 +1,167 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<!--
+This file is part of DisOrder.
+Copyright (C) 2009 Richard Kettlewell
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+-->
+<html>
+ <head>
+   <title>Disobedience: Window Layout</title>
+   <link rel=stylesheet
+         type="text/css"
+         href="disobedience.css">
+ </head>
+ <body>
+   <h1>2. Window Layout</h1>
+
+   <p>This chapter covers the following topics:</p>
+
+   <ul>
+   </ul>
+
+   <h2>2.1 The Disobedience Window</h2>
+   
+   <p>Disobedience should look something like this when you've started
+   it up and logged in:</p>
+
+   <p class=image><img src="queue.png"></p>
+
+   <p>At the top is the menu bar, and immediately below it a toolbar
+   with some buttons and a volume control.  (In some cases the volume
+   control may be absent.)  Below that is a row of
+   tabs: <b>Queue</b>, <b>Recent</b> and so on.  The <b>Queue</b> tab
+   is selected: this displays the currently playing track and the list
+   of tracks that will play in the near future.</p>
+
+   <p>In this example nothing is actually playing.  (Apart from the
+   fact that you wouldn't hear anything) you can tell this because the
+   top row only has a single length indicator (&ldquo;3:04&rdquo;).
+   If it was playing it would show how far through the track it was
+   too.  Secondly, all the tracks were chosen at random.  You can tell
+   this because the <b>Who</b> column is empty.
+
+   <p>In the screenshot below both of these things have changed.
+   Use <tt>rjk</tt> has selected some tracks and the first of them is
+   playing.</p>
+
+   <p class=image><img src="queue2.png"></p>
+
+   <p>The first track is 4 minutes and 10 seconds long and so far, the
+   first 21 seconds of it has played.</p>
+
+   <h2>2.2 Buttons</h2>
+
+   <p>The meaning of the buttons is as follows:</p>
+
+   <table>
+     <tr>
+       <td><img src="button-pause.png"></td>
+       <td>The pause button.  This only effective when a track is
+       playing.  When it is pressed the playing track is paused and
+       the button turns into a &ldquo;play&rdquo; icon instead.</td>
+     </tr>
+
+     <tr>
+       <td><img src="button-scratch.png"></td>
+       <td>The scratch button.  As above this is only effective when
+       a track is playing.  Pressing it will stop that track playing
+       and move onto the next one.</td>
+     </tr>
+
+     <tr>
+        <td><img src="button-random.png"></td>
+        <td>The random play button.  Random play means that if
+        nothing is playing the server will automatically pick a track
+        at random and play that.  Furthermore it will ensure that the
+        queue always has a minimum number of tracks, so you can see
+        ahead of time what will play next.<br>
+        As shown, random play is disabled.  The button goes green
+        when it is enabled.</td>
+     </tr>
+
+     <tr>
+        <td><img src="button-playing.png"></td>
+        <td>The playing button.  Normally this would always be left
+        enabled (green).  If it is disabled then nothing will be
+        played at all, regardless of whether it was randomly chosen
+        or picked by a human.</td>
+     </tr>
+
+     <tr>
+        <td><img src="button-rtp.png"></td>
+        <td>The network play button.  This is only effective if the
+        server is playing over the network (as opposed to using a
+        local sound card).  When network play is enabled,
+        Disobedience runs a client program on your computer to play
+        sound received over the network using your sound card.<br>
+        As shown, network play is disabled.  The button goes green
+        when it is enabled.</td>
+     </tr>
+   </table>
+
+   <p>To the right of the buttons are two sliders:</p>
+
+   <p class=image><img src="volume-slider.png"></p>
+
+   <p>The left hand slider is the volume control.  This ranges from 0
+   (silent) to 10 (loudest).  The right hand slider is the balance
+   control, which ranges form -1.0 (left) to +1.0 (right).</p>
+
+   <h2>2.3 The Menu Bar</h2>
+
+   <p class=image><img src="menu-server.png"></p>
+
+   <p>The <b>Server</b> menu is loosely analogous to the <b>File</b>
+   menu in othe applications.  It has no file-related options though,
+   so the name would not be appropriate!  Instead the three options it
+   has are <b>Login</b>, which brings back the login window shown the
+   first time it is run, <b>Manage Users</b> which allows
+   adminstrators to do user management, and <b>Quit</b>.</p>
+
+   <!-- TODO link to use management -->
+
+   <p class=image><img src="menu-edit.png"></p>
+
+   <p>The <b>Edit</b> menu has options to select or deselect all
+   tracks.  You can also do this with CTRL-A and CTRL-SHIFT-A, and of
+   course you can select tracks in the queue (or other tabs) with the
+   mouse.</p>
+
+   <p>The <b>Track Properties</b> option will create a window with
+   editable properties of each selected track and the <b>Edit
+   Playlists</b> option will create a window allowing editing of
+   playlists.</p>
+
+   <!-- TODO link to properties -->
+
+   <!-- TODO link to playlists -->
+
+   <p class=image><img src="menu-control.png"></p>
+
+   <p>The <b>Control</b> menu options are mostly equivalent to the
+   buttons described above.  The one exception is <b>Activate
+   Playlist</b> which allows you to play a playlist.</p>
+
+   <!-- TODO link to playlists -->
+
+   <p class=image><img src="menu-help.png"></p>
+
+   <p>The <b>Help</b> menu has an option to bring up the Disobedience
+   manual and an <b>About</b> option which will display a bit of
+   version information for the server and for Disobedience (which
+   might not be the same).</p>
+
+ </body>
+</html>