Merge pull request #2550 from wallabag/reorder-documentation

[github/wallabag/wallabag.git] / docs / en / user / articles.rst

Articles
========

Save your first article
-----------------------

The main purpose of wallabag is to save web articles. You have many ways to do it. If you think that the article is wrong displayed, `you can read this documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_.

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.

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.

.. 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.

By using a browser add-on
^^^^^^^^^^^^^^^^^^^^^^^^^

Firefox
"""""""

You can download the `Firefox addon here <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_.

Chrome
""""""

You can download the `Chrome addon here <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_.

By using your smarphone application
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Android
"""""""

You can download the `Android application here <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_.

Windows Phone
"""""""""""""

You can downlaod the `Windows Phone application here <https://www.microsoft.com/store/apps/9nblggh5x3p6>`_.

Download your articles
----------------------

You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV.

On the article view, click on this icon, in the sidebar:

.. image:: ../../img/user/download_article.png
   :alt: download article
   :align: center

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

Share your articles
-------------------

When you're reading an article, you can share it. Just click on the share button:

.. image:: ../../img/user/share.png
   :alt: share article
   :align: center

Now, you can share the article:

- with a public URL (you'll have a light view of the article)
- with a tweet
- into your Shaarli
- with a post in Diaspora*
- to Carrot
- with an email

Annotate your articles
----------------------

In each article you read, you can write annotations. It's easier to understand with some pictures.

Select the part of the article that you want to annotate and click on the pencil:

.. image:: ../../img/user/annotations_1.png
   :alt: Select your text
   :align: center

Then, write your annotation:

.. image:: ../../img/user/annotations_2.png
   :alt: Write your annotation
   :align: center

The text is now highlighted and you can read your annotation if you move the mouse cursor over it.

.. image:: ../../img/user/annotations_3.png
   :alt: Read your annotation
   :align: center

You can create as many annotations as you wish.