X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/daf0351f962a969c28bea01ed6b66453cccfe556..af4b13cae1f3755f6edef10c2d19a55b78018cb9:/templates/help.tmpl diff --git a/templates/help.tmpl b/templates/help.tmpl index 44d75b2..00c7e87 100644 --- a/templates/help.tmpl +++ b/templates/help.tmpl @@ -3,20 +3,18 @@ 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 . --> @@ -26,9 +24,9 @@ USA @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 @@ -38,9 +36,9 @@ 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 @@ -63,9 +61,9 @@ USA

-

Manage

+

Manage

-
+

This screen is almost identical to Playing except that it includes extra @@ -127,9 +125,9 @@ USA

-

Recent

+

Recent

-
+

This screen displays recently played tracks, most recent first. The -

New

+

New

-
+

This screen displays tracks recently added to the database, most recent first. The -

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:

+ @@ -189,21 +221,21 @@ USA
- -

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. @@ -227,36 +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

- - -
- - TODO search is folded into choose now - -

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.

@@ -276,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:

@@ -310,9 +321,9 @@ USA
-

Man Pages

+

Man Pages

-
+

disorder_config(5) - configuration

@@ -320,6 +331,9 @@ USA

disorder_templates(5) - template language

+

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

+

disorder(1) - command line client