From a42938f42caf91a602617ef4354d17e1bc3f3629 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 8 Jan 2016 15:02:51 +0100 Subject: documentation cleaning --- docs/en/user/configuration.rst | 40 ++++++++++++++++++++++++++++++++++++- docs/en/user/download_articles.rst | 16 +++++++++++++++ docs/en/user/filters.rst | 2 ++ docs/en/user/first_article.rst | 41 ++++++++++---------------------------- docs/en/user/import.rst | 25 +++++++++++++++++++++++ docs/en/user/tags.rst | 2 ++ 6 files changed, 94 insertions(+), 32 deletions(-) create mode 100644 docs/en/user/download_articles.rst create mode 100644 docs/en/user/filters.rst create mode 100644 docs/en/user/tags.rst (limited to 'docs/en/user') diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index 60aae4e5..369c977a 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst @@ -3,7 +3,7 @@ Configuration Now you're logged in, it's time to configure your account as you want. -Click on ``Config`` menu. You have four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``. +Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``. Settings -------- @@ -59,3 +59,41 @@ Password -------- You can change your password here. + +Tagging rules +------------- + +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. + +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. +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 »*. + +Which variables and operators can I use to write rules? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following variables and operators can be used to create tagging rules: + +=========== ============================================== ======== ========== +Variable Meaning Operator Meaning +----------- ---------------------------------------------- -------- ---------- +title Title of the entry <= Less than… +url URL of the entry < Strictly less than… +isArchived Whether the entry is archived or not => Greater than… +isStared Whether the entry is starred or not > Strictly greater than… +content The entry's content = Equal to… +language The entry's language != Not equal to… +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 diff --git a/docs/en/user/download_articles.rst b/docs/en/user/download_articles.rst new file mode 100644 index 00000000..21ab1995 --- /dev/null +++ b/docs/en/user/download_articles.rst @@ -0,0 +1,16 @@ +Download 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 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 diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst new file mode 100644 index 00000000..65fdedcb --- /dev/null +++ b/docs/en/user/filters.rst @@ -0,0 +1,2 @@ +Filters +======= \ No newline at end of file diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst index 4e6735c6..c1ffd23f 100644 --- a/docs/en/user/first_article.rst +++ b/docs/en/user/first_article.rst @@ -27,53 +27,32 @@ By using a browser add-on Firefox ~~~~~~~ -Firefox Classic Add-on -^^^^^^^^^^^^^^^^^^^^^^ - -Download the Firefox add-on at `addons.mozilla.org`_ and install it like -any other Firefox add-on. - -In the add-on’s settings, fill the complete URL of your installation of -wallabag or your Framabag account. - -Personalize the Firefox toolbar to add wallabag (**W** icon). When you -find an article you want to save, click on this icon: a new window will -open to add the article and will close itself automatically. - -Firefox Social API Service -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -*Available from wallabag v1.9.1 only* - -You will need an https connection to use this. It’s a Firefox -`requirement`_, sorry. - -With Firefox 29+ versions, your browser comes with an integrated -interface to share things to multiple social services directly from your -browser. In the Firefox interface, it is shown a paper plane-like icon -that you will use to share a page, which means here, save an article. -You can add the service by going into the Config page of wallabag, then -click on Mozilla Services Social API Extension. You must also accept to -use Firefox Services. +*This addon is not yet available for wallabag v2*. Chrome ~~~~~~ +*This addon is not yet available for wallabag v2*. + By using your smarphone application ----------------------------------- Android ~~~~~~~ +*This application is not yet available for wallabag v2*. + Firefox OS ~~~~~~~~~~ +*This application is not yet available for wallabag v2*. + Windows Phone ~~~~~~~~~~~~~ +*This application is not yet available for wallabag v2*. + iOS ~~~ - -.. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/ -.. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents +*This application is not yet available for wallabag v2*. \ No newline at end of file diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index d326b06e..8f6cf4c1 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -29,11 +29,36 @@ All your wallabag 1.x articles will be imported. From Pocket ----------- +Create a new applicaton 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. + +* 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 + +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``. + +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 --------------- +*Feature not yet implemented in wallabag v2.* + From Readability ---------------- +*Feature not yet implemented in wallabag v2.* + From HTML or JSON file ---------------------- + +*Feature not yet implemented in wallabag v2.* diff --git a/docs/en/user/tags.rst b/docs/en/user/tags.rst new file mode 100644 index 00000000..8ddc0f40 --- /dev/null +++ b/docs/en/user/tags.rst @@ -0,0 +1,2 @@ +Tags +==== \ No newline at end of file -- cgit v1.2.3