diff options
| author | 2022-01-08 21:58:55 +0100 | |
|---|---|---|
| committer | 2022-01-08 21:58:55 +0100 | |
| commit | 1acd3ab09be1b65bfd6122ee351490c3b5527bb8 (patch) | |
| tree | f11de558e7a09522a45d1c155d9707ecda6bf1eb /docs/en/users | |
| parent | 916df412f5b6f7fb9bcfb705a3c8c23e35304410 (diff) | |
Use typographic quotes (#4133)
* Use typographic quotes
* A few fixes
* Fix
* Fix not saved
* Implement feedback
* Detail
* Revert spoken English fixes
Left for a future dedicated discussion
* More reverts
* Final reverts
* Final minor
Diffstat (limited to 'docs/en/users')
| -rw-r--r-- | docs/en/users/02_First_steps.md | 4 | ||||
| -rw-r--r-- | docs/en/users/03_Main_view.md | 20 | ||||
| -rw-r--r-- | docs/en/users/04_Subscriptions.md | 14 | ||||
| -rw-r--r-- | docs/en/users/05_Configuration.md | 26 | ||||
| -rw-r--r-- | docs/en/users/07_Frequently_Asked_Questions.md | 12 |
5 files changed, 38 insertions, 38 deletions
diff --git a/docs/en/users/02_First_steps.md b/docs/en/users/02_First_steps.md index b7d441ca8..b70d5f1a9 100644 --- a/docs/en/users/02_First_steps.md +++ b/docs/en/users/02_First_steps.md @@ -1,4 +1,4 @@ -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. +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 will guide you to the pages you need to get started. The order is tailored to newcomers. @@ -14,7 +14,7 @@ Once you have added your feeds to FreshRSS, it is time to read them. There are t 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'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: +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 11fd20d65..ee68c989b 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -2,14 +2,14 @@ FreshRSS has three primary viewing modes: Normal, Global, and Reader view. # Normal view -Normal view will allow you to view articles in a compressed view. They can be separated by category or individual feed, or viewed in the "main stream" containing all feeds. Clicking a feed in the sidebar (mobile users will need to click the folder icon to open it) will open that feed's view. +Normal view will allow you to view articles in a compressed view. They can be separated by category or individual feed, or viewed in the "main stream" containing all feeds. Clicking a feed in the sidebar (mobile users will need to click the folder icon to open it) will open that feed’s view. ## Article List By default, the normal view includes six items per article. From left to right: * **Read status:** An envelope icon to show if the article has been read or not. Closed envelopes are unread, open envelopes are read. Clicking on the icon will toggle the read status. * **Favourite status:** A star icon to show if the article has been favourited or not. Filled stars are favourited, empty stars are not. Clicking on the icon will toggle the favourite status. -* **Feed name:** The name of the feed that the article is from. Clicking the feed name will move to that feed's view in normal view. +* **Feed name:** The name of the feed that the article is from. Clicking the feed name will move to that feed’s view in normal view. * **Article title:** The title of the article. Clicking will open the article for viewing within FreshRSS. * **Article date/time:** The time the article was posted. * **Link to original article:** A globe icon that can be clicked to go to the article on the original website. @@ -19,14 +19,14 @@ By default, the normal view includes six items per article. From left to right: Clicking the gear icon next to an individual feed will display additional options for that feed. * **Filter:** Run the defined filter to mark articles as read * **Statistics:** View statistics about the feed -* **See website:** Open the feed's website in another tab +* **See website:** Open the feed’s website in another tab * **Manage:** Configure the feed * **Actualize:** Force-update the feed * **Mark as read:** Mark all items in the feed as read # Global view -Global view allows quick views of feed's statuses at once. Feeds and categories are shown with the number of unread articles next to them. Clicking a feed's name will open it in a view similar to normal view. +Global view allows quick views of feed’s statuses at once. Feeds and categories are shown with the number of unread articles next to them. Clicking a feed’s name will open it in a view similar to normal view. # Reader view @@ -111,7 +111,7 @@ You can also target a different user by adding their username to the query strin ### HTTP authentication -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!** +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' @@ -119,7 +119,7 @@ When using HTTP authentication, the syntax in the two previous sections is unusa ## Manual 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. +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 @@ -141,7 +141,7 @@ This update occurs on the selected feed only. To trigger it, simply click on the ## 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. +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. ## How-to filter @@ -167,7 +167,7 @@ There are several methods to filter articles by feed: 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. -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. +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.  @@ -240,7 +240,7 @@ 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` -When combining multiple negative operators (e.g. `!intitle:'thing1' AND !intitle:'thing2'`), you'll need to consider [De Morgan's laws](https://en.wikipedia.org/wiki/De_Morgan%27s_laws). See [this GitHub comment](https://github.com/FreshRSS/FreshRSS/issues/3236#issuecomment-891219460) for more details on the usage of `AND` vs `OR` when using combining multiple negative operators. +When combining multiple negative operators (e.g. `!intitle:'thing1' AND !intitle:'thing2'`), you’ll need to consider [De Morgan’s laws](https://en.wikipedia.org/wiki/De_Morgan%27s_laws). See [this GitHub comment](https://github.com/FreshRSS/FreshRSS/issues/3236#issuecomment-891219460) for more details on the usage of `AND` vs `OR` when using combining multiple negative operators. ### By sorting by date @@ -261,7 +261,7 @@ Display the user queries drop-down by clicking the button next to the state butt Then click on the bookmark action. -Congratulations, you're done! +Congratulations, you’re done! ### Using a bookmarked query diff --git a/docs/en/users/04_Subscriptions.md b/docs/en/users/04_Subscriptions.md index 93834e354..d50d92bf2 100644 --- a/docs/en/users/04_Subscriptions.md +++ b/docs/en/users/04_Subscriptions.md @@ -10,7 +10,7 @@ ## Subscription management -The "Subscription management" submenu allows categories and feeds to be configured. Feeds can be moved between categories by drag-and-drop, or in the individual feed's settings. Hovering over a feed/category will cause a gear icon to appear. Clicking the icon will bring up the settings for that item. +The "Subscription management" submenu allows categories and feeds to be configured. Feeds can be moved between categories by drag-and-drop, or in the individual feed’s settings. Hovering over a feed/category will cause a gear icon to appear. Clicking the icon will bring up the settings for that item. ## Category Settings @@ -33,15 +33,15 @@ This section will let you override the default settings for feed archiving and u ### Login -Some feeds require a username/password submitted over HTTP. These usually aren't needed for feeds. +Some feeds require a username/password submitted over HTTP. These usually aren’t needed for feeds. ### Advanced #### Retrieve a truncated feed from within FreshRSS -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. :) +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. :) -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! +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! The "Article CSS selector on original website" 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). The basics are explained [here](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors). @@ -50,7 +50,7 @@ The "Article CSS selector on original website" corresponds to the "path" consis To find this path, you have to go to the address of one of the truncated articles. You look have to look for the "block" of HTML that corresponds to article content (in the source code!). -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```. +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 article CSS path on the feed configuration page @@ -63,7 +63,7 @@ Examples: ##### Combining CSS Classes -Let's say we have an article which contains ads, and we do not want to have those ads retrieved by FreshRSS. Example HTML: +Let’s say we have an article which contains ads, and we do not want to have those ads retrieved by FreshRSS. Example HTML: ```html <div id="article"> @@ -78,7 +78,7 @@ Let's say we have an article which contains ads, and we do not want to have thos </div> ``` -In this case it's possible to combine multiple CSS selectors with a comma: ```#article p.content, #article h2``` +In this case it’s possible to combine multiple CSS selectors with a comma: ```#article p.content, #article h2``` #### Retrieve a truncated feed with external tools diff --git a/docs/en/users/05_Configuration.md b/docs/en/users/05_Configuration.md index 2002a18fe..9352937ba 100644 --- a/docs/en/users/05_Configuration.md +++ b/docs/en/users/05_Configuration.md @@ -4,16 +4,16 @@ ## Language 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 +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). -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. +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, ko, nl, oc, pt-br, ru, tr, zh-cn. ## Theme -There's no accounting for tastes, which 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** @@ -24,13 +24,13 @@ There's no accounting for tastes, which is why FreshRSS offers eight official th * *Screwdriver* by **Mister aiR** * *Swage* by **Patrick Crandol** -If you can't find any themes you like, it's 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 -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: +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** displays content up to a maximum width of 550 pixels * **Medium** displays content up to a maximum width of 800 pixels @@ -46,7 +46,7 @@ Please note that this section only affects normal view. 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 +If you disable every item in the top line, you’ll still be able to see it since it contains the feed name and the article title. But if you do the same thing for the bottom line, it will be empty. @@ -62,7 +62,7 @@ By default, FreshRSS displays buttons to ease the article navigation when browsi  -If you don't use those buttons because you never browse on mobile or because you browse with gestures, you can disable them from the interface. +If you don’t use those buttons because you never browse on mobile or because you browse with gestures, you can disable them from the interface. # Reading @@ -82,11 +82,11 @@ This will set images to load as they are viewed. This can save data, but will ca ## Archiving -These are the global options for fetching and retaining articles from feeds. They can be overwridden by individual feed's settings. +These are the global options for fetching and retaining articles from feeds. They can be overwridden by individual feed’s settings. ## Maintenance -This allows for purging/optimizing the current user's articles in the database. +This allows for purging/optimizing the current user’s articles in the database. # Sharing @@ -115,7 +115,7 @@ To remove an item from the list, follow those simple steps: To ease the use of the application, FreshRSS comes with a lot of predefined keyboard shortcuts. They allow actions to improve the user experience with a keyboard. -Of course, if you're not satisfied with the key mapping, you can change you configuration to fit your needs. +Of course, if you’re not satisfied with the key mapping, you can change you configuration to fit your needs. There are 4 types of shortcuts: @@ -124,13 +124,13 @@ There are 4 types of shortcuts: 1. Article actions: they allow interactions with an article, like sharing or opening it on the original web-site. 1. Other actions: they allow other interactions with the application, like opening the user queries menu or accessing the documentation. -It's worth noting that the share article action has two levels. Once you press the shortcut, a menu containing all the share options opens. -To choose one share option, you need to select it by its number. When there is only one option, it's selected automatically though. +It’s worth noting that the share article action has two levels. Once you press the shortcut, a menu containing all the share options opens. +To choose one share option, you need to select it by its number. When there is only one option, it’s selected automatically though. The same process applies to the user queries. Be aware that there is no validation on the selected shortcuts. -This means that if you assign a shortcut to more than one action, you'll end up with some unexpected behavior. +This means that if you assign a shortcut to more than one action, you’ll end up with some unexpected behavior. # User queries diff --git a/docs/en/users/07_Frequently_Asked_Questions.md b/docs/en/users/07_Frequently_Asked_Questions.md index ac04cf5f2..548762510 100644 --- a/docs/en/users/07_Frequently_Asked_Questions.md +++ b/docs/en/users/07_Frequently_Asked_Questions.md @@ -2,7 +2,7 @@ We may not have answered all of your questions in the previous sections. The FAQ ## What is `/i` at the end of the application URL? -Of course, ```/i``` has a purpose! It's used 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. * The ```./p/``` public root can be served without any HTTP access restrictions. Whereas it could be implemented in ```./p/i/```. @@ -13,7 +13,7 @@ Of course, ```/i``` has a purpose! It's used for performance and usability: 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](../admins/09_AccessControl.html), it's highly recommended to make only the public section available at the domain level. +As explained in the [security section](../admins/09_AccessControl.html), it’s 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. The same principle applies to `favicon.ico` and `.htaccess`. @@ -25,9 +25,9 @@ The feed syntax can be invalid, it can be unrecognized by the SimplePie library, 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'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. +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 can you change a forgotten password? @@ -44,7 +44,7 @@ For more information on that matter, please refer to the [dedicated documentatio ## Permissions under SELinux -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: +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(/.*)?' |
