Merge pull request #1750 from wallabag/v2-quickstart-documentation

Documentation about filters / Quickstart changes
2024-09-28 14:22:02 +00:00 · 2016-03-04 16:14:39 +01:00 · 2016-03-04 16:14:39 +01:00 · e68568cd5b
commit e68568cd5b
parent d89908aed3 e166a58fd9
12 changed files with 143 additions and 18 deletions
--- a/docs/en/user/filters.rst
+++ b/docs/en/user/filters.rst
@ -1,2 +1,49 @@
 Filters
-=======
+=======
+
+To retrieve articles easier, you can use filters.
+Click on the third icon in the top bar.
+
+.. image:: ../../img/user/topbar.png
+   :alt: Top bar
+   :align: center
+
+All these filters can be combined.
+
+.. image:: ../../img/user/filters.png
+   :alt: Combine all filters
+   :align: center
+
+Status
+------
+
+Use these checkboxes to find archived or starred articles.
+
+Preview picture
+---------------
+
+Check this filter if you want to retrieve articles with a preview picture.
+
+Language
+--------
+
+wallabag (via graby) can detect article language. It's easy to you to retrieve articles
+written in a specific language.
+
+Reading time
+------------
+
+wallabag estimates how many time you need to read an article. With this filter,
+you can for example find the articles with a reading time between 2 and 5 minutes.
+
+Domain name
+-----------
+
+Thanks to this filter, you can retrieve the articles from the same domain name.
+For example, in this field, type ``bbc.co.uk`` to retrieve the articles of this website.
+
+Creation date
+-------------
+
+When you save an article, wallabag stored the current date. So handful to retrieve articles written
+between 1st and 31th January for example.
--- a/docs/fr/user/configuration.rst
+++ b/docs/fr/user/configuration.rst
@ -58,7 +58,7 @@ Si vous activez 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
+    :alt: Authentification à deux facteurs
    :align: center

 Si vous ne souhaitez pas recevoir un code à chaque fois que vous vous connectez,
--- a/docs/fr/user/create_account.rst
+++ b/docs/fr/user/create_account.rst
@ -4,14 +4,14 @@ 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
+   :alt: Formulaire de création de compte
   :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
+   :alt: Un email a été envoyé pour activer votre compte
   :align: center

 Vérifiez votre boite de réception, vous avez un nouvel email avec un lien comme celui-ci
@ -21,7 +21,7 @@ Cliquez dessus pour activer votre compte.
 Votre compte est maintenant actif.

 .. image:: ../../img/user/activated_account.png
-   :alt: Welcome on board!
+   :alt: Bienvenue à bord !
   :align: center

 Foire aux questions
--- a/docs/fr/user/download_articles.rst
+++ b/docs/fr/user/download_articles.rst
@ -6,12 +6,12 @@ Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PD
 Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale :

 .. image:: ../../img/user/download_article.png
-   :alt: download article
+   :alt: Télécharger l'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
+   :alt: Télécharger l'article
   :align: center
--- a/docs/fr/user/errors_during_fetching.rst
+++ b/docs/fr/user/errors_during_fetching.rst
@ -23,5 +23,5 @@ Si wallabag échoue en récupérant l'article, vous pouvez cliquer sur le bouton
 (le troisième sur l'image ci-dessous).

 .. image:: ../../img/user/refetch.png
-   :alt: Refetch content
+   :alt: Réessayer de récupérer le contenu
   :align: center
--- a/docs/fr/user/filters.rst
+++ b/docs/fr/user/filters.rst
@ -1,2 +1,50 @@
 Filtres
 =======
+
+Pour retrouver plus facilement vos articles, vous pouvez utiliser les filtres.
+Cliquez sur la troisième icône de la barre supérieure.
+
+.. image:: ../../img/user/topbar.png
+   :alt: Barre supérieure
+   :align: center
+
+Tous ces filtres peuvent être combinés.
+
+.. image:: ../../img/user/filters.png
+   :alt: Combine all filters
+   :align: center
+
+Statut
+------
+
+Utilisez ces cases à cocher pour retrouver les articles lus ou mis en favori.
+
+Image de prévisualisation
+-------------------------
+
+Cochez ce filtre si vous voulez retrouver les articles avec une image de prévisualisation.
+
+Langage
+-------
+
+wallabag (via graby) peut détecter la langue dans laquelle l'article est écrit.
+C'est ainsi facile pour vous de retrouver des articles écrits dans une langue spécifique.
+
+Temps de lecture
+----------------
+
+wallabag estime combien de temps vous avez besoin pour lire un article.
+Avec ce filtre, vous pouvez par exemple retrouver les articles qui ont une estimation
+entre 2 et 5 minutes.
+
+Nom de domaine
+--------------
+
+Grâce à ce filtre, vous pouvez retrouver les articles venant d'un même nom de domaine.
+Par exemple, dans ce champ, saisissez ``lemonde.fr`` pour retrouver les articles de ce site.
+
+Date de création
+----------------
+
+Quand vous ajoutez un article, wallabag stocke la date courante.
+C'est très pratique pour retrouver les articles ajoutés entre le 1er et le 31 janvier par exemple.
--- a/docs/fr/user/first_article.rst
+++ b/docs/fr/user/first_article.rst
@ -25,7 +25,7 @@ Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icôn
 un signe plus, vous pouvez facilement ajouter un nouvel article.

 .. image:: ../../img/user/topbar.png
-   :alt: Top bar
+   :alt: Barre supérieure
   :align: center

 Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez
--- a/docs/fr/user/import.rst
+++ b/docs/fr/user/import.rst
@ -10,7 +10,7 @@ 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
+   :alt: Export depuis wallabag 1.x
   :align: center

 Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``.
@ -21,7 +21,7 @@ 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
+   :alt: Export depuis wallabag 2.x
   :align: center

 Vous obtiendrez un fichier ``Unread articles.json``.
@ -33,7 +33,7 @@ Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag
 sélectionnez votre fichier d'export sur votre ordinateur et importez-le.

 .. image:: ../../img/user/import_wllbg.png
-   :alt: Import from wallabag 1.x
+   :alt: Import depuis wallabag 1.x
   :align: center

 Tous vos articles wallabag seront importés.
--- a/docs/fr/user/login.rst
+++ b/docs/fr/user/login.rst
@ -9,7 +9,7 @@ Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connec
 vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an.

 .. image:: ../../img/user/login_form.png
-   :alt: Login form
+   :alt: Formulaire de connexion
   :align: center

 Foire aux questions
--- a/docs/img/user/filters.png
+++ b/docs/img/user/filters.png
--- a/src/Wallabag/CoreBundle/Resources/views/themes/baggy/Static/quickstart.html.twig
+++ b/src/Wallabag/CoreBundle/Resources/views/themes/baggy/Static/quickstart.html.twig
@ -4,32 +4,47 @@

 {% block content %}

-    <h2>{% trans %}Welcome to wallabag!{% endtrans %}</h2>
+    <h3>{% trans %}Welcome to wallabag!{% endtrans %}</h3>
    <p>{% trans %}We'll accompany you to visit wallabag and show you some features which can interess you.{% endtrans %}</p>
    <p>{% trans %}Follow us!{% endtrans %}</p>
    <h4>{% trans %}Configure the application{% endtrans %}</h4>
    <ul>
        <li><a href="{{ path('config') }}">{% trans %}Change language and design{% endtrans %}</a></li>
        <li><a href="{{ path('config') }}#set2">{% trans %}Enable RSS feeds{% endtrans %}</a></li>
+        <li><a href="{{ path('config') }}#set5">{% trans %}Write rules to automatically tag your articles{% endtrans %}</a></li>
    </ul>
-    <h3>{% trans %}First steps{% endtrans %}</h3>
+    {% if is_granted('ROLE_SUPER_ADMIN') %}
+        <h4>{% trans %}Administration{% endtrans %}</h4>
+        <p>{% trans %}As a administrator, you have privileges on wallabag. You can:{% endtrans %}</p>
+        <ul>
+            <li><a href="{{ path('config') }}#set6">{% trans %}Create a new user{% endtrans %}</a></li>
+            <li><a href="{{ path('craue_config_settings_modify') }}#set-analytics">{% trans %}Configure analytics{% endtrans %}</a></li>
+            <li><a href="{{ path('craue_config_settings_modify') }}#set-entry">{% trans %}Enable some parameters about article sharing{% endtrans %}</a></li>
+            <li><a href="{{ path('craue_config_settings_modify') }}#set-export">{% trans %}Configure export{% endtrans %}</a></li>
+            <li><a href="{{ path('craue_config_settings_modify') }}#set-import">{% trans %}Configure import{% endtrans %}</a></li>
+        </ul>
+    {% endif %}
+    <h4>{% trans %}First steps{% endtrans %}</h4>
    <ul>
        <li><a href="{{ path('new') }}">{% trans %}Save your first article{% endtrans %}</a></li>
        <li><a href="{{ path('unread') }}">{% trans %}And classify it!{% endtrans %}</a></li>
    </ul>
-    <h3>{% trans %}Migrate from an existing service{% endtrans %}</h3>
+    <h4>{% trans %}Migrate from an existing service{% endtrans %}</h4>
    <p>{% trans %}You're using an other service? We'll help you to retrieve your data on wallabag.{% endtrans %}</p>
    <ul>
        <li><a href="{{ path('import_pocket') }}">{% trans %}Migrate from Pocket{% endtrans %}</a></li>
        <li><a href="{{ path('import_wallabag_v1') }}">{% trans %}Migrate from wallabag v1{% endtrans %}</a></li>
+        <li><a href="{{ path('import_wallabag_v2') }}">{% trans %}Migrate from wallabag v2{% endtrans %}</a></li>
    </ul>
-    <h3>{% trans %}Full documentation{% endtrans %}</h3>
+    <h4>{% trans %}Full documentation{% endtrans %}</h4>
    <ul>
+        <li><a href="http://wallabag.readthedocs.org">{% trans %}Annotate your article{% endtrans %}</a></li>
        <li><a href="http://wallabag.readthedocs.org">{% trans %}Convert your articles into ePUB or PDF{% endtrans %}</a></li>
        <li><a href="http://wallabag.readthedocs.org">{% trans %}See how you can look for an article by using search engine and filters{% endtrans %}</a></li>
+        <li><a href="http://wallabag.readthedocs.org">{% trans %}What can I do if an article encounters errors during fetching?{% endtrans %}</a></li>
        <li><a href="http://wallabag.readthedocs.org">{% trans %}And so many other articles!{% endtrans %}</a></li>
    </ul>
-    <h3>{% trans %}Support{% endtrans %}</h3>
+    <h4>{% trans %}Support{% endtrans %}</h4>
    <p>{% trans %}If you need some help, we are here for you.{% endtrans %}</p>
    <ul>
        <li><a href="https://github.com/wallabag/wallabag/issues/">{% trans %}On GitHub{% endtrans %}</a></li>
--- a/src/Wallabag/CoreBundle/Resources/views/themes/material/Static/quickstart.html.twig
+++ b/src/Wallabag/CoreBundle/Resources/views/themes/material/Static/quickstart.html.twig
@ -16,7 +16,19 @@
                    <ul>
                        <li><a href="{{ path('config') }}">{% trans %}Change language and design{% endtrans %}</a></li>
                        <li><a href="{{ path('config') }}#set2">{% trans %}Enable RSS feeds{% endtrans %}</a></li>
+                        <li><a href="{{ path('config') }}#set5">{% trans %}Write rules to automatically tag your articles{% endtrans %}</a></li>
                    </ul>
+                    {% if is_granted('ROLE_SUPER_ADMIN') %}
+                    <h4>{% trans %}Administration{% endtrans %}</h4>
+                    <p>{% trans %}As a administrator, you have privileges on wallabag. You can:{% endtrans %}</p>
+                    <ul>
+                        <li><a href="{{ path('config') }}#set6">{% trans %}Create a new user{% endtrans %}</a></li>
+                        <li><a href="{{ path('craue_config_settings_modify') }}#set-analytics">{% trans %}Configure analytics{% endtrans %}</a></li>
+                        <li><a href="{{ path('craue_config_settings_modify') }}#set-entry">{% trans %}Enable some parameters about article sharing{% endtrans %}</a></li>
+                        <li><a href="{{ path('craue_config_settings_modify') }}#set-export">{% trans %}Configure export{% endtrans %}</a></li>
+                        <li><a href="{{ path('craue_config_settings_modify') }}#set-import">{% trans %}Configure import{% endtrans %}</a></li>
+                    </ul>
+                    {% endif %}
                    <h4>{% trans %}First steps{% endtrans %}</h4>
                    <ul>
                        <li><a href="{{ path('new') }}">{% trans %}Save your first article{% endtrans %}</a></li>
@ -27,11 +39,14 @@
                    <ul>
                        <li><a href="{{ path('import_pocket') }}">{% trans %}Migrate from Pocket{% endtrans %}</a></li>
                        <li><a href="{{ path('import_wallabag_v1') }}">{% trans %}Migrate from wallabag v1{% endtrans %}</a></li>
+                        <li><a href="{{ path('import_wallabag_v2') }}">{% trans %}Migrate from wallabag v2{% endtrans %}</a></li>
                    </ul>
                    <h4>{% trans %}Full documentation{% endtrans %}</h4>
                    <ul>
+                        <li><a href="http://wallabag.readthedocs.org">{% trans %}Annotate your article{% endtrans %}</a></li>
                        <li><a href="http://wallabag.readthedocs.org">{% trans %}Convert your articles into ePUB or PDF{% endtrans %}</a></li>
                        <li><a href="http://wallabag.readthedocs.org">{% trans %}See how you can look for an article by using search engine and filters{% endtrans %}</a></li>
+                        <li><a href="http://wallabag.readthedocs.org">{% trans %}What can I do if an article encounters errors during fetching?{% endtrans %}</a></li>
                        <li><a href="http://wallabag.readthedocs.org">{% trans %}And so many other articles!{% endtrans %}</a></li>
                    </ul>
                    <h4>{% trans %}Support{% endtrans %}</h4>