diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml
index 8754c583..1b9a0c04 100644
--- a/src/doc/user/usermanual.sgml
+++ b/src/doc/user/usermanual.sgml
@@ -24,7 +24,7 @@
Dockes
- $Id: usermanual.sgml,v 1.64 2008-09-24 06:34:35 dockes Exp $
+ $Id: usermanual.sgml,v 1.65 2008-10-07 08:07:47 dockes Exp $
This document introduces full text search notions
@@ -834,8 +834,13 @@ fvwm
simple search entry when the search mode selector is set to
Query Language.
+ The language is roughly based on the
+ Xesam user search language specification.
+
Here follows a sample request that we are going to
explain:
+
author:"john doe" Beatles OR Lennon Live OR Unplugged -potatoes
@@ -851,6 +856,15 @@ fvwm
unplugged but not
potatoes (in any part of the document).
+ An element is composed of an optional field specification,
+ and a value, separated by a colon. Exemple:
+ Beatles,
+ author:balzac,
+ dc:title:grandet
+
+ The colon, if present, means "contains". Xesam defines other
+ relations, which are not supported for now.
+
All elements in the search entry are normally combined
with an implicit AND. It is possible to specify that elements be
OR'ed instead, as in Beatles
@@ -870,16 +884,17 @@ fvwm
word3. Do not enter explicit
parenthesis, they are not supported for now.
- An entry preceded by a - specifies a
- term that should not appear.
+ An element preceded by a - specifies a
+ term that should not appear. Pure negative
+ queries are forbidden.
- The first element in the above exemple,
- author:"john doe" is a phrase search limited
- to a specific field. Phrase searches are specified as usual by
- enclosing the words in double quotes. The field specification
- appears before the colon (of course this is not limited to
- phrases, author:Balzac would be ok
- too). &RCL; currently manages the following fields:
+ As usual, words inside quotes define a phrase
+ (the order of words is significant), so that
+ title:"prejudice pride" is not the same as
+ title:prejudice title:pride, and is
+ unlikely to find a result.
+
+ &RCL; currently manages the following default fields:
title,
subject or caption are
@@ -889,29 +904,32 @@ fvwm
author or
from for searching the documents originators.
+ recipient or
+ to for searching the documents recipients.
+
keyword for searching the
- document specified keywords (few documents actually have any).
+ document-specified keywords (few documents actually have any).
+
+ filename for the document's
+ file name.
+ ext specifies the file
+ name extension (Ex: ext:html)
- As of release 1.9, the filters have the possibility to
- create other fields with arbitrary names. No standard filters
- use this possibility yet.
-
- There are two other elements which may be specified
- through the field syntax, but are somewhat special:
+ The field syntax also supports a few field-like, but
+ special, criteria:
- ext for specifying the file
- name extension (Ex: ext:html)
-
- dir for specifying the file
- location (Ex:
+ dir for filtering the
+ results on file location (Ex:
dir:/home/me/somedir). Please note
that this is quite inefficient, that it may produce very
slow searches, and that it may be worth in some
cases to set up separate databases instead.
- mime for specifying the
+
+ mime or
+ format for specifying the
mime type. This one is quite special because you can specify
several values which will be OR'ed (the normal default for the
language is AND). Ex: mime:text/plain
@@ -920,19 +938,43 @@ fvwm
mime specification is not supported and
will produce strange results.
+
+ type or
+ rclcat for specifying the category (as in
+ text/media/presentation/etc.). The classification of mime
+ types in categories is defined in the &RCL; configuration
+ (mimeconf), and can be modified or
+ extended. The default category names are those which permit
+ filtering results in the main GUI screen. Categories are OR'ed
+ like mime types above.
+
+
+
+ The document filters used while indexing have the
+ possibility to create other fields with arbitrary names, and
+ aliases may be defined in the configuration, so that the exact
+ field search possibilities may be different for you if someone
+ took care of the customisation.
+
The query language is currently the only way to use the
&RCL; field search capability.
Words inside phrases and capitalized words are not
stem-expanded. Wildcards may be used anywhere inside a term.
Specifying a wild-card on the left of a term can produce a very
- slow search.
+ slow search (or even an incorrect one if the expansion is
+ truncated because of excessive size).
You can use the show query link at the
top of the result list to check the exact query which was
finally executed by Xapian.
+ Most Xesam phrase modifiers are unsupported, except for
+ l (small ell) to disable stemming, and
+ p to turn an phrase into a NEAR (unordered)
+ search. Exemple: "prejudice pride"p
+