Skip to content

Commit

Permalink
Add Quick Search documentation / help texts
Browse files Browse the repository at this point in the history
  • Loading branch information
bkis committed Sep 17, 2024
1 parent 00b7892 commit cf6259f
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Tekst-Web/translations/help/deDE/quickSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,19 @@
- `(` und `)` kennzeichnen den Vorrang von Suchoperatoren
- `~N` nach einem Wort für Editierdistanz (Unschärfe), wobei `N` eine Ziffer ist
- `~N` nach einer Phrase für den Wortabstand, wobei `N` eine Ziffer ist

## Einstellungen

### Texte
Legt fest, in welchen Texten gesucht wird.

### Alle Begriffe müssen vorkommen
Mit "_Alle Begriffe müssen vorkommen_" lässt sich bestimmen, wie einzelne Suchbegriffe logisch miteinander verknüpft sein sollen. Ist die Funktion aktiviert, werden ausschließlich Belegstellen mit Inhalten gefunden, in denen alle eingegebenen Suchbegriffe vorkommen. Andernfalls werden die Fundstellen mit den meisten Treffern einen höheren Rang in den Suchergebnissen erhalten, also solche mit weniger Treffern.

### Interpretiere Reguläre Ausdrücke
Die Schnellsuche kann Suchanfragen mit einem Regulären Ausdruck verarbeiten. Diese Funktion **deaktiviert die oben aufgelisteten Standard-Suchoperatoren**!

Der Ausdruck _muss_ in jedem Fall einem ganzen Term entsprechen – benutzen Sie also keine entsprechenden Anker (`^` am Anfang und `$` am Ende des Ausdrucks). Eine Übersicht über die verfügbare RegExp-Syntax ist in der [Dokumentation von Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html) zu finden.

### Berücksichtige Diakritika
Ist diese Funktion aktiviert, werden eingegebene oder fehlende (!) Diakritika bei der Suche berücksichtigt und nur Inhalte mit derselben Verwendung von Diakritika gefunden.
17 changes: 17 additions & 0 deletions Tekst-Web/translations/help/enUS/quickSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,20 @@
- `(` and `)` signify search operator precedence
- `~N` after a word signifies edit distance (fuzziness), where `N` is a digit
- `~N` after a phrase signifies slop amount, where `N` is a digit


## Settings

### Texts
Decides which texts are searched.

### All terms must occur
With “_All terms must occur_” you can decide how individual search terms should be logically linked to each other. If the function is activated, only locations with contents that contain hits for all the search terms entered will be found. Otherwise, the locations with the most hits will be given a higher rank in the search results than those with fewer hits.

### Interpret Regular Expressions
The Quick Search is capable of running search queries based on a Regular Expression. Switching this setting _on_ will **disable the standard search operators listed above**!

The expression _must_ match a whole term in any case, so don't use anchors (`^` at the beginning and `$` at the end of the expression). For an overview of the available RegExp syntax, please see [the Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html).

### Respect diacritics
If this function is activated, entered or missing (!) diacritics are taken into account in the search and only content with the same use of diacritics is found.
17 changes: 17 additions & 0 deletions docs/generated/help/quickSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,20 @@
- `(` and `)` signify search operator precedence
- `~N` after a word signifies edit distance (fuzziness), where `N` is a digit
- `~N` after a phrase signifies slop amount, where `N` is a digit


## Settings

### Texts
Decides which texts are searched.

### All terms must occur
With “_All terms must occur_” you can decide how individual search terms should be logically linked to each other. If the function is activated, only locations with contents that contain hits for all the search terms entered will be found. Otherwise, the locations with the most hits will be given a higher rank in the search results than those with fewer hits.

### Interpret Regular Expressions
The Quick Search is capable of running search queries based on a Regular Expression. Switching this setting _on_ will **disable the standard search operators listed above**!

The expression _must_ match a whole term in any case, so don't use anchors (`^` at the beginning and `$` at the end of the expression). For an overview of the available RegExp syntax, please see [the Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html).

### Respect diacritics
If this function is activated, entered or missing (!) diacritics are taken into account in the search and only content with the same use of diacritics is found.

0 comments on commit cf6259f

Please sign in to comment.