From 85cbfcedb50b3a579d13697b4ec27c87450f68a7 Mon Sep 17 00:00:00 2001 From: Alexis Degrugillier Date: Thu, 7 Jan 2021 15:47:39 -0500 Subject: Update user query feature (#3338) * Change user query wording There was some misunderstanding in the use of the user query feature, probably because of the wording. I've change it to make it more obvious. * Fix feedback when a query is bookmarked Before, the displayed query name was not the one intended. Now, the name is the one of the current bookmark * Document user queries I've added a few words on how to use the user queries because it seems there was some misunderstanding. See #3219 --- docs/en/users/03_Main_view.md | 44 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) (limited to 'docs/en/users') diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index 8d4af3a26..c5800081c 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -116,16 +116,19 @@ This update occurs on the selected feed only. To trigger it, simply click on the # Filtering articles +## Purpose When the number of articles stored by FreshRSS inevitably grows larger, it's important to use efficient filters to display only a subset of the articles. There are several methods that filter with different criteria. Usually those methods can be combined. -## By category +## How-to filter + +### By category This is the easiest method. You only need to click on the category title in the side panel. There are two special categories at the top of the panel: * *Main feed* displays only articles from feeds marked as available in that category * *Favourites* displays only articles marked as favourites -## By feed +### By feed There are several methods to filter articles by feed: @@ -136,7 +139,7 @@ There are several methods to filter articles by feed: ![Feed filter](../img/users/feed.filter.1.png) -## By status +### By status Each article has two attributes that can be combined. The first attribute indicates whether or not the article has been read. The second attribute indicates if the article was marked as favorite or not. @@ -150,11 +153,11 @@ Starting with version 0.8, all attribute filters are visible as toggle icons. Th By default, this filter displays only unread articles -## By content +### By content It is possible to filter articles by their content by inputting a string in the search field. -## With the search field +### With the search field You can use the search field to further refine results: @@ -208,3 +211,34 @@ For example, you can enter multiple instances of `f:`, `author:`, `intitle:`, `i Combining several search criteria implies a logical *and*, but the keyword ` OR ` can be used to combine several search criteria with a logical *or* instead: `author:Dupont OR author:Dupond` + +### By sorting by date + +You can change the sort order by clicking the toggle button available in the header. + +## Store your filters + +Once you came up with your perfect filter, it would be a shame if you need to recreate it every time you need to use it. + +Hopefully, there is a way to bookmark them for later use. +We call them _user queries_. +You can create as many as you want, the only limit is how they will be displayed on your screen. + +### Bookmark the current query + +Display the user queries drop-down by clicking the button next to the state buttons. +![User queries drop-down](../img/users/user.queries.drop-down.empty.png) + +Then click on the bookmark action. + +Congratulations, you're done! + +### Using a bookmarked query + +Display the user queries drop-down by clicking the button next to the state buttons. +![User queries drop-down](../img/users/user.queries.drop-down.not.empty.png) + +Then click on the bookmarked query, the previously stored query will be applied. + +> Note that only the query is stored, not the articles. +> The results you are seing now could be different from the results on the day you've created the query. -- cgit v1.2.3