Add mood methods {artist, title, album, comment}_matches.

[paraslash.git] / README.afs

diff --git a/README.afs b/README.afs
index ca01df6ac678a7cb3b1be14ac5957a1ddb1a4137..7889bda9d29d72b1804ba507b0c6fdc53bbed7ed 100644 (file)
--- a/README.afs
+++ b/README.afs
@@ -78,10 +78,10 @@ A mood consists of a unique name and its *mood definition*, which is
 a set of *mood lines* containing expressions in terms of attributes
 and other data contained in the database.
 
 a set of *mood lines* containing expressions in terms of attributes
 and other data contained in the database.
 

-A mood defines a subset of audio files called the *admissible audio
-files* for that mood. At any time, at most one mood can be *active*
-which means that para_server is going to select only files from that
-subset of admissible files.
+A mood defines a subset of audio files called the *admissible audio files*
+for that mood. At any time, at most one mood can be *active* which
+means that para_server is going to select only files from that subset
+of admissible files.

 
 So in order to create a mood definition one has to write a set of
 mood lines. Mood lines come in three flavours: Accept lines, deny
 
 So in order to create a mood definition one has to write a set of
 mood lines. Mood lines come in three flavours: Accept lines, deny


@@ -156,20 +156,30 @@ List of mood_methods
 Takes no arguments and matches an audio file if and only if no
 attributes are set.
 
 Takes no arguments and matches an audio file if and only if no
 attributes are set.
 

-       played_rarely
-
-Takes no arguments and matches all audio files where the number of
-times this audio file was selected is below the average.
-
-       is_set attribute_name
+       is_set <attribute_name>

 
 Takes the name of an attribute and matches iff that attribute is set.
 
 
 Takes the name of an attribute and matches iff that attribute is set.
 

-       path_matches pattern
+       path_matches <pattern>

 
 Takes a filename pattern and matches iff the path of the audio file
 matches the pattern.
 
 
 Takes a filename pattern and matches iff the path of the audio file
 matches the pattern.
 

+       artist_matches <pattern>
+       album_matches <pattern>
+       title_matches <pattern>
+       comment_matches <pattern>
+
+Takes an extended regular expression and matches iff the text of the
+corresponding tag of the audio file matches the pattern. If the tag
+is not set, the empty string is matched against the pattern.
+
+       year
+
+Takes a comparator ~ of the set {<, =, <=, >, >=, !=} and a number
+N. Matches iff the year tag Y of the audio file is a number that
+satisfies the condition Y ~ N. If the audio file has no year tag,
+or if the tag is not a number, the file does not match.

 
 ----------
 Mood usage
 
 ----------
 Mood usage