[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 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>
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
	29	<p>This chapter covers the following topics:</p>
	30
	31	<ul>
	32	</ul>
	33
	34	<h2>2.1 The Disobedience Window</h2>
	35
	36	<p>Disobedience should look something like this when you've started
	37	it up and logged in:</p>
	38
	39	<p class=image><img src="queue.png"></p>
	40
	41	<p>At the top is the menu bar, and immediately below it a toolbar
	42	with some buttons and a volume control. (In some cases the volume
	43	control may be absent.) Below that is a row of
	44	tabs: <b>Queue</b>, <b>Recent</b> and so on. The <b>Queue</b> tab
	45	is selected: this displays the currently playing track and the list
	46	of tracks that will play in the near future.</p>
	47
	48	<p>In this example nothing is actually playing. (Apart from the
	49	fact that you wouldn't hear anything) you can tell this because the
	50	top row only has a single length indicator (“3:04”).
	51	If it was playing it would show how far through the track it was
	52	too. Secondly, all the tracks were chosen at random. You can tell
	53	this because the <b>Who</b> column is empty.
	54
	55	<p>In the screenshot below both of these things have changed.
	56	Use <tt>rjk</tt> has selected some tracks and the first of them is
	57	playing.</p>
	58
	59	<p class=image><img src="queue2.png"></p>
	60
	61	<p>The first track is 4 minutes and 10 seconds long and so far, the
	62	first 21 seconds of it has played.</p>
	63
	64	<h2>2.2 Buttons</h2>
65
66	<p>The meaning of the buttons is as follows:</p>
67
68	<table>
69	<tr>
70	<td><img src="button-pause.png"></td>
71	<td>The pause button. This only effective when a track is
72	playing. When it is pressed the playing track is paused and
73	the button turns into a “play” icon instead.</td>
74	</tr>
75
76	<tr>
77	<td><img src="button-scratch.png"></td>
78	<td>The scratch button. As above this is only effective when
79	a track is playing. Pressing it will stop that track playing
80	and move onto the next one.</td>
81	</tr>
82
83	<tr>
84	<td><img src="button-random.png"></td>
85	<td>The random play button. Random play means that if
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
89	ahead of time what will play next.<br>
90	As shown, random play is disabled. The button goes green
91	when it is enabled.</td>
92	</tr>
93
94	<tr>
95	<td><img src="button-playing.png"></td>
96	<td>The playing button. Normally this would always be left
97	enabled (green). If it is disabled then nothing will be
98	played at all, regardless of whether it was randomly chosen
99	or picked by a human.</td>
100	</tr>
101
102	<tr>
103	<td><img src="button-rtp.png"></td>
104	<td>The network play button. This is only effective if the
105	server is playing over the network (as opposed to using a
106	local sound card). When network play is enabled,
107	Disobedience runs a client program on your computer to play
108	sound received over the network using your sound card.<br>
109	As shown, network play is disabled. The button goes green
110	when it is enabled.</td>
111	</tr>
112	</table>
113
114	<p>To the right of the buttons are two sliders:</p>
115
116	<p class=image><img src="volume-slider.png"></p>
117
118	<p>The left hand slider is the volume control. This ranges from 0
119	(silent) to 10 (loudest). The right hand slider is the balance
120	control, which ranges form -1.0 (left) to +1.0 (right).</p>
121
122	<h2>2.3 The Menu Bar</h2>
123
124	<p class=image><img src="menu-server.png"></p>
125
126	<p>The <b>Server</b> menu is loosely analogous to the <b>File</b>
127	menu in othe applications. It has no file-related options though,
128	so the name would not be appropriate! Instead the three options it
129	has are <b>Login</b>, which brings back the login window shown the
130	first time it is run, <b>Manage Users</b> which allows
131	adminstrators to do user management, and <b>Quit</b>.</p>
132
133	<!-- TODO link to use management -->
134
135	<p class=image><img src="menu-edit.png"></p>
136
137	<p>The <b>Edit</b> menu has options to select or deselect all
138	tracks. You can also do this with CTRL-A and CTRL-SHIFT-A, and of
139	course you can select tracks in the queue (or other tabs) with the
140	mouse.</p>
141
142	<p>The <b>Track Properties</b> option will create a window with
143	editable properties of each selected track and the <b>Edit
144	Playlists</b> option will create a window allowing editing of
145	playlists.</p>
146
147	<!-- TODO link to properties -->
148
149	<!-- TODO link to playlists -->
150
151	<p class=image><img src="menu-control.png"></p>
152
153	<p>The <b>Control</b> menu options are mostly equivalent to the
154	buttons described above. The one exception is <b>Activate
155	Playlist</b> which allows you to play a playlist.</p>
156
157	<!-- TODO link to playlists -->
158
159	<p class=image><img src="menu-help.png"></p>
160
161	<p>The <b>Help</b> menu has an option to bring up the Disobedience
162	manual and an <b>About</b> option which will display a bit of
163	version information for the server and for Disobedience (which
164	might not be the same).</p>
165
166	</body>
167	</html>