Features
========

.. warning::

   | **rdltr** is no longer maintained.

Users
^^^^^

- User must to register to use **rdltr**.
- User registration can be disabled with the environment variable ``RDLTR_ALLOW_REGISTRATION`` initialized to ``false`` (see `Installation <installation.html>`__)

.. note::
    **rdltr** was originally intended to be single-user application. No administration is planned for now.

Settings
^^^^^^^^

- User can add and modify **categories** and **tags**.

.. figure:: _images/screenshot_settings.png
   :alt: rdltr settings screenshot
   :figclass: doc-img

   **rdltr** settings

- Categories.

.. figure:: _images/screenshot_categories.png
   :alt: rdltr categories screenshot
   :figclass: doc-img

   **rdltr** categories (example)

.. note::
    Pre-existing default category can not be deleted.

- Tags

.. figure:: _images/screenshot_tags.png
   :alt: rdltr tags screenshot
   :figclass: doc-img

   **rdltr** tags (example)

Articles
^^^^^^^^
- User can add an article from an URL: **rdltr** gets only the article content (server-side scraping). Links to images or videos remain unchanged and therefore point to the original resources.

.. figure:: _images/screenshot_add.png
   :alt: rdltr screenshot
   :figclass: doc-img


.. figure:: _images/screenshot_article.png
   :alt: rdltr article screenshot
   :figclass: doc-img

   example of an article saved with **rdltr** (truncated)

- Articles can be organized into categories and tagged. If the category is not specified, the article is added into the default one.
- Articles can be marked as **read**.
- Articles can be marked as **favorite**.
- Article content can be reloaded (only server-side scraping).

.. warning::
    if the content was initially scraped browser-side, the reloaded content can be incomplete or different.

- User can add comments.
- A keywords **search** (on article title and content) is available.

.. figure:: _images/screenshot.png
   :alt: rdltr screenshot
   :figclass: doc-img

Share from others applications to rdltr
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- It is possible to add articles from `FreshRSS <https://freshrss.org/>`__.

To add **rdtlr** share link, select "**wallabag v2**" and enter **rdltr** instance URL:

.. figure:: _images/freshrss_settings.png
   :alt: freshrss settings screenshot
   :figclass: doc-img

The share link will be available in the feed item:

.. figure:: _images/freshrss_share_link.png
   :alt: freshrss share link screenshot
   :figclass: doc-img


Web extension
^^^^^^^^^^^^^

- A `Firefox add-on <https://addons.mozilla.org/en-US/firefox/addon/rdltr/>`__ is available. It allows to add content from browser side.

.. figure:: _images/addon_popup.png
   :alt: add-on popup screenshot
   :figclass: doc-img

- To configure it, enter instance url and credentials to connect to **rdltr**.

.. figure:: _images/addon_settings.png
   :alt: add-on options screenshot
   :figclass: doc-img