chiark - git - mdw - disorder/blob - templates/help.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <!--
   3 This file is part of DisOrder.
   4 Copyright (C) 2004-2008 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 2 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, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 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, write to the Free Software
  18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19 USA
  20 -->
  21 <html>
  22  <head>
  23 @include{stdhead}@
  24   <title>@label{help.title}@</title>
  25  </head>
  26  <body>
  27 @include{topbar}@
  28    <h1 class=title>@label{help.title}@</h1>
  29
  30    <h2 class=helptitle>Introduction</h2>
  31
  32    <div class=helpsection>
  33
  34      <p>All screens in the DisOrder web interface have a set of
  35      hyperlinks at the top.  You can use these to visit the various
  36      screens described below.  Note that if you are not logged in some
  37      of these will be greyed out.  The link for the currently active
  38      screen is highlighted.</p>
  39
  40    </div>
  41
  42    <h2 class=helptitle><a name=playing>Playing</a></h2>
  43
  44    <div class=helpsection>
  45
  46     <p>This screen displays the currently playing track (if there is one) and
  47     lists all the tracks in the queue (the track that will be played soonest
  48     being listed first.)  Where possible, estimated start times are
  49     given.</p>
  50
  51     <p>Each track has a <img class=button src="@image:scratch@"
  52     title="@label:playing.scratch@" alt="@label:playing.scratch@">
  53     button next to it.  For the currently playing track this can be
  54     used to stop playing the track before it has finished; this is
  55     called &ldquo;scratching&rdquo;.  For a track in the queue it
  56     removes the track from the queue.</p>
  57
  58     <p>If you are not logged in, or if your user has limited rights,
  59     you may only be able to scratch or remove certain tracks (for
  60     instance, those you picked yourself).</p>
  61
  62     <p>Artist and album names are hyperlinks to the relevant locations
  63     in the <a href="#choose">Choose</a> screen (see below).</p>
  64
  65    </div>
  66
  67    <h2 class=helptitle><a name=manage>Manage</a></h2>
  68
  69    <div class=helpsection>
  70
  71     <p>This screen is almost identical to <a
  72     href="#playing">Playing</a> except that it includes extra
  73     management features.</p>
  74
  75    <p>At the top of the screen are the following controls:</p>
  76
  77    <ul>
  78     <li>Pause.  This button can be used to pause playing (provided the
  79     player supports it).  <img width=16 height=16 class=imgbutton
  80     src="@image:enabled@"> indicates that playing is paused,
  81     <img width=16 height=16 class=imgbutton
  82     src="@image:disabled@"> that it is not.</li>
  83
  84     <li>Enable/disable random play.  If disabled then queued tracks
  85     will still be played but if the queue is empty nothing will be
  86     picked at random.  <img width=16 height=16 class=imgbutton
  87     src="@image:enabled@"> indicates that random play is
  88     enabled, <img width=16 height=16 class=imgbutton
  89     src="@image:disabled@"> that it is disabled.</li>
  90
  91     <li>Enable/disable play.  If disabled then tracks in the queue
  92     will not be played, but will remain in the queue instead.  <img
  93     width=16 height=16 class=imgbutton src="@image:enabled@">
  94     indicates that play is enabled, <img width=16 height=16
  95     class=imgbutton src="@image:disabled@"> that it is
  96     disabled.</li>
  97
  98     <li>Volume control.  You can use the <img class=button
  99        src="@image:up@"
 100        title="@label:volume.increase@"
 101        alt="@label:volume.increase@"> and <img
 102        src="@image:down@"
 103        title="@label:volume.reduce@"
 104        alt="@label:volume.reduce@"> buttons to increase or
 105     decrease the volume, or enter new volume settings for the left
 106     and/or right speakers.</li>
 107
 108    </ul>
 109
 110    <p>Below this is the same table of current and queued tracks as for
 111     the main playing screen, but with extra buttons for managing the
 112     queue.
 113     The <img class=button src="@image:up@"
 114      title="@label:playing.up@" alt="@label:playing.up@"> and <img
 115      src="@image:down@" title="@label:playing.down@"
 116      alt="@label:playing.down@"> buttons on each track move that
 117     track around in the queue.  Similarly the <img class=button
 118      src="@image:upall@" title="@label:playing.upall@"
 119      alt="@label:playing.upall@"> and <img
 120      src="@image:downall@" title="@label:playing.downall@"
 121      alt="@label:playing.downall@"> buttons move each track to the head or
 122     tail of the queue.</p>
 123
 124     <p>If you are not logged in, or if your user has limited rights,
 125     you may only be able to move certain tracks (for instance, those
 126     you picked yourself), and may not be able to adjust the volume,
 127     random play setting, etc.</p>
 128
 129    </div>
 130
 131    <h2 class=helptitle><a name=recent>Recent</a></h2>
 132
 133    <div class=helpsection>
 134
 135     <p>This screen displays recently played tracks, most recent first.
 136     The <img class=button src="@image:edit@"
 137     title="@label:choose.prefs@" alt="@label:choose.prefs@">
 138     button can be used to edit the details for a track; see <a
 139     href="#prefs">Editing Preferences</a> below.</p>
 140
 141     <p>The number of tracks remembered is controlled by the server
 142     configuration.  See the <span class=configuration>history</span>
 143     option in <a
 144     href="@url@?action=disorder_config.5">disorder_config(5)</a> for
 145     more details.</p>
 146
 147    </div>
 148
 149    <h2 class=helptitle><a name=new>New</a></h2>
 150
 151    <div class=helpsection>
 152
 153     <p>This screen displays tracks recently added to the database,
 154     most recent first.  The <img class=button
 155     src="@image:edit@" title="@label:choose.prefs@"
 156     alt="@label:choose.prefs@"> button can be used to edit the details
 157     for a track; see <a href="#prefs">Editing Preferences</a> below,
 158     and clicking on the track title will add it to the queue.</p>
 159
 160     <p>The time tracks are remembered for is controlled by the server
 161     configuration.  See the <span
 162     class=configuration>noticed_history</span> option in <a
 163     href="@url@?action=disorder_config.5">disorder_config(5)</a> for
 164     more details.</p>
 165
 166    </div>
 167
 168    <h2 class=helptitle><a name=choose>Choose</a></h2>
 169
 170    <div class=helpsection>
 171
 172     <p>This screen allows you to choose a track to be played, by navigating
 173      through the directory structure of the tracks filesystem.  The following
 174      buttons appear:</p>
 175
 176     <table class=helpbuttons>
 177      <tbody>
 178       <tr>
 179        <td class=helpbuttons><img
 180        class=button src="@image:edit@"
 181        title="@label:choose.prefs@"
 182        alt="@label:choose.prefs@"></td>
 183        <td class=helpbuttons>This button can be used to edit the details for a
 184        track; see <a href="#prefs">Editing Preferences</a> below.</td>
 185       </tr>
 186       <tr>
 187        <td class=helpbuttons><span class=button>@label{choose.playall}@</span></td>
 188        <td class=helpbuttons>This button plays all the tracks in a directory,
 189        in order.  This is used to efficiently play a whole album.</td>
 190       </tr>
 191      </tbody>
 192     </table>
 193
 194     <p>This screen has two forms: <a
 195     href="@url@?action=choose">choose</a>, which give
 196     you all the top-level directories at once, and <a
 197     href="@url@?action=choosealpha">choosealpha</a>,
 198     which breaks them down by initial letter.</p>
 199
 200     <p>This screen will may not be available if you are not logged in
 201     or if your user has limited rights.</p>
 202
 203    </div>
 204
 205    <h2 class=helptitle><a name=prefs>Editing Preferences</a></h2>
 206
 207    <div class=helpsection>
 208
 209     <p>This screen, reached from <a href="#choose">Choose</a> or <a
 210     href="#recent">Recent</a>, is used to edit a track's preferences.
 211     Note that if you are not logged in, or your user has limited
 212     rights, you may not be able to edit track preferences.</p>
 213
 214     <p>The form can be used to
 215     edit artist, album and title fields for the track as displayed, or
 216     to set the tags for a track, or to enable or disable random play
 217     for the track.</p>
 218
 219     <p>Tags are separated by commas and can contain any other printing
 220     characters (including spaces).  Leading and trailing spaces are
 221     not significant.</p>
 222
 223     <p>By default, any track can be picked for random play.  The check
 224     box at the bottom can be used to selectivel enable or disable it
 225     for individual tracks.</p>
 226
 227    </div>
 228
 229    <h2 class=helptitle>Search</h2>
 230
 231    <div class=helpsection>
 232
 233     <p>This screen allows you to search for keywords in track names.  If you
 234     specify more than one keyword then only tracks containing all of them are
 235     listed.  Results are grouped by artist, album and title.</p>
 236
 237     <p>It is possible to limit results to tracks with a particular
 238     tag, by using <b>tag:</b><i>TAG</i> among the search terms.</p>
 239
 240     <p>Some keywords, known as &ldquo;stopwords&rdquo;, are excluded
 241     from the search, and will never match.  See the <span
 242     class=configuration>stopword</span> option in <a
 243     href="@url@?action=disorder_config.5">disorder_config(5)</a> for
 244     further details about this.</p>
 245
 246     <p>This screen will may not be available if you are not logged in
 247     or if your user has limited rights.</p>
 248
 249    </div>
 250
 251   <h2 class=helptitle><a name=Login>Login</a></h2>
 252
 253   <div class=helpsection>
 254
 255    <p>This screen has two different versions.</p>
 256
 257    <p><b>1</b>. When no user is logged in, it has a login form and a
 258    registration form.  If you do not have a username and password,
 259    fill in and submit the registration form.  You will be emailed an
 260    email with a confirmation URL that you must visit.  Only after
 261    visiting this URL will your login become active.</p>
 262
 263    <p>Once you have a username and password, you can use the login
 264    form to authenticate yourself to the web interface.  Note that this
 265    is your primary DisOrder password, which (in old installations) may
 266    differ from your original web password.</p>
 267
 268    <p><b>2</b>. When you are logged in, this screen instead has a form
 269    to change your email address or password, and a logout button.</p>
 270
 271   </div>
 272
 273   <h2 class=helptitle>Troubleshooting</h2>
 274
 275   <div class=helpsection>
 276
 277    <p>If you cannot play a track, or it does not appear in the
 278    database even after a rescan, check the following things:</p>
 279
 280    <ul>
 281
 282     <li>Are there any error messages in the system log?  The server
 283     logs to <span class=configuration>LOG_DAEMON</span>, which
 284     typically ends up in <i>/var/log/daemon.log</i> or
 285     <i>/var/log/messages</i>, though this depends on local
 286     configuration.
 287
 288     <li>Is the track in a known format?  Out of the box, OGG, MP3,
 289      FLAC and WAV are supported.  You can look at the configuration
 290      file for additional formats recognized by the local installation.
 291
 292     <li>Do permissions on the track allow the server to read it?  If
 293     the server cannot read it then it will not be able to play it.
 294
 295     <li>Do the permissions on the containing directories allow the
 296     server to read and execute them?
 297
 298    </ul>
 299
 300    <p>The user the server runs as is determined by the <span
 301    class=configuration>user</span> directive in the configuration
 302    file.  The README recommends using <b>jukebox</b> for this purpose
 303    but it could be different locally.</p>
 304
 305   </div>
 306
 307    <h2 class=helptitle>Man Pages</h2>
 308
 309    <div class=helpsection>
 310
 311     <p><a href="@url@?action=disorder_config.5">disorder_config(5)</a> -
 312      configuration</p>
 313
 314     <p><a href="@url@?action=disorder.1">disorder(1)</a> - command line
 315      client</p>
 316
 317     <p><a href="@url@?action=disobedience.1">disobedience(1)</a> - GTK+
 318      client</p>
 319
 320     <p><a href="@url@?action=disorderd.8">disorderd(8)</a> - server</p>
 321
 322     <p><a href="@url@?action=disorder-dump.8">disorder-dump(8)</a> -
 323      dump/restore preferences database</p>
 324
 325     <p><a href="@url@?action=disorder.3">disorder(3)</a> - C API</p>
 326
 327     <p><a href="@url@?action=disorder_protocol.5">disorder_protocol(5)</a> -
 328      DisOrder control protocol</p>
 329
 330    </div>
 331
 332 @include{topbarend}@
 333   </div>
 334  </body>
 335 </html>
 336 @@
 337 <!--
 338 Local variables:
 339 mode:sgml
 340 sgml-always-quote-attributes:nil
 341 sgml-indent-step:1
 342 sgml-indent-data:t
 343 End:
 344 -->