aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/en/index.rst1
-rw-r--r--docs/en/user/filters.rst49
-rw-r--r--docs/en/user/installation.rst4
-rw-r--r--docs/fr/user/configuration.rst32
-rw-r--r--docs/fr/user/create_account.rst6
-rw-r--r--docs/fr/user/download_articles.rst4
-rw-r--r--docs/fr/user/errors_during_fetching.rst2
-rw-r--r--docs/fr/user/filters.rst48
-rw-r--r--docs/fr/user/first_article.rst2
-rw-r--r--docs/fr/user/import.rst6
-rw-r--r--docs/fr/user/installation.rst2
-rw-r--r--docs/fr/user/login.rst2
-rw-r--r--docs/img/user/filters.pngbin0 -> 28654 bytes
13 files changed, 127 insertions, 31 deletions
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 54d79e0c..3367c8a9 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -44,3 +44,4 @@ The main documentation for this application is organized into a couple sections:
44 developer/docker 44 developer/docker
45 developer/translate 45 developer/translate
46 developer/maintenance 46 developer/maintenance
47 developer/releasing
diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst
index 65fdedcb..ad06819b 100644
--- a/docs/en/user/filters.rst
+++ b/docs/en/user/filters.rst
@@ -1,2 +1,49 @@
1Filters 1Filters
2======= \ No newline at end of file 2=======
3
4To retrieve articles easier, you can use filters.
5Click on the third icon in the top bar.
6
7.. image:: ../../img/user/topbar.png
8 :alt: Top bar
9 :align: center
10
11All these filters can be combined.
12
13.. image:: ../../img/user/filters.png
14 :alt: Combine all filters
15 :align: center
16
17Status
18------
19
20Use these checkboxes to find archived or starred articles.
21
22Preview picture
23---------------
24
25Check this filter if you want to retrieve articles with a preview picture.
26
27Language
28--------
29
30wallabag (via graby) can detect article language. It's easy to you to retrieve articles
31written in a specific language.
32
33Reading time
34------------
35
36wallabag estimates how many time you need to read an article. With this filter,
37you can for example find the articles with a reading time between 2 and 5 minutes.
38
39Domain name
40-----------
41
42Thanks to this filter, you can retrieve the articles from the same domain name.
43For example, in this field, type ``bbc.co.uk`` to retrieve the articles of this website.
44
45Creation date
46-------------
47
48When you save an article, wallabag stored the current date. So handful to retrieve articles written
49between 1st and 31th January for example.
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 760fd4d2..385d6595 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -11,7 +11,7 @@ You'll need the following extensions for wallabag to work. Some of these may alr
11- php-session 11- php-session
12- php-ctype 12- php-ctype
13- php-dom 13- php-dom
14- pĥp-hash 14- php-hash
15- php-simplexml 15- php-simplexml
16- php-json 16- php-json
17- php-gd 17- php-gd
@@ -48,7 +48,7 @@ To install wallabag itself, you must run these two commands:
48 48
49:: 49::
50 50
51 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev 51 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.0-beta.1" --no-dev
52 php bin/console wallabag:install --env=prod 52 php bin/console wallabag:install --env=prod
53 53
54To start php's build-in server and test if everything did install correctly, you can do: 54To start php's build-in server and test if everything did install correctly, you can do:
diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst
index f8bb6d42..ee5be052 100644
--- a/docs/fr/user/configuration.rst
+++ b/docs/fr/user/configuration.rst
@@ -1,9 +1,9 @@
1Configuration 1Configuration
2============= 2=============
3 3
4Maintenant que vous êtes connecté, il est temps de confirurer votre compte. 4Maintenant que vous êtes connecté, il est temps de configurer votre compte.
5 5
6Cliquez sur le menu ``Configuration``. Vous avez accès à 5 onglets: 6Cliquez sur le menu ``Configuration``. Vous avez accès à 5 onglets :
7``Paramètres``, ``RSS``, ``Mon compte``, ``Mot de passe`` and ``Règles de tag automatiques``. 7``Paramètres``, ``RSS``, ``Mon compte``, ``Mot de passe`` and ``Règles de tag automatiques``.
8 8
9Paramètres 9Paramètres
@@ -14,7 +14,7 @@ Thème
14 14
15L'affichage de wallabag est personnalisable. C'est ici que vous choisissez le thème 15L'affichage de wallabag est personnalisable. C'est ici que vous choisissez le thème
16que vous préférez. Vous pouvez aussi en créer un nouveau, une documentation sera 16que vous préférez. Vous pouvez aussi en créer un nouveau, une documentation sera
17disponible pour apprendre comment. Le thème par défaut ``Material``, c'est ce thème 17disponible pour guider. Le thème par défaut est ``Material``, c'est celui
18qui est utilisé dans les captures d'écran de la documentation. 18qui est utilisé dans les captures d'écran de la documentation.
19 19
20Nombre d'articles par page 20Nombre d'articles par page
@@ -31,12 +31,12 @@ pour que la nouvelle langue soit prise en compte.
31RSS 31RSS
32--- 32---
33 33
34wallabag propose un flux RSS for chaque statut d'article : non lus, favoris and lus. 34wallabag propose un flux RSS pour chaque statut d'article : non lus, favoris et lus.
35 35
36Tout d'abord, vous devez vous créer un jeton personnel : cliquez sur ``Créez votre jeton``. 36Tout d'abord, vous devez vous créer un jeton personnel : cliquez sur ``Créez votre jeton``.
37C'est possible de regénérer votre jeton en cliquant sur ``Réinitialisez votre jeton``. 37Il est possible de regénérer votre jeton en cliquant sur ``Réinitialisez votre jeton``.
38 38
39Vous avez maintenant trois liens, un par statut : ajoutez les dans votre agrégateur de flux RSS préféré. 39Vous avez maintenant trois liens, un par statut : ajoutez-les dans votre agrégateur de flux RSS préféré.
40 40
41Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS 41Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS
42(50 est la valeur par défaut). 42(50 est la valeur par défaut).
@@ -49,16 +49,16 @@ Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double a
49Double authentification (2FA) 49Double authentification (2FA)
50~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 50~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51 51
52 Two-factor authentication (also known as 2FA) is a technology patented in 52 L'authentification à deux facteurs (également appelée 2FA) est une technologie brevetée en 1984
53 1984 that provides identification of users by means of the combination of two different components. 53 qui fournit l'identification des utilisateurs au moyen de la combinaison de deux composants différents .
54 54
55https://en.wikipedia.org/wiki/Two-factor_authentication 55https://fr.wikipedia.org/wiki/Authentification_forte
56 56
57Si vous activer 2FA, à chaque tentative de connexion à wallabag, vous recevrez 57Si vous activez 2FA, à chaque tentative de connexion à wallabag, vous recevrez
58un code par email. Vous devez renseigner ce code dans le formulaire suivant : 58un code par email. Vous devez renseigner ce code dans le formulaire suivant :
59 59
60.. image:: ../../img/user/2FA_form.png 60.. image:: ../../img/user/2FA_form.png
61 :alt: Two factor authentication 61 :alt: Authentification à deux facteurs
62 :align: center 62 :align: center
63 63
64Si vous ne souhaitez pas recevoir un code à chaque fois que vous vous connectez, 64Si vous ne souhaitez pas recevoir un code à chaque fois que vous vous connectez,
@@ -89,15 +89,15 @@ Comment les utiliser ?
89 89
90Admettons que vous voulez ajouter comme tag *« lecture rapide »* quand le temps de lecture 90Admettons que vous voulez ajouter comme tag *« lecture rapide »* quand le temps de lecture
91d'un article est inférieur à 3 minutes. 91d'un article est inférieur à 3 minutes.
92Dans ce cas, vous devez ajouter « readingTime <= 3 » dans le champ **Règle** et *« lecture rapide »* dans le champ **Tags**. 92Dans ce cas, vous devez ajouter « readingTime <= 3 » dans le champ **Règle** et *« lecture rapide »* dans le champ **Tags**.
93Plusieurs tags peuvent être ajoutés en même temps en les séparant par une virgule : *« lecture rapide, à lire »*. 93Plusieurs tags peuvent être ajoutés en même temps en les séparant par une virgule : *« lecture rapide, à lire »*.
94Des règles complexes peuvent être écrites en utilisant les opérateurs pré-définis : 94Des règles complexes peuvent être écrites en utilisant les opérateurs pré-définis :
95if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. 95if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*.
96 96
97Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? 97Quels variables et opérateurs puis-je utiliser pour écrire mes règles ?
98~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 98~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99 99
100Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles : 100Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles :
101 101
102=========== ============================================== ========== ========== 102=========== ============================================== ========== ==========
103Variable Sens Opérateur Sens 103Variable Sens Opérateur Sens
@@ -110,5 +110,5 @@ content Le contenu de l'article = Égal Ã
110language La langue de l'article != Différent de … 110language La langue de l'article != Différent de …
111mimetype The type MIME de l'article OR Telle règle ou telle autre règle 111mimetype The type MIME de l'article OR Telle règle ou telle autre règle
112readingTime Le temps de lecture de l'article, en minutes AND Telle règle et telle règle 112readingTime Le temps de lecture de l'article, en minutes AND Telle règle et telle règle
113domainName Le nom de domaine de l'article matches Contient telle chaine de caractère (insensible à la casse). Exemple : title matches "football" 113domainName Le nom de domaine de l'article matches Contient telle chaîne de caractère (insensible à la casse). Exemple : title matches "football"
114=========== ============================================== ========== ========== 114=========== ============================================== ========== ==========
diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst
index 4fc98069..7f29b0f0 100644
--- a/docs/fr/user/create_account.rst
+++ b/docs/fr/user/create_account.rst
@@ -4,14 +4,14 @@ Se créer un compte
4Sur la page de connexion, cliquez sur le bouton ``Créer un compte``. 4Sur la page de connexion, cliquez sur le bouton ``Créer un compte``.
5 5
6.. image:: ../../img/user/registration_form.png 6.. image:: ../../img/user/registration_form.png
7 :alt: Registration form 7 :alt: Formulaire de création de compte
8 :align: center 8 :align: center
9 9
10Vous devez renseigner le formulaire. Faites attention de bien renseigner une adresse 10Vous devez renseigner le formulaire. Faites attention de bien renseigner une adresse
11email valide, nous allons vous envoyer un email d'activation. 11email valide, nous allons vous envoyer un email d'activation.
12 12
13.. image:: ../../img/user/sent_email.png 13.. image:: ../../img/user/sent_email.png
14 :alt: Email was sent to activate account 14 :alt: Un email a été envoyé pour activer votre compte
15 :align: center 15 :align: center
16 16
17Vérifiez votre boite de réception, vous avez un nouvel email avec un lien comme celui-ci 17Vérifiez votre boite de réception, vous avez un nouvel email avec un lien comme celui-ci
@@ -21,7 +21,7 @@ Cliquez dessus pour activer votre compte.
21Votre compte est maintenant actif. 21Votre compte est maintenant actif.
22 22
23.. image:: ../../img/user/activated_account.png 23.. image:: ../../img/user/activated_account.png
24 :alt: Welcome on board! 24 :alt: Bienvenue à bord !
25 :align: center 25 :align: center
26 26
27Foire aux questions 27Foire aux questions
diff --git a/docs/fr/user/download_articles.rst b/docs/fr/user/download_articles.rst
index dafeba37..39c98206 100644
--- a/docs/fr/user/download_articles.rst
+++ b/docs/fr/user/download_articles.rst
@@ -6,12 +6,12 @@ Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PD
6Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale : 6Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale :
7 7
8.. image:: ../../img/user/download_article.png 8.. image:: ../../img/user/download_article.png
9 :alt: download article 9 :alt: Télécharger l'article
10 :align: center 10 :align: center
11 11
12Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats. 12Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats.
13Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure : 13Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure :
14 14
15.. image:: ../../img/user/download_articles.png 15.. image:: ../../img/user/download_articles.png
16 :alt: download articles 16 :alt: Télécharger l'article
17 :align: center 17 :align: center
diff --git a/docs/fr/user/errors_during_fetching.rst b/docs/fr/user/errors_during_fetching.rst
index b20e5973..34a6ce18 100644
--- a/docs/fr/user/errors_during_fetching.rst
+++ b/docs/fr/user/errors_during_fetching.rst
@@ -23,5 +23,5 @@ Si wallabag échoue en récupérant l'article, vous pouvez cliquer sur le bouton
23(le troisième sur l'image ci-dessous). 23(le troisième sur l'image ci-dessous).
24 24
25.. image:: ../../img/user/refetch.png 25.. image:: ../../img/user/refetch.png
26 :alt: Refetch content 26 :alt: Réessayer de récupérer le contenu
27 :align: center 27 :align: center
diff --git a/docs/fr/user/filters.rst b/docs/fr/user/filters.rst
index ecb29948..6592f140 100644
--- a/docs/fr/user/filters.rst
+++ b/docs/fr/user/filters.rst
@@ -1,2 +1,50 @@
1Filtres 1Filtres
2======= 2=======
3
4Pour retrouver plus facilement vos articles, vous pouvez utiliser les filtres.
5Cliquez sur la troisième icône de la barre supérieure.
6
7.. image:: ../../img/user/topbar.png
8 :alt: Barre supérieure
9 :align: center
10
11Tous ces filtres peuvent être combinés.
12
13.. image:: ../../img/user/filters.png
14 :alt: Combine all filters
15 :align: center
16
17Statut
18------
19
20Utilisez ces cases à cocher pour retrouver les articles lus ou mis en favori.
21
22Image de prévisualisation
23-------------------------
24
25Cochez ce filtre si vous voulez retrouver les articles avec une image de prévisualisation.
26
27Langage
28-------
29
30wallabag (via graby) peut détecter la langue dans laquelle l'article est écrit.
31C'est ainsi facile pour vous de retrouver des articles écrits dans une langue spécifique.
32
33Temps de lecture
34----------------
35
36wallabag estime combien de temps vous avez besoin pour lire un article.
37Avec ce filtre, vous pouvez par exemple retrouver les articles qui ont une estimation
38entre 2 et 5 minutes.
39
40Nom de domaine
41--------------
42
43Grâce à ce filtre, vous pouvez retrouver les articles venant d'un même nom de domaine.
44Par exemple, dans ce champ, saisissez ``lemonde.fr`` pour retrouver les articles de ce site.
45
46Date de création
47----------------
48
49Quand vous ajoutez un article, wallabag stocke la date courante.
50C'est très pratique pour retrouver les articles ajoutés entre le 1er et le 31 janvier par exemple.
diff --git a/docs/fr/user/first_article.rst b/docs/fr/user/first_article.rst
index 90c45a44..f482badc 100644
--- a/docs/fr/user/first_article.rst
+++ b/docs/fr/user/first_article.rst
@@ -25,7 +25,7 @@ Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icôn
25un signe plus, vous pouvez facilement ajouter un nouvel article. 25un signe plus, vous pouvez facilement ajouter un nouvel article.
26 26
27.. image:: ../../img/user/topbar.png 27.. image:: ../../img/user/topbar.png
28 :alt: Top bar 28 :alt: Barre supérieure
29 :align: center 29 :align: center
30 30
31Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez 31Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst
index c95f175d..967df1f6 100644
--- a/docs/fr/user/import.rst
+++ b/docs/fr/user/import.rst
@@ -10,7 +10,7 @@ Exportez vos données de wallabag 1.x
10Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``. 10Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``.
11 11
12.. image:: ../../img/user/export_wllbg_1.png 12.. image:: ../../img/user/export_wllbg_1.png
13 :alt: Export from wallabag 1.x 13 :alt: Export depuis wallabag 1.x
14 :align: center 14 :align: center
15 15
16Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``. 16Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``.
@@ -21,7 +21,7 @@ Exportez vos données de wallabag 2.x
21Dans la barre latérale de téléchargement, cliquez sur ``JSON``. 21Dans la barre latérale de téléchargement, cliquez sur ``JSON``.
22 22
23.. image:: ../../img/user/export_wllbg_2.png 23.. image:: ../../img/user/export_wllbg_2.png
24 :alt: Export from wallabag 2.x 24 :alt: Export depuis wallabag 2.x
25 :align: center 25 :align: center
26 26
27Vous obtiendrez un fichier ``Unread articles.json``. 27Vous obtiendrez un fichier ``Unread articles.json``.
@@ -33,7 +33,7 @@ Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag
33sélectionnez votre fichier d'export sur votre ordinateur et importez-le. 33sélectionnez votre fichier d'export sur votre ordinateur et importez-le.
34 34
35.. image:: ../../img/user/import_wllbg.png 35.. image:: ../../img/user/import_wllbg.png
36 :alt: Import from wallabag 1.x 36 :alt: Import depuis wallabag 1.x
37 :align: center 37 :align: center
38 38
39Tous vos articles wallabag seront importés. 39Tous vos articles wallabag seront importés.
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index e4ff49ce..a2a5dabf 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -46,7 +46,7 @@ Pour installer wallabag, vous devez exécuter ces deux commandes :
46 46
47:: 47::
48 48
49 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev 49 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.0-beta.1" --no-dev
50 php bin/console wallabag:install --env=prod 50 php bin/console wallabag:install --env=prod
51 51
52Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : 52Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
diff --git a/docs/fr/user/login.rst b/docs/fr/user/login.rst
index 7ef70569..3a02d1d5 100644
--- a/docs/fr/user/login.rst
+++ b/docs/fr/user/login.rst
@@ -9,7 +9,7 @@ Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connec
9vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an. 9vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an.
10 10
11.. image:: ../../img/user/login_form.png 11.. image:: ../../img/user/login_form.png
12 :alt: Login form 12 :alt: Formulaire de connexion
13 :align: center 13 :align: center
14 14
15Foire aux questions 15Foire aux questions
diff --git a/docs/img/user/filters.png b/docs/img/user/filters.png
new file mode 100644
index 00000000..1e566bd3
--- /dev/null
+++ b/docs/img/user/filters.png
Binary files differ