[disorder] / disobedience / manual / tabs.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: 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>
Commit	Line	Data
d365231a 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: Tabs</title>
	22	<link rel=stylesheet
	23	type="text/css"
	24	href="disobedience.css">
	25	</head>
	26	<body>
	27	<h1>3. Tabs</h1>
	28
	29	<p>The chaper contains detailed descriptions of the Queue, Recent,
	30	Choose and Added tabs.</p>
	31
	32	<h2><a name=queue>3.1 The Queue</a></h2>
	33
	34	<p>The <b>Queue</b> tab has already
	35	been <a href="window.html#main">briefly described</a>, but there
	36	are some more things to say about. To start with, the meaning of
	37	the columns:</p>
	38
	39	<table>
	40	<tr>
	41	<td><b>When</b></td>
	42	<td>This is the server's estimate of when the track will start.
	43	If play is disabled but the queue isn't empty, then it is based
	44	on the assumption that play is about to be enabled.</td>
	45	</tr>
	46	<tr>
	47	<td><b>Who</b></td>
	48	<td>This is the person who selected the track. If the track
	49	was picked at random by the server it is empty. You can
	50	“adopt” a randomly picked track; see below.</td>
	51	</tr>
	52	<tr>
	53	<td><b>Artist</b></td>
	54	<td>The artist responsible for the track. Like the other track
	55	name columns, this depends on the server's logic for parsing
	56	filename, so can be a bit wrong. You can edit the track
	57	properties to correct it.</td>
	58	</tr>
	59	<tr>
	60	<td><b>Album</b></td>
	61	<td>The album that the track came from.</td>
	62	</tr>
	63	<tr>
	64	<td><b>Title</b></td>
65	<td>The title of the track.</td>
66	</tr>
67	<tr>
68	<td><b>Length</b></td>
69	<td>The length the track will play for. For the playing track
70	this will include the amount of time it's been playing so
71	far.</td>
72	</tr>
73	</table>
74
75	<p>You can select tracks in the queue by clicking on them. You can
76	select multiple tracks by clicking in a second location with SHIFT
77	depressed (to select all tracks between the first and second click)
78	or with CTRL depressed (to add a single track to the selection).</p>
79
80	<p>Having selected tracks you can drag them to a new location in
81	the queue. Of course, you can't drag the playing track, nor can
82	you drag other tracks before it.</p>
83
84	<p>Right-clicking in the queue will create a pop-up menu:</p>
85
86	<p class=image><img src="queue-menu.png"></p>
87
88	<p><b>Track Properties</b> will create a window with editable
89	properties of each selected track. <b>Scratch playing track</b>
90	only works if the playing track is the selected track and will stop
91	it playing. <b>Remove track from queue</b> will remove the
92	selected (non-playing) tracks from the queue.</p>
93
94	<p><b>Adopt track</b> will apply your name to one without an entry
95	in the <b>Who</b> column, i.e. one that was randomly picked by the
96	server. The reason you might do this is to signal to other users
97	that you did want this track to play. (For instance, it might be
98	an accepted convention that randomly picked tracks were fair game
99	for removal but that tracks picked by a human should normally be
100	left alone.)</p>
101
102	<h2><a name=recent>3.2 Recently Played Tracks</a></h2>
103
104	<p class=image><img src="recent.png"></p>
105
106	<p>The <b>Recent</b> tab is similar in structure to the queue but
107	it shows tracks that have played recently. The <b>When</b> column
108	indicates when the track played rather than when it will
109	played.</p>
110
111	<p>Right clicking will create a pop-up menu with similar options to
112	those found in the queue's equivalent menu. The one additional
113	option is <b>Play track</b>, which allows a recently played track
114	to be added back to the queue.</p>
115
116	<p>The other way of adding tracks from this tab back to the queue
117	is to drag them to the queue tab and then to the desired point into
118	the queue.</p>
119
120	<h2><a name=choose>3.3 Choosing Tracks</a></h2>
121
122	<p>The <b>Choose</b> tab contains all the tracks known to the
123	server, organized into a hierarchical structure based on the
124	underlying file and directory structure.</p>
125
126	<p class=image><img src="choose.png"></p>
127
128	<p>The boxes in the <b>Queued</b> column are ticked if the track is
129	somewhere in the queue. You can click on an unticked box to add
130	the track to the queue, but clicking an already-ticked one will
131	have no effect.</p>
132
133	<p>Directories can be expanded or collapsed by clicking on the
134	triangular signs left of their names. Tracks can be selected and
135	deselected by clicking on them. You can select multiple tracks by
136	clicking in a second location with SHIFT depressed (to select all
137	tracks between the first and second click) or with CTRL depressed
138	(to add a single track to the selection).</p>
139
140	<p>Right clicking will create a pop-up menu with what are hopefuly
141	now familiar options. <b>Play track</b> will add the selected
142	track(s) to the queue and <b>Track Properties</b> will create a
143	window with editable properties of each selected track.</p>
144
145	<p>Note that when tracks are added to the queue these ways they
146	will be added before any tracks picked at random by the server, so
147	that users don't have to wait for them to play out.</p>
148
149	<p>Selected tracks can also be dragged to the queue, by dragging
150	first to the <b>Queue</b> tab itself and then to the desired
151	location in the queue.</p>
152
153	<p class=image><img src="choose-search.png"></p>
154
155	<p>To do a word search over all tracks, you can just start typing.
156	Your search terms will appear in the input box at the bottom of the
157	window. Directories containing matching tracks are automatically
158	opened and the matches highlighted in yellow. You can jump to the
159	previous or next search result with the up and down arrows at the
160	bottom right of the screen (or jump to the next one by pressing
161	CTRL+G).</p>
162
163	<p>To clear the search, press the <b>Cancel</b> button.</p>
164
165	<h2><a name=added>3.4 Newly Added Tracks</a></h2>
166
167	<p>The <b>Added</b> tab shows tracks that have been newly detected
168	by the server, in order to allow those tracks to be conveniently
169	played. In behavior it is the same as the
170	recently <a href="#recent">played tracks list</a>.</p>
171
172	</body>
173	</html>