aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/en/developer/docker.rst6
-rw-r--r--docs/en/developer/translate.rst35
-rw-r--r--docs/en/index.rst4
-rw-r--r--docs/en/user/configuration.rst42
-rw-r--r--docs/fr/developer/docker.rst50
-rw-r--r--docs/fr/developer/translate.rst62
-rw-r--r--docs/fr/index.rst30
-rw-r--r--docs/fr/user/configuration.rst114
8 files changed, 315 insertions, 28 deletions
diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst
index aece2984..8816cbcf 100644
--- a/docs/en/developer/docker.rst
+++ b/docs/en/developer/docker.rst
@@ -15,11 +15,11 @@ your system and up to date.
15Switch DBMS 15Switch DBMS
16----------- 16-----------
17 17
18By default, wallabag will start with a sqlite database. 18By default, wallabag will start with a SQLite database.
19Since wallabag provides support for Postgresql and MySQL, docker 19Since wallabag provides support for Postgresql and MySQL, docker
20containers are also available for these ones. 20containers are also available for these ones.
21 21
22In ``docker-compose.yml``, for the chosen DBMS uncomment : 22In ``docker-compose.yml``, for the chosen DBMS uncomment:
23 23
24- the container definition (``postgres`` or ``mariadb`` root level 24- the container definition (``postgres`` or ``mariadb`` root level
25 block) 25 block)
@@ -27,7 +27,7 @@ In ``docker-compose.yml``, for the chosen DBMS uncomment :
27- the container env file in the ``php`` container 27- the container env file in the ``php`` container
28 28
29In order to keep running Symfony commands on your host (such as 29In order to keep running Symfony commands on your host (such as
30``wallabag:install``), you also should : 30``wallabag:install``), you also should:
31 31
32- source the proper env files on your command line, so variables 32- source the proper env files on your command line, so variables
33 like ``SYMFONY__ENV__DATABASE_HOST`` will exist. 33 like ``SYMFONY__ENV__DATABASE_HOST`` will exist.
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst
index 85cf2563..33b0ebdb 100644
--- a/docs/en/developer/translate.rst
+++ b/docs/en/developer/translate.rst
@@ -1,31 +1,38 @@
1Translate wallabag 1Translate wallabag
2================== 2==================
3 3
4wallabag web application
5------------------------
6
4Translation files 7Translation files
5----------------- 8~~~~~~~~~~~~~~~~~
6 9
7.. note:: 10.. note::
8 11
9 As wallabag is mainly developed by a French team, please consider that french translation is the most updated one and please copy it to create your own translation. 12 As wallabag is mainly developed by a French team, please consider that french
13 translation is the most updated one and please copy it to create your own translation.
10 14
11You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. 15You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
12 16
13You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE is the the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__). 17You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE
18is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
14 19
15Other files to translate: 20Other files to translate:
16 21
17- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. 22- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
18- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations. 23- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations.
19 24
20You have to create ``CraueConfigBundle.CODE.yml``. 25You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files.
21 26
22Configuration file 27Configuration file
23------------------ 28~~~~~~~~~~~~~~~~~~
24 29
25You have to edit `app/config/config.yml 30You have to edit `app/config/config.yml
26<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display your language on Configuration page of wallabag (to allow users to switch to this new translation). 31<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display
32your language on Configuration page of wallabag (to allow users to switch to this new translation).
27 33
28Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example 34Under the ``wallabag_core.languages`` section, you have to add a new line with
35your translation. For example:
29 36
30:: 37::
31 38
@@ -36,6 +43,18 @@ Under the ``wallabag_core.languages`` section, you have to add a new line for wi
36 fr: 'Français' 43 fr: 'Français'
37 44
38 45
39For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above). 46For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code
47of your language (see above).
40 48
41For the second column, it's the name of your language. Just that. 49For the second column, it's the name of your language. Just that.
50
51wallabag documentation
52----------------------
53
54.. note::
55
56 Contrary to the web application, the main language for documentation is english.
57
58Documentation files are stored here: https://github.com/wallabag/wallabag/tree/v2/docs
59
60You need to respect the ``en`` folder structure when you create your own translation.
diff --git a/docs/en/index.rst b/docs/en/index.rst
index acd9b383..85c764da 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -8,6 +8,10 @@ wallabag documentation
8**wallabag** is a read-it-later application: it saves a web page by 8**wallabag** is a read-it-later application: it saves a web page by
9keeping content only. Elements like navigation or ads are deleted. 9keeping content only. Elements like navigation or ads are deleted.
10 10
11.. note::
12
13 This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.
14
11The main documentation for this application is organized into a couple sections: 15The main documentation for this application is organized into a couple sections:
12 16
13* :ref:`user-docs` 17* :ref:`user-docs`
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index 369c977a..70d960ff 100644
--- a/docs/en/user/configuration.rst
+++ b/docs/en/user/configuration.rst
@@ -3,7 +3,8 @@ Configuration
3 3
4Now you're logged in, it's time to configure your account as you want. 4Now you're logged in, it's time to configure your account as you want.
5 5
6Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``. 6Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``,
7``User information``, ``Password`` and ``Tagging rules``.
7 8
8Settings 9Settings
9-------- 10--------
@@ -11,7 +12,9 @@ Settings
11Theme 12Theme
12~~~~~ 13~~~~~
13 14
14wallabag is customizable. You can choose your prefered theme here. You can also create a new one, a chapter is dedicated for this. The default theme is ``Material``, it's the theme used in the documentation screenshots. 15wallabag is customizable. You can choose your prefered theme here. You can also
16create a new one, a chapter will be dedicated for this. The default theme is
17``Material``, it's the theme used in the documentation screenshots.
15 18
16Items per page 19Items per page
17~~~~~~~~~~~~~~ 20~~~~~~~~~~~~~~
@@ -21,7 +24,8 @@ You can change the number of articles displayed on each page.
21Language 24Language
22~~~~~~~~ 25~~~~~~~~
23 26
24You can change the language of wallabag interface. 27You can change the language of wallabag interface. You need to logout for this change
28to take effect.
25 29
26RSS 30RSS
27--- 31---
@@ -43,41 +47,49 @@ You can change your name, your email address and enable ``Two factor authenticat
43Two factor authentication 47Two factor authentication
44~~~~~~~~~~~~~~~~~~~~~~~~~ 48~~~~~~~~~~~~~~~~~~~~~~~~~
45 49
46 Two-factor authentication (also known as 2FA) is a technology patented in 1984 that provides identification of users by means of the combination of two different components. 50 Two-factor authentication (also known as 2FA) is a technology patented in 1984
51 that provides identification of users by means of the combination of two different components.
47 52
48https://en.wikipedia.org/wiki/Two-factor_authentication 53https://en.wikipedia.org/wiki/Two-factor_authentication
49 54
50If you enable 2FA, each time you want to login to wallabag, you'll receive a code by email. You have to put this code on the following form. 55If you enable 2FA, each time you want to login to wallabag, you'll receive
56a code by email. You have to put this code on the following form.
51 57
52.. image:: ../../img/user/2FA_form.png 58.. image:: ../../img/user/2FA_form.png
53 :alt: Two factor authentication 59 :alt: Two factor authentication
54 :align: center 60 :align: center
55 61
56If you don't want to receive a code each time you want to login, you can check the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days. 62If you don't want to receive a code each time you want to login, you can check
63the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days.
57 64
58Password 65Password
59-------- 66--------
60 67
61You can change your password here. 68You can change your password here (8 characters minimum).
62 69
63Tagging rules 70Tagging rules
64------------- 71-------------
65 72
66If you want to automatically assign a tag to new articles, this part of the configuration is for you. 73If you want to automatically assign a tag to new articles, this part
74of the configuration is for you.
67 75
68What does « tagging rules » mean? 76What does « tagging rules » mean?
69~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 77~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70 78
71They are rules used by wallabag to automatically tag new entries. 79They are rules used by wallabag to automatically tag new entries.
72Each time a new entry is added, all the tagging rules will be used to add the tags you configured, thus saving you the trouble to manually classify your entries. 80Each time a new entry is added, all the tagging rules will be used to add
81the tags you configured, thus saving you the trouble to manually classify your entries.
73 82
74How do I use them? 83How do I use them?
75~~~~~~~~~~~~~~~~~~ 84~~~~~~~~~~~~~~~~~~
76 85
77Let assume you want to tag new entries as *« short reading »* when the reading time is inferior to 3 minutes. 86Let assume you want to tag new entries as *« short reading »* when
78In that case, you should put « readingTime <= 3 » in the **Rule** field and *« short reading »* in the **Tags** field. 87the reading time is inferior to 3 minutes.
88In that case, you should put « readingTime <= 3 » in the **Rule** field
89and *« short reading »* in the **Tags** field.
79Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. 90Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*.
80Complex rules can be written by using predefined operators: if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. 91Complex rules can be written by using predefined operators:
92if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*.
81 93
82Which variables and operators can I use to write rules? 94Which variables and operators can I use to write rules?
83~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 95~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -96,4 +108,4 @@ language The entry's language != Not equal
96mimetype The entry's mime-type OR One rule or another 108mimetype The entry's mime-type OR One rule or another
97readingTime The estimated entry's reading time, in minutes AND One rule and another 109readingTime The estimated entry's reading time, in minutes AND One rule and another
98domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" 110domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football"
99=========== ============================================== ======== ========== \ No newline at end of file 111=========== ============================================== ======== ==========
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..1c5fd108 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=========== ============================================== ========== ==========