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 ++++++++++++++++++++++++++--------------- 4 files changed, 61 insertions(+), 26 deletions(-) (limited to 'docs/en') 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 +=========== ============================================== ======== ========== -- 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 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'docs/en') 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. -- 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 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/en') 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 -- 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 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'docs/en') 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. -- 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 ++++++++++++++++-------- 2 files changed, 25 insertions(+), 13 deletions(-) (limited to 'docs/en') 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 --------------- -- cgit v1.2.3