X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/8a9a4b7acdf393d17b90e625f8a4263153616f55..4a4c673c7705370b080f225d959293b845168a0c:/templates/help.html diff --git a/templates/help.html b/templates/help.html index 045d821..1b4cecc 100644 --- a/templates/help.html +++ b/templates/help.html @@ -27,6 +27,17 @@ USA @include{topbar}@

@label{help.title}@

+ + +
+ +

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.

+ +
+
@@ -190,10 +201,9 @@ USA

This screen, reached from Choose or Recent, is used to edit a track's preferences. - Preferences can be edited in two ways.

+ href="#recent">Recent, is used to edit a track's preferences.

-

At the top appear "cooked" preferences. These can be used to +

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.

@@ -205,62 +215,6 @@ USA

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

-

Below this are "raw" preferences, which allow individual - database fields to be modified.

- -

To change an existing preference, edit its value and press its - @label{prefs.set}@ button.

- -

To delete an existing preference, press its - @label{prefs.delete}@ button.

- -

To add a new preference, enter its name and value in the box at the - bottom and press the @label{prefs.new}@ button. - If the preference exists already it will be overwritten.

- - -

Preferences can have any name or value but certain names have special - significance:

- - - - - - - - - - - -
pick_at_randomIf this preference is present and set to "0" then - the track will not be picked for random play. Otherwise it may be.
trackname_context_partThese preferences can be used to override the - filename parsing rules to find a track name part. trackname_part will - be used if the full version is not present.
- -

context can be anything but standard - values are:

- - - - - - - - - - - - -
displayDisplayed in a web page
sortUsed when sorting track names
- -

part can be anything too but standard - values are "artist", "album" and "title", with the obvious meanings.

- -

See also disorder(1) and disorder_config(5) for further - details.

-
@@ -281,21 +235,27 @@ USA
- @if{@eq{@label:menu@}{sidebar}@} - { + - +
-
+

This screen has two different versions.

-

This screen allows you to set the playback volume, if this is enabled in - the server configuration. See the "channel" and "mixer" options in disorder_config(5) for further - details about this.

+

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

-
+

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.

- }{}@ +

2. When you are logged in, this screen instead has a form + to change your email address or password, and a logout button.

+ +