chiark / gitweb /
General-purpose event distribution interface
[disorder] / templates / help.tmpl
index 44d75b24d561072cec258b70c8ed918e154e42bf..5e8169ed3ccffa9ebd13d34e59a9ddfee93a9de3 100644 (file)
@@ -26,9 +26,9 @@ USA
 @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
@@ -38,9 +38,9 @@ USA
 
    </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
@@ -63,9 +63,9 @@ USA
 
    </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
@@ -127,9 +127,9 @@ USA
 
    </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}"
@@ -145,9 +145,9 @@ USA
 
    </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
@@ -164,14 +164,48 @@ USA
 
    </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>
@@ -189,21 +223,21 @@ USA
       </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 &ldquo;stopwords&rdquo;, 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.
@@ -229,34 +263,9 @@ USA
 
    </div>
 
-   <h2 class=helptitle>Search</h2>
-
-   
-   <div class=helpsection>
-
-     TODO  search is folded into choose now
-
-     <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 &ldquo;stopwords&rdquo;, 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>
 
@@ -276,9 +285,9 @@ USA
 
   </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>
@@ -310,9 +319,9 @@ USA
 
   </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> -
      configuration</p>