diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/en/developer/docker.rst | 6 | ||||
-rw-r--r-- | docs/en/developer/translate.rst | 35 | ||||
-rw-r--r-- | docs/en/index.rst | 4 | ||||
-rw-r--r-- | docs/en/user/configuration.rst | 42 | ||||
-rw-r--r-- | docs/fr/developer/docker.rst | 50 | ||||
-rw-r--r-- | docs/fr/developer/translate.rst | 62 | ||||
-rw-r--r-- | docs/fr/index.rst | 30 | ||||
-rw-r--r-- | docs/fr/user/configuration.rst | 114 |
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. | |||
15 | Switch DBMS | 15 | Switch DBMS |
16 | ----------- | 16 | ----------- |
17 | 17 | ||
18 | By default, wallabag will start with a sqlite database. | 18 | By default, wallabag will start with a SQLite database. |
19 | Since wallabag provides support for Postgresql and MySQL, docker | 19 | Since wallabag provides support for Postgresql and MySQL, docker |
20 | containers are also available for these ones. | 20 | containers are also available for these ones. |
21 | 21 | ||
22 | In ``docker-compose.yml``, for the chosen DBMS uncomment : | 22 | In ``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 | ||
29 | In order to keep running Symfony commands on your host (such as | 29 | In 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 @@ | |||
1 | Translate wallabag | 1 | Translate wallabag |
2 | ================== | 2 | ================== |
3 | 3 | ||
4 | wallabag web application | ||
5 | ------------------------ | ||
6 | |||
4 | Translation files | 7 | Translation 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 | ||
11 | You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. | 15 | You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. |
12 | 16 | ||
13 | You 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>`__). | 17 | You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE |
18 | is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__). | ||
14 | 19 | ||
15 | Other files to translate: | 20 | Other 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 | ||
20 | You have to create ``CraueConfigBundle.CODE.yml``. | 25 | You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. |
21 | 26 | ||
22 | Configuration file | 27 | Configuration file |
23 | ------------------ | 28 | ~~~~~~~~~~~~~~~~~~ |
24 | 29 | ||
25 | You have to edit `app/config/config.yml | 30 | You 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 |
32 | your language on Configuration page of wallabag (to allow users to switch to this new translation). | ||
27 | 33 | ||
28 | Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example | 34 | Under the ``wallabag_core.languages`` section, you have to add a new line with |
35 | your 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 | ||
39 | For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above). | 46 | For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code |
47 | of your language (see above). | ||
40 | 48 | ||
41 | For the second column, it's the name of your language. Just that. | 49 | For the second column, it's the name of your language. Just that. |
50 | |||
51 | wallabag documentation | ||
52 | ---------------------- | ||
53 | |||
54 | .. note:: | ||
55 | |||
56 | Contrary to the web application, the main language for documentation is english. | ||
57 | |||
58 | Documentation files are stored here: https://github.com/wallabag/wallabag/tree/v2/docs | ||
59 | |||
60 | You 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 |
9 | keeping content only. Elements like navigation or ads are deleted. | 9 | keeping 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 | |||
11 | The main documentation for this application is organized into a couple sections: | 15 | The 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 | ||
4 | Now you're logged in, it's time to configure your account as you want. | 4 | Now you're logged in, it's time to configure your account as you want. |
5 | 5 | ||
6 | Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``. | 6 | Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, |
7 | ``User information``, ``Password`` and ``Tagging rules``. | ||
7 | 8 | ||
8 | Settings | 9 | Settings |
9 | -------- | 10 | -------- |
@@ -11,7 +12,9 @@ Settings | |||
11 | Theme | 12 | Theme |
12 | ~~~~~ | 13 | ~~~~~ |
13 | 14 | ||
14 | wallabag 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. | 15 | wallabag is customizable. You can choose your prefered theme here. You can also |
16 | create 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 | ||
16 | Items per page | 19 | Items per page |
17 | ~~~~~~~~~~~~~~ | 20 | ~~~~~~~~~~~~~~ |
@@ -21,7 +24,8 @@ You can change the number of articles displayed on each page. | |||
21 | Language | 24 | Language |
22 | ~~~~~~~~ | 25 | ~~~~~~~~ |
23 | 26 | ||
24 | You can change the language of wallabag interface. | 27 | You can change the language of wallabag interface. You need to logout for this change |
28 | to take effect. | ||
25 | 29 | ||
26 | RSS | 30 | RSS |
27 | --- | 31 | --- |
@@ -43,41 +47,49 @@ You can change your name, your email address and enable ``Two factor authenticat | |||
43 | Two factor authentication | 47 | Two 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 | ||
48 | https://en.wikipedia.org/wiki/Two-factor_authentication | 53 | https://en.wikipedia.org/wiki/Two-factor_authentication |
49 | 54 | ||
50 | If 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. | 55 | If you enable 2FA, each time you want to login to wallabag, you'll receive |
56 | a 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 | ||
56 | If 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. | 62 | If you don't want to receive a code each time you want to login, you can check |
63 | the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days. | ||
57 | 64 | ||
58 | Password | 65 | Password |
59 | -------- | 66 | -------- |
60 | 67 | ||
61 | You can change your password here. | 68 | You can change your password here (8 characters minimum). |
62 | 69 | ||
63 | Tagging rules | 70 | Tagging rules |
64 | ------------- | 71 | ------------- |
65 | 72 | ||
66 | If you want to automatically assign a tag to new articles, this part of the configuration is for you. | 73 | If you want to automatically assign a tag to new articles, this part |
74 | of the configuration is for you. | ||
67 | 75 | ||
68 | What does « tagging rules » mean? | 76 | What does « tagging rules » mean? |
69 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 77 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
70 | 78 | ||
71 | They are rules used by wallabag to automatically tag new entries. | 79 | They are rules used by wallabag to automatically tag new entries. |
72 | Each 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. | 80 | Each time a new entry is added, all the tagging rules will be used to add |
81 | the tags you configured, thus saving you the trouble to manually classify your entries. | ||
73 | 82 | ||
74 | How do I use them? | 83 | How do I use them? |
75 | ~~~~~~~~~~~~~~~~~~ | 84 | ~~~~~~~~~~~~~~~~~~ |
76 | 85 | ||
77 | Let assume you want to tag new entries as *« short reading »* when the reading time is inferior to 3 minutes. | 86 | Let assume you want to tag new entries as *« short reading »* when |
78 | In that case, you should put « readingTime <= 3 » in the **Rule** field and *« short reading »* in the **Tags** field. | 87 | the reading time is inferior to 3 minutes. |
88 | In that case, you should put « readingTime <= 3 » in the **Rule** field | ||
89 | and *« short reading »* in the **Tags** field. | ||
79 | Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. | 90 | Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. |
80 | Complex rules can be written by using predefined operators: if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. | 91 | Complex rules can be written by using predefined operators: |
92 | if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. | ||
81 | 93 | ||
82 | Which variables and operators can I use to write rules? | 94 | Which variables and operators can I use to write rules? |
83 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 95 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -96,4 +108,4 @@ language The entry's language != Not equal | |||
96 | mimetype The entry's mime-type OR One rule or another | 108 | mimetype The entry's mime-type OR One rule or another |
97 | readingTime The estimated entry's reading time, in minutes AND One rule and another | 109 | readingTime The estimated entry's reading time, in minutes AND One rule and another |
98 | domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" | 110 | domainName 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 @@ | |||
1 | Exécuter wallabag avec docker-compose | ||
2 | ===================================== | ||
3 | |||
4 | Pour faire tourner votre propre instance de développement de wallabag, vous pouvez | ||
5 | utiliser les fichiers docker pré-configurés. | ||
6 | |||
7 | Pré-requis | ||
8 | ---------- | ||
9 | |||
10 | Soyez sur d'avoir `Docker | ||
11 | <https://docs.docker.com/installation/ubuntulinux/>`__ et `Docker | ||
12 | Compose <https://docs.docker.com/compose/install/>`__ installés et à jour sur votre | ||
13 | système. | ||
14 | |||
15 | Changer de SGBD | ||
16 | --------------- | ||
17 | |||
18 | Par défaut, wallabag fonctionne avec une base de données SQLite. | ||
19 | Depuis que wallabag supporte Postgresql et MySQL, les conteneurs Docker sont | ||
20 | aussi disponibles pour ces SGBD. | ||
21 | |||
22 | Dans ``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 | |||
28 | Pour que les commandes Symfony (par exemple ``wallabag:install``) continuent de | ||
29 | fonctionner sur votre système, vous devez aussi : | ||
30 | |||
31 | - charger le bon fichier d'environnement dans votre ligne de commandes (``source``), | ||
32 | pour que les variables comme ``SYMFONY__ENV__DATABASE_HOST`` existent. | ||
33 | - ajouter une ligne ``127.0.0.1 rdbms`` dans votre fichier ``hosts`` | ||
34 | |||
35 | Exé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 | |||
47 | Il est possible de rencontrer des problèmes de droits UNIX, de mauvais chemins | ||
48 | dans les fichiers de cache, etc… | ||
49 | Les opérations comme vider le cache ou restaurer les permissions des fichiers | ||
50 | peuvent ê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 @@ | |||
1 | Traduire wallabag | ||
2 | ================= | ||
3 | |||
4 | L'application web | ||
5 | ----------------- | ||
6 | |||
7 | Fichiers 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 | |||
16 | Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. | ||
17 | |||
18 | Vous devez créer les fichiers ``messages.CODE.yml`` et ``validators.CODE.yml``, | ||
19 | où CODE est le code ISO 639-1 de votre langue (`cf wikipedia <https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1>`__). | ||
20 | |||
21 | Autres 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 | |||
26 | Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``. | ||
27 | |||
28 | Fichier de configuration | ||
29 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
30 | |||
31 | Vous devez éditer `app/config/config.yml | ||
32 | <https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ pour | ||
33 | afficher votre langue dans la page Configuration de wallabag (pour permettre aux | ||
34 | utilisateurs de choisir cette nouvelle traduction). | ||
35 | |||
36 | Dans la section ``wallabag_core.languages``, vous devez ajouter une nouvelle ligne | ||
37 | avec votre traduction. Par exemple : | ||
38 | |||
39 | :: | ||
40 | |||
41 | wallabag_core: | ||
42 | ... | ||
43 | languages: | ||
44 | en: 'English' | ||
45 | fr: 'Français' | ||
46 | |||
47 | |||
48 | Pour la première colonne (``en``, ``fr``, etc.), vous devez ajouter le code ISO 639-1 | ||
49 | de votre langue (voir ci-dessus). | ||
50 | |||
51 | Pour la seconde colonne, c'est juste le nom de votre langue. | ||
52 | |||
53 | Documentation de wallabag | ||
54 | ------------------------- | ||
55 | |||
56 | .. note:: | ||
57 | |||
58 | Contrairement à l'application, la langue principale de la documentation est l'anglais | ||
59 | |||
60 | Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/docs | ||
61 | |||
62 | Vous 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 | |||
9 | simplement d’archiver une page web en ne conservant que le contenu. Les | 9 | simplement 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 | |||
12 | La documentation principale de cette application est découpée en plusieurs sections : | 16 | La 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 @@ | |||
1 | Configuration | ||
2 | ============= | ||
3 | |||
4 | Maintenant que vous êtes connecté, il est temps de confirurer votre compte. | ||
5 | |||
6 | Cliquez 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 | |||
9 | Paramètres | ||
10 | ---------- | ||
11 | |||
12 | Thème | ||
13 | ~~~~~ | ||
14 | |||
15 | L'affichage de wallabag est personnalisable. C'est ici que vous choisissez le thème | ||
16 | que vous préférez. Vous pouvez aussi en créer un nouveau, une documentation sera | ||
17 | disponible pour apprendre comment. Le thème par défaut ``Material``, c'est ce thème | ||
18 | qui est utilisé dans les captures d'écran de la documentation. | ||
19 | |||
20 | Nombre d'articles par page | ||
21 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
22 | |||
23 | Vous pouvez définir le nombre d'articles affichés sur chaque page. | ||
24 | |||
25 | Langue | ||
26 | ~~~~~~ | ||
27 | |||
28 | Vous pouvez définir la langue de l'interface de wallabag. Vous devrez vous déconnecter | ||
29 | pour que la nouvelle langue soit prise en compte. | ||
30 | |||
31 | RSS | ||
32 | --- | ||
33 | |||
34 | wallabag propose un flux RSS for chaque statut d'article : non lus, favoris and lus. | ||
35 | |||
36 | Tout d'abord, vous devez vous créer un jeton personnel : cliquez sur ``Créez votre jeton``. | ||
37 | C'est possible de regénérer votre jeton en cliquant sur ``Réinitialisez votre jeton``. | ||
38 | |||
39 | Vous avez maintenant trois liens, un par statut : ajoutez les dans votre agrégateur de flux RSS préféré. | ||
40 | |||
41 | Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS | ||
42 | (50 est la valeur par défaut). | ||
43 | |||
44 | Mon compte | ||
45 | ---------- | ||
46 | |||
47 | Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``. | ||
48 | |||
49 | Double 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 | |||
55 | https://en.wikipedia.org/wiki/Two-factor_authentication | ||
56 | |||
57 | Si vous activer 2FA, à chaque tentative de connexion à wallabag, vous recevrez | ||
58 | un 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 | |||
64 | Si vous ne souhaitez pas recevoir un code à chaque fois que vous vous connectez, | ||
65 | vous pouvez cocher la case ``Je suis sur un ordinateur de confiance`` : wallabag | ||
66 | se souviendra de vous pour 15 jours. | ||
67 | |||
68 | Mot de passe | ||
69 | ------------ | ||
70 | |||
71 | Vous pouvez changer de mot de passe ici (8 caractères minimum). | ||
72 | |||
73 | Règles de tag automatiques | ||
74 | -------------------------- | ||
75 | |||
76 | Si vous voulez automatiquement assigner un tag à de nouveaux articles en fonction de | ||
77 | certains critères, cette partie de la configuration est pour vous. | ||
78 | |||
79 | Que veut dire « règles de tag automatiques » ? | ||
80 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
81 | |||
82 | Ce 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 | ||
85 | les tags que vous avez configurés, vous épargnant ainsi la peine de classer manuellement vos articles. | ||
86 | |||
87 | Comment les utiliser ? | ||
88 | ~~~~~~~~~~~~~~~~~~~~~~ | ||
89 | |||
90 | Admettons que vous voulez ajouter comme tag *« lecture rapide »* quand le temps de lecture | ||
91 | d'un article est inférieur à 3 minutes. | ||
92 | Dans ce cas, vous devez ajouter « readingTime <= 3 » dans le champ **Règle** et *« lecture rapide »* dans le champ **Tags**. | ||
93 | Plusieurs tags peuvent être ajoutés en même temps en les séparant par une virgule : *« lecture rapide, à lire »*. | ||
94 | Des règles complexes peuvent être écrites en utilisant les opérateurs pré-définis : | ||
95 | if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. | ||
96 | |||
97 | Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? | ||
98 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
99 | |||
100 | Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles : | ||
101 | |||
102 | =========== ============================================== ========== ========== | ||
103 | Variable Sens Opérateur Sens | ||
104 | ----------- ---------------------------------------------- ---------- ---------- | ||
105 | title Titre de l'article <= Inférieur ou égal à … | ||
106 | url URL de l'article < Strictement inférieur à … | ||
107 | isArchived Si l'article est archivé ou non => Supérieur ou égal à … | ||
108 | isStared Si l'article est en favori ou non > Strictement supérieur à … | ||
109 | content Le contenu de l'article = Égal à … | ||
110 | language La langue de l'article != Différent de … | ||
111 | mimetype The type MIME de l'article OR Telle règle ou telle autre règle | ||
112 | readingTime Le temps de lecture de l'article, en minutes AND Telle règle et telle règle | ||
113 | domainName Le nom de domaine de l'article matches Contient telle chaine de caractère (insensible à la casse). Exemple : title matches "football" | ||
114 | =========== ============================================== ========== ========== | ||