aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/en/user/first_article.rst14
-rw-r--r--docs/en/user/import.rst24
-rw-r--r--docs/fr/index.rst2
-rw-r--r--docs/fr/user/first_article.rst68
-rw-r--r--docs/fr/user/import.rst83
5 files changed, 178 insertions, 13 deletions
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst
index 6f94bbef..1400e1e8 100644
--- a/docs/en/user/first_article.rst
+++ b/docs/en/user/first_article.rst
@@ -10,20 +10,24 @@ The main purpose of wallabag is to save web articles. You have many ways to do i
10By using a bookmarklet 10By using a bookmarklet
11---------------------- 11----------------------
12 12
13On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser. 13On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!``
14link to your bookmarks bar of your browser.
14 15
15Now, each time you're reading an article on the web and you want to save it, click on the ``bag it!`` link in your bookmarks bar. The article is saved. 16Now, each time you're reading an article on the web and you want to save it,
17click on the ``bag it!`` link in your bookmarks bar. The article is saved.
16 18
17By using the classic form 19By using the classic form
18------------------------- 20-------------------------
19 21
20In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article. 22In the top bar of your screen, you have 3 icons. With the first one, a plus sign,
23you can easily save a new article.
21 24
22.. image:: ../../img/user/topbar.png 25.. image:: ../../img/user/topbar.png
23 :alt: Top bar 26 :alt: Top bar
24 :align: center 27 :align: center
25 28
26Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved. 29Click on it to display a new field, paste the article URL inside and press your
30``Return`` key. The article is saved.
27 31
28By using a browser add-on 32By using a browser add-on
29------------------------- 33-------------------------
@@ -59,4 +63,4 @@ Windows Phone
59iOS 63iOS
60~~~ 64~~~
61 65
62*This application is not yet available for wallabag v2*. \ No newline at end of file 66*This application is not yet available for wallabag v2*.
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index 37f375b2..d6054d39 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -29,7 +29,8 @@ You will have a ``Unread articles.json`` file.
29Import your data into wallabag 2.x 29Import your data into wallabag 2.x
30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31 31
32Click on ``Import`` link in the menu, select your export file on your computer and import it. 32Click on ``Import`` link in the menu, choose the right wallabag version,
33select your export file on your computer and import it.
33 34
34.. image:: ../../img/user/import_wllbg.png 35.. image:: ../../img/user/import_wllbg.png
35 :alt: Import from wallabag 1.x 36 :alt: Import from wallabag 1.x
@@ -40,24 +41,31 @@ All your wallabag articles will be imported.
40From Pocket 41From Pocket
41----------- 42-----------
42 43
43Create a new applicaton on Pocket 44Create a new application on Pocket
44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 45~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45 46
46To import your data from Pocket, we use the Pocket API. You need to create a new application on their developer website to continue. 47To import your data from Pocket, we use the Pocket API. You need to create
48a new application on their developer website to continue.
47 49
48* Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_ 50* Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_
49* Fill in the required fields: application name, application description, permissions (only **retrieve**), platform (**web**), accept the terms of service and submit your new application 51* Fill in the required fields: application name, application description,
52 permissions (only **retrieve**), platform (**web**), accept the terms of service
53 and submit your new application
50 54
51Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag. 55Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
56You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag.
52 57
53Now, all is fine to migrate from Pocket. 58Now, all is fine to migrate from Pocket.
54 59
55Import your data into wallabag 2.x 60Import your data into wallabag 2.x
56~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 61~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57 62
58Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section and then on ``Connect to Pocket and import data``. 63Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section
64and then on ``Connect to Pocket and import data``.
59 65
60You need to authorize wallabag to interact with your Pocket account. Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). 66You need to authorize wallabag to interact with your Pocket account.
67Your data will be imported. Data import can be a demanding process for your server
68(we need to work on this import to improve it).
61 69
62From Instapaper 70From Instapaper
63--------------- 71---------------
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 236c44c3..d4ff7296 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -27,6 +27,8 @@ La documentation principale de cette application est découpée en plusieurs sec
27 user/create_account 27 user/create_account
28 user/login 28 user/login
29 user/configuration 29 user/configuration
30 user/first_article
31 user/import
30 user/download_articles 32 user/download_articles
31 user/filters 33 user/filters
32 user/tags 34 user/tags
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.*