aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/fr
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-02-20 10:13:48 +0100
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-02-20 10:13:48 +0100
commitc90f8036ef2e6dc3e4b485471dbf75677db90d04 (patch)
tree624db5223c2de49d3f199c7cb78d14b7e8cd4b01 /docs/fr
parent0cde91cc6f42497844866d7631b8f28e024af965 (diff)
parent8b197f27d857f7e1f7f45b2eb9e793650a664fc0 (diff)
downloadwallabag-c90f8036ef2e6dc3e4b485471dbf75677db90d04.tar.gz
wallabag-c90f8036ef2e6dc3e4b485471dbf75677db90d04.tar.zst
wallabag-c90f8036ef2e6dc3e4b485471dbf75677db90d04.zip
Merge pull request #1705 from wallabag/v2-french-doc
French translation for documentation
Diffstat (limited to 'docs/fr')
-rw-r--r--docs/fr/developer/docker.rst50
-rw-r--r--docs/fr/developer/translate.rst62
-rw-r--r--docs/fr/index.rst28
-rw-r--r--docs/fr/user/configuration.rst114
-rw-r--r--docs/fr/user/create_account.rst46
-rw-r--r--docs/fr/user/download_articles.rst17
-rw-r--r--docs/fr/user/filters.rst2
-rw-r--r--docs/fr/user/first_article.rst68
-rw-r--r--docs/fr/user/import.rst83
-rw-r--r--docs/fr/user/login.rst23
-rw-r--r--docs/fr/user/tags.rst2
11 files changed, 494 insertions, 1 deletions
diff --git a/docs/fr/developer/docker.rst b/docs/fr/developer/docker.rst
new file mode 100644
index 00000000..73cb56be
--- /dev/null
+++ b/docs/fr/developer/docker.rst
@@ -0,0 +1,50 @@
1Exécuter wallabag avec docker-compose
2=====================================
3
4Pour faire tourner votre propre instance de développement de wallabag, vous pouvez
5utiliser les fichiers docker pré-configurés.
6
7Pré-requis
8----------
9
10Soyez sur d'avoir `Docker
11<https://docs.docker.com/installation/ubuntulinux/>`__ et `Docker
12Compose <https://docs.docker.com/compose/install/>`__ installés et à jour sur votre
13système.
14
15Changer de SGBD
16---------------
17
18Par défaut, wallabag fonctionne avec une base de données SQLite.
19Depuis que wallabag supporte Postgresql et MySQL, les conteneurs Docker sont
20aussi disponibles pour ces SGBD.
21
22Dans ``docker-compose.yml``, en fonction de votre SGBD, décommentez :
23
24- la définition du conteneur (le block racine ``postgres`` ou ``mariadb``)
25- le conteneur ``links`` dans le conteneur ``php``
26- le conteneur ``env_file`` dans le conteneur ``php``
27
28Pour que les commandes Symfony (par exemple ``wallabag:install``) continuent de
29fonctionner sur votre système, vous devez aussi :
30
31- charger le bon fichier d'environnement dans votre ligne de commandes (``source``),
32pour que les variables comme ``SYMFONY__ENV__DATABASE_HOST`` existent.
33- ajouter une ligne ``127.0.0.1 rdbms`` dans votre fichier ``hosts``
34
35Exécuter wallabag
36-----------------
37
38#. Forker et cloner le projet
39#. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*``
40 par les lignes commentées (celles avec des valeurs préfixées par ``env.``)
41#. ``composer install`` pour installer les dépendances
42#. ``php app/console wallabag:install`` pour créer le schéma de la BDD
43#. ``docker-compose up`` pour démarrer les conteneurs
44#. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation
45 tout propre de wallabag.
46
47Il est possible de rencontrer des problèmes de droits UNIX, de mauvais chemins
48dans les fichiers de cache, etc…
49Les opérations comme vider le cache ou restaurer les permissions des fichiers
50peuvent être fréquemment nécessaires, n'ayez crainte !
diff --git a/docs/fr/developer/translate.rst b/docs/fr/developer/translate.rst
new file mode 100644
index 00000000..87e78cb4
--- /dev/null
+++ b/docs/fr/developer/translate.rst
@@ -0,0 +1,62 @@
1Traduire wallabag
2=================
3
4L'application web
5-----------------
6
7Fichiers de traductions
8~~~~~~~~~~~~~~~~~~~~~~~
9
10.. note::
11
12 Comme wallabag est principalement dévelopée par une équipe française, c'est
13 cette traduction qui est considérée comme la plus récente. Merci de vous baser
14 sur celle-ci pour créer votre traduction.
15
16Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
17
18Vous devez créer les fichiers ``messages.CODE.yml`` et ``validators.CODE.yml``,
19où CODE est le code ISO 639-1 de votre langue (`cf wikipedia <https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1>`__).
20
21Autres fichiers à traduire :
22
23- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
24- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations.
25
26Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``.
27
28Fichier de configuration
29~~~~~~~~~~~~~~~~~~~~~~~~
30
31Vous devez éditer `app/config/config.yml
32<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ pour
33afficher votre langue dans la page Configuration de wallabag (pour permettre aux
34utilisateurs de choisir cette nouvelle traduction).
35
36Dans la section ``wallabag_core.languages``, vous devez ajouter une nouvelle ligne
37avec votre traduction. Par exemple :
38
39::
40
41 wallabag_core:
42 ...
43 languages:
44 en: 'English'
45 fr: 'Français'
46
47
48Pour la première colonne (``en``, ``fr``, etc.), vous devez ajouter le code ISO 639-1
49de votre langue (voir ci-dessus).
50
51Pour la seconde colonne, c'est juste le nom de votre langue.
52
53Documentation de wallabag
54-------------------------
55
56.. note::
57
58 Contrairement à l'application, la langue principale de la documentation est l'anglais
59
60Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/docs
61
62Vous devez respecter la structure du dossier ``en`` quand vous crééz votre traduction.
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 31c7bd3a..d4ff7296 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -9,9 +9,35 @@ Documentation de wallabag
9simplement d’archiver une page web en ne conservant que le contenu. Les 9simplement d’archiver une page web en ne conservant que le contenu. Les
10éléments superflus (menu, publicité, etc.) sont supprimés. 10éléments superflus (menu, publicité, etc.) sont supprimés.
11 11
12.. note::
13
14 Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici <https://github.com/wallabag/documentation>`__.
15
12La documentation principale de cette application est découpée en plusieurs sections : 16La documentation principale de cette application est découpée en plusieurs sections :
13 17
18* :ref:`user-docs`
19* :ref:`dev-docs`
20
21.. _user-docs:
22
23.. toctree::
24 :maxdepth: 2
25 :caption: Documentation utilisateur
26
27 user/create_account
28 user/login
29 user/configuration
30 user/first_article
31 user/import
32 user/download_articles
33 user/filters
34 user/tags
35
36.. _dev-docs:
37
14.. toctree:: 38.. toctree::
15 :maxdepth: 2 39 :maxdepth: 2
40 :caption: Documentation développeur
16 41
17 index 42 developer/docker
43 developer/translate
diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst
new file mode 100644
index 00000000..f8bb6d42
--- /dev/null
+++ b/docs/fr/user/configuration.rst
@@ -0,0 +1,114 @@
1Configuration
2=============
3
4Maintenant que vous êtes connecté, il est temps de confirurer votre compte.
5
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``.
8
9Paramètres
10----------
11
12Thème
13~~~~~
14
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
17disponible pour apprendre comment. Le thème par défaut ``Material``, c'est ce thème
18qui est utilisé dans les captures d'écran de la documentation.
19
20Nombre d'articles par page
21~~~~~~~~~~~~~~~~~~~~~~~~~~
22
23Vous pouvez définir le nombre d'articles affichés sur chaque page.
24
25Langue
26~~~~~~
27
28Vous pouvez définir la langue de l'interface de wallabag. Vous devrez vous déconnecter
29pour que la nouvelle langue soit prise en compte.
30
31RSS
32---
33
34wallabag propose un flux RSS for chaque statut d'article : non lus, favoris and lus.
35
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``.
38
39Vous avez maintenant trois liens, un par statut : ajoutez les dans votre agrégateur de flux RSS préféré.
40
41Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS
42(50 est la valeur par défaut).
43
44Mon compte
45----------
46
47Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``.
48
49Double authentification (2FA)
50~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51
52 Two-factor authentication (also known as 2FA) is a technology patented in
53 1984 that provides identification of users by means of the combination of two different components.
54
55https://en.wikipedia.org/wiki/Two-factor_authentication
56
57Si vous activer 2FA, à chaque tentative de connexion à wallabag, vous recevrez
58un code par email. Vous devez renseigner ce code dans le formulaire suivant :
59
60.. image:: ../../img/user/2FA_form.png
61 :alt: Two factor authentication
62 :align: center
63
64Si vous ne souhaitez pas recevoir un code à chaque fois que vous vous connectez,
65vous pouvez cocher la case ``Je suis sur un ordinateur de confiance`` : wallabag
66se souviendra de vous pour 15 jours.
67
68Mot de passe
69------------
70
71Vous pouvez changer de mot de passe ici (8 caractères minimum).
72
73Règles de tag automatiques
74--------------------------
75
76Si vous voulez automatiquement assigner un tag à de nouveaux articles en fonction de
77certains critères, cette partie de la configuration est pour vous.
78
79Que veut dire « règles de tag automatiques » ?
80~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81
82Ce sont des règles utilisées par wallabag pour automatiquement assigner un tag
83à un nouvel article.
84À chaque fois que vous ajoutez un nouvel article, toutes les règles sont utilisées pour ajouter
85les tags que vous avez configurés, vous épargnant ainsi la peine de classer manuellement vos articles.
86
87Comment les utiliser ?
88~~~~~~~~~~~~~~~~~~~~~~
89
90Admettons que vous voulez ajouter comme tag *« lecture rapide »* quand le temps de lecture
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**.
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 :
95if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*.
96
97Quels variables et opérateurs puis-je utiliser pour écrire mes règles ?
98~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99
100Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles :
101
102=========== ============================================== ========== ==========
103Variable Sens Opérateur Sens
104----------- ---------------------------------------------- ---------- ----------
105title Titre de l'article <= Inférieur ou égal à …
106url URL de l'article < Strictement inférieur à …
107isArchived Si l'article est archivé ou non => Supérieur ou égal à …
108isStared Si l'article est en favori ou non > Strictement supérieur à …
109content Le contenu de l'article = Égal à …
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
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"
114=========== ============================================== ========== ==========
diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst
new file mode 100644
index 00000000..7fea6edf
--- /dev/null
+++ b/docs/fr/user/create_account.rst
@@ -0,0 +1,46 @@
1Se créer un compte
2==================
3
4Sur la page de connexion, cliquez sur le bouton ``Créer un compte``.
5
6.. image:: ../../img/user/registration_form.png
7 :alt: Registration form
8 :align: center
9
10Vous devez renseigner le formulaire. Faites attention de bien renseigner une adresse
11email valide, nous allons vous envoyer un email d'activation.
12
13.. image:: ../../img/user/sent_email.png
14 :alt: Email was sent to activate account
15 :align: center
16
17Vérifiez votre boite de réception, vous avez un nouvel email avec un lien comme celui-ci
18``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``.
19Cliquez dessus pour activer votre compte.
20
21Votre compte est maintenant actif.
22
23.. image:: ../../img/user/activated_account.png
24 :alt: Welcome on board!
25 :align: center
26
27Foire aux questions
28-------------------
29
30Je ne veux pas valider le formulaire de création de compte
31~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32
33Soyez sur d'avoir bien renseigné tous les champs :
34
35* une adresse email valide
36* le même mot de passe dans les deux champs
37
38Je n'ai pas reçu mon email d'activation
39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40
41Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ?
42
43Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
46Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte.
diff --git a/docs/fr/user/download_articles.rst b/docs/fr/user/download_articles.rst
new file mode 100644
index 00000000..dafeba37
--- /dev/null
+++ b/docs/fr/user/download_articles.rst
@@ -0,0 +1,17 @@
1Télécharger des articles
2========================
3
4Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PDF, XML, JSON, CSV.
5
6Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale :
7
8.. image:: ../../img/user/download_article.png
9 :alt: download article
10 :align: center
11
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 :
14
15.. image:: ../../img/user/download_articles.png
16 :alt: download articles
17 :align: center
diff --git a/docs/fr/user/filters.rst b/docs/fr/user/filters.rst
new file mode 100644
index 00000000..ecb29948
--- /dev/null
+++ b/docs/fr/user/filters.rst
@@ -0,0 +1,2 @@
1Filtres
2=======
diff --git a/docs/fr/user/first_article.rst b/docs/fr/user/first_article.rst
new file mode 100644
index 00000000..90c45a44
--- /dev/null
+++ b/docs/fr/user/first_article.rst
@@ -0,0 +1,68 @@
1Sauvegardez votre premier article
2=================================
3
4La fonctionnalité principale de wallabag est de sauvegarder des articles.
5Vous avez plusieurs manières de le faire.
6
7.. note::
8
9 Un guide de démarrage s'affichera dans l'application jusqu'à ce que vous
10 enregistriez votre premier article.
11
12En utilisant le bookmarklet
13---------------------------
14
15Sur la page ``Aide``, vous avez un onglet ``Bookmarklet``. Glissez/déposez le lien ``bag it!``
16dans votre barre de favoris de votre navigateur.
17
18Maintennat, à chaque fois que vous lisez un article et que vous souhaitez le sauvegarder,
19cliquez sur le lien ``bag it!`` dans votre barre de favoris. L'article est enregistré.
20
21En utilisant le formulaire classique
22------------------------------------
23
24Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icône,
25un signe plus, vous pouvez facilement ajouter un nouvel article.
26
27.. image:: ../../img/user/topbar.png
28 :alt: Top bar
29 :align: center
30
31Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez
32sur la touche ``Entrée``. L'article est enregistré.
33
34En utilisant l'extension de votre navigateur
35--------------------------------------------
36
37Firefox
38~~~~~~~
39
40*Cette extension n'est pas encore disponible pour wallabag v2*.
41
42Chrome
43~~~~~~
44
45*Cette extension n'est pas encore disponible pour wallabag v2*.
46
47En utilisant l'application de votre smartphone
48----------------------------------------------
49
50Android
51~~~~~~~
52
53*Cette application n'est pas encore disponible pour wallabag v2*.
54
55Firefox OS
56~~~~~~~~~~
57
58*Cette application n'est pas encore disponible pour wallabag v2*.
59
60Windows Phone
61~~~~~~~~~~~~~
62
63*Cette application n'est pas encore disponible pour wallabag v2*.
64
65iOS
66~~~
67
68*Cette application n'est pas encore disponible pour wallabag v2*.
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst
new file mode 100644
index 00000000..c95f175d
--- /dev/null
+++ b/docs/fr/user/import.rst
@@ -0,0 +1,83 @@
1Migrer à wallabag
2=================
3
4Depuis wallabag
5---------------
6
7Exportez vos données de wallabag 1.x
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9
10Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``.
11
12.. image:: ../../img/user/export_wllbg_1.png
13 :alt: Export from wallabag 1.x
14 :align: center
15
16Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``.
17
18Exportez vos données de wallabag 2.x
19~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
21Dans la barre latérale de téléchargement, cliquez sur ``JSON``.
22
23.. image:: ../../img/user/export_wllbg_2.png
24 :alt: Export from wallabag 2.x
25 :align: center
26
27Vous obtiendrez un fichier ``Unread articles.json``.
28
29Importez vos données wallabag 2.x
30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31
32Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag correspondante,
33sélectionnez votre fichier d'export sur votre ordinateur et importez-le.
34
35.. image:: ../../img/user/import_wllbg.png
36 :alt: Import from wallabag 1.x
37 :align: center
38
39Tous vos articles wallabag seront importés.
40
41Depuis Pocket
42-------------
43
44Créer une nouvelle application dans Pocket
45~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46
47Pour importer vos données depuis Pocket, nous utilisons l'API de Pocket.
48Vous devez créer une nouvelle application sur leur site dédié aux développeurs pour continuer.
49
50* Créez une nouvelle application `sur leur site Développeurs <https://getpocket.com/developer/apps/new>`_
51* Remplissez les champs requis : nom de l'application, description de l'application,
52 permissions (seulement **retrieve**), la plateforme (**web**), acceptez les
53 termes d'utilisation du service et soumettez votre application
54
55Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`).
56Vous devez configurer la ``pocket_consumer_key`` dans le fichier ``app/config/parameters.yml``.
57
58Maintenant, tout est bien configuré pour migrer depuis Pocket.
59
60Importez vos données dans wallabag 2.x
61~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
62
63Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans
64la section Pocket puis sur ``Se connecter à Pocket et importer les données``.
65
66Vous devez autoriser wallabag à se connecter à votre compte Pocket.
67Vos données vont être importées. L'import de données est une action qui peut être couteuse
68pour votre serveur (nous devons encore travailler pour améliorer cet import).
69
70Depuis Instapaper
71-----------------
72
73*Fonctionnalité pas encore implémentée dans wallabag v2.*
74
75Depuis Readability
76------------------
77
78*Fonctionnalité pas encore implémentée dans wallabag v2.*
79
80Depuis un fichier HTML ou JSON
81------------------------------
82
83*Fonctionnalité pas encore implémentée dans wallabag v2.*
diff --git a/docs/fr/user/login.rst b/docs/fr/user/login.rst
new file mode 100644
index 00000000..7ef70569
--- /dev/null
+++ b/docs/fr/user/login.rst
@@ -0,0 +1,23 @@
1Se connecter
2============
3
4Votre compte est maintenant actif, félicitations !
5
6Pour vous connecter à wallabag, remplissez le formulaire de connexion.
7
8Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connecté
9vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an.
10
11.. image:: ../../img/user/login_form.png
12 :alt: Login form
13 :align: center
14
15Foire aux questions
16-------------------
17
18J'ai oublié mon mot de passe
19~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
21Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``,
22sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur,
23un email vous sera envoyé.
diff --git a/docs/fr/user/tags.rst b/docs/fr/user/tags.rst
new file mode 100644
index 00000000..8ddc0f40
--- /dev/null
+++ b/docs/fr/user/tags.rst
@@ -0,0 +1,2 @@
1Tags
2==== \ No newline at end of file