chiark / gitweb /
Update Disobedience manual for compact mode interface.
[disorder] / disobedience / manual / window.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <!--
3 This file is part of DisOrder.
4 Copyright (C) 2009 Richard Kettlewell
5
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 -->
19 <html>
20  <head>
21    <title>Disobedience: Window Layout</title>
22    <link rel=stylesheet
23          type="text/css"
24          href="disobedience.css">
25  </head>
26  <body>
27    <h1>2. Window Layout</h1>
28
29    <p>This chapter contains a tour of the main Disobedience
30    window.</p>
31
32    <h2><a name=main>2.1 The Disobedience Window</a></h2>
33    
34    <p>Disobedience should look something like this when you've started
35    it up and logged in:</p>
36
37    <p class=image><img src="queue.png"></p>
38
39    <p>At the top is the menu bar, and immediately below it a toolbar
40    with some buttons and a volume control.  (In some cases the volume
41    control may be absent.)  Below that is a row of
42    tabs: <b>Queue</b>, <b>Recent</b> and so on.  The <b>Queue</b> tab
43    is selected: this displays the currently playing track and the list
44    of tracks that will play in the near future.</p>
45
46    <p>In this example nothing is actually playing.  (Apart from the
47    fact that you wouldn't hear anything) you can tell this because the
48    top row only has a single length indicator (&ldquo;3:04&rdquo;).
49    If it was playing it would show how far through the track it was
50    too.  Secondly, all the tracks were chosen at random.  You can tell
51    this because the <b>Who</b> column is empty.
52
53    <p>In the screenshot below both of these things have changed.
54    Use <tt>rjk</tt> has selected some tracks and the first of them is
55    playing.</p>
56
57    <p class=image><img src="queue2.png"></p>
58
59    <p>The playing track is highlighted with a green backgroud.  It's 4
60    minutes and 10 seconds long and so far, the first 21 seconds of it
61    has played.</p>
62
63    <h2><a name=buttons>2.2 Buttons</a></h2>
64
65    <p>The meaning of the buttons is as follows:</p>
66
67    <table>
68      <tr>
69        <td><img src="button-pause.png"></td>
70        <td>The pause button.  This only effective when a track is
71        playing.  When it is pressed the playing track is paused and
72        the button turns into a &ldquo;play&rdquo; icon instead.</td>
73      </tr>
74
75      <tr>
76        <td><img src="button-scratch.png"></td>
77        <td>The scratch button.  As above this is only effective when
78        a track is playing.  Pressing it will stop that track playing
79        and move onto the next one.</td>
80      </tr>
81
82      <tr>
83          <td><img src="button-random.png"></td>
84          <td>The random play button.  Random play means that if
85          nothing is playing the server will automatically pick a track
86          at random and play that.  Furthermore it will ensure that the
87          queue always has a minimum number of tracks, so you can see
88          ahead of time what will play next.<br>
89          As shown, random play is disabled.  The button goes green
90          when it is enabled.</td>
91      </tr>
92
93      <tr>
94          <td><img src="button-playing.png"></td>
95          <td>The playing button.  Normally this would always be left
96          enabled (green).  If it is disabled then nothing will be
97          played at all, regardless of whether it was randomly chosen
98          or picked by a human.</td>
99      </tr>
100
101      <tr>
102          <td><img src="button-rtp.png"></td>
103          <td>The network play button.  This is only effective if the
104          server is playing over the network (as opposed to using a
105          local sound card).  When network play is enabled,
106          Disobedience runs a client program on your computer to play
107          sound received over the network using your sound card.<br>
108          As shown, network play is disabled.  The button goes green
109          when it is enabled.</td>
110      </tr>
111    </table>
112
113    <p>To the right of the buttons are two sliders:</p>
114
115    <p class=image><img src="volume-slider.png"></p>
116
117    <p>The left hand slider is the volume control.  This ranges from 0
118    (silent) to 10 (loudest).  The right hand slider is the balance
119    control, which ranges form -1.0 (left) to +1.0 (right).</p>
120
121    <h2><a name=menu>2.3 The Menu Bar</a></h2>
122
123    <p class=image><img src="menu-server.png"></p>
124
125    <p>The <b>Server</b> menu is loosely analogous to the <b>File</b>
126    menu in othe applications.  It has no file-related options though,
127    so the name would not be appropriate!  Instead the three options it
128    has are <b>Login</b>, which brings back the login window shown the
129    first time it is run, <b>Manage Users</b> which allows
130    adminstrators to do user management, and <b>Quit</b>.</p>
131
132    <!-- TODO link to user management -->
133
134    <p class=image><img src="menu-edit.png"></p>
135
136    <p>The <b>Edit</b> menu has options to select or deselect all
137    tracks.  You can also do this with CTRL-A and CTRL-SHIFT-A, and of
138    course you can select tracks in the queue (or other tabs) with the
139    mouse.</p>
140
141    <p>The <b>Track Properties</b> option will create a window with
142    editable <a href="properties.html">properties</a> of each selected
143    track and the <b>Edit Playlists</b> option will create a window
144    allowing editing of <a href="playlists.html">playlists</a>.</p>
145
146    <p class=image><img src="menu-control.png"></p>
147
148    <p>The <b>Control</b> menu options are mostly equivalent to the
149    buttons described above.  The exceptions is <b>Activate
150    Playlist</b> which allows you to play
151    a <A href="playlists.html">playlist</a>, and <b>Compact Mode</b>
152    which switches Disobedience's window to a smaller format.</p>
153
154    <p class=image><img src="menu-help.png"></p>
155
156    <p>The <b>Help</b> menu has an option to bring up the Disobedience
157    manual and an <b>About</b> option which will display a bit of
158    version information for the server and for Disobedience (which
159    might not be the same).</p>
160
161    <hr>
162
163    <a href="index.html">Back to contents</a>
164
165  </body>
166 </html>