From af37d88d859b4301018c4a0351574d485903bd32 Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Sat, 7 Sep 2024 23:25:02 +0200 Subject: Improved doc search (#6785) * Improved doc search * <&"> --- docs/en/users/10_filter.md | 11 +++++++---- docs/fr/users/03_Main_view.md | 9 ++++++--- 2 files changed, 13 insertions(+), 7 deletions(-) (limited to 'docs') 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:` * 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 `&`). +> 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 world<\/span>/` +As opposed to normal searches, special XML characters `<&">` are not escaped in regex searches, to allow searching HTML code, like: `/Hello world<\/span>/` + +> ℹ️ A literal slash needs to be escaped, like `\/` ⚠️ Advanced regex syntax details depend on the regex engine used: diff --git a/docs/fr/users/03_Main_view.md b/docs/fr/users/03_Main_view.md index 2af7a86b5..8274d0b79 100644 --- a/docs/fr/users/03_Main_view.md +++ b/docs/fr/users/03_Main_view.md @@ -149,7 +149,7 @@ disponible dans le menu du flux. Avec le nombre croissant d’articles stockés par FreshRSS, il devient important d’avoir des filtres efficaces pour n’afficher qu’une partie des articles. Il existe plusieurs méthodes qui filtrent selon des critères -différents. Ces méthodes peuvent être combinées dans la plus part des cas. +différents. Ces méthodes peuvent être combinées dans la plupart des cas. ### Par catégorie @@ -264,7 +264,8 @@ encore plus précis, et il est autorisé d’avoir plusieurs instances de : Combiner plusieurs critères implique un *et* logique, mais le mot clef `OR` peut être utilisé pour combiner plusieurs critères avec un *ou* logique : `author:Dupont OR author:Dupond` -> ℹ️ Les recherches sont effectuées sur le code HTML brut +> ℹ️ Les recherches sont effectuées sur le code HTML, et les caractères XML spéciaux `<&">` sont automatiquement encodés (donc on peut chercher `'A & B'` sans avoir à encoder le `&`). +> Pour chercher des tags HTML, il faut utiliser les recherches regex (voir ci-dessous). Enfin, les parenthèses peuvent être utilisées pour des expressions plus complexes, avec un support basique de la négation : @@ -290,7 +291,9 @@ Le mode multilignes peut être activé avec l’option de recherche `m` comme : Exemple pour rechercher des articles dont le titre commence par le mot *Lol* avec un nombre indéterminé de *o*: `intitle:/^Lo+l/i` -Contrairement aux recherches normales, les caractères spéciaux HTML ne sont pas encodés dans les recherches regex, afin de permettre de chercher du code HTML, comme : `/Bonjour à tous<\/span>/` +Contrairement aux recherches normales, les caractères spéciaux XML `<&">` ne sont pas encodés dans les recherches regex, afin de permettre de chercher du code HTML, comme : `/Bonjour à tous<\/span>/` + +> ℹ️ Une barre oblique (slash) doit être échappée comme suit : `\/` ⚠️ Les détails de syntaxe regex avancée dépendent du moteur regex utilisé : -- cgit v1.2.3