aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/en
diff options
context:
space:
mode:
authorAlexandre Alapetite <alexandre@alapetite.fr>2019-10-01 18:12:21 +0200
committerGitHub <noreply@github.com>2019-10-01 18:12:21 +0200
commit37b52b7361d3ac15273ca19a0b96ef74299e759e (patch)
tree23ab272309a6e1ddc23bdd52ef4db130b11c6287 /docs/en
parent7ae4e9f159c9f0678d767dd29baa6cec8f0b04d8 (diff)
downloadfreshrss-37b52b7361d3ac15273ca19a0b96ef74299e759e.tar.gz
freshrss-37b52b7361d3ac15273ca19a0b96ef74299e759e.zip
Trim whitespace (#2544)
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/admins/02_Installation.md2
-rw-r--r--docs/en/admins/03_Updating.md4
-rw-r--r--docs/en/contributing.md2
-rw-r--r--docs/en/developers/01_First_steps.md42
-rw-r--r--docs/en/developers/03_Backend/05_Extensions.md110
-rw-r--r--docs/en/users/03_Main_view.md16
-rw-r--r--docs/en/users/05_Configuration.md2
-rw-r--r--docs/en/users/07_Frequently_Asked_Questions.md2
8 files changed, 90 insertions, 90 deletions
diff --git a/docs/en/admins/02_Installation.md b/docs/en/admins/02_Installation.md
index 446ef0dcf..7bba647ec 100644
--- a/docs/en/admins/02_Installation.md
+++ b/docs/en/admins/02_Installation.md
@@ -137,7 +137,7 @@ A step-by-step tutorial is available [in French](http://www.pihomeserver.fr/2013
# Security
-Make sure to expose only the `./p/` folder on the web, the other directories contain personal and sensitive data.
+Make sure to expose only the `./p/` folder on the web, the other directories contain personal and sensitive data.
See the Apache and nginx config examples above.
**TODO**
diff --git a/docs/en/admins/03_Updating.md b/docs/en/admins/03_Updating.md
index 4e1fdfa5d..461366049 100644
--- a/docs/en/admins/03_Updating.md
+++ b/docs/en/admins/03_Updating.md
@@ -15,7 +15,7 @@ The update process depends on your installation type, see below:
Change to your installation at http://localhost/FreshRSS/p/i/?c=update and hit the "Check for new updates" button.
-If there is a new version you will be prompted again.
+If there is a new version you will be prompted again.
## Using git
@@ -72,7 +72,7 @@ cd /usr/share/FreshRSS
```
Commands intended to be executed in order (you can c/p the whole block if desired):
-
+
```sh
wget https://github.com/FreshRSS/FreshRSS/archive/master.zip
unzip master.zip
diff --git a/docs/en/contributing.md b/docs/en/contributing.md
index 45c1650fb..870e0c14f 100644
--- a/docs/en/contributing.md
+++ b/docs/en/contributing.md
@@ -52,5 +52,5 @@ We are working on a better way to handle internationalization but don't hesitate
## Contribute to documentation
-The documentation needs a lot of improvements in order to be more useful to new contributors and we are working on it.
+The documentation needs a lot of improvements in order to be more useful to new contributors and we are working on it.
If you want to give some help, meet us in the main repositories [docs directory](https://github.com/FreshRSS/FreshRSS/tree/master/docs)!
diff --git a/docs/en/developers/01_First_steps.md b/docs/en/developers/01_First_steps.md
index 6b7f437a7..28c249be4 100644
--- a/docs/en/developers/01_First_steps.md
+++ b/docs/en/developers/01_First_steps.md
@@ -61,7 +61,7 @@ The `TAG` variable can be anything (e.g. `dev-local`). You can target a specific
# Extensions
-If you want to create your own FreshRSS extension, take a look at the [extension documentation](03_Backend/05_Extensions.md).
+If you want to create your own FreshRSS extension, take a look at the [extension documentation](03_Backend/05_Extensions.md).
# Coding style
@@ -110,7 +110,7 @@ There is a space before and after every operator.
```php
if ($a == 10) {
- // do something
+ // do something
}
echo $a ? 1 : 0;
@@ -122,11 +122,11 @@ There is no spaces in the brackets. There is no space before the opening bracket
```php
if ($a == 10) {
- // do something
+ // do something
}
if ((int)$a == 10) {
- // do something
+ // do something
}
```
@@ -137,16 +137,16 @@ It happens most of the time in Javascript files. When there is chained functions
```javascript
// First instruction
shortcut.add(shortcuts.mark_read, function () {
- //...
- }, {
- 'disable_in_input': true
- });
+ //...
+ }, {
+ 'disable_in_input': true
+ });
// Second instruction
shortcut.add("shift+" + shortcuts.mark_read, function () {
- //...
- }, {
- 'disable_in_input': true
- });
+ //...
+ }, {
+ 'disable_in_input': true
+ });
```
## Line length
@@ -158,7 +158,7 @@ With functions, parameters can be declared on different lines.
```php
function my_function($param_1, $param_2,
$param_3, $param_4) {
- // do something
+ // do something
}
```
@@ -173,7 +173,7 @@ They must follow the "snake case" convention.
```php
// a function
function function_name() {
- // do something
+ // do something
}
// a variable
$variable_name;
@@ -185,7 +185,7 @@ They must follow the "lower camel case" convention.
```php
private function methodName() {
- // do something
+ // do something
}
```
@@ -213,7 +213,7 @@ They must be at the end of the line if a condition runs on more than one line.
```php
if ($a == 10 ||
$a == 20) {
- // do something
+ // do something
}
```
@@ -226,9 +226,9 @@ If the file contains only PHP code, the PHP closing tag must be omitted.
If an array declaration runs on more than one line, each element must be followed by a comma even the last one.
```php
-$variable = array(
- "value 1",
- "value 2",
- "value 3",
-);
+$variable = [
+ "value 1",
+ "value 2",
+ "value 3",
+];
```
diff --git a/docs/en/developers/03_Backend/05_Extensions.md b/docs/en/developers/03_Backend/05_Extensions.md
index 7c1f8c046..0cfa5c8b7 100644
--- a/docs/en/developers/03_Backend/05_Extensions.md
+++ b/docs/en/developers/03_Backend/05_Extensions.md
@@ -48,13 +48,13 @@ Code example:
<?php
class FreshRSS_hello_Controller extends Minz_ActionController {
- public function indexAction() {
- $this->view->a_variable = 'FooBar';
- }
+ public function indexAction() {
+ $this->view->a_variable = 'FooBar';
+ }
- public function worldAction() {
- $this->view->a_variable = 'Hello World!';
- }
+ public function worldAction() {
+ $this->view->a_variable = 'Hello World!';
+ }
}
?>
@@ -74,7 +74,7 @@ As explained above, the views consist of HTML mixed with PHP. Code example:
```html
<p>
- This is a parameter passed from the controller: <?php echo $this->a_variable; ?>
+ This is a parameter passed from the controller: <?php echo $this->a_variable; ?>
</p>
```
@@ -119,7 +119,7 @@ To take full advantage of the Minz routing system, it is strongly discouraged to
```html
<p>
- Go to page <a href="http://example.com?c=hello&amp;a=world">Hello world</a>!
+ Go to page <a href="http://example.com?c=hello&amp;a=world">Hello world</a>!
</p>
```
@@ -130,13 +130,13 @@ So use the `Minz_Url` class and its `display()` method instead. `Minz_Url::displ
```php
<?php
-$url_array = array(
- 'c' => 'hello',
- 'a' => 'world',
- 'params' => array(
- 'foo' => 'bar',
- )
-);
+$url_array = [
+ 'c' => 'hello',
+ 'a' => 'world',
+ 'params' => [
+ 'foo' => 'bar',
+ ],
+];
// Show something like .?c=hello&amp;a=world&amp;foo=bar
echo Minz_Url::display($url_array);
@@ -166,10 +166,10 @@ Code example:
```php
<?php
-$url_array = array(
- 'c' => 'hello',
- 'a' => 'world'
-);
+$url_array = [
+ 'c' => 'hello',
+ 'a' => 'world',
+];
// Tells Minz to redirect the user to the hello / world page.
// Note that this is a redirection in the Minz sense of the term, not a redirection that the browser will have to manage (HTTP code 301 or 302)
@@ -188,10 +188,10 @@ It is very common to want display a message to the user while performing a redir
```php
<?php
-$url_array = array(
- 'c' => 'hello',
- 'a' => 'world'
-);
+$url_array = [
+ 'c' => 'hello',
+ 'a' => 'world',
+];
$feedback_good = 'Tout s\'est bien passé !';
$feedback_bad = 'Oups, quelque chose n\'a pas marché.';
@@ -226,18 +226,18 @@ The translation files are quite simple: it is only a matter of returning a PHP t
<?php
return array(
- 'action' => array(
- 'actualize' => 'Actualiser',
- 'back_to_rss_feeds' => '← Retour à vos flux RSS',
- 'cancel' => 'Annuler',
- 'create' => 'Créer',
- 'disable' => 'Désactiver',
- ),
- 'freshrss' => array(
- '_' => 'FreshRSS',
- 'about' => 'À propos de FreshRSS',
- ),
-);
+ 'action' => [
+ 'actualize' => 'Actualiser',
+ 'back_to_rss_feeds' => '← Retour à vos flux RSS',
+ 'cancel' => 'Annuler',
+ 'create' => 'Créer',
+ 'disable' => 'Désactiver',
+ ),
+ 'freshrss' => array(
+ '_' => 'FreshRSS',
+ 'about' => 'À propos de FreshRSS',
+ ),
+];
?>
```
@@ -247,9 +247,9 @@ Code example:
```html
<p>
- <a href="<?php echo _url('index', 'index'); ?>">
- <?php echo _t('gen.action.back_to_rss_feeds'); ?>
- </a>
+ <a href="<?php echo _url('index', 'index'); ?>">
+ <?php echo _t('gen.action.back_to_rss_feeds'); ?>
+ </a>
</p>
```
@@ -267,8 +267,8 @@ An extension allows you to add functionality easily to FreshRSS without having t
### Basic files and folders
-The first thing to note is that **all** extensions **must** be located in the `extensions` directory, at the base of the FreshRSS tree.
-An extension is a directory containing a set of mandatory (and optional) files and subdirectories.
+The first thing to note is that **all** extensions **must** be located in the `extensions` directory, at the base of the FreshRSS tree.
+An extension is a directory containing a set of mandatory (and optional) files and subdirectories.
The convention requires that the main directory name be preceded by an "x" to indicate that it is not an extension included by default in FreshRSS.
The main directory of an extension must contain at least two **mandatory** files:
@@ -276,16 +276,16 @@ The main directory of an extension must contain at least two **mandatory** files
- A `metadata.json` file that contains a description of the extension. This file is written in JSON.
- An `extension.php` file containing the entry point of the extension (which is a class that inherits Minz_Extension).
-Please note that there is a not a required link between the directory name of the extension and the name of the class inside `extension.php`,
-but you should follow our best practice:
+Please note that there is a not a required link between the directory name of the extension and the name of the class inside `extension.php`,
+but you should follow our best practice:
If you want to write a `HelloWorld` extension, the directory name should be `xExtension-HelloWorld` and the base class name `HelloWorldExtension`.
In the file `freshrss/extensions/xExtension-HelloWorld/extension.php` you need the structure:
```html
class HelloWorldExtension extends Minz_Extension {
- public function init() {
- // your code here
- }
+ public function init() {
+ // your code here
+ }
}
```
There is an example HelloWorld extension that you can download from [our GitHub repo](https://github.com/FreshRSS/xExtension-HelloWorld).
@@ -315,14 +315,14 @@ Only the `name` and` entrypoint` fields are required.
### Choose between « system » or « user »
-A __user__ extension can be enabled by some users and not by others (typically for user preferences).
+A __user__ extension can be enabled by some users and not by others (typically for user preferences).
A __system__ extension in comparison is enabled for every account.
### Writing your own extension.php
-This file is the entry point of your extension. It must contain a specific class to function.
-As mentioned above, the name of the class must be your `entrypoint` suffixed by` Extension` (`HelloWorldExtension` for example).
+This file is the entry point of your extension. It must contain a specific class to function.
+As mentioned above, the name of the class must be your `entrypoint` suffixed by` Extension` (`HelloWorldExtension` for example).
In addition, this class must be inherited from the `Minz_Extension` class to benefit from extensions-specific methods.
Your class will benefit from four methods to redefine:
@@ -351,13 +351,13 @@ You can register at the FreshRSS event system in an extensions `init()` method,
```html
class HelloWorldExtension extends Minz_Extension
{
- public function init() {
- $this->registerHook('entry_before_display', array($this, 'renderEntry'));
- }
- public function renderEntry($entry) {
- $entry->_content('<h1>Hello World</h1>' . $entry->content());
- return $entry;
- }
+ public function init() {
+ $this->registerHook('entry_before_display', array($this, 'renderEntry'));
+ }
+ public function renderEntry($entry) {
+ $entry->_content('<h1>Hello World</h1>' . $entry->content());
+ return $entry;
+ }
}
```
diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md
index 59d051e7e..c6c3e3b50 100644
--- a/docs/en/users/03_Main_view.md
+++ b/docs/en/users/03_Main_view.md
@@ -32,20 +32,20 @@ Here is an example to trigger article update every hour.
Special parameters to configure the script - all parameters can be combined:
-- Parameter "force"
-https://freshrss.example.net/i/?c=feed&a=actualize&force=1
+- Parameter "force"
+https://freshrss.example.net/i/?c=feed&a=actualize&force=1
If *force* is set to 1 all feeds will be refreshed at once.
-- Parameter "ajax"
-https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1
+- Parameter "ajax"
+https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1
Only a status site is returned and not a complete website. Example: "OK"
-- Parameter "maxFeeds"
-https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=30
+- Parameter "maxFeeds"
+https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=30
If *maxFeeds* is set the configured amount of feeds is refreshed at once. The default setting is "10".
-- Parameter "token"
-https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734
+- Parameter "token"
+https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734
Security parameter to prevent unauthorized refreshes. For detailed Documentation see "Form authentication".
### Online cron
diff --git a/docs/en/users/05_Configuration.md b/docs/en/users/05_Configuration.md
index 225c1e5f9..f635f9d5e 100644
--- a/docs/en/users/05_Configuration.md
+++ b/docs/en/users/05_Configuration.md
@@ -9,7 +9,7 @@ the missing bits or add a new language, please check how you can [contribute to
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.
-Available languages are: cz, de, en, es, fr, he, it, kr, nl, oc, pt-br, ru, tr, zh-cn.
+Available languages are: cz, de, en, es, fr, he, it, kr, nl, oc, pt-br, ru, tr, zh-cn.
## Theme
diff --git a/docs/en/users/07_Frequently_Asked_Questions.md b/docs/en/users/07_Frequently_Asked_Questions.md
index 42156b1a9..fd3db4bea 100644
--- a/docs/en/users/07_Frequently_Asked_Questions.md
+++ b/docs/en/users/07_Frequently_Asked_Questions.md
@@ -47,7 +47,7 @@ For more information on that matter, there is a [dedicated documentation](../../
## 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 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 :
```sh
semanage fcontext -a -t httpd_sys_rw_content_t '/usr/share/FreshRSS/data(/.*)?'
restorecon -Rv /usr/share/FreshRSS/data