diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 9fc5d710..05447521 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -987,9 +987,16 @@ fvwm Complex/advanced search - The advanced search dialog has a number of fields that - will allow a more refined search. Each entry field is - configurable for the following modes: + The advanced search dialog helps you build more complex + queries. It can be opened through the Tools + menu or through the main toolbar. + + The dialog has three parts: + + + The top part allows constructing a query by + combining multiple clauses of different types. + Each entry field is configurable for the following modes: All terms. @@ -1004,41 +1011,48 @@ fvwm Proximity (terms in any order within an adjustable window). - Filename search with wildcards. + Filename search. - Additional entry fields can be created by clicking the - Add clause button. + Additional entry fields can be created by clicking the + Add clause button. - You can choose that all relevant fields will be combined - by either an AND or an OR conjunction. All types of clauses - except "phrase" and "near" can accept a mix of single words and - phrases enclosed in double quotes. Stemming expansion will be - performed for all terms not beginning with a capital letter, - except for terms inside "phrase" clauses. Wildcards will be - processed everywhere. + When searching, the non-empty clauses will be + combined either with an AND or an OR conjunction, depending on + the choice made on the left (All clauses or + Any clause). - Advanced search will also let you search for documents of - specific mime types (ie: only text/plain, or - text/HTML or - application/pdf etc...). The state of the - file type selection can be saved as the default (the file type - filter will not be activated at program start-up, but the lists - will be in the restored state). + Entries of all types except "Phrase" and "Near" accept + a mix of single words and phrases enclosed in double quotes. + Stemming and wildcard expansion will be performed as for simple + search. + + + The next part allows filtering the + results by their mime types. + The state of the file type selection can be saved as + the default (the file type filter will not be activated at + program start-up, but the lists will be in the restored + state). + + + + The bottom part allows restricting the search results to a + sub-tree of the indexed area. If you need to do this often, + you may think of setting up multiple indexes instead, as the + performance will be much better. + + + - You can also restrict the search results - to a sub-tree of the indexed area. If you need to do this often, - you may think of setting up multiple indexes instead, as the - performance will be much better. Click on the Start Search button in - the advanced search dialog, or type Enter in - any text field to start the search. The button in - the main window always performs a simple search. - + the advanced search dialog, or type Enter in + any text field to start the search. The button in + the main window always performs a simple search. Click on the Show query details link at - the top of the result page to see the query expansion. + the top of the result page to see the query expansion. @@ -1242,32 +1256,42 @@ fvwm - Sorting search results + Sorting search results and collapsing duplicates The documents in a result list are normally sorted in - order of relevance. It is possible to specify different sort - parameters by using the Sort parameters - dialog (located in the Tools - menu). + order of relevance. It is possible to specify different sort + parameters by using the Sort parameters + dialog (located in the Tools menu). The tool sorts a specified number of the most - relevant documents in the result list, according to - specified criteria. The currently available criteria are - date and mime type. + relevant documents in the result list, according to specified + criteria. The currently available criteria are + date and mime + type. - The sort parameters stay in effect until they are explicitly - reset, or the program exits. An activated sort is indicated in - the result list header. + The sort parameters stay in effect until they are + explicitly reset, or the program exits. An activated sort is + indicated in the result list header. Sort parameters are remembered between program - invocations, but result sorting is normally always inactive when - the program starts. It is possible to keep the sorting - activation state between program invocations by checking the - Remember sort activation state - option in the preferences. + invocations, but result sorting is normally always inactive + when the program starts. It is possible to keep the sorting + activation state between program invocations by checking the + Remember sort activation state option in + the preferences. + + It is also possible to hide duplicate entries inside + the result list (documents with the exact same contents as the + displayed one). The test of identity is based on an MD5 hash + of the document container, not only of the text contents (so + that ie, a text document with an image added will not be a + duplicate of the text only). Duplicates hiding is controlled + by an entry in the Query configuration + dialog, and is off by default. + Search tips, shortcuts @@ -1424,6 +1448,11 @@ fvwm page: + Hide duplicate results: + decides if result list entries are shown for identical + documents found in different places. + + Highlight color for query terms: Terms from the user query are highlighted in the result