diff options
| author | 2019-12-03 22:37:40 +0100 | |
|---|---|---|
| committer | 2019-12-03 22:37:40 +0100 | |
| commit | 705318aa39a605a4d869db588f6cffb12019a611 (patch) | |
| tree | 36383dfee24999f9928957621b655e67b20714b7 /docs/en/users/03_Main_view.md | |
| parent | 0de7e84380dff5222e6728aacbbb42abaac51dd9 (diff) | |
Translate docs with po4a (#2590)
* [i18n] Add docs po4a script
* Add proof of concept
* Add a few more translations
* Hush ShellCheck and shfmt
* Make that list po4a-friendly
* drat, this document could've probably been auto-generated
* Definitive proof that it's translated from French ;-)
* Add some brand spanking new French translation
* More translation
* Mostly finish that config page
* Fix up FAQ
* More contributing
* Dev first steps
* Let's ignore that admin stuff at the very least for now
* Translate release new version, make French the source first and copy all translations
Then replace French with English in the source.
Much quicker than any alternative route.
* And add the English translation
* Minor stylistic leftover from French
* Most of first steps
* Forgot the extensions
* Use po4a 0.56 to get rid of way too many newlines
* Fix up those newlines
* No point linking to Firefox integration anymore from the new user guide
* Start on main view
* A bunch of main view stuff
* More main view
* And some subscriptions before going to bed
* First steps for devs
* More dev first steps
* Incomplete French → English dev/GH translation
Because I need to ask about that mailing list thing
* Fix typo in docs/en/developers/02_Github.md
* Translate & complete devs/github to English
* Fix up most of extensions
* Is that supposed to be a non-breaking space? Let's see
* Match up some users/mobile access
* More users/mobile access
* Add fresh French translation to Fever API
* Fix typo
* Match frontend todo thingies
* Fix a typo
* Some extensions strings
* Remove Fx subscription service from the docs
Cf. https://github.com/FreshRSS/FreshRSS/pull/2606
* Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643
* fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009
* Add some more French translations
* Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909
* Translate some of the meaningless stuff
* Translate the rest of contributing.md to French
* Fix conflicts
* Translate Docker first steps to French
* Update with change from #2665
* Add @aledeg corrections
* Overlooked a couple @aledeg corrections thanks to GitHub autohide
* Latest @aledeg suggestions
Diffstat (limited to 'docs/en/users/03_Main_view.md')
| -rw-r--r-- | docs/en/users/03_Main_view.md | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index c6c3e3b50..7259d756e 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -12,7 +12,7 @@ # Refreshing feeds -To use FreshRSS at its full potential, it needs to grab subscribed feeds new articles. To do so, you have several methods available. +To take full advantage of FreshRSS, it needs to retrieve new items from the feeds you have subscribed to. There are several ways to do this. ## Automatic update @@ -20,7 +20,7 @@ This is the recommended method since you can forget about it once it is configur ### With the actualize_script.php script -This method is available only if you have access to the installation server scheduled tasks. +This method is only available if you have access to the scheduled tasks of the machine on which your FreshRSS instance is installed. The script is named *actualize_script.php* and is located in the *app* folder. The scheduled task syntax will not be explained here. However, here is [a quick introduction to crontab](http://www.adminschoice.com/crontab-quick-reference/) that might help you. @@ -68,13 +68,13 @@ If you configure the application to allow anonymous reading, you can also allow  -The URL used in the previous section becomes accessible and therefore, you can use the same syntax for the scheduled task. +The URL used in the previous section will now become accessible to anyone. Therefore you can use the same syntax for the scheduled task. -You can also configure an authentication token to grant a special right on the server. +You can also configure an authentication token to grant special access on the server.  -The scheduled task syntax to use will be the following: +The scheduled task syntax should look as follows: ```cron 0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize&token=my-token' @@ -88,7 +88,7 @@ You can also target a different user by adding their username to the query strin ### HTTP authentication -In that case, the syntax in the two previous section are unusable. It means that you need to provide your credentials to the scheduled task. **Note that this method is highly discouraged since it means that your credentials will be in plain sight!** +When using HTTP authentication, the syntax in the two previous sections is unusable. You'll need to provide your credentials to the scheduled task. **Note that this method is highly discouraged since it means that your credentials will be in plain sight!** ```cron 0 * * * * curl -u alice:password123 'https://freshrss.example.net/i/?c=feed&a=actualize' @@ -96,11 +96,11 @@ In that case, the syntax in the two previous section are unusable. It means that ## Manual update -If you cannot or do not want to use the automatic methods, you can make it manually. There is two ways, the partial or the complete update. +If you can't or don't want to use the automatic method, you can update manually. There are two methods for updating all or some of the feeds. ### Complete update -This update occurs on all feeds. To trigger it, you need to click on the navigation menu update link. +This update occurs on all feeds. To trigger it, simply click on the update link in the navigation menu.  @@ -110,24 +110,24 @@ When the update starts, a progress bar appears and changes while feeds are proce ### Partial update -This update occurs on the selected feed only. To trigger it, you need to click on the feed menu update link. +This update occurs on the selected feed only. To trigger it, simply click on the update link in the feed menu.  # Filtering articles -While the number of articles stored by FreshRSS increase, it is important to have efficient filters to display only a subset of the articles. There is several methods with different criterion. Most of the time, those methods can be combined. +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 -This is the easiest method. You only need to click on the category title in the side panel. There are two special categories on top of that panel: +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* which displays only articles from feeds marked as available in that category - * *Favourites* which displays only articles marked as favourites + * *Main feed* displays only articles from feeds marked as available in that category + * *Favourites* displays only articles marked as favourites ## By feed -There is several methods to filter articles by feed: +There are several methods to filter articles by feed: * by clicking the feed title in the side panel * by clicking the feed title in the article details @@ -138,9 +138,9 @@ There is several methods to filter articles by feed: ## By status -Each article has two attributes, which can be combined. The first attribute indicates if the article was read or not. The second attribute indicates if the article was marked as favorite or not. +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. -With version 0.7, attribute filters are available in the article display dropdown list. With this version, it is not possible to combine those filters. For instance, it is not possible to display only read and favourite articles. +In version 0.7, attribute filters are available in the article display dropdown list. With this version, it's not possible to combine filters. For instance, it's not possible to display only read and favorite articles.  @@ -156,7 +156,7 @@ It is possible to filter articles by their content by inputting a string in the ## With the search field -It is possible to use the search field to further refine results: +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'` @@ -197,12 +197,12 @@ It is possible to use the search field to further refine results: * `date:P1DT1H/` (past one day and one hour) * by date of publication, using the same format: `pubdate:<date-interval>` -Beware that there is no space between the operator and the value. +Be careful not to enter a space between the operator and the search value. Some operators can be used negatively, to exclude articles, with the same syntax as above, but prefixed by a `!` or `-`: `-author:name`, `-intitle:keyword`, `-inurl:keyword`, `-#tag`, `!keyword`. -It is also possible to combine operators to have a very sharp filter, and it is allowed to have multiple instances of `author:`, `intitle:`, `inurl:`, `#`, and free-text. +It is also possible to combine keywords to create a more precise filter. For example, you can enter multiple instances of `author:`, `intitle:`, `inurl:`, `#`, and free-text. 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` |
