chiark / gitweb /
A new chapter with descriptions of the tabs
authorRichard Kettlewell <rjk@greenend.org.uk>
Thu, 26 Nov 2009 17:57:23 +0000 (17:57 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Thu, 26 Nov 2009 17:57:23 +0000 (17:57 +0000)
disobedience/manual/choose-search.png [new file with mode: 0644]
disobedience/manual/choose.png [new file with mode: 0644]
disobedience/manual/disobedience.css
disobedience/manual/index.html
disobedience/manual/intro.html
disobedience/manual/queue-menu.png [new file with mode: 0644]
disobedience/manual/recent.png [new file with mode: 0644]
disobedience/manual/tabs.html [new file with mode: 0644]
disobedience/manual/window.html

diff --git a/disobedience/manual/choose-search.png b/disobedience/manual/choose-search.png
new file mode 100644 (file)
index 0000000..bc28194
Binary files /dev/null and b/disobedience/manual/choose-search.png differ
diff --git a/disobedience/manual/choose.png b/disobedience/manual/choose.png
new file mode 100644 (file)
index 0000000..2f88ece
Binary files /dev/null and b/disobedience/manual/choose.png differ
index 605d81e..e28b881 100644 (file)
@@ -32,6 +32,10 @@ a {
   text-decoration: none
 }
 
+h2 a {
+  color: black
+}
+
 a:active {
   color: red
 }
index 6810c4e..6c9bc7e 100644 (file)
@@ -39,7 +39,15 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    <p><a href="window.html">2. Window Layout</a></p>
 
    <ul>
-     <li>What the various elements of the main window mean and do</li>
+     <li>A tour of the Disobedience window</li>
+   </ul>
+
+   <p><a href="tabs.html">3. Tabs</a></p>
+
+   <ul>
+     <li>Detailed descriptions of
+       the <b>Queue</b>, <b>Recent</b>, <b>Choose</b> and <b>Added</b>
+       tabs.</li>
    </ul>
 
  </body>
index 1230ec5..0603538 100644 (file)
@@ -34,7 +34,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
      <li>How to start Disobedience</li>
    </ul>
 
-   <h2>1.1 What is DisOrder?</h2>
+   <h2><a name=whatis>1.1 What is DisOrder?</a></h2>
 
    <p><a href="http://www.greenend.org.uk/rjk/disorder/">DisOrder</a>
    is a multi-user software jukebox.  It allows MP3s, OGGs, etc to be
@@ -75,7 +75,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    on the same computer as the server provided it can run X11
    applications.</p>
 
-   <h2>1.2 Getting DisOrder</h2>
+   <h2><a name=getting>1.2 Getting DisOrder</a></h2>
 
    <p>There are two ways to get DisOrder.</p>
 
@@ -114,7 +114,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    <p>There is no Windows support (although the web interface can be
    used from Windows computers).</p>
 
-   <h2>1.3 Getting a DisOrder login</h2>
+   <h2><a name=createloging>1.3 Getting a DisOrder login</a></h2>
 
    <p>The easiest way to get a DisOrder login is to access the web
    interface and set one up using that.  To do this,
@@ -144,7 +144,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    you want to take advantage of its more convenient design and extra
    features.</p>
 
-   <h2>1.4 Starting Disobedience</h2>
+   <h2><a name=starting>1.4 Starting Disobedience</a></h2>
 
    <p>On Debian systems it should be possible to find Disobedience in
    the menu system:</p>
@@ -162,7 +162,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    should <a href="http://code.google.com/p/disorder/issues/list">be
    reported</a>.)</p>
 
-   <h2>1.5 Initial Login</h2>
+   <h2><a name=login>1.5 Initial Login</a></h2>
 
    <p>The first time you run Disobedience it won't know what server to
    connect to, your username or your password, and will therefore
diff --git a/disobedience/manual/queue-menu.png b/disobedience/manual/queue-menu.png
new file mode 100644 (file)
index 0000000..af2dff9
Binary files /dev/null and b/disobedience/manual/queue-menu.png differ
diff --git a/disobedience/manual/recent.png b/disobedience/manual/recent.png
new file mode 100644 (file)
index 0000000..8ee5e68
Binary files /dev/null and b/disobedience/manual/recent.png differ
diff --git a/disobedience/manual/tabs.html b/disobedience/manual/tabs.html
new file mode 100644 (file)
index 0000000..7b7485c
--- /dev/null
@@ -0,0 +1,173 @@
+<!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: Tabs</title>
+   <link rel=stylesheet
+         type="text/css"
+         href="disobedience.css">
+ </head>
+ <body>
+   <h1>3. Tabs</h1>
+
+   <p>The chaper contains detailed descriptions of the Queue, Recent,
+   Choose and Added tabs.</p>
+
+   <h2><a name=queue>3.1 The Queue</a></h2>
+
+   <p>The <b>Queue</b> tab has already
+   been <a href="window.html#main">briefly described</a>, but there
+   are some more things to say about.  To start with, the meaning of
+   the columns:</p>
+
+   <table>
+     <tr>
+       <td><b>When</b></td>
+       <td>This is the server's estimate of when the track will start.
+       If play is disabled but the queue isn't empty, then it is based
+       on the assumption that play is about to be enabled.</td>
+     </tr>
+     <tr>
+       <td><b>Who</b></td>
+       <td>This is the person who selected the track.  If the track
+       was picked at random by the server it is empty.  You can
+       &ldquo;adopt&rdquo; a randomly picked track; see below.</td>
+     </tr>
+     <tr>
+       <td><b>Artist</b></td>
+       <td>The artist responsible for the track.  Like the other track
+       name columns, this depends on the server's logic for parsing
+       filename, so can be a bit wrong.  You can edit the track
+       properties to correct it.</td>
+     </tr>
+     <tr>
+       <td><b>Album</b></td>
+       <td>The album that the track came from.</td>
+     </tr>
+     <tr>
+       <td><b>Title</b></td>
+       <td>The title of the track.</td>
+     </tr>
+     <tr>
+       <td><b>Length</b></td>
+       <td>The length the track will play for.  For the playing track
+       this will include the amount of time it's been playing so
+       far.</td>
+     </tr>
+   </table>
+
+   <p>You can select tracks in the queue by clicking on them.  You can
+   select multiple tracks by clicking in a second location with SHIFT
+   depressed (to select all tracks between the first and second click)
+   or with CTRL depressed (to add a single track to the selection).</p>
+
+   <p>Having selected tracks you can drag them to a new location in
+   the queue.  Of course, you can't drag the playing track, nor can
+   you drag other tracks before it.</p>
+
+   <p>Right-clicking in the queue will create a pop-up menu:</p>
+
+   <p class=image><img src="queue-menu.png"></p>
+
+   <p><b>Track Properties</b> will create a window with editable
+   properties of each selected track.  <b>Scratch playing track</b>
+   only works if the playing track is the selected track and will stop
+   it playing.  <b>Remove track from queue</b> will remove the
+   selected (non-playing) tracks from the queue.</p>
+
+   <p><b>Adopt track</b> will apply your name to one without an entry
+   in the <b>Who</b> column, i.e. one that was randomly picked by the
+   server.  The reason you might do this is to signal to other users
+   that you did want this track to play.  (For instance, it might be
+   an accepted convention that randomly picked tracks were fair game
+   for removal but that tracks picked by a human should normally be
+   left alone.)</p>
+
+   <h2><a name=recent>3.2 Recently Played Tracks</a></h2>
+
+   <p class=image><img src="recent.png"></p>
+
+   <p>The <b>Recent</b> tab is similar in structure to the queue but
+   it shows tracks that have played recently.  The <b>When</b> column
+   indicates when the track played rather than when it will
+   played.</p>
+
+   <p>Right clicking will create a pop-up menu with similar options to
+   those found in the queue's equivalent menu.  The one additional
+   option is <b>Play track</b>, which allows a recently played track
+   to be added back to the queue.</p>
+
+   <p>The other way of adding tracks from this tab back to the queue
+   is to drag them to the queue tab and then to the desired point into
+   the queue.</p>
+
+   <h2><a name=choose>3.3 Choosing Tracks</a></h2>
+
+   <p>The <b>Choose</b> tab contains all the tracks known to the
+   server, organized into a hierarchical structure based on the
+   underlying file and directory structure.</p>
+
+   <p class=image><img src="choose.png"></p>
+
+   <p>The boxes in the <b>Queued</b> column are ticked if the track is
+   somewhere in the queue.  You can click on an unticked box to add
+   the track to the queue, but clicking an already-ticked one will
+   have no effect.</p>
+
+   <p>Directories can be expanded or collapsed by clicking on the
+   triangular signs left of their names.  Tracks can be selected and
+   deselected by clicking on them.  You can select multiple tracks by
+   clicking in a second location with SHIFT depressed (to select all
+   tracks between the first and second click) or with CTRL depressed
+   (to add a single track to the selection).</p>
+
+   <p>Right clicking will create a pop-up menu with what are hopefuly
+   now familiar options.  <b>Play track</b> will add the selected
+   track(s) to the queue and <b>Track Properties</b> will create a
+   window with editable properties of each selected track.</p>
+
+   <p>Note that when tracks are added to the queue these ways they
+   will be added before any tracks picked at random by the server, so
+   that users don't have to wait for them to play out.</p>
+
+   <p>Selected tracks can also be dragged to the queue, by dragging
+   first to the <b>Queue</b> tab itself and then to the desired
+   location in the queue.</p>
+
+   <p class=image><img src="choose-search.png"></p>
+
+   <p>To do a word search over all tracks, you can just start typing.
+   Your search terms will appear in the input box at the bottom of the
+   window.  Directories containing matching tracks are automatically
+   opened and the matches highlighted in yellow.  You can jump to the
+   previous or next search result with the up and down arrows at the
+   bottom right of the screen (or jump to the next one by pressing
+   CTRL+G).</p>
+
+   <p>To clear the search, press the <b>Cancel</b> button.</p>
+
+   <h2><a name=added>3.4 Newly Added Tracks</a></h2>
+
+   <p>The <b>Added</b> tab shows tracks that have been newly detected
+   by the server, in order to allow those tracks to be conveniently
+   played.  In behavior it is the same as the
+   recently <a href="#recent">played tracks list</a>.</p>
+
+ </body>
+</html>
index 92a6d5d..0282f6a 100644 (file)
@@ -26,12 +26,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  <body>
    <h1>2. Window Layout</h1>
 
-   <p>This chapter covers the following topics:</p>
+   <p>This chapter contains a tour of the main Disobedience
+   window.</p>
 
-   <ul>
-   </ul>
-
-   <h2>2.1 The Disobedience Window</h2>
+   <h2><a name=main>2.1 The Disobedience Window</a></h2>
    
    <p>Disobedience should look something like this when you've started
    it up and logged in:</p>
@@ -61,7 +59,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    <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>
+   <h2><a name=buttons>2.2 Buttons</a></h2>
 
    <p>The meaning of the buttons is as follows:</p>
 
@@ -119,7 +117,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    (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>
+   <h2><a name=menu>2.3 The Menu Bar</a></h2>
 
    <p class=image><img src="menu-server.png"></p>