aboutsummaryrefslogtreecommitdiff
path: root/docs/en
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2024-09-07 23:25:02 +0200
committerGravatar GitHub <noreply@github.com> 2024-09-07 23:25:02 +0200
commitaf37d88d859b4301018c4a0351574d485903bd32 (patch)
treed000f40dad8fa8b74c8767d83037b70e40dc00ec /docs/en
parentf7235bcb54e9f24e4de1f83d7428fa3ff970bb05 (diff)
Improved doc search (#6785)
* Improved doc search * <&">
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/users/10_filter.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/en/users/10_filter.md b/docs/en/users/10_filter.md
index 943537471..0aa9ed018 100644
--- a/docs/en/users/10_filter.md
+++ b/docs/en/users/10_filter.md
@@ -49,7 +49,7 @@ You can use the search field to further refine results:
* by author: `author:name` or `author:'composed name'`
* by title: `intitle:keyword` or `intitle:'composed keyword'`
* by URL: `inurl:keyword` or `inurl:'composed keyword'`
-* by tag: `#tag` or `#tag+with+whitespace` or or `#'tag with whitespace'`
+* by tag: `#tag` or `#tag+with+whitespace` or `#'tag with whitespace'`
* by free-text: `keyword` or `'composed keyword'`
* by date of discovery, using the [ISO 8601 time interval format](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals): `date:<date-interval>`
* From a specific day, or month, or year:
@@ -105,7 +105,8 @@ can be used to combine several search criteria with a logical *or* instead: `aut
You don’t have to do anything special to combine multiple negative operators. Writing `!intitle:'thing1' !intitle:'thing2'` implies AND, see above. For more pointers on how AND and OR interact with negation, see [this GitHub comment](https://github.com/FreshRSS/FreshRSS/issues/3236#issuecomment-891219460).
Additional reading: [De Morgan’s laws](https://en.wikipedia.org/wiki/De_Morgan%27s_laws).
-> ℹ️ Searches are applied to the raw HTML content
+> ℹ️ Searches are applied to the HTML content, and special XML characters `<&">` are automatically encoded (so one can search for `'A & B'` without having to encode the `&amp;`).
+> To search HTML tags, one must use regex searches (see below).
Finally, parentheses may be used to express more complex queries, with basic negation support:
@@ -123,7 +124,7 @@ Text searches (including `author:`, `intitle:`, `inurl:`, `#`) may use regular e
Regex searches are case-sensitive by default, but can be made case-insensitive with the `i` modifier like: `/Alice/i`
-Supports multiline mode with `m` modifier like: `/^Alice/m`
+Supports multiline mode with `m` modifier, like: `/^Alice/m`
> ℹ️ `author:` is working with one author per line, so the multiline mode may advantageously be used, like: `author:/^Alice Dupont$/im`
>
@@ -131,7 +132,9 @@ Supports multiline mode with `m` modifier like: `/^Alice/m`
Example to search entries, which title starts with the *Lol* word, with any number of *o*: `intitle:/^Lo+l/i`
-As opposed to normal searches, HTML special characters are not escaped in regex searches, to allow searching HTML code, like: `/Hello <span>world<\/span>/`
+As opposed to normal searches, special XML characters `<&">` are not escaped in regex searches, to allow searching HTML code, like: `/Hello <span>world<\/span>/`
+
+> ℹ️ A literal slash needs to be escaped, like `\/`
⚠️ Advanced regex syntax details depend on the regex engine used: