New Search page with detailled explanations #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
supahgreg
reviewed
Nov 21, 2025
docs/Search.md
Outdated
| * ``label:Somelabel`` - articles that belong to a specified label | ||
| * ``tag:mytag`` - articles which have specified tag | ||
| * ``title:``, ``author:`` - self explanatory | ||
| <a id="text_keyword"></a>A keyword can be a **text keyword**. A text keyword is a single word such as `ocean`, or successive words enclosed in quotes such as `"pacific ocean"`. These keywords are searched using PostgreSQL [Full Text Search](#full_text_search) engine. This engine supports [word stemming](#word_stemming), and [logical operators](#logical_operators). |
Contributor
There was a problem hiding this comment.
- Please go with kebab case (e.g.
text-keyword) to match what "Just the Docs" generates for headlines. using PostgreSQL'sorusing the PostgreSQL- I understand the current wording was in use before this PR, but it seems like a good time to start tweaking things. I plan on manually reviewing the rest of the site's content at some point.
- There's at least one similar instance below.
docs/Search.md
Outdated
|
|
||
| A keyword starting with `-` (negative sign) is considered a negative match. The `-` can be applied before any type of keyword. For example `-unwanted`, `-"unwanted words"`, `-title:unwanted`, `-tag:"unwanted words"` or `-@yesterday`. | ||
|
|
||
| A logical `AND` operator is applied between keywords. For example `ocean "tree flower" note:true -title:"orange color"` searches for articles containing the word _ocean_ (with [stemming](#word_stemming)) AND the sentence _"tree flower"_ (with [stemming](#word_stemming)) AND a note AND a title not containing the string _"orange color"_. This _AND_ must not be written, it is applied by default. |
Contributor
There was a problem hiding this comment.
AND the sentence --> AND the phrase
docs/Search.md
Outdated
|
|
||
| Word stemming is powerful, but has one drawback: both languages of the feed and of the search query have to be well configured. Indeed, the word stemming process depends on the language: French and English words are not stemmed in the same way, so comparing them may lead to unexpected results. | ||
|
|
||
| On the Tiny Tiny RSS interface, there is a special language named _Simple_. Word stemming in the _Simple_ language is almost equivalent to exact string matching. With the _Simple_ language, only punctuation such as commas are removed. The power of word stemming is thus not applied, but it works well in usages with multiple languages. |
Contributor
There was a problem hiding this comment.
In Tiny Tiny RSS there is a special language named _Simple_.
docs/Search.md
Outdated
|
|
||
| {: warning } | ||
| > Due to current parser limitations, the handling of space is important: | ||
| > - Spaces are **compulsory around words enclosed in quotes** such as `"black sea"`, otherwise the parser does not detect the quotes. |
docs/Search.md
Outdated
| > - Spaces are **recommended around logical operators**, otherwise highlighting may not work correctly. | ||
| {: warning } | ||
| > Due to current parser limitations, when at least one operator is detected, Tiny Tiny RSS does not apply the default _AND_ operator. Tiny Tiny RSS expects the whole query to be well formatted. For example the query `one two` works because no operator is detected, so tt-rss adds the _AND_. However, `one two & three` fails because tt-rss detects the `&` operator, so expects the whole query to be well formatted, and does not add the missing `&` between the words `one` and `two`. |
Contributor
There was a problem hiding this comment.
when at least one operator is detected Tiny Tiny RSS does not- might be good to use
Tiny Tiny RSSfor consistency
docs/Search.md
Outdated
| > Due to current parser limitations, when at least one operator is detected, Tiny Tiny RSS does not apply the default _AND_ operator. Tiny Tiny RSS expects the whole query to be well formatted. For example the query `one two` works because no operator is detected, so tt-rss adds the _AND_. However, `one two & three` fails because tt-rss detects the `&` operator, so expects the whole query to be well formatted, and does not add the missing `&` between the words `one` and `two`. | ||
| {: .note } | ||
| > When a search query contains [name-value](#namevalue_keyword)/[date](#date_keyword) keywords and [text keywords](#text_keyword) using _logical operators_, it is recommended to write the [text keywords](#text_keyword) at the end (or the beginning), and to surround them with parenthesis. For example when reading `-title:submarine @yesterday ( pacific | atlantic )` one can easily understand that the parenthesis contains a complex fragment, that has to be well formatted with no missing operator. |
Contributor
There was a problem hiding this comment.
parenthesis-->parenthesesa complex fragment that has
docs/Search.md
Outdated
| > When a search query contains [name-value](#namevalue_keyword)/[date](#date_keyword) keywords and [text keywords](#text_keyword) using _logical operators_, it is recommended to write the [text keywords](#text_keyword) at the end (or the beginning), and to surround them with parenthesis. For example when reading `-title:submarine @yesterday ( pacific | atlantic )` one can easily understand that the parenthesis contains a complex fragment, that has to be well formatted with no missing operator. | ||
| {: .note } | ||
| > Due to current parser limitations, the `-` negation does not work before a parenthesis. It only works before a [text keyword](#text_keyword). When a parenthesis group needs to be negated, use the `!` operator. For example: `-title:submarine @yesterday ( ! ( pacific | atlantic ) )` |
Contributor
There was a problem hiding this comment.
does not work before a parenthesis (only before a [text keyword](#text_keyword)).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This new help page describes the various types of keywords, and known limitations.