From 3495f78d7735f88f11ddf548955d8b57f1ddd020 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 08:39:08 +0100 Subject: French translation for documentation --- docs/en/developer/docker.rst | 6 +-- docs/en/developer/translate.rst | 35 +++++++++--- docs/en/index.rst | 4 ++ docs/en/user/configuration.rst | 42 +++++++++------ docs/fr/developer/docker.rst | 50 ++++++++++++++++++ docs/fr/developer/translate.rst | 62 ++++++++++++++++++++++ docs/fr/index.rst | 30 ++++++++++- docs/fr/user/configuration.rst | 114 ++++++++++++++++++++++++++++++++++++++++ 8 files changed, 315 insertions(+), 28 deletions(-) create mode 100644 docs/fr/developer/docker.rst create mode 100644 docs/fr/developer/translate.rst create mode 100644 docs/fr/user/configuration.rst (limited to 'docs') 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. Switch DBMS ----------- -By default, wallabag will start with a sqlite database. +By default, wallabag will start with a SQLite database. Since wallabag provides support for Postgresql and MySQL, docker containers are also available for these ones. -In ``docker-compose.yml``, for the chosen DBMS uncomment : +In ``docker-compose.yml``, for the chosen DBMS uncomment: - the container definition (``postgres`` or ``mariadb`` root level block) @@ -27,7 +27,7 @@ In ``docker-compose.yml``, for the chosen DBMS uncomment : - the container env file in the ``php`` container In order to keep running Symfony commands on your host (such as -``wallabag:install``), you also should : +``wallabag:install``), you also should: - source the proper env files on your command line, so variables 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 @@ Translate wallabag ================== +wallabag web application +------------------------ + Translation files ------------------ +~~~~~~~~~~~~~~~~~ .. note:: - 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. + 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. You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. -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 `__). +You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE +is the ISO 639-1 code of your language (`see wikipedia `__). Other files to translate: - https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. - https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations. -You have to create ``CraueConfigBundle.CODE.yml``. +You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. Configuration file ------------------- +~~~~~~~~~~~~~~~~~~ You have to edit `app/config/config.yml -`__ to display your language on Configuration page of wallabag (to allow users to switch to this new translation). +`__ to display +your language on Configuration page of wallabag (to allow users to switch to this new translation). -Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example +Under the ``wallabag_core.languages`` section, you have to add a new line with +your translation. For example: :: @@ -36,6 +43,18 @@ Under the ``wallabag_core.languages`` section, you have to add a new line for wi fr: 'Français' -For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above). +For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code +of your language (see above). For the second column, it's the name of your language. Just that. + +wallabag documentation +---------------------- + +.. note:: + + Contrary to the web application, the main language for documentation is english. + +Documentation files are stored here: https://github.com/wallabag/wallabag/tree/v2/docs + +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 **wallabag** is a read-it-later application: it saves a web page by keeping content only. Elements like navigation or ads are deleted. +.. note:: + + This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here `__. + The main documentation for this application is organized into a couple sections: * :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 Now you're logged in, it's time to configure your account as you want. -Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``. +Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, +``User information``, ``Password`` and ``Tagging rules``. Settings -------- @@ -11,7 +12,9 @@ Settings Theme ~~~~~ -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. +wallabag is customizable. You can choose your prefered theme here. You can also +create a new one, a chapter will be dedicated for this. The default theme is +``Material``, it's the theme used in the documentation screenshots. Items per page ~~~~~~~~~~~~~~ @@ -21,7 +24,8 @@ You can change the number of articles displayed on each page. Language ~~~~~~~~ -You can change the language of wallabag interface. +You can change the language of wallabag interface. You need to logout for this change +to take effect. RSS --- @@ -43,41 +47,49 @@ You can change your name, your email address and enable ``Two factor authenticat Two factor authentication ~~~~~~~~~~~~~~~~~~~~~~~~~ - 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. + 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. https://en.wikipedia.org/wiki/Two-factor_authentication -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. +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. .. image:: ../../img/user/2FA_form.png - :alt: Two factor authentication - :align: center + :alt: Two factor authentication + :align: center -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. +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. Password -------- -You can change your password here. +You can change your password here (8 characters minimum). Tagging rules ------------- -If you want to automatically assign a tag to new articles, this part of the configuration is for you. +If you want to automatically assign a tag to new articles, this part +of the configuration is for you. What does « tagging rules » mean? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ They are rules used by wallabag to automatically tag new entries. -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. +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. How do I use them? ~~~~~~~~~~~~~~~~~~ -Let assume you want to tag new entries as *« short reading »* when the reading time is inferior to 3 minutes. -In that case, you should put « readingTime <= 3 » in the **Rule** field and *« short reading »* in the **Tags** field. +Let assume you want to tag new entries as *« short reading »* when +the reading time is inferior to 3 minutes. +In that case, you should put « readingTime <= 3 » in the **Rule** field +and *« short reading »* in the **Tags** field. Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. -Complex rules can be written by using predefined operators: if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. +Complex rules can be written by using predefined operators: +if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. Which variables and operators can I use to write rules? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -96,4 +108,4 @@ language The entry's language != Not equal mimetype The entry's mime-type OR One rule or another readingTime The estimated entry's reading time, in minutes AND One rule and another domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" -=========== ============================================== ======== ========== \ No newline at end of file +=========== ============================================== ======== ========== 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 @@ +Exécuter wallabag avec docker-compose +===================================== + +Pour faire tourner votre propre instance de développement de wallabag, vous pouvez +utiliser les fichiers docker pré-configurés. + +Pré-requis +---------- + +Soyez sur d'avoir `Docker +`__ et `Docker +Compose `__ installés et à jour sur votre +système. + +Changer de SGBD +--------------- + +Par défaut, wallabag fonctionne avec une base de données SQLite. +Depuis que wallabag supporte Postgresql et MySQL, les conteneurs Docker sont +aussi disponibles pour ces SGBD. + +Dans ``docker-compose.yml``, en fonction de votre SGBD, décommentez : + +- la définition du conteneur (le block racine ``postgres`` ou ``mariadb``) +- le conteneur ``links`` dans le conteneur ``php`` +- le conteneur ``env_file`` dans le conteneur ``php`` + +Pour que les commandes Symfony (par exemple ``wallabag:install``) continuent de +fonctionner sur votre système, vous devez aussi : + +- charger le bon fichier d'environnement dans votre ligne de commandes (``source``), +pour que les variables comme ``SYMFONY__ENV__DATABASE_HOST`` existent. +- ajouter une ligne ``127.0.0.1 rdbms`` dans votre fichier ``hosts`` + +Exécuter wallabag +----------------- + +#. Forker et cloner le projet +#. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*`` + par les lignes commentées (celles avec des valeurs préfixées par ``env.``) +#. ``composer install`` pour installer les dépendances +#. ``php app/console wallabag:install`` pour créer le schéma de la BDD +#. ``docker-compose up`` pour démarrer les conteneurs +#. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation + tout propre de wallabag. + +Il est possible de rencontrer des problèmes de droits UNIX, de mauvais chemins +dans les fichiers de cache, etc… +Les opérations comme vider le cache ou restaurer les permissions des fichiers +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 @@ +Traduire wallabag +================= + +L'application web +----------------- + +Fichiers de traductions +~~~~~~~~~~~~~~~~~~~~~~~ + +.. note:: + + Comme wallabag est principalement dévelopée par une équipe française, c'est + cette traduction qui est considérée comme la plus récente. Merci de vous baser + sur celle-ci pour créer votre traduction. + +Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. + +Vous devez créer les fichiers ``messages.CODE.yml`` et ``validators.CODE.yml``, +où CODE est le code ISO 639-1 de votre langue (`cf wikipedia `__). + +Autres fichiers à traduire : + +- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. +- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations. + +Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``. + +Fichier de configuration +~~~~~~~~~~~~~~~~~~~~~~~~ + +Vous devez éditer `app/config/config.yml +`__ pour +afficher votre langue dans la page Configuration de wallabag (pour permettre aux +utilisateurs de choisir cette nouvelle traduction). + +Dans la section ``wallabag_core.languages``, vous devez ajouter une nouvelle ligne +avec votre traduction. Par exemple : + +:: + + wallabag_core: + ... + languages: + en: 'English' + fr: 'Français' + + +Pour la première colonne (``en``, ``fr``, etc.), vous devez ajouter le code ISO 639-1 +de votre langue (voir ci-dessus). + +Pour la seconde colonne, c'est juste le nom de votre langue. + +Documentation de wallabag +------------------------- + +.. note:: + + Contrairement à l'application, la langue principale de la documentation est l'anglais + +Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/docs + +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 simplement d’archiver une page web en ne conservant que le contenu. Les éléments superflus (menu, publicité, etc.) sont supprimés. +.. note:: + + Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici `__. + La documentation principale de cette application est découpée en plusieurs sections : +* :ref:`user-docs` +* :ref:`dev-docs` + +.. _user-docs: + +.. toctree:: +:maxdepth: 2 + :caption: Documentation utilisateur + + user/create_account + user/login + user/configuration + user/first_article + user/import + user/download_articles + user/filters + user/tags + +.. _dev-docs: + .. toctree:: - :maxdepth: 2 +:maxdepth: 2 + :caption: Documentation développeur - index + developer/docker + 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 @@ +Configuration +============= + +Maintenant que vous êtes connecté, il est temps de confirurer votre compte. + +Cliquez sur le menu ``Configuration``. Vous avez accès à 5 onglets: +``Paramètres``, ``RSS``, ``Mon compte``, ``Mot de passe`` and ``Règles de tag automatiques``. + +Paramètres +---------- + +Thème +~~~~~ + +L'affichage de wallabag est personnalisable. C'est ici que vous choisissez le thème +que vous préférez. Vous pouvez aussi en créer un nouveau, une documentation sera +disponible pour apprendre comment. Le thème par défaut ``Material``, c'est ce thème +qui est utilisé dans les captures d'écran de la documentation. + +Nombre d'articles par page +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Vous pouvez définir le nombre d'articles affichés sur chaque page. + +Langue +~~~~~~ + +Vous pouvez définir la langue de l'interface de wallabag. Vous devrez vous déconnecter +pour que la nouvelle langue soit prise en compte. + +RSS +--- + +wallabag propose un flux RSS for chaque statut d'article : non lus, favoris and lus. + +Tout d'abord, vous devez vous créer un jeton personnel : cliquez sur ``Créez votre jeton``. +C'est possible de regénérer votre jeton en cliquant sur ``Réinitialisez votre jeton``. + +Vous avez maintenant trois liens, un par statut : ajoutez les dans votre agrégateur de flux RSS préféré. + +Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS +(50 est la valeur par défaut). + +Mon compte +---------- + +Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``. + +Double authentification (2FA) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + 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. + +https://en.wikipedia.org/wiki/Two-factor_authentication + +Si vous activer 2FA, à chaque tentative de connexion à wallabag, vous recevrez +un code par email. Vous devez renseigner ce code dans le formulaire suivant : + +.. image:: ../../img/user/2FA_form.png + :alt: Two factor authentication + :align: center + +Si vous ne souhaitez pas recevoir un code à chaque fois que vous vous connectez, +vous pouvez cocher la case ``Je suis sur un ordinateur de confiance`` : wallabag +se souviendra de vous pour 15 jours. + +Mot de passe +------------ + +Vous pouvez changer de mot de passe ici (8 caractères minimum). + +Règles de tag automatiques +-------------------------- + +Si vous voulez automatiquement assigner un tag à de nouveaux articles en fonction de +certains critères, cette partie de la configuration est pour vous. + +Que veut dire « règles de tag automatiques » ? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Ce sont des règles utilisées par wallabag pour automatiquement assigner un tag +à un nouvel article. +À chaque fois que vous ajoutez un nouvel article, toutes les règles sont utilisées pour ajouter +les tags que vous avez configurés, vous épargnant ainsi la peine de classer manuellement vos articles. + +Comment les utiliser ? +~~~~~~~~~~~~~~~~~~~~~~ + +Admettons que vous voulez ajouter comme tag *« lecture rapide »* quand le temps de lecture +d'un article est inférieur à 3 minutes. +Dans ce cas, vous devez ajouter « readingTime <= 3 » dans le champ **Règle** et *« lecture rapide »* dans le champ **Tags**. +Plusieurs tags peuvent être ajoutés en même temps en les séparant par une virgule : *« lecture rapide, à lire »*. +Des règles complexes peuvent être écrites en utilisant les opérateurs pré-définis : +if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. + +Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles : + +=========== ============================================== ========== ========== +Variable Sens Opérateur Sens +----------- ---------------------------------------------- ---------- ---------- +title Titre de l'article <= Inférieur ou égal à … +url URL de l'article < Strictement inférieur à … +isArchived Si l'article est archivé ou non => Supérieur ou égal à … +isStared Si l'article est en favori ou non > Strictement supérieur à … +content Le contenu de l'article = Égal à … +language La langue de l'article != Différent de … +mimetype The type MIME de l'article OR Telle règle ou telle autre règle +readingTime Le temps de lecture de l'article, en minutes AND Telle règle et telle règle +domainName Le nom de domaine de l'article matches Contient telle chaine de caractère (insensible à la casse). Exemple : title matches "football" +=========== ============================================== ========== ========== -- cgit v1.2.3 From ce168b6ead9ef753583cc7c49bc6b566e1fd7508 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 08:50:36 +0100 Subject: typos on french homepage --- docs/fr/index.rst | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) (limited to 'docs') diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 1c5fd108..3daeb69b 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -21,23 +21,14 @@ La documentation principale de cette application est découpée en plusieurs sec .. _user-docs: .. toctree:: -:maxdepth: 2 - :caption: Documentation utilisateur - - user/create_account - user/login - user/configuration - user/first_article - user/import - user/download_articles - user/filters - user/tags + :maxdepth: 2 + :caption: Documentation utilisateur .. _dev-docs: .. toctree:: -:maxdepth: 2 - :caption: Documentation développeur + :maxdepth: 2 + :caption: Documentation développeur developer/docker developer/translate -- cgit v1.2.3 From 05e173f283c530ffc2678f92bb1e6652c380586e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 08:52:16 +0100 Subject: typos on french homepage --- docs/fr/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 3daeb69b..a4956a65 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -30,5 +30,5 @@ La documentation principale de cette application est découpée en plusieurs sec :maxdepth: 2 :caption: Documentation développeur - developer/docker - developer/translate + developer/docker + developer/translate -- cgit v1.2.3 From 91485cf27d22ffd3c0969f19169f6451e0c06e89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 08:54:18 +0100 Subject: forgot link for config page --- docs/fr/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/fr/index.rst b/docs/fr/index.rst index a4956a65..6892f080 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -24,6 +24,8 @@ La documentation principale de cette application est découpée en plusieurs sec :maxdepth: 2 :caption: Documentation utilisateur + user/configuration + .. _dev-docs: .. toctree:: -- cgit v1.2.3 From 66755f8955e46d9e2f1e006eebe5757138dd88a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 09:05:11 +0100 Subject: create account in french --- docs/en/user/create_account.rst | 11 ++++++---- docs/fr/index.rst | 1 + docs/fr/user/create_account.rst | 46 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 54 insertions(+), 4 deletions(-) create mode 100644 docs/fr/user/create_account.rst (limited to 'docs') diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst index 11fe304c..f0110e55 100644 --- a/docs/en/user/create_account.rst +++ b/docs/en/user/create_account.rst @@ -7,13 +7,16 @@ On the login page, click on ``Register`` button. :alt: Registration form :align: center -You have to fill the form. Please sure to type a valid email address, we'll send you an activation email. +You have to fill the form. Please sure to type a valid email address, +we'll send you an activation email. .. image:: ../../img/user/sent_email.png :alt: Email was sent to activate account :align: center -Check your inbox, you now have a new mail with a link like this ``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. Click on it to activate your account. +Check your inbox, you now have a new mail with a link like this +``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. +Click on it to activate your account. Your account is now activated. @@ -33,11 +36,11 @@ Make sure that all fields are well filled: * same passwords in two fields I don't receive my activation email -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Are you sure your email address was correct? Did you check your spams folder? When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. -~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You already enabled your account or the URL of the activation email is wrong. diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 6892f080..0875a538 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -24,6 +24,7 @@ La documentation principale de cette application est découpée en plusieurs sec :maxdepth: 2 :caption: Documentation utilisateur + user/create_account user/configuration .. _dev-docs: diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst new file mode 100644 index 00000000..34f6c342 --- /dev/null +++ b/docs/fr/user/create_account.rst @@ -0,0 +1,46 @@ +Se créer un compte +================== + +Sur la page de connexion, cliquez sur le bouton ``Créer un compte``. + +.. image:: ../../img/user/registration_form.png + :alt: Registration form + :align: center + +Vous devez renseigner le formulaire. Faites attention de bien renseigner une adresse +email valide, nous allons vous envoyer un email d'activation. + +.. image:: ../../img/user/sent_email.png + :alt: Email was sent to activate account + :align: center + +Vérifiez votre boite de réception, vous avez un nouvel email avec un lien comme celui-ci +``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. +Cliquez dessus pour activer votre compte. + +Votre compte est maintenant actif. + +.. image:: ../../img/user/activated_account.png + :alt: Welcome on board! + :align: center + +Foire aux questions +------------------- + +Je ne veux pas valider le formulaire de création de compte +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Soyez sur d'avoir bien renseigné tous les champs : + +* une adresse email valide +* le même mot de passe dans les deux champs + +Je n'ai pas reçu mon email d'activation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ? + +Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte. -- cgit v1.2.3 From 9e60429c6d5cd8ab0b7156a9b5086e19a9f40214 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 09:09:33 +0100 Subject: download articles in french --- docs/en/user/download_articles.rst | 5 +++-- docs/fr/index.rst | 1 + docs/fr/user/create_account.rst | 2 +- docs/fr/user/download_articles.rst | 17 +++++++++++++++++ 4 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/fr/user/download_articles.rst (limited to 'docs') diff --git a/docs/en/user/download_articles.rst b/docs/en/user/download_articles.rst index 21ab1995..4813776d 100644 --- a/docs/en/user/download_articles.rst +++ b/docs/en/user/download_articles.rst @@ -9,8 +9,9 @@ On the article view, click on this icon, in the sidebar: :alt: download article :align: center -You can also download a full category in these formats. For example, on **Unread** view, click on this icon in the top bar: +You can also download a full category (unread, starred, archive) in these formats. +For example, on **Unread** view, click on this icon in the top bar: .. image:: ../../img/user/download_articles.png :alt: download articles - :align: center \ No newline at end of file + :align: center diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 0875a538..71ef27a0 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -26,6 +26,7 @@ La documentation principale de cette application est découpée en plusieurs sec user/create_account user/configuration + user/download_articles .. _dev-docs: diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst index 34f6c342..7fea6edf 100644 --- a/docs/fr/user/create_account.rst +++ b/docs/fr/user/create_account.rst @@ -43,4 +43,4 @@ Je n'ai pas reçu mon email d'activation Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte. +Vous 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 @@ +Télécharger des articles +======================== + +Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PDF, XML, JSON, CSV. + +Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale : + +.. image:: ../../img/user/download_article.png + :alt: download article + :align: center + +Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats. +Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure : + +.. image:: ../../img/user/download_articles.png + :alt: download articles + :align: center -- cgit v1.2.3 From 8dbca9c1331e93fc017d49a2eff7455befad54a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 09:16:22 +0100 Subject: french translation for login doc --- docs/en/user/login.rst | 7 +++++-- docs/fr/index.rst | 3 +++ docs/fr/user/filters.rst | 2 ++ docs/fr/user/login.rst | 23 +++++++++++++++++++++++ docs/fr/user/tags.rst | 2 ++ 5 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 docs/fr/user/filters.rst create mode 100644 docs/fr/user/login.rst create mode 100644 docs/fr/user/tags.rst (limited to 'docs') diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst index 1b6b8875..1813f3d8 100644 --- a/docs/en/user/login.rst +++ b/docs/en/user/login.rst @@ -5,7 +5,8 @@ Your account is now enabled, congratulations! To login to wallabag, fill the form on login page. -If you are on your personal computer and you want to stay connected, you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year. +If you are on your personal computer and you want to stay connected, +you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year. .. image:: ../../img/user/login_form.png :alt: Login form @@ -17,4 +18,6 @@ Frequently asked questions I forgot my password ~~~~~~~~~~~~~~~~~~~~ -You can reset your password by clicking on ``Forgot your password?`` link, on the login page. Then, fill the form with your email address +You can reset your password by clicking on ``Forgot your password?`` link, +on the login page. Then, fill the form with your email address or your username, +you'll receive an email to reset your password. diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 71ef27a0..236c44c3 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -25,8 +25,11 @@ La documentation principale de cette application est découpée en plusieurs sec :caption: Documentation utilisateur user/create_account + user/login user/configuration user/download_articles + user/filters + user/tags .. _dev-docs: 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 @@ +Filtres +======= 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 @@ +Se connecter +============ + +Votre compte est maintenant actif, félicitations ! + +Pour vous connecter à wallabag, remplissez le formulaire de connexion. + +Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connecté +vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an. + +.. image:: ../../img/user/login_form.png + :alt: Login form + :align: center + +Foire aux questions +------------------- + +J'ai oublié mon mot de passe +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``, +sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur, +un 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 @@ +Tags +==== \ No newline at end of file -- cgit v1.2.3 From 8b197f27d857f7e1f7f45b2eb9e793650a664fc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 20 Feb 2016 09:45:05 +0100 Subject: import and first article french translations --- docs/en/user/first_article.rst | 14 ++++--- docs/en/user/import.rst | 24 ++++++++---- docs/fr/index.rst | 2 + docs/fr/user/first_article.rst | 68 ++++++++++++++++++++++++++++++++++ docs/fr/user/import.rst | 83 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 178 insertions(+), 13 deletions(-) create mode 100644 docs/fr/user/first_article.rst create mode 100644 docs/fr/user/import.rst (limited to 'docs') 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 By using a bookmarklet ---------------------- -On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser. +On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` +link to your bookmarks bar of your browser. -Now, 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. +Now, 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. By using the classic form ------------------------- -In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article. +In the top bar of your screen, you have 3 icons. With the first one, a plus sign, +you can easily save a new article. .. image:: ../../img/user/topbar.png :alt: Top bar :align: center -Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved. +Click on it to display a new field, paste the article URL inside and press your +``Return`` key. The article is saved. By using a browser add-on ------------------------- @@ -59,4 +63,4 @@ Windows Phone iOS ~~~ -*This application is not yet available for wallabag v2*. \ No newline at end of file +*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. Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Click on ``Import`` link in the menu, select your export file on your computer and import it. +Click on ``Import`` link in the menu, choose the right wallabag version, +select your export file on your computer and import it. .. image:: ../../img/user/import_wllbg.png :alt: Import from wallabag 1.x @@ -40,24 +41,31 @@ All your wallabag articles will be imported. From Pocket ----------- -Create a new applicaton on Pocket -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a new application on Pocket +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To import your data from Pocket, we use the Pocket API. You need to create a new application on their developer website to continue. +To import your data from Pocket, we use the Pocket API. You need to create +a new application on their developer website to continue. * Create a new application `on the developer website `_ -* Fill in the required fields: application name, application description, permissions (only **retrieve**), platform (**web**), accept the terms of service and submit your new application +* Fill in the required fields: application name, application description, + permissions (only **retrieve**), platform (**web**), accept the terms of service + and submit your new application -Pocket 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. +Pocket 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. Now, all is fine to migrate from Pocket. Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section and then on ``Connect to Pocket and import data``. +Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section +and then on ``Connect to Pocket and import data``. -You 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). +You 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). From Instapaper --------------- 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 user/create_account user/login user/configuration + user/first_article + user/import user/download_articles user/filters 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 @@ +Sauvegardez votre premier article +================================= + +La fonctionnalité principale de wallabag est de sauvegarder des articles. +Vous avez plusieurs manières de le faire. + +.. note:: + + Un guide de démarrage s'affichera dans l'application jusqu'à ce que vous + enregistriez votre premier article. + +En utilisant le bookmarklet +--------------------------- + +Sur la page ``Aide``, vous avez un onglet ``Bookmarklet``. Glissez/déposez le lien ``bag it!`` +dans votre barre de favoris de votre navigateur. + +Maintennat, à chaque fois que vous lisez un article et que vous souhaitez le sauvegarder, +cliquez sur le lien ``bag it!`` dans votre barre de favoris. L'article est enregistré. + +En utilisant le formulaire classique +------------------------------------ + +Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icône, +un signe plus, vous pouvez facilement ajouter un nouvel article. + +.. image:: ../../img/user/topbar.png + :alt: Top bar + :align: center + +Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez +sur la touche ``Entrée``. L'article est enregistré. + +En utilisant l'extension de votre navigateur +-------------------------------------------- + +Firefox +~~~~~~~ + +*Cette extension n'est pas encore disponible pour wallabag v2*. + +Chrome +~~~~~~ + +*Cette extension n'est pas encore disponible pour wallabag v2*. + +En utilisant l'application de votre smartphone +---------------------------------------------- + +Android +~~~~~~~ + +*Cette application n'est pas encore disponible pour wallabag v2*. + +Firefox OS +~~~~~~~~~~ + +*Cette application n'est pas encore disponible pour wallabag v2*. + +Windows Phone +~~~~~~~~~~~~~ + +*Cette application n'est pas encore disponible pour wallabag v2*. + +iOS +~~~ + +*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 @@ +Migrer à wallabag +================= + +Depuis wallabag +--------------- + +Exportez vos données de wallabag 1.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``. + +.. image:: ../../img/user/export_wllbg_1.png + :alt: Export from wallabag 1.x + :align: center + +Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``. + +Exportez vos données de wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Dans la barre latérale de téléchargement, cliquez sur ``JSON``. + +.. image:: ../../img/user/export_wllbg_2.png + :alt: Export from wallabag 2.x + :align: center + +Vous obtiendrez un fichier ``Unread articles.json``. + +Importez vos données wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag correspondante, +sélectionnez votre fichier d'export sur votre ordinateur et importez-le. + +.. image:: ../../img/user/import_wllbg.png + :alt: Import from wallabag 1.x + :align: center + +Tous vos articles wallabag seront importés. + +Depuis Pocket +------------- + +Créer une nouvelle application dans Pocket +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Pour importer vos données depuis Pocket, nous utilisons l'API de Pocket. +Vous devez créer une nouvelle application sur leur site dédié aux développeurs pour continuer. + +* Créez une nouvelle application `sur leur site Développeurs `_ +* Remplissez les champs requis : nom de l'application, description de l'application, + permissions (seulement **retrieve**), la plateforme (**web**), acceptez les + termes d'utilisation du service et soumettez votre application + +Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`). +Vous devez configurer la ``pocket_consumer_key`` dans le fichier ``app/config/parameters.yml``. + +Maintenant, tout est bien configuré pour migrer depuis Pocket. + +Importez vos données dans wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans +la section Pocket puis sur ``Se connecter à Pocket et importer les données``. + +Vous devez autoriser wallabag à se connecter à votre compte Pocket. +Vos données vont être importées. L'import de données est une action qui peut être couteuse +pour votre serveur (nous devons encore travailler pour améliorer cet import). + +Depuis Instapaper +----------------- + +*Fonctionnalité pas encore implémentée dans wallabag v2.* + +Depuis Readability +------------------ + +*Fonctionnalité pas encore implémentée dans wallabag v2.* + +Depuis un fichier HTML ou JSON +------------------------------ + +*Fonctionnalité pas encore implémentée dans wallabag v2.* -- cgit v1.2.3