This file is part of DisOrder.
Copyright (C) 2004-2008 Richard Kettlewell
-This program is free software; you can redistribute it and/or modify
+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 2 of the License, or
+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.
+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, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-USA
+along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
<html>
<head>
-@include{stdhead}@
- <title>@label{help.title}@</title>
+@stdhead{help}
</head>
<body>
-@include{topbar}@
- <h1>@label{help.title}@</h1>
+@stdmenu{help}
+ <h1>@label{help.title}</h1>
- <h2 class=helptitle>Introduction</h2>
+ <h2 class=sectiontitle>Introduction</h2>
- <div class=helpsection>
+ <div class=section>
<p>All screens in the DisOrder web interface have a set of
hyperlinks at the top. You can use these to visit the various
</div>
- <h2 class=
helptitle><a name=playing>Playing</a></h2>
+ <h2 class=
sectiontitle><a name=playing>Playing</a></h2>
- <div class=helpsection>
+ <div class=section>
<p>This screen displays the currently playing track (if there is one) and
lists all the tracks in the queue (the track that will be played soonest
being listed first.) Where possible, estimated start times are
given.</p>
- <p>Each track has a <img class=button src="@image:scratch@"
- title="@label:playing.scratch@" alt="@label:playing.scratch@">
+ <p>Each track has a <img class=button src="@image{remove}"
+ title="@label{playing.remove}" alt="@label{playing.remove}">
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
</div>
- <h2 class=
helptitle><a name=manage>Manage</a></h2>
+ <h2 class=
sectiontitle><a name=manage>Manage</a></h2>
- <div class=helpsection>
+ <div class=section>
<p>This screen is almost identical to <a
href="#playing">Playing</a> except that it includes extra
<ul>
<li>Pause. This button can be used to pause playing (provided the
- player supports it). <img width=16 height=16 class=imgbutton
- src="@image:enabled@"> indicates that playing is paused,
- <img width=16 height=16 class=imgbutton
- src="@image:disabled@"> that it is not.</li>
+ player supports it). <img width=@width height=@height class=imgbutton
+ src="@image{enabled}"> indicates that playing is paused,
+ <img width=@width height=@height class=imgbutton
+ 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="@image:enabled@"> indicates that random play is
- enabled, <img width=16 height=16 class=imgbutton
- src="@image:disabled@"> that it is disabled.</li>
+ picked at random. <img width=@width height=@height class=imgbutton
+ src="@image{enabled}"> indicates that random play is
+ enabled, <img width=@width height=@height class=imgbutton
+ 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="@image:enabled@">
- indicates that play is enabled, <img width=16 height=16
- class=imgbutton src="@image:disabled@"> that it is
+ width=@width height=@height class=imgbutton src="@image{enabled}">
+ indicates that play is enabled, <img width=@width height=@height
+ class=imgbutton src="@image{disabled}"> that it is
disabled.</li>
<li>Volume control. You can use the <img class=button
- src="@image:up@"
- title="@label:volume.increase@"
- alt="@label
:volume.increase@"> and <img
- src="@image:down@"
- title="@label:volume.reduce@"
- alt="@label:volume.reduce@"> buttons to increase or
+ src="@image{up}"
+ title="@label{volume.up}"
+ alt="@label
{volume.up}"> and <img
+ src="@image{down}"
+ title="@label{volume.down}"
+ alt="@label{volume.down}"> buttons to increase or
decrease the volume, or enter new volume settings for the left
and/or right speakers.</li>
<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="@image:up@"
- title="@label
:playing.up@" alt="@label:playing.up@"> and <img
- src="@image:down@" title="@label:playing.down@"
- alt="@label:playing.down@"> buttons on each track move that
+ The <img class=button src="@image{up}"
+ title="@label
{playing.up}" alt="@label{playing.up}"> and <img
+ 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="@image:upall@" title="@label:playing.upall@"
- alt="@label
:playing.upall@"> and <img
- src="@image:downall@" title="@label:playing.downall@"
- alt="@label:playing.downall@"> buttons move each track to the head or
+ src="@image{upall}" title="@label{playing.upall}"
+ alt="@label
{playing.upall}"> and <img
+ src="@image{downall}" title="@label{playing.downall}"
+ alt="@label{playing.downall}"> buttons move each track to the head or
tail of the queue.</p>
<p>If you are not logged in, or if your user has limited rights,
</div>
- <h2 class=
helptitle><a name=recent>Recent</a></h2>
+ <h2 class=
sectiontitle><a name=recent>Recent</a></h2>
- <div class=helpsection>
+ <div class=section>
<p>This screen displays recently played tracks, most recent first.
- The <img class=button src="@image:edit@"
- title="@label:choose.prefs@" alt="@label:choose.prefs@">
+ 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 <span class=configuration>history</span>
option in <a
- href="@url@?action=disorder_config.5">disorder_config(5)</a> for
+ href="@url?action=disorder_config.5">disorder_config(5)</a> for
more details.</p>
</div>
- <h2 class=
helptitle><a name=new>New</a></h2>
+ <h2 class=
sectiontitle><a name=new>New</a></h2>
- <div class=helpsection>
+ <div class=section>
<p>This screen displays tracks recently added to the database,
most recent first. The <img class=button
- src="@image:edit@" title="@label:choose.prefs@"
- alt="@label:choose.prefs@"> button can be used to edit the details
+ 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 <span
class=configuration>noticed_history</span> option in <a
- href="@url@?action=disorder_config.5">disorder_config(5)</a> for
+ href="@url?action=disorder_config.5">disorder_config(5)</a> for
more details.</p>
</div>
- <h2 class=
helptitle><a name=choose>Choose</a></h2>
+ <h2 class=
sectiontitle><a name=choose>Choose</a></h2>
- <div class=helpsection>
+ <div class=section>
<p>This screen allows you to choose a track to be played, by navigating
- through the directory structure of the tracks filesystem. The following
- buttons appear:</p>
+ through the directory structure of the tracks filesystem.
+
+ @if{@eq{@label{menu.choosewhich}}{choosealpha}}
+ {
+
+ <p>At the top of the page is a list of first letters. Click on
+ any of these takes you to a list of directories starting with
+ that letter.</p>
+
+ <p>Below this is a search form. You can enter one or more
+ keywords here and select @label{search.search} and get a list of
+ tracks containing all those keywords. It is possible to limit
+ search results to tracks with a particular tag, by using
+ <b>tag:</b><i>TAG</i> among the search terms. Select
+ @label{search.clear} to clear the search results.</p>
+
+ <p>Initially the rest of the page is empty. However when you
+ have selected an initial letter, you will see a list of the
+ matching directories and files. Select a directory to enter it,
+ or a file to play it.
+
+ }
+ {
+
+ <p>At the top of the page is a search form. You can enter one or
+ more keywords here and select @label{search.search} and get a
+ list of tracks containing all those keywords. It is possible to
+ limit search results to tracks with a particular tag, by using
+ <b>tag:</b><i>TAG</i> among the search terms.</p>
+
+ <p>Below this appears a list of top-level files and directories.
+ Select a directory to enter it, or a file to play it.</p>
+
+ }
+ <p>The following icons will also appear:</p>
+
<table class=helpbuttons>
<tbody>
<tr>
<td><img
- class=button src="@image:edit@"
- title="@label:choose.prefs@"
- alt="@label:choose.prefs@"></td>
+ class=button src="@image{edit}"
+ title="@label{choose.prefs}"
+ alt="@label{choose.prefs}"></td>
<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><span class=button>@label{choose.playall}@</span></td>
+ <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">choose</a>, which give
-
you all the top-level directories at once, and <a
- href="@url@?action=choosealpha">choosealpha</a>,
- which breaks them down by initial letter.</p>
+
+ <p>NB. 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>
- <h2 class=
helptitle><a name=prefs>Editing Preferences</a></h2>
+ <h2 class=
sectiontitle><a name=prefs>Editing Preferences</a></h2>
- <div class=helpsection>
+ <div class=section>
<p>This screen, reached from <a href="#choose">Choose</a> or <a
href="#recent">Recent</a>, is used to edit a track's preferences.
box at the bottom can be used to selectivel enable or disable it
for individual tracks.</p>
+ <p>See <a
+ href="@url?action=disorder_preferences.5">disorder_preferences(5)</a>
+ for full documentation of track preferences.</p>
+
</div>
- <h2 class=helptitle>Search</h2>
-
- <div class=helpsection>
-
- <p>This screen allows you to search for keywords in track names. If you
- specify more than one keyword then only tracks containing all of them are
- listed. Results are grouped by artist, album and title.</p>
-
- <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 <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>
-
- <h2 class=helptitle><a name=Login>Login</a></h2>
+ <h2 class=sectiontitle><a name=Login>Login</a></h2>
- <div class=helpsection>
+ <div class=section>
<p>This screen has two different versions.</p>
</div>
- <h2 class=helptitle>Troubleshooting</h2>
+ <h2 class=sectiontitle>Troubleshooting</h2>
- <div class=helpsection>
+ <div class=section>
<p>If you cannot play a track, or it does not appear in the
database even after a rescan, check the following things:</p>
</div>
- <h2 class=helptitle>Man Pages</h2>
+ <h2 class=sectiontitle>Man Pages</h2>
- <div class=helpsection>
+ <div class=section>
- <p><a href="@url@?action=disorder_config.5">disorder_config(5)</a> -
+ <p><a href="@url?action=disorder_config.5">disorder_config(5)</a> -
configuration</p>
- <p><a href="@url@?action=disorder.1">disorder(1)</a> - command line
+ <p><a href="@url?action=disorder_templates.5">disorder_templates(5)</a> -
+ template language</p>
+
+ <p><a href="@url?action=disorder_preferences.5">disorder_preferences(5)</a> -
+ per-track and global preferences</p>
+
+ <p><a href="@url?action=disorder.1">disorder(1)</a> - command line
client</p>
- <p><a href="@url@?action=disobedience.1">disobedience(1)</a> - GTK+
+ <p><a href="@url?action=disobedience.1">disobedience(1)</a> - GTK+
client</p>
- <p><a href="@url@?action=disorderd.8">disorderd(8)</a> - server</p>
+ <p><a href="@url?action=disorderd.8">disorderd(8)</a> - server</p>
- <p><a href="@url@?action=disorder-dump.8">disorder-dump(8)</a> -
+ <p><a href="@url?action=disorder-dump.8">disorder-dump(8)</a> -
dump/restore preferences database</p>
- <p><a href="@url@?action=disorder.3">disorder(3)</a> - C API</p>
+ <p><a href="@url?action=disorder.3">disorder(3)</a> - C API</p>
- <p><a href="@url@?action=disorder_protocol.5">disorder_protocol(5)</a> -
+ <p><a href="@url?action=disorder_protocol.5">disorder_protocol(5)</a> -
DisOrder control protocol</p>
</div>
-@include{topbarend}@
+@credits
</div>
</body>
</html>
-@@
-<!--
+@discard{
Local variables:
mode:sgml
sgml-always-quote-attributes:nil
sgml-indent-step:1
sgml-indent-data:t
+indent-tabs-mode:nil
+fill-column:79
End:
--->
+}@#
~mdw / disorder / blobdiff