<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<!--
This file is part of DisOrder.
-Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
+Copyright (C) 2004-2008 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
<title>@label{help.title}@</title>
</head>
<body>
-@include{@label{menu}@}@
- <h1 class=title>@label{help.title}@</h1>
+@include{topbar}@
+ <h1>@label{help.title}@</h1>
- <h2 class=sidebarlink><a name=playing>Playing</a></h2>
+ <h2 class=helptitle>Introduction</h2>
+
+ <div class=helpsection>
+
+ <p>All screens in the DisOrder web interface have a set of
+ hyperlinks at the top. You can use these to visit the various
+ screens described below. Note that if you are not logged in some
+ of these will be greyed out. The link for the currently active
+ screen is highlighted.</p>
+
+ </div>
+
+ <h2 class=helptitle><a name=playing>Playing</a></h2>
<div class=helpsection>
being listed first.) Where possible, estimated start times are
given.</p>
- <p>Each track has a <img class=button
- src="@label:images.scratch@"
- title="@label:playing.scratch@"
- alt="@label:playing.scratch@"> button next to it. For the
- currently playing track this can be used to stop playing the
- track before it has finished. For a track in the queue it
- removes the track from the queue.</p>
+ <p>Each track has a <img class=button src="@image:scratch@"
+ title="@label:playing.scratch@" alt="@label:playing.scratch@">
+ button next to it. For the currently playing track this can be
+ used to stop playing the track before it has finished; this is
+ called “scratching”. For a track in the queue it
+ removes the track from the queue.</p>
- <p>Depending on the server configuration, you may be able to do
- this for any track, or only for tracks you submitted or that were
- randomly picked. See the "restrict" option in <a
- href="@url@?action=disorder_config.5">disorder_config(5)</a> for more
- details.</p>
+ <p>If you are not logged in, or if your user has limited rights,
+ you may only be able to scratch or remove certain tracks (for
+ instance, those you picked yourself).</p>
- <p>Artist and album names are hyperlinks to the relevant locations
- in the <a href="#choose">Choose</a> screen (see below).</p>
+
<p>Artist and album names are hyperlinks to the relevant locations
+
in the <a href="#choose">Choose</a> screen (see below).</p>
</div>
- <h2 class=
sidebarlink><a name=manage>Manage</a></h2>
+ <h2 class=
helptitle><a name=manage>Manage</a></h2>
<div class=helpsection>
<ul>
<li>Pause. This button can be used to pause playing (provided the
player supports it). <img width=16 height=16 class=imgbutton
- src="@label:images.enabled@"> indicates that playing is paused,
+ src="@image:enabled@"> indicates that playing is paused,
<img width=16 height=16 class=imgbutton
- src="@label:images.disabled@"> that it is not.</li>
+ src="@image:disabled@"> that it is not.</li>
<li>Enable/disable random play. If disabled then queued tracks
will still be played but if the queue is empty nothing will be
picked at random. <img width=16 height=16 class=imgbutton
- src="@label:images.enabled@"> indicates that random play is
+ src="@image:enabled@"> indicates that random play is
enabled, <img width=16 height=16 class=imgbutton
- src="@label:images.disabled@"> that it is disabled.</li>
+ src="@image:disabled@"> that it is disabled.</li>
<li>Enable/disable play. If disabled then tracks in the queue
will not be played, but will remain in the queue instead. <img
- width=16 height=16 class=imgbutton src="@label:images.enabled@">
+ width=16 height=16 class=imgbutton src="@image:enabled@">
indicates that play is enabled, <img width=16 height=16
- class=imgbutton src="@label:images.disabled@"> that it is
+ class=imgbutton src="@image:disabled@"> that it is
disabled.</li>
<li>Volume control. You can use the <img class=button
- src="@label:images.up@"
+ src="@image:up@"
title="@label:volume.increase@"
alt="@label:volume.increase@"> and <img
- src="@label:images.down@"
+ src="@image:down@"
title="@label:volume.reduce@"
alt="@label:volume.reduce@"> buttons to increase or
decrease the volume, or enter new volume settings for the left
<p>Below this is the same table of current and queued tracks as for
the main playing screen, but with extra buttons for managing the
queue.
- The <img class=button src="@label:images.up@"
+ The <img class=button src="@image:up@"
title="@label:playing.up@" alt="@label:playing.up@"> and <img
- src="@label:images.down@" title="@label:playing.down@"
+ src="@image:down@" title="@label:playing.down@"
alt="@label:playing.down@"> buttons on each track move that
track around in the queue. Similarly the <img class=button
- src="@label:images.upall@" title="@label:playing.upall@"
+ src="@image:upall@" title="@label:playing.upall@"
alt="@label:playing.upall@"> and <img
- src="@label:images.downall@" title="@label:playing.downall@"
+ src="@image:downall@" title="@label:playing.downall@"
alt="@label:playing.downall@"> buttons move each track to the head or
- tail of the queue.
- Depending on server configuration, it may be that only trusted
- users can move tracks around the queue.</p>
+ tail of the queue.</p>
+
+ <p>If you are not logged in, or if your user has limited rights,
+ you may only be able to move certain tracks (for instance, those
+ you picked yourself), and may not be able to adjust the volume,
+ random play setting, etc.</p>
</div>
- <h2 class=
sidebarlink><a name=recent>Recent</a></h2>
+ <h2 class=
helptitle><a name=recent>Recent</a></h2>
<div class=helpsection>
<p>This screen displays recently played tracks, most recent first.
- The <img class=button src="@label:images.edit@"
+ The <img class=button src="@image:edit@"
title="@label:choose.prefs@" alt="@label:choose.prefs@">
button can be used to edit the details for a track; see <a
href="#prefs">Editing Preferences</a> below.</p>
<p>The number of tracks remembered is controlled by the server
- configuration. See the "history" option in <a
- href="@url@?action=disorder_config.5">disorder_config(5)</a> for more
- details.</p>
+ configuration. See the <span class=configuration>history</span>
+ option in <a
+ href="@url@?action=disorder_config.5">disorder_config(5)</a> for
+ more details.</p>
</div>
- <h2 class=
sidebarlink><a name=new>New</a></h2>
+ <h2 class=
helptitle><a name=new>New</a></h2>
<div class=helpsection>
<p>This screen displays tracks recently added to the database,
most recent first. The <img class=button
- src="@label:images.edit@" title="@label:choose.prefs@"
+ src="@image:edit@" title="@label:choose.prefs@"
alt="@label:choose.prefs@"> button can be used to edit the details
for a track; see <a href="#prefs">Editing Preferences</a> below,
and clicking on the track title will add it to the queue.</p>
<p>The time tracks are remembered for is controlled by the server
- configuration. See the "noticed_history" option in <a
+ configuration. See the <span
+ class=configuration>noticed_history</span> option in <a
href="@url@?action=disorder_config.5">disorder_config(5)</a> for
more details.</p>
</div>
- <h2 class=
sidebarlink><a name=choose>Choose</a></h2>
+ <h2 class=
helptitle><a name=choose>Choose</a></h2>
<div class=helpsection>
<table class=helpbuttons>
<tbody>
<tr>
- <td
class=helpbuttons><img
- class=button src="@label:images.edit@"
+ <td><img
+ class=button src="@image:edit@"
title="@label:choose.prefs@"
alt="@label:choose.prefs@"></td>
- <td class=helpbuttons>This button can be used to edit the details for a
+ <td>This button can be used to edit the details for a
track; see <a href="#prefs">Editing Preferences</a> below.</td>
</tr>
<tr>
- <td class=helpbuttons><span class=button>@label{choose.playall}@</span></td>
- <td class=helpbuttons>This button plays all the tracks in a directory,
+ <td><span class=button>@label{choose.playall}@</span></td>
+ <td>This button plays all the tracks in a directory,
in order. This is used to efficiently play a whole album.</td>
</tr>
</tbody>
</table>
<p>This screen has two forms: <a
- href="@url@?action=choose&nonce=@nonce@">choose</a>, which give
+ href="@url@?action=choose">choose</a>, which give
you all the top-level directories at once, and <a
- href="@url@?action=choosealpha&nonce=@nonce@">choosealpha</a>,
+ href="@url@?action=choosealpha">choosealpha</a>,
which breaks them down by initial letter.</p>
+ <p>This screen will may not be available if you are not logged in
+ or if your user has limited rights.</p>
+
</div>
- <h2 class=
sidebarlink><a name=prefs>Editing Preferences</a></h2>
+ <h2 class=
helptitle><a name=prefs>Editing Preferences</a></h2>
<div class=helpsection>
<p>This screen, reached from <a href="#choose">Choose</a> or <a
href="#recent">Recent</a>, is used to edit a track's preferences.
- Preferences can be edited in two ways.</p>
+ Note that if you are not logged in, or your user has limited
+ rights, you may not be able to edit track preferences.</p>
- <p>At the top appear "cooked" preferences. These can be used to
+ <p>The form can be used to
edit artist, album and title fields for the track as displayed, or
to set the tags for a track, or to enable or disable random play
for the track.</p>
characters (including spaces). Leading and trailing spaces are
not significant.</p>
- <p>Random play for any given track is enabled by default, but you
- can use this screen to disable it for undesirable tracks.</p>
-
- <p>Below this are "raw" preferences, which allow individual
- database fields to be modified.</p>
-
- <p>To change an existing preference, edit its value and press its
- <span class=button>@label{prefs.set}@</span> button.</p>
-
- <p>To delete an existing preference, press its
- <span class=button>@label{prefs.delete}@</span> button.</p>
-
- <p>To add a new preference, enter its name and value in the box at the
- bottom and press the <span class=button>@label{prefs.new}@</span> button.
- If the preference exists already it will be overwritten.</p>
-
-
- <p>Preferences can have any name or value but certain names have special
- significance:</p>
-
- <table class=helpprefs>
- <tbody>
- <tr>
- <td class=helpprefs><span class=helppref>pick_at_random</span></td>
- <td class=helpprefs>If this preference is present and set to "0" then
- the track will not be picked for random play. Otherwise it may be.</td>
- </tr>
- <tr>
- <td class=helpprefs><span class=helppref>trackname_<span class=helpprefbit>context</span>_<span class=helpprefbit>part</span></span></td>
- <td class=helpprefs>These preferences can be used to override the
- filename parsing rules to find a track name part. <span
- class=helppref>trackname_<span class=helpprefbit>part</span></span> will
- be used if the full version is not present.</td>
- </tbody>
- </table>
-
- <p><span class=helpprefbit>context</span> can be anything but standard
- values are:</p>
-
- <table class=helpcontexts>
- <tbody>
- <tr>
- <td class=helpcontexts><span class=helpcontext>display</span></td>
- <td class=helpcontexts>Displayed in a web page</td>
- </tr>
- <tr>
- <td class=helpcontexts><span class=helpcontext>sort</span></td>
- <td class=helpcontexts>Used when sorting track names</td>
- </tr>
- </tbody>
- </table>
-
- <p><span class=helpprefbit>part</span> can be anything too but standard
- values are "artist", "album" and "title", with the obvious meanings.</p>
-
- <p>See also <a href="@url@?action=disorder.1">disorder(1)</a> and <a
- href="@url@?action=disorder_config.5">disorder_config(5)</a> for further
- details.</p>
+ <p>By default, any track can be picked for random play. The check
+ box at the bottom can be used to selectivel enable or disable it
+ for individual tracks.</p>
</div>
- <h2 class=sidebarlink>Search</h2>
+ <h2 class=helptitle>Search</h2>
<div class=helpsection>
<p>It is possible to limit results to tracks with a particular
tag, by using <b>tag:</b><i>TAG</i> among the search terms.</p>
- <p>Some keywords, known as "stopwords", are excluded from the search, and
- will never match. See the "stopword" option in <a
- href="@url@?action=disorder_config.5">disorder_config(5)</a> for further
- details about this.</p>
+ <p>Some keywords, known as “stopwords”, are excluded
+ from the search, and will never match. See the <span
+ class=configuration>stopword</span> option in <a
+ href="@url@?action=disorder_config.5">disorder_config(5)</a> for
+ further details about this.</p>
+
+ <p>This screen will may not be available if you are not logged in
+ or if your user has limited rights.</p>
</div>
- @if{@eq{@label:menu@}{sidebar}@}
- {
+ <h2 class=helptitle><a name=Login>Login</a></h2>
- <h2 class=sidebarlink>Volume</h2>
+ <div class=helpsection>
- <div class=helpsection>
+ <p>This screen has two different versions.</p>
- <p>This screen allows you to set the playback volume, if this is enabled in
- the server configuration. See the "channel" and "mixer" options in <a
- href="@url@?action=disorder_config.5">disorder_config(5)</a> for further
- details about this.</p>
+ <p><b>1</b>. When no user is logged in, it has a login form and a
+ registration form. If you do not have a username and password,
+ fill in and submit the registration form. You will be emailed an
+ email with a confirmation URL that you must visit. Only after
+ visiting this URL will your login become active.</p>
- </div>
+ <p>Once you have a username and password, you can use the login
+ form to authenticate yourself to the web interface. Note that this
+ is your primary DisOrder password, which (in old installations) may
+ differ from your original web password.</p>
- }{<!-- volume currently only linked in sidebar menu -->}@
+ <p><b>2</b>. When you are logged in, this screen instead has a form
+ to change your email address or password, and a logout button.</p>
+
+ </div>
- <h2 class=sidebarlink>Troubleshooting</h2>
+ <h2 class=helptitle>Troubleshooting</h2>
<div class=helpsection>
<ul>
<li>Are there any error messages in the system log? The server
- logs to <tt>LOG_DAEMON</tt>, which typically ends up in
- <i>/var/log/daemon.log</i> or <i>/var/log/messages</i>, though
- this depends on local configuration.
+ logs to <span class=configuration>LOG_DAEMON</span>, which
+ typically ends up in <i>/var/log/daemon.log</i> or
+ <i>/var/log/messages</i>, though this depends on local
+ configuration.
- <li>Is the track in a known format? Have a look at the
- configuration file for the formats recognized by the local
- installation. The filename matching is case-sensitive.
+ <li>Is the track in a known format? Out of the box, OGG, MP3,
+ FLAC and WAV are supported. You can look at the configuration
+ file for additional formats recognized by the local installation.
- <li>Do permissions on the track allow the server to read it?
+ <li>Do permissions on the track allow the server to read it? If
+ the server cannot read it then it will not be able to play it.
<li>Do the permissions on the containing directories allow the
server to read and execute them?
</ul>
- <p>The user the server runs as is determined by the <tt>user</tt>
- directive in the configuration file. The README recommends using
- <b>jukebox</b> for this purpose but it could be different
- locally.</p>
+ <p>The user the server runs as is determined by the <span
+ class=configuration>user</span> directive in the configuration
+ file. The README recommends using <b>jukebox</b> for this purpose
+ but it could be different locally.</p>
</div>
- <h2 class=sidebarlink>Man Pages</h2>
+ <h2 class=helptitle>Man Pages</h2>
<div class=helpsection>
</div>
-@include{@label{menu}@end}@
+@include{topbarend}@
</div>
</body>
</html>
~mdw / disorder / blobdiff