diff --git a/README.md b/README.md index 4c2e838..a9fb902 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,200 @@ of Ajax with views (powered by Solr), search blocks, facets, and search results. The module provides Boolean search, enables you to use AND, OR or NOT options to helps expanding or narrowing your search parameters. -![image](https://user-images.githubusercontent.com/7862086/216671865-6cfb7285-dfc1-4d76-8f3a-89e97adf02e1.png) + + + + + + + + + + + + + + + + + + + + + + + +
  +

Standard Query Parser

+		 +

The Extended DisMax (eDismax) Query Parser 

+
+

Use

+		 +

If  Edimax is turned off in configuration, the “Standard Query Parser” is used.

+		 +

Edismax is enabled by default, but can be turned off in configuration (/admin/config/search/advanced). 

+
+

Capacity

+		 +
    +
  • Search a content field
    • +
+		 +
    +
  • Search a content field
    • +
  • Search across all of the fields which are indexed to Solr in Search API configuration. 
    • +
+
+

Search

+		 +

Content indexed into a string field

+
    +
  • Search returns on an exact field match (case sensitive)
    • +
+
+

Content indexed into a full-text field

+
    +
  • Search returns on single words or phrases (words in order), and is case insensitive. 
    • +
+		 +

Content indexed into a string field

+
    +
  • Search returns on an exact field match (case sensitive)
    • +
+
+

Content indexed into a full-text field

+
    +
  • “Bounded” searches return exact phrase matches, replicating the standard query parser features.
    • +
  • Case insensitive
    • +
  • Support for word searching in any order.
    • +
  • Syntax for wildcards and other search features available (described in table below)
    • +
+
Use the following syntaxes (eDismax ONLY) to increase Search acuracy is provided below: -![image](https://user-images.githubusercontent.com/7862086/216650782-6ed65aad-2389-4e1e-b38f-e96d41278634.png) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Operator

+		 +

Usage

+		 +

Example

+
+

AND

+		 +

Narrow down your search to include results that contain both search terms

+		 +

orientation AND games

+
+

OR

+		 +

Broaden your search to include results that contain either search term

+		 +

students OR undergraduates

+
+

NOT

+		 +

Narrow your search by excluding certain words or phrases

+		 +

orientation NOT games

+
+

Asterisk (*)

+		 +

Replaces the asterisk with multiple characters. Use to search for multiple beginnings, middles, and endings of words.

+		 +

librar* 

+
+

will include results like:

+
    +
  • library
    • +
  • libraries
    • +
  • librarian
    • +
+
+

Question Mark (?)

+		 +

Replaces the question mark with a single character. Use to search for multiple beginnings, middles, and endings of words.

+		 +

?est

+
+

will include results like:

+
    +
  • Test
    • +
  • Pest
    • +
  • West
    • +
+
+

Will not include:

+
    +
  • Contest
    • +
+
+

Tilde (~)

+		 +

Use to make your search ‘fuzzy’ or search for synonyms and alternate spellings. 

+
+

Only works for Keyword search.

+		 +

Shaun~

+
+

will include results like:

+
    +
  • Shaun
    • +
  • Sean
    • +
  • Shawn
    • +
+
+

Quotation Marks (“”)

+		 +

Use quotation marks to search for a specific word or phrase.

+		 +

“alumni golf tournament”

+
+

 

## Requirements