aboutsummaryrefslogtreecommitdiff
path: root/docs/en/users/05_Configuration.md
diff options
context:
space:
mode:
authorGravatar Frans de Jonge <fransdejonge@gmail.com> 2019-12-03 22:37:40 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2019-12-03 22:37:40 +0100
commit705318aa39a605a4d869db588f6cffb12019a611 (patch)
tree36383dfee24999f9928957621b655e67b20714b7 /docs/en/users/05_Configuration.md
parent0de7e84380dff5222e6728aacbbb42abaac51dd9 (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/05_Configuration.md')
-rw-r--r--docs/en/users/05_Configuration.md62
1 files changed, 31 insertions, 31 deletions
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.
![Article icons configuration](../img/users/configuration.article.icons.png)
@@ -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.
![Sharing configuration](../img/users/configuration.sharing.png)
-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