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 | |
| 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')
| -rw-r--r-- | docs/en/users/02_First_steps.md | 15 | ||||
| -rw-r--r-- | docs/en/users/03_Main_view.md | 38 | ||||
| -rw-r--r-- | docs/en/users/04_Subscriptions.md | 22 | ||||
| -rw-r--r-- | docs/en/users/05_Configuration.md | 62 | ||||
| -rw-r--r-- | docs/en/users/06_Fever_API.md | 77 | ||||
| -rw-r--r-- | docs/en/users/06_Mobile_access.md | 2 | ||||
| -rw-r--r-- | docs/en/users/07_Frequently_Asked_Questions.md | 34 |
7 files changed, 115 insertions, 135 deletions
diff --git a/docs/en/users/02_First_steps.md b/docs/en/users/02_First_steps.md index 6bebb124a..5490147d8 100644 --- a/docs/en/users/02_First_steps.md +++ b/docs/en/users/02_First_steps.md @@ -1,21 +1,20 @@ -Learning how to handle a new application is not always easy. We build FreshRSS to be intuitive, but you will need some guidance to get your hand on it. +Learning how to handle a new application is not always easy. We've tried to make FreshRSS as intuitive as possible, but you might still need a little help to master the program. -This section guides you to the pages you need as a new comer. +This section will guide you to the pages you need to get started. The order is tailored to newcomers. [After installing the application](../admins/03_Installation.md), the first step is to add some feeds. You have a few options: 1. [Add a feed manually](04_Subscriptions.md#adding-a-feed) 2. [Import an OPML or JSON file](04_Subscriptions.md#import-and-export) 3. [Use the bookmarklet](04_Subscriptions.md#use-bookmarklet) -4. [Firefox integration](04_Subscriptions.md#firefox-subscription-service) -Once you have added your feeds to FreshRSS, it is time to read them. You have access to three reading modes: +Once you have added your feeds to FreshRSS, it is time to read them. There are three availalbe reading modes: -1. [The normal view](03_Main_view.md#normal-view) which allows you to display and read quickly new articles -2. [The global view](03_Main_view.md#global-view) which allows you to see in one glance the status of your feeds -3. [The reader view](03_Main_view.md#reader-view) which allows you to have a nice reading experience. +1. [The normal view](03_Main_view.md#normal-view) enables you to quickly read new articles +2. [The global view](03_Main_view.md#global-view) shows you an overview of the status of your feeds in one glance +3. [The reader view](03_Main_view.md#reader-view) offers you a comfortable reading experience -Now that you know the basic usages, it is time to configure FreshRSS to improve your reading experience. It has a lot of options, so play with them to find your perfect configuration. However, here is few resources to help you: +Now that you've mastered basic use, it's time to configure FreshRSS to improve your reading experience. It's highly configurable, so it's recommended to play around with them to find a configuration that suits you well. Here are a few resources to help you improve your daily FreshRSS experience: * [Organize your feeds in categories](04_Subscriptions.md#feed-management) * [Change the home page](05_Configuration.md#changing-the-view) 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` diff --git a/docs/en/users/04_Subscriptions.md b/docs/en/users/04_Subscriptions.md index 4b40f691a..be8efe0a6 100644 --- a/docs/en/users/04_Subscriptions.md +++ b/docs/en/users/04_Subscriptions.md @@ -8,7 +8,7 @@ # Use bookmarklet -Bookmarklets are little scripts that you can execute to perform useful or frivolous tasks. FreshRSS offers a bookmarklet for subscribing to newsfeeds. +Bookmarklets are little scripts that you can execute to perform various tasks. FreshRSS offers a bookmarklet for subscribing to newsfeeds. 1. Open "Subscriptions management". 2. Click on "Subscription tools". @@ -17,23 +17,3 @@ Bookmarklets are little scripts that you can execute to perform useful or frivol # Feed management **TODO** - -# Firefox subscription service - -NB: From version 63 and onwards Firefox has removed the ability to add your own subscription services that aren't standalone programs. This makes it impossible to add FreshRSS to the feed preview/subscription page, though this page is set to be removed from version 64 anyway (see [bugzilla](https://bugzilla.mozilla.org/show_bug.cgi?id=1477667)). You can use the bookmarklet mentioned above for an easy way to subscribe to feeds. - -If you're using a version pre-63 you can manually add your FreshRSS app to the list of Firefox subscription services, which enables you to subscribe to sites which provide a feed link using the Firefox built-in "Subscribe" button. An in-depth process is described in the [official documentation](https://developer.mozilla.org/en-US/Firefox/Releases/2/Adding_feed_readers_to_Firefox) but you can use the following steps: - - 1. Open about:config in Firefox - - 2. Search for "browser.contentHandlers.types." and note the highest number following the returned strings (ie if yo see browser.contentHandlers.types.1.something up to browser.contentHandlers.types.5.somethingelse etc. the highest number is 5). Your contentHandler will have to have a free number so just pick one higher than currently registered (you would chose six in above example). - - 3. You will have to add three new strings to your about config (replace %NUMBER% with the number from previous step and example.com with your installation address): - - | Preference name | Value | Note | - | -------------------------------------------- | ---------------------------------------------------------- | --------------------------------------------------------- | - | browser.contentHandlers.types.%NUMBER%.title | **FreshRSS** | Use any name you would like (ie. "My feeds") | - | browser.contentHandlers.types.%NUMBER%.type | **application/vnd.mozilla.maybe.feed** | Do not change this value! | - | browser.contentHandlers.types.%NUMBER%.uri | **http://EXAMPLE.COM/FreshRss/i?c=feed&a=add&url_rss=%s** | Replace base url with yours and switch to https (if used) | - - 4. Restart Firefox and you can subscribe to sites with the Firefox built-in "Subscribe" button. Just select the name you set under the first Preference name from the dropdown (you can also make it default with the checbox) and you will be redirected to FreshRSS subscription settings (you must be logged in). diff --git a/docs/en/users/05_Configuration.md b/docs/en/users/05_Configuration.md index f635f9d5e..767ed2be4 100644 --- a/docs/en/users/05_Configuration.md +++ b/docs/en/users/05_Configuration.md @@ -3,17 +3,17 @@ ## Language -At the moment, FreshRSS is available in 13 languages. After you confirm your choice, the interface will be displayed in the chosen language. -Depending on the chosen language, there might be parts of the interface that are still not translated. If you're willing to help translating -the missing bits or add a new language, please check how you can [contribute to the project](../contributing.md#contribute-to-internationalization-i18n). +FreshRSS is currently available in 14 languages. After confirming your choice, the interface will be displayed in your preferred language. +Depending on the language chosen, parts of the interface may not be not translated yet. If you're willing to help translate +the missing bits or would like to add a new language, please take a look at how you can [contribute to the project](../contributing.md#contribute-to-internationalization-i18n). -There are parts of FreshRSS that are not translated and are not intended to be translated. For now, the logs visible in the application as well as the one generated by automatic update scripts are part of it. +Some parts of FreshRSS aren't translated and aren't intended to be translated either. For now, this includes the logs visible in the application as well as the log generated by automatic update scripts. Available languages are: cz, de, en, es, fr, he, it, kr, nl, oc, pt-br, ru, tr, zh-cn. ## Theme -In matters of taste and color, there can be no disputes. This is why FreshRSS offers eight official themes: +There's no accounting for tastes, which is why FreshRSS offers eight official themes: * *Blue Lagoon* by **Mister aiR** * *Dark* by **AD** @@ -22,24 +22,24 @@ In matters of taste and color, there can be no disputes. This is why FreshRSS of * *Origine-compact* by **Kevin Papst** * *Pafat* by **Plopoyop** * *Screwdriver* by **Mister aiR** - * *Swage* par **Patrick Crandol** + * *Swage* by **Patrick Crandol** -If none of these are suitable for you, it is always possible to [create your own](../developers/04_Frontend/02_Design.md). +If you can't find any themes you like, it's always possible to [create your own](../developers/04_Frontend/02_Design.md). To select a theme, simply scroll through the themes and select one that strikes your fancy. After confirmation, the theme will be applied to the interface. ## Content width -There are some who prefer short lines of text while others prefer to maximize the available screen space. To satisfy the maximum number of people it is possible to choose the width of the displayed content. There are four settings available: +Some people prefer short lines of text, while others prefer to maximize the available screen space. To satisfy the maximum number of people, it's possible to customize the width of the displayed content. There are four settings available: - * **Fine** which displays content up to 550 pixels - * **Medium** which displays content up to 800 pixels - * **Large** which displays content up to 1000 pixels - * **No limit** which displays the content on 100% of the available space + * **Fine** displays content up to a maximum width of 550 pixels + * **Medium** displays content up to a maximum width of 800 pixels + * **Large** displays content up to a maximum width of 1000 pixels + * **No limit** displays the content on 100% of the available space ## Article icons -It worth noting that this section only has effects in normal view. +Please note that this section only affects normal view.  @@ -47,12 +47,12 @@ Each article is rendered with a header (top line) and a footer (bottom line). In that section, you can choose what will be displayed in those. If you disable every item in the top line, you'll still be able to see it since -there is the feed name and the article title. But if you do the same thing for +it contains the feed name and the article title. But if you do the same thing for the bottom line, it will be empty. ## HTML5 notification timout -After the automatic updates of the feeds, FreshRSS uses the HTML5 notification API to notify of the arrival of new articles. +After automatically updating the feeds, FreshRSS can pop up a notification using the HTML5 notification API. The duration of this notification can be set. By default, the value is 0. @@ -68,29 +68,29 @@ If you don't use those buttons because you never browse on mobile or because you **TODO** -# Archiving +# Archival **TODO** # Sharing -To make your life easier, you can share directly an article within FreshRSS. +To make your life easier, you can share articles straight from FreshRSS. -At the moment, FreshRSS supports 15 sharing methods ranging from self-hosted services (Shaarli, etc.) to proprietary services (Facebook, etc.). +At the moment, FreshRSS supports 18 sharing methods, ranging from self-hosted services (Shaarli, etc.) to proprietary services (Facebook, etc.). By default, the sharing list is empty.  -To add a new item in the list, follow those simple steps: +To add a new item to the list, please follow the following simple steps: - 1. Select the share method in the drop-down. - 1. Press the ```✚``` sign to add it to the list. - 1. Configure the method in the list. All method names can be modified in the display. Some methods need the sharing URL to be able to work properly (ex: Shaarli). + 1. Select the desired sharing method in the drop-down list. + 1. Press the ```✚``` button to add it to the list. + 1. Configure the method in the list. All names can be modified in the display. Some methods need the sharing URL to be able to work properly (ex: Shaarli). 1. Submit your changes. To remove an item from the list, follow those simple steps: - 1. Press the ```❌``` sign next to the share method you want to remove. + 1. Press the ```❌``` button next to the share method you want to remove. 1. Submit your changes. # Shortcuts @@ -151,7 +151,7 @@ More information can be found in the [Apache documentation](http://httpd.apache. **TODO** -## Archivage +## Archival **TODO** @@ -163,24 +163,24 @@ More information can be found in the [Apache documentation](http://httpd.apache. ### Retrieve a truncated stream from within FreshRSS -The question comes up regularly, so we will try to clarify here how one can retrieve a truncated RSS feed with FreshRSS. Please note that the process is absolutely not "user friendly", but it works :) +This question comes up regularly, so we'll try to clarify how one can retrieve a truncated RSS feed with FreshRSS. Please note that the process is absolutely not user friendly, but it works. :) -Also know that this way you are generating much more traffic to the originating sites and that they might block you accordingly. The performance of FreshRSS is also negatively affected because you have to fetch the full article content one by one. So it's a feature to use sparingly! +Please be aware that this way you'll generate much more traffic to the originating sites, and they might block you accordingly. FreshRSS performance is also negatively affected, because you'll have to fetch the full article content one by one. So it's a feature to use sparingly! -What is meant by "CSS path of articles on the original site" actually corresponds to the "path" consisting of IDs and classes (which in html, matches the id and class attributes) to retrieve only the interesting part that corresponds to the article. Ideally, this path starts with an id (which is unique to the page). +What's meant by "CSS path of articles on the original site" actually corresponds to the "path" consisting of IDs and classes (which in HTML, matches the id and class attributes) to retrieve only the interesting part that corresponds to the article. Ideally, this path starts with an id (which is unique to the page). #### Example: Rue89 -To find this path, you must go to the address of one of the truncated articles (for example http://www.rue89.com/2013/10/15/prof-maths-jai-atteint-lextase-dihn-pedagogie-inversee-246635). You must then look for the "block" of HTML corresponding to the content of the article (in the source code!). +To find this path, you have to go to the address of one of the truncated articles (for example, http://www.rue89.com/2013/10/15/prof-maths-jai-atteint-lextase-dihn-pedagogie-inversee-246635). You look have to look for the "block" of HTML that corresponds to article content (in the source code!). -We find here that the block that encompasses only the content of the article is ```<div class="content clearfix">```. We will only use the ".content" class here. Nevertheless, as said above, it is best to start the path with an id. If we go back to the parent block, this is the block ```<div id="article">``` and that's perfect! The path will be ```#article .content```. +Here we find that the block that encompasses nothing but the content of the article is ```<div class="content clearfix">```. We'll only use the `.content` class here. Nevertheless, as said above, it's best to start the path with an id. If we go back to the parent block, we find ```<div id="article">``` and that's perfect! The path will be ```#article .content```. -#### Add the corresponding classes to the articles CSS path on the feed configuration page. Examples: +#### Add the corresponding classes to the article CSS path on the feed configuration page. Examples: * Rue89: ```#article .content``` * PCINpact: ```#actu_content``` * Lesnumériques: ```article#body div.text.clearfix``` -* Phoronix : ```#main .content``` +* Phoronix: ```#main .content``` ### Retrieve a truncated stream with external tools diff --git a/docs/en/users/06_Fever_API.md b/docs/en/users/06_Fever_API.md index b1cf6cb21..5da090872 100644 --- a/docs/en/users/06_Fever_API.md +++ b/docs/en/users/06_Fever_API.md @@ -5,51 +5,52 @@ and general aspects of API access. ## RSS clients -There are many RSS clients existing supporting Fever APIs but they seem to understand the Fever API a bit differently. -If your favourite client does not work properly with this API, create an issue and we will have a look. +There are many RSS clients that support the Fever API, but they seem to understand the Fever API a bit differently. +If your favourite client doesn't work properly with this API, please create an issue and we'll have a look. But we can **only** do that for free clients. ### Usage & Authentication -Before you can start to use this API, you have to enable and setup API access, which is [documented here](https://freshrss.github.io/FreshRSS/en/users/06_Mobile_access.html), -and then re-set the user’s API password. +Before you can start using this API, you have to enable and setup API access, which is [documented here](https://freshrss.github.io/FreshRSS/en/users/06_Mobile_access.html), +and then reset the user’s API password. -Then point your mobile application to the URL of `fever.php` (e.g. `https://freshrss.example.net/api/fever.php`). +Then point your mobile application to the `fever.php` address (e.g. `https://freshrss.example.net/api/fever.php`). -## Compatibility +## Compatible clients Tested with: -- Android - - [Readably](https://play.google.com/store/apps/details?id=com.isaiasmatewos.readably) (Closed source) +* Android + * [Readably](https://play.google.com/store/apps/details?id=com.isaiasmatewos.readably) (Closed source) -- iOS - - [Fiery Feeds](https://apps.apple.com/app/fiery-feeds-rss-reader/id1158763303) (Closed source) - - [Unread](https://apps.apple.com/app/unread-rss-reader/id1252376153) (Commercial) - - [Reeder](https://www.reederapp.com/) (Commercial) (Use its Google Reader API / native FreshRSS option when possible) +* iOS + * [Fiery Feeds](https://apps.apple.com/app/fiery-feeds-rss-reader/id1158763303) (Closed source) + * [Unread](https://apps.apple.com/app/unread-rss-reader/id1252376153) (Commercial) + * [Reeder](https://www.reederapp.com/) (Commercial) (Use its Google Reader API / native FreshRSS option when possible) -- MacOS - - [ReadKit](https://apps.apple.com/app/readkit/id588726889) (Commercial) +* MacOS + * [ReadKit](https://apps.apple.com/app/readkit/id588726889) (Commercial) ## Features -Following features are implemented: +The following features are implemented: -- fetching categories -- fetching feeds -- fetching RSS items (new, favorites, unread, by_id, by_feed, by_category, since) -- fetching favicons -- setting read marker for item(s) -- setting starred marker for item(s) -- setting read marker for feed -- setting read marker for category -- supports FreshRSS extensions, which use the `entry_before_display` hook +* fetching categories +* fetching feeds +* fetching RSS items (new, favorites, unread, by_id, by_feed, by_category, since) +* fetching favicons +* setting read marker for item(s) +* setting starred marker for item(s) +* setting read marker for feed +* setting read marker for category +* supports FreshRSS extensions, which use the `entry_before_display` hook -Following features are not supported: -- **Hot Links** aka **hot** as there is nothing in FreshRSS yet that is similar or could be used to simulate it +The following features are not supported: -## Testing and error search +* **Hot Links** aka **hot** as there is nothing in FreshRSS yet that is similar or could be used to simulate it. + +## Testing and debugging If this API does not work as expected in your RSS reader, you can test it manually with a tool like [Postman](https://www.getpostman.com/). @@ -83,25 +84,25 @@ This should give: "last_refreshed_on_time": "1520013061" } ``` -Perfect, you are authenticated and can now start testing the more advanced features. Therefor change the URL and append the possible API actions to your request parameters. Check the [original Fever documentation](https://feedafever.com/api) for more information. +Perfect, you're now authenticated and you can start testing the more advanced features. To do so, change the URL and append the possible API actions to your request parameters. Please refer to the [original Fever documentation](https://feedafever.com/api) for more information. Some basic calls are: -- https://freshrss.example.net/api/fever.php?api&items -- https://freshrss.example.net/api/fever.php?api&feeds -- https://freshrss.example.net/api/fever.php?api&groups -- https://freshrss.example.net/api/fever.php?api&unread_item_ids -- https://freshrss.example.net/api/fever.php?api&saved_item_ids -- https://freshrss.example.net/api/fever.php?api&items&since_id=some_id -- https://freshrss.example.net/api/fever.php?api&items&max_id=some_id -- https://freshrss.example.net/api/fever.php?api&mark=item&as=read&id=some_id -- https://freshrss.example.net/api/fever.php?api&mark=item&as=unread&id=some_id +* https://freshrss.example.net/api/fever.php?api&items +* https://freshrss.example.net/api/fever.php?api&feeds +* https://freshrss.example.net/api/fever.php?api&groups +* https://freshrss.example.net/api/fever.php?api&unread_item_ids +* https://freshrss.example.net/api/fever.php?api&saved_item_ids +* https://freshrss.example.net/api/fever.php?api&items&since_id=some_id +* https://freshrss.example.net/api/fever.php?api&items&max_id=some_id +* https://freshrss.example.net/api/fever.php?api&mark=item&as=read&id=some_id +* https://freshrss.example.net/api/fever.php?api&mark=item&as=unread&id=some_id Replace `some_id` with a real ID from your `freshrss_username_entry` database. ### Debugging -If nothing helps and your clients still misbehaves, add these lines to the start of `fever.api`: +If nothing helps and your client is still misbehaving, you can add the following lines to the beginning of the `fever.api` file to determine the cause of the problems: ```php file_put_contents(__DIR__ . '/fever.log', $_SERVER['HTTP_USER_AGENT'] . ': ' . json_encode($_REQUEST) . PHP_EOL, FILE_APPEND); diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md index f5f1520e9..195663f36 100644 --- a/docs/en/users/06_Mobile_access.md +++ b/docs/en/users/06_Mobile_access.md @@ -44,7 +44,7 @@ See the [page about the Fever compatible API](06_Fever_API.md) for another possi # Compatible clients 6. On the same FreshRSS API page, note the address given under “Your API address”, like `https://freshrss.example.net/api/greader.php` - * You will type it in a client, together with your FreshRSS username, and the corresponding special API password. + * Type the API address in a client, together with your FreshRSS username, and the corresponding special API password. 7. Pick a client supporting a Google Reader-like API. Selection: * Android diff --git a/docs/en/users/07_Frequently_Asked_Questions.md b/docs/en/users/07_Frequently_Asked_Questions.md index 577931572..757b2528a 100644 --- a/docs/en/users/07_Frequently_Asked_Questions.md +++ b/docs/en/users/07_Frequently_Asked_Questions.md @@ -1,47 +1,47 @@ We may not have answered all of your questions in the previous sections. The FAQ contains some questions that have not been answered elsewhere. -## What is /i at the end of the application URL? +## What is `/i` at the end of the application URL? -Of course, ```/i``` has a purpose! We used it for performance and usability: +Of course, ```/i``` has a purpose! It's used for performance and usability: * It allows for serving icons, images, styles and scripts without cookies. Without that trick, those files would be downloaded more often, especially when form authentication is used. Also, HTTP requests would be heavier. -* ```./p/``` public root can be served without any HTTP access restrictions. Whereas it could be implemented in ```./p/i/```. +* The ```./p/``` public root can be served without any HTTP access restrictions. Whereas it could be implemented in ```./p/i/```. * It avoids problems while serving public resources like ```favicon.ico```, ```robots.txt```, etc. * It allows the logo to be displayed instead of a white page while hitting a restriction or a delay during the loading process. -## Why robots.txt is located in a sub-folder? +## Why is `robots.txt` located in a sub-folder? -To increase security, FreshRSS is hosted in two sections. The first section is public (```./p``` folder) and the second section is private (everything else). Therefore the ```robots.txt``` file is located in ```./p``` sub-folder. +To increase security, FreshRSS is hosted in two sections. The first section is public (the `./p` folder) and the second section is private (everything else). Therefore the `robots.txt` file is located in the `./p` sub-folder. -As explained in the [security section](/en/User_documentation/Installation/Security), it is highly recommended to make only the public section available at the domain level. With that configuration, ```./p``` is the root folder for https://demo.freshrss.org/, thus making ```robots.txt``` available at the root of the application. +As explained in the [security section](/en/User_documentation/Installation/Security), it's highly recommended to make only the public section available at the domain level. With that configuration, `./p` is the root folder for http://demo.freshrss.org/, thus making `robots.txt` available at the root of the application. -The same rule applies for ```favicon.ico``` and ```.htaccess```. +The same principle applies to `favicon.ico` and `.htaccess`. ## Why do I have errors while registering a feed? There can be different origins for that problem. -The feed syntax can be invalid, it can be unrecognized by the SimplePie library. the hosting server can be the root of the problem, FreshRSS can be buggy. +The feed syntax can be invalid, it can be unrecognized by the SimplePie library, the hosting server can be the root of the problem, or FreshRSS can be buggy. The first step is to identify what causes the problem. Here are the steps to follow: -1. __Verify if the feed syntax is valid__ with the [W3C on-line tool](https://validator.w3.org/feed/ "RSS and Atom feed validator"). If it is not valid, there is nothing we can do. -1. __Verify SimplePie validation__ with the [SimplePie on-line tool](https://simplepie.org/demo/ "SimplePie official demo"). If it is not recognized, there is nothing we can do. -1. __Verify FreshRSS integration__ with the [demo](https://demo.freshrss.org "FreshRSS official demo"). If it is not working, you need to [create an issue on Github](https://github.com/FreshRSS/FreshRSS/issues/new "Create an issue for FreshRSS") so we can have a look at it. If it is working, there is probably something fishy with the hosting server. +1. __Verify if the feed syntax is valid__ with the [W3C on-line tool](https://validator.w3.org/feed/ "RSS and Atom feed validator"). If it's not valid, there's nothing we can do. +1. __Verify SimplePie validation__ with the [SimplePie on-line tool](https://simplepie.org/demo/ "SimplePie official demo"). If it's not recognized, there's nothing we can do. +1. __Verify FreshRSS integration__ with the [demo](https://demo.freshrss.org "FreshRSS official demo"). If it's not working, you need to [create an issue on Github](https://github.com/FreshRSS/FreshRSS/issues/new "Create an issue for FreshRSS") so we can have a look at it. If it's working, there's probably something fishy with the hosting server. -## How to change a forgotten password? +## How can you change a forgotten password? -Since [1.10.0](https://github.com/FreshRSS/FreshRSS/releases/tag/1.10.0) release, admins are able to change user passwords directly from the interface. This interface is available under ```Administration → Manage users```. +Since the [1.10.0](https://github.com/FreshRSS/FreshRSS/releases/tag/1.10.0) release, admins can change user passwords directly from the interface. This interface is available under ```Administration → Manage users```. Select a user, enter a password, and validate. -Since [1.8.0](https://github.com/FreshRSS/FreshRSS/releases/tag/1.8.0) release, admins are able to change user passwords using a terminal. It worth mentioning that it must have access to PHP CLI. Open a terminal, and type the following command: +Since the [1.8.0](https://github.com/FreshRSS/FreshRSS/releases/tag/1.8.0) release, admins can change user passwords using a terminal. It worth mentioning that you must have access to PHP CLI. Open a terminal, and type the following command: ```sh ./cli/update_user.php --user <username> --password <password> ``` -For more information on that matter, there is a [dedicated documentation](../../cli/README.md). +For more information on that matter, please refer to the [dedicated documentation](../../cli/README.md). ## Permissions under SELinux -Some Linux distribution like Fedora or RedHat Enterprise Linux have SELinux system enabled. This acts like a firewall application, so all applications cannot write/modify files under certain conditions. While installing FreshRSS, step 2 can fail if the httpd process cannot write to some data sub-directories, the following command should be executed as root : +Some Linux distribution, like Fedora or RedHat Enterprise Linux, have SELinux enabled. This acts similar to a firewall application, so that applications can't write or modify files under certain conditions. While installing FreshRSS, step 2 can fail if the httpd process can't write to some data sub-directories. The following command should be executed as root to fix this problem: ```sh semanage fcontext -a -t httpd_sys_rw_content_t '/usr/share/FreshRSS/data(/.*)?' restorecon -Rv /usr/share/FreshRSS/data @@ -49,7 +49,7 @@ restorecon -Rv /usr/share/FreshRSS/data ## Why do I have a blank page while trying to configure the sharing options? -The `sharing` word in the URL is a trigger word for some an-blocker rules. Starting at version 1.16, `sharing` has been replaced by `integration` in the faulty URL while keeping the exact same wording through out the application. +The `sharing` word in the URL is a trigger word for some ad-blocker rules. Starting with version 1.16, `sharing` has been replaced by `integration` in the faulty URL while keeping the exact same wording throughout the application. If you are using a version prior to 1.16, you can disable your ad-blocker for FreshRSS or you can add a rule to allow the `sharing` page to be accessed. |
