X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/8f9616f198b617214724183e32d598339c3bbbc4..566145652162e02433c1cd461bf9b5e312abbc40:/templates/help.html?ds=sidebyside diff --git a/templates/help.html b/templates/help.html index 37e0004..8e298ef 100644 --- a/templates/help.html +++ b/templates/help.html @@ -25,20 +25,21 @@ USA @include{topbar}@ -

@label{help.title}@

+

@label{help.title}@

- +

Introduction

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.

+ of these will be greyed out. The link for the currently active + screen is highlighted.

- +

Playing

@@ -47,26 +48,23 @@ USA being listed first.) Where possible, estimated start times are given.

-

Each track has a @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.

+

Each track has a @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.

-

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 disorder_config(5) for more - details.

+

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).

-

Artist and album names are hyperlinks to the relevant locations - in the Choose screen (see below).

+

Artist and album names are hyperlinks to the relevant locations + in the Choose screen (see below).

- +

Manage

@@ -121,13 +119,16 @@ USA alt="@label:playing.upall@"> and @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.

+ tail of the queue.

+ +

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.

- +

Recent

@@ -138,13 +139,14 @@ USA href="#prefs">Editing Preferences below.

The number of tracks remembered is controlled by the server - configuration. See the "history" option in disorder_config(5) for more - details.

+ configuration. See the history + option in disorder_config(5) for + more details.

- +

New

@@ -156,13 +158,14 @@ USA 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 noticed_history option in disorder_config(5) for more details.

- +

Choose

@@ -173,51 +176,61 @@ USA - - - - +
@label:choose.prefs@This button can be used to edit the details for a + This button can be used to edit the details for a track; see Editing Preferences below.
@label{choose.playall}@This button plays all the tracks in a directory, + @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 + href="@url@?action=choose">choose, which give you all the top-level directories at once, and choosealpha, + href="@url@?action=choosealpha">choosealpha, which breaks them down by initial letter.

+

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

+
- +

Editing Preferences

This screen, reached from Choose or Recent, is used to edit a track's preferences.

+ href="#recent">Recent, is used to edit a track's preferences. + Note that if you are not logged in, or your user has limited + rights, you may not be able to edit track preferences.

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 + edit artist, album and title fields for the track as displayed; or + to set the tags or weight for a track; or to enable or disable random play for the track.

Tags are separated by commas and can contain any other printing characters (including spaces). Leading and trailing spaces are not significant.

-

Random play for any given track is enabled by default, but you - can use this screen to disable it for undesirable tracks.

+

Weights determine how likely a track is to be picked at + random. Tracks with higher weights are more likely to be picked. + The default weight is 90000 and the maximum is 2147483647.

+ +

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.

- +

Search

@@ -228,14 +241,18 @@ USA

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.

+

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

@@ -257,7 +274,7 @@ USA
- +

Troubleshooting

@@ -267,29 +284,31 @@ USA -

The user the server runs as is determined by the user - directive in the configuration file. The README recommends using - jukebox for this purpose but it could be different - locally.

+

The user the server runs as is determined by the user directive in the configuration + file. The README recommends using jukebox for this purpose + but it could be different locally.

- +

Man Pages