X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/9faa7a88b7419b2d6151ac2c3fa52261c876ee8d..1ce62256052854cdf87b90fb555a39eb6deea0f8:/templates/help.tmpl diff --git a/templates/help.tmpl b/templates/help.tmpl index 8e298ef..00c7e87 100644 --- a/templates/help.tmpl +++ b/templates/help.tmpl @@ -3,33 +3,30 @@ 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 . --> -@include{stdhead}@ - @label{help.title}@ +@stdhead{help} -@include{topbar}@ -

@label{help.title}@

+@stdmenu{help} +

@label{help.title}

-

Introduction

+

Introduction

-
+

All screens in the DisOrder web interface have a set of hyperlinks at the top. You can use these to visit the various @@ -39,17 +36,17 @@ USA

-

Playing

+

Playing

-
+

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.

-

Each track has a @label:playing.scratch@ +

Each track has a @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 @@ -64,9 +61,9 @@ USA

-

Manage

+

Manage

-
+

This screen is almost identical to Playing except that it includes extra @@ -76,32 +73,32 @@ USA

  • Pause. This button can be used to pause playing (provided the - player supports it). indicates that playing is paused, - that it is not.
    • + player supports it). indicates that playing is paused, + that it is not.
  • 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. indicates that random play is - enabled, that it is disabled.
    • + picked at random. indicates that random play is + enabled, that it is disabled.
  • Enable/disable play. If disabled then tracks in the queue will not be played, but will remain in the queue instead. - indicates that play is enabled, that it is + width=@width height=@height class=imgbutton src="@image{enabled}"> + indicates that play is enabled, that it is disabled.
  • Volume control. You can use the @label:volume.increase@ and @label:volume.reduce@ buttons to increase or + src="@image{up}" + title="@label{volume.up}" + alt="@label{volume.up}"> and @label{volume.down} buttons to increase or decrease the volume, or enter new volume settings for the left and/or right speakers.
    • @@ -110,15 +107,15 @@ USA

    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 @label:playing.up@ and @label:playing.down@ buttons on each track move that + The @label{playing.up} and @label{playing.down} buttons on each track move that track around in the queue. Similarly the @label:playing.upall@ and @label:playing.downall@ buttons move each track to the head or + src="@image{upall}" title="@label{playing.upall}" + alt="@label{playing.upall}"> and @label{playing.downall} buttons move each track to the head or tail of the queue.

    If you are not logged in, or if your user has limited rights, @@ -128,83 +125,117 @@ USA

-

Recent

+

Recent

-
+

This screen displays recently played tracks, most recent first. - The @label:choose.prefs@ + The @label{choose.prefs} button can be used to edit the details for a track; see Editing Preferences below.

The number of tracks remembered is controlled by the server configuration. See the history option in disorder_config(5) for + href="@url?action=disorder_config.5">disorder_config(5) for more details.

-

New

+

New

-
+

This screen displays tracks recently added to the database, most recent first. The @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 Editing Preferences below, and clicking on the track title will add it to the queue.

The time tracks are remembered for is controlled by the server configuration. See the noticed_history option in disorder_config(5) for + href="@url?action=disorder_config.5">disorder_config(5) for more details.

-

Choose

+

Choose

-
+

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:

+ through the directory structure of the tracks filesystem. + + @if{@eq{@label{menu.choosewhich}}{choosealpha}} + { + +

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.

+ +

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 + tag:TAG among the search terms. Select + @label{search.clear} to clear the search results.

+ +

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. + + } + { + +

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 + tag:TAG among the search terms.

+ +

Below this appears a list of top-level files and directories. + Select a directory to enter it, or a file to play it.

+ + } +

The following icons will also appear:

+ + class=button src="@image{edit}" + title="@label{choose.prefs}" + alt="@label{choose.prefs}"> - +
@label:choose.prefs@ This button can be used to edit the details for a track; see Editing Preferences below.
@label{choose.playall}@@label{choose.playall} This button plays all the tracks in a directory, in order. This is used to efficiently play a whole album.
- -

This screen has two forms: choose, which give - you all the top-level directories at once, and choosealpha, - which breaks them down by initial letter.

+ +

NB. Some keywords, known as “stopwords”, are + excluded from the search, and will never match. See the stopword option in disorder_config(5) for + further details about this.

This screen will may not be available if you are not logged in or if your user has limited rights.

-

Editing Preferences

+

Editing Preferences

-
+

This screen, reached from Choose or Recent, is used to edit a track's preferences. @@ -228,33 +259,15 @@ USA box at the bottom can be used to selectivel enable or disable it for individual tracks.

+

See disorder_preferences(5) + for full documentation of track preferences.

+
-

Search

- -
- -

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.

- -

It is possible to limit results to tracks with a particular - tag, by using tag:TAG among the search terms.

- -

Some keywords, known as “stopwords”, are excluded - from the search, and will never match. See the stopword option in disorder_config(5) for - further details about this.

- -

This screen will may not be available if you are not logged in - or if your user has limited rights.

- -
- -

Login

+

Login

-
+

This screen has two different versions.

@@ -274,9 +287,9 @@ USA
-

Troubleshooting

+

Troubleshooting

-
+

If you cannot play a track, or it does not appear in the database even after a rescan, check the following things:

@@ -308,41 +321,48 @@ USA
-

Man Pages

+

Man Pages

-
+
-

disorder_config(5) - +

disorder_config(5) - configuration

-

disorder(1) - command line +

disorder_templates(5) - + template language

+ +

disorder_preferences(5) - + per-track and global preferences

+ +

disorder(1) - command line client

-

disobedience(1) - GTK+ +

disobedience(1) - GTK+ client

-

disorderd(8) - server

+

disorderd(8) - server

-

disorder-dump(8) - +

disorder-dump(8) - dump/restore preferences database

-

disorder(3) - C API

+

disorder(3) - C API

-

disorder_protocol(5) - +

disorder_protocol(5) - DisOrder control protocol

-@include{topbarend}@ +@credits
-@@ - +}@#