diff options
Diffstat (limited to 'docs/fr')
-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 |
4 files changed, 254 insertions, 2 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 @@ | |||
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 | =========== ============================================== ========== ========== | ||