[disorder] / disobedience / manual / window.html

<!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 contains a tour of the main Disobedience
   window.</p>

   <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>

   <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 playing track is highlighted with a green backgroud.  It's 4
   minutes and 10 seconds long and so far, the first 21 seconds of it
   has played.</p>

   <h2><a name=buttons>2.2 Buttons</a></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.</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, which is enabled
	 when the button is depressed, 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.</td>
     </tr>

     <tr>
	 <td><img src="button-playing.png"></td>
	 <td>The playing button.  Normally this would always be left
	 enabled, i.e. with the button depressed.
         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.</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><a name=menu>2.3 The Menu Bar</a></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 user 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 <a href="properties.html">properties</a> of each selected
   track and the <b>Edit Playlists</b> option will create a window
   allowing editing of <a href="playlists.html">playlists</a>.</p>

   <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 exceptions are:</p>

   <ul>
     <li><b>Compact Mode</b> which switches Disobedience's window to a smaller format.</li>
     <li><b>Global Preferences</b> which allows global server settings to be modified.</li>
     <li><b>Activate Playlist</b> which allows you to play a <A href="playlists.html">playlist</a>.</li>
   </ul>

   <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>

   <hr>

   <a href="index.html">Back to contents</a>

 </body>
</html>
Commit	Line	Data
85c95b7f RK	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
d365231a RK	29	<p>This chapter contains a tour of the main Disobedience
d365231a RK	30	window.</p>
85c95b7f	31
d365231a	32	<h2><a name=main>2.1 The Disobedience Window</a></h2>
85c95b7f RK	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 (“3:04”).
	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
77ef4998 RK	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>
85c95b7f	62
d365231a	63	<h2><a name=buttons>2.2 Buttons</a></h2>
85c95b7f RK	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
1ff5c1b0	71	playing. When it is pressed the playing track is paused.</td>
85c95b7f RK	72	</tr>
	73
	74	<tr>
	75	<td><img src="button-scratch.png"></td>
	76	<td>The scratch button. As above this is only effective when
	77	a track is playing. Pressing it will stop that track playing
	78	and move onto the next one.</td>
	79	</tr>
	80
	81	<tr>
	82	<td><img src="button-random.png"></td>
1ff5c1b0 RK	83
	84	<td>The random play button. Random play, which is enabled
	85	when the button is depressed, means that if
85c95b7f RK	86	nothing is playing the server will automatically pick a track
	87	at random and play that. Furthermore it will ensure that the
	88	queue always has a minimum number of tracks, so you can see
1ff5c1b0	89	ahead of time what will play next.</td>
85c95b7f RK	90	</tr>
	91
	92	<tr>
	93	<td><img src="button-playing.png"></td>
	94	<td>The playing button. Normally this would always be left
1ff5c1b0 RK	95	enabled, i.e. with the button depressed.
1ff5c1b0 RK	96	If it is disabled then nothing will be
85c95b7f RK	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
1ff5c1b0	107	sound received over the network using your sound card.</td>
85c95b7f RK	108	</tr>
	109	</table>
	110
	111	<p>To the right of the buttons are two sliders:</p>
	112
	113	<p class=image><img src="volume-slider.png"></p>
	114
	115	<p>The left hand slider is the volume control. This ranges from 0
	116	(silent) to 10 (loudest). The right hand slider is the balance
	117	control, which ranges form -1.0 (left) to +1.0 (right).</p>
	118
d365231a	119	<h2><a name=menu>2.3 The Menu Bar</a></h2>
85c95b7f RK	120
	121	<p class=image><img src="menu-server.png"></p>
	122
	123	<p>The <b>Server</b> menu is loosely analogous to the <b>File</b>
	124	menu in othe applications. It has no file-related options though,
	125	so the name would not be appropriate! Instead the three options it
	126	has are <b>Login</b>, which brings back the login window shown the
	127	first time it is run, <b>Manage Users</b> which allows
	128	adminstrators to do user management, and <b>Quit</b>.</p>
	129
7ab62f66	130	<!-- TODO link to user management -->
85c95b7f RK	131
	132	<p class=image><img src="menu-edit.png"></p>
	133
	134	<p>The <b>Edit</b> menu has options to select or deselect all
	135	tracks. You can also do this with CTRL-A and CTRL-SHIFT-A, and of
	136	course you can select tracks in the queue (or other tabs) with the
	137	mouse.</p>
	138
	139	<p>The <b>Track Properties</b> option will create a window with
7ab62f66 RK	140	editable <a href="properties.html">properties</a> of each selected
	141	track and the <b>Edit Playlists</b> option will create a window
	142	allowing editing of <a href="playlists.html">playlists</a>.</p>
85c95b7f RK	143
	144	<p class=image><img src="menu-control.png"></p>
	145
	146	<p>The <b>Control</b> menu options are mostly equivalent to the
a80fe344 RK	147	buttons described above. The exceptions are:</p>
	148
	149	<ul>
	150	<li><b>Compact Mode</b> which switches Disobedience's window to a smaller format.</li>
	151	<li><b>Global Preferences</b> which allows global server settings to be modified.</li>
	152	<li><b>Activate Playlist</b> which allows you to play a <A href="playlists.html">playlist</a>.</li>
	153	</ul>
85c95b7f RK	154
	155	<p class=image><img src="menu-help.png"></p>
	156
	157	<p>The <b>Help</b> menu has an option to bring up the Disobedience
	158	manual and an <b>About</b> option which will display a bit of
	159	version information for the server and for Disobedience (which
	160	might not be the same).</p>
	161
f326f12d RK	162	<hr>
	163
	164	<a href="index.html">Back to contents</a>
	165
85c95b7f RK	166	</body>
85c95b7f RK	167	</html>