chiark / gitweb /
Track properties
authorRichard Kettlewell <rjk@greenend.org.uk>
Thu, 26 Nov 2009 18:41:17 +0000 (18:41 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Thu, 26 Nov 2009 18:41:17 +0000 (18:41 +0000)
disobedience/manual/disobedience.css
disobedience/manual/index.html
disobedience/manual/intro.html
disobedience/manual/properties.html [new file with mode: 0644]
disobedience/manual/tabs.html
disobedience/manual/track-properties.png [new file with mode: 0644]

index e28b881..4c3392c 100644 (file)
@@ -36,6 +36,13 @@ h2 a {
   color: black
 }
 
+p.chapter a {
+  color: black;
+  font-family: helvetica,sans-serif;
+  font-weight: bold;
+  font-size: 18pt
+}
+
 a:active {
   color: red
 }
index 6c9bc7e..7e37478 100644 (file)
@@ -29,20 +29,20 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    <p>This is the manual for Disobedience, the graphical client
    for <a href="http://www.greenend.org.uk/rjk/disorder/">DisOrder</a>.</p>
 
-   <p><a href="intro.html">1. Introduction</a></p>
+   <p class=chapter><a href="intro.html">1. Introduction</a></p>
    <ul>
-     <li>What DisOrder and Disobedience are, and how to get them</li>
-     <li>How to get a DisOrder login</li>
-     <li>How to start Disobedience</li>
+     <li>What DisOrder and Disobedience are, and how to get them.</li>
+     <li>How to get a DisOrder login.</li>
+     <li>How to start Disobedience.</li>
    </ul>
 
-   <p><a href="window.html">2. Window Layout</a></p>
+   <p class=chapter><a href="window.html">2. Window Layout</a></p>
 
    <ul>
-     <li>A tour of the Disobedience window</li>
+     <li>A tour of the Disobedience window.</li>
    </ul>
 
-   <p><a href="tabs.html">3. Tabs</a></p>
+   <p class=chapter><a href="tabs.html">3. Tabs</a></p>
 
    <ul>
      <li>Detailed descriptions of
@@ -50,5 +50,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
        tabs.</li>
    </ul>
 
+   <p class=chapter><a href="properties.html">4. Track Properties</a></p>
+
+   <ul>
+     <li>How to edit track properties.</li>
+   </ul>
+
+   </ul>
  </body>
 </html>
index 0603538..86d247f 100644 (file)
@@ -185,8 +185,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    <p>Once you have logged in successfuly, Disobedience will remember
    these login settings, so it should not be necessary to enter them
    again.  If you need to change them for any reason, you can either
-   select the Server > Login option to bring the login window back, or
-   (if you prefer), edit the file <tt>~/.disorder/passwd</tt>
+   select the <b>Server > Login</b> option to bring the login window
+   back, or (if you prefer), edit the file <tt>~/.disorder/passwd</tt>
    directly.</p>
 
  </body>
diff --git a/disobedience/manual/properties.html b/disobedience/manual/properties.html
new file mode 100644 (file)
index 0000000..dc81890
--- /dev/null
@@ -0,0 +1,93 @@
+<!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: Track Properties</title>
+   <link rel=stylesheet
+         type="text/css"
+         href="disobedience.css">
+ </head>
+ <body>
+   <h1>4. Track Properties</h1>
+
+   <p>The chapter describes how to edit track properties.</p>
+
+   <p class=image><img src="track-properties.png"></p>
+
+   <p>This window can be invoked from any of the four tabs by
+   selecting one or more tracks and then either selected <b>Edit >
+   Track Properties</b> or via the right-click pop-up menu.</p>
+
+   <h2><a name=names>4.1 Track Name Parts</a></h2>
+
+   <p>The first three fields for each track are the parts of its name:
+   the artist, album and title.  These control what appear in the
+   similarly named columns in the queue and other tabs.  If they are
+   wrong then you can edit them here to correct them.</p>
+
+   <p>The double-headed arrow at the right of each field will copy the
+   current field value to all the other tracks in the window.  For
+   instance if an album name is mis-spelled or wrong then you could
+   follow the following procedure to correct it for all its
+   tracks:</p>
+
+   <ol>
+
+     <li>In the <b>Choose</b> tab, select all the tracks in the album.</li>
+
+     <li>Select <b>Edit > Track Properties</b> to bring up the track
+     properties window.</li>
+
+     <li>Edit the album name in the first track.</li>
+
+     <li>Click the arrow button to the right of the corrected version.</li>
+
+     <li>Click the <b>OK</b> button.</li>
+
+   </ol>
+
+   <h2><a name=tags>4.2 Tags</a></h2>
+
+   <p>Each track has an associated collection of tags.  These can used
+   when searching for tracks in the <b>Choose</b> tab or to control
+   which tracks are picked at random (although this functionality is
+   not readily available in current versions of Disobedience).</p>
+
+   <p>To add tags to a track enter the tags you want to apply to it in
+   the <b>Tags</b> field, separated by commas.  Tags cannot contain
+   commas and are compared without regard to whitespace.</p>
+
+   <h2><a name=weight>4.3 Track Weight</a></h2>
+
+   <p>Every track has an associated weight.  A higher weight makes the
+   track more likely to be picked at random and lower weight makes it
+   less likely to be picked at random.  (In the simplest case the
+   probability that it will be picked is equal to its weight divided
+   by the total weight of all tracks, although there are a number of
+   other factors that modify this.)</p>
+
+   <p>If no weight has been explicitly set then the track gets a
+   default weight of 90,000.</p>
+
+   <p>One way to prevent a track being picked at random would be to
+   set its weight to zero, but in fact there is a box you can untick
+   to suppress random selection of tracks too.</p>
+
+ </body>
+</html>
index 7b7485c..7c73c45 100644 (file)
@@ -26,7 +26,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  <body>
    <h1>3. Tabs</h1>
 
-   <p>The chaper contains detailed descriptions of the Queue, Recent,
+   <p>The chapter contains detailed descriptions of the Queue, Recent,
    Choose and Added tabs.</p>
 
    <h2><a name=queue>3.1 The Queue</a></h2>
@@ -160,6 +160,14 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
    bottom right of the screen (or jump to the next one by pressing
    CTRL+G).</p>
 
+   <p>If you enter more than one word at a time then only tracks which
+   match <i>both</i> words will be listed.</p>
+
+   <p>You can search for <a href="properties.html#tags">tags</a> as
+   well as words.  For instance to search for the tag
+   &ldquo;happy&rdquo; you would enter <tt>tag:happy</tt> in the
+   search box.</p>
+
    <p>To clear the search, press the <b>Cancel</b> button.</p>
 
    <h2><a name=added>3.4 Newly Added Tracks</a></h2>
diff --git a/disobedience/manual/track-properties.png b/disobedience/manual/track-properties.png
new file mode 100644 (file)
index 0000000..27093b8
Binary files /dev/null and b/disobedience/manual/track-properties.png differ