Commit a9261d75 authored by Mathias Goebel's avatar Mathias Goebel 🎠
Browse files

first draft for user documentation on serach function

parent f7f113ac
# Faceted search for users
This document is also related to:
* [index configuration](index-configuration.md)
* [faceted search technical documentation](faceted-search.md)
One of the key features of SADE is the faceted search functionality. It provides
a mechanism to search in the text documents and apply filter to search results.
## Search
SADE is prepared with a configured text index made for TEI documents. By default
you can find the search input filed in the to bar on every page. Simply type in
a term to query the TEI documents for.
Users can perform any search according to the [Lucene Syntax](https://lucene.apache.org/core/4_10_4/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description).
### Word
Searching for a single term will return the list of all documents containing the
term.
> Example: `search.html?q=Hase`
### Phrase
Use standard double quotation marks to enclose a phrase.
> Example: `search.html?q="Meister Lampe"`
### Wildcards
The search function is able to parse two types of wildcards (replacements of any characters):
* ? → a single character
* \* → zero ore more characters
Wildcards MUST NOT appear at the beginning of a term.
> Example: `search.html?q=berlin*`
### Fuzzy Search
With the help of the `~` operator the number of hits can be extended by words
that are variants of the search term.
> Example: `search.html?q=Hase~`
This function uses the [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance)
and can be specified by setting a number afterwards. Allowed values are `0, 1
or 2`, the default is 2.
> Example: `search.html?q=Hase~1`
### Range
If the `~` operator is applied to a phrase, the terms within the phrase are
allowed to be spread about a number of other words. This number MUST be specifed.
> Example: `search.html?q="Meister Lampe"~10`
## Facets
Facets are filters applied to a list of hits.
### Character Mappings and Synonyms
Some character replacements and synonym lists may be applied by the
configuration. Typical replacements are applied to German Umlauts and will map
„ä“ to “ae” and so on. This is also possible for complete words (synonyms).
Please have a look at the technical documentation to learn more about this
feature and how to configure these mappings.
A search request is performed on a stable URL. This means you can share the URL
pointing to your results with others, but the search will be performed on the
current data. The URL is stable, the hits might change.
## Facets
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
This document is also related to: This document is also related to:
* [index configuration](index-configuration.md) * [index configuration](index-configuration.md)
* [faceted search user documentation](faceted-search-usage.md)
## Configuration: basics ## Configuration: basics
As always the configuration is stored at `config.xml` in the application's root As always the configuration is stored at `config.xml` in the application's root
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment