]> git.immae.eu Git - github/wallabag/wallabag.git/commitdiff
Merge pull request #1750 from wallabag/v2-quickstart-documentation
authorJeremy Benoist <j0k3r@users.noreply.github.com>
Fri, 4 Mar 2016 15:14:39 +0000 (16:14 +0100)
committerJeremy Benoist <j0k3r@users.noreply.github.com>
Fri, 4 Mar 2016 15:14:39 +0000 (16:14 +0100)
Documentation about filters / Quickstart changes

12 files changed:
docs/en/user/filters.rst
docs/fr/user/configuration.rst
docs/fr/user/create_account.rst
docs/fr/user/download_articles.rst
docs/fr/user/errors_during_fetching.rst
docs/fr/user/filters.rst
docs/fr/user/first_article.rst
docs/fr/user/import.rst
docs/fr/user/login.rst
docs/img/user/filters.png [new file with mode: 0644]
src/Wallabag/CoreBundle/Resources/views/themes/baggy/Static/quickstart.html.twig
src/Wallabag/CoreBundle/Resources/views/themes/material/Static/quickstart.html.twig

index 65fdedcba0e452dbe3772b729bf950b1f6083cd2..ad06819bb06c54ae780651bcee02ea6666f8f091 100644 (file)
@@ -1,2 +1,49 @@
 Filters
-=======
\ No newline at end of file
+=======
+
+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.
index 1b75f32fd2252655a0f1697798878cde549fdefd..ee5be052106ce5b15fbc257120f847e6b880f3a8 100644 (file)
@@ -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,
index 4fc9806992e6855b15b1d2989d73d6b7fd9458f2..7f29b0f00bf70bdb9ccb2e0e3528164672ff184c 100644 (file)
@@ -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
index dafeba37aee0b8838fb35781d86f0c37047b65a4..39c98206a5bdf56e6023dae5288e8a35b9f5dd51 100644 (file)
@@ -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
index b20e5973736ecc3317bd03bc85ff8118cee841ab..34a6ce186b6c1420586447bb6c68212bf3dbf8c2 100644 (file)
@@ -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
index ecb29948cd62cedeb3d06e7f4c5f8c6fec6e96ea..6592f140454cc8da2fddb96e6cc7a4c115edb4e6 100644 (file)
@@ -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.
index 90c45a44061afe9d8ac440f5f7e0abadf0116e04..f482badc9a6aa6d776d8190e4b898363a6c63974 100644 (file)
@@ -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
index c95f175d06ee512bba78b11665659b2dc4a1edc1..967df1f60eb3f2d95c01837d535ba3b595448ea9 100644 (file)
@@ -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.
index 7ef705691277f3afb7d56d93ef52475cc8012dcc..3a02d1d51ed9f4c5c6aeaf7c7599e26c5dbedbe9 100644 (file)
@@ -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
diff --git a/docs/img/user/filters.png b/docs/img/user/filters.png
new file mode 100644 (file)
index 0000000..e17b863
Binary files /dev/null and b/docs/img/user/filters.png differ
index 3984081c6a007aa30b9d39f34c2b8c51a7ee9b01..319eaea392a32241aafcce87b77cc2e9b8f330e0 100644 (file)
@@ -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>
index aff8dd2b897cbb11e18a5de4db760877b32a9c40..3d21271adddb03f7a70270ee3fa6d810f6557e65 100644 (file)
                     <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>
                     <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>