Difference between revisions of "Search with Xapian Guide"

From EPrints Documentation
Jump to: navigation, search
m
m (formatting improved)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
If your repository has Xapian search enabled for "Simple Search" (e.g. http://example.eprints.org/cgi/search/simple).  Then you can make use of the Xapian search syntax to make more complex queries, which needing to use advanced search.  This may be useful if you have another website you wish to search your EPrints repository with a specific filter on the results returned (e.g. only results for a particular faculty of department).  Below is a guide to some of the syntax that can be used with Xapian-based search.
+
[[Category: Howto]]
 +
[[Category: Work in Progress]]
  
== AND ==
+
If your repository has Xapian search enabled for "Simple Search" (e.g. <nowiki>http://example.eprints.org/cgi/search/simple</nowiki>).  Then you can take advantage of some useful features to make more effective queries.  You should be able to tell whether you have Xapian search enabled by checking whether you have the option ''by relevance match'' in the list of ordering options.  This in itself can be useful, as it will rank results where the words you are searching for occur more frequently, which can be useful if the words are likely to match against a lot of items.
  
== OR ==
+
== Specific Phrases ==
 +
If you want to search for a specific phrase then ensure the whole phrase is within quote marks:
 +
"supply change management"
  
== NOT ==
+
== Some words but not others ==
 +
If you prepend the words you want to find with a <code>+</code> and the words you do not want to find with a <code>-</code>:
 +
+science -engineering +mathematics
  
== ANDs and ORs ==
+
== This word near another word ==
 +
If you put the phrase <code>NEAR</code> between the two words then it will find matches where the words have 10 or less words in between:
 +
science NEAR mathematics
 +
 
 +
If you want to find two words that are near or further apart then you can add <code>/''n''</code> (where ''n'' is a number of words between the two words):
 +
science NEAR/3 mathematics
 +
 +
science NEAR/15 mathematics
  
 
== More complex queries ==
 
== More complex queries ==
 +
You can ''combine'' the above three features in various ways:
 +
"supply change management" NEAR business
 +
 +
+"supply change management" -science
 +
 +
Xapian has a much more complex query syntax than this but this is not directly available for the simple search web interface (e.g. <nowiki>http://example.eprints.org/cgi/search/simple</nowiki>).  However, it would be possible to create a separate search interface (available through a web browser or directly over HTTP without a human-readable web interface) that would allow you do even more specific or complex searches as described at https://xapian.org/docs/queryparser.html.

Latest revision as of 14:38, 16 October 2019


If your repository has Xapian search enabled for "Simple Search" (e.g. http://example.eprints.org/cgi/search/simple). Then you can take advantage of some useful features to make more effective queries. You should be able to tell whether you have Xapian search enabled by checking whether you have the option by relevance match in the list of ordering options. This in itself can be useful, as it will rank results where the words you are searching for occur more frequently, which can be useful if the words are likely to match against a lot of items.

Specific Phrases

If you want to search for a specific phrase then ensure the whole phrase is within quote marks:

"supply change management"

Some words but not others

If you prepend the words you want to find with a + and the words you do not want to find with a -:

+science -engineering +mathematics

This word near another word

If you put the phrase NEAR between the two words then it will find matches where the words have 10 or less words in between:

science NEAR mathematics

If you want to find two words that are near or further apart then you can add /n (where n is a number of words between the two words):

science NEAR/3 mathematics

science NEAR/15 mathematics

More complex queries

You can combine the above three features in various ways:

"supply change management" NEAR business

+"supply change management" -science

Xapian has a much more complex query syntax than this but this is not directly available for the simple search web interface (e.g. http://example.eprints.org/cgi/search/simple). However, it would be possible to create a separate search interface (available through a web browser or directly over HTTP without a human-readable web interface) that would allow you do even more specific or complex searches as described at https://xapian.org/docs/queryparser.html.