1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2025-08-01 17:38:38 +00:00
This commit is contained in:
Nicolas Lœuillet 2015-10-21 14:14:51 +02:00
parent a4e1ddf2d6
commit 59e91bc893
58 changed files with 2643 additions and 0 deletions

View file

@ -0,0 +1,118 @@
.. _`Configure wallabag`:
Configure wallabag
==================
From the configuration menu, you can change some of wallabag's options.
Some parts won't be detailed here, as they have a dedicated chapter in
the documentation (:ref:`RSS feeds`, :ref:`Import / Export`, :ref:`ePub conversion` and :ref:`Multi users`).
Saving articles
---------------
You'll find help about the different ways to save articles to your
wallabag here.
Save article field
~~~~~~~~~~~~~~~~~~
Enter a link in the field and click “bag it!” to save.
Browser extensions
~~~~~~~~~~~~~~~~~~
Links to download extensions for your favourite browser, Firefox or
Chrome.
Mobile apps
~~~~~~~~~~~
Links to download mobile apps, Android, iOS or Windows Phone.
For Android, you have the choice to download either from Google's Play
Store of from the Free and Open Source market
`F-Droid <https://f-droid.org>`__
Bookmarklet
~~~~~~~~~~~
Lastly, you can use the bookmarklet. A bookmarklet is a simple link you
can drag to your browser's bookmarks. Once it's in your bookmarks,
simply clicking on it will save the webpage you're currently viewing to
your wallabag.
Feeds
-----
Plese refer to `RSS feeds <rss_feed.html>`__ for more details.
.. _`Howto change theme`:
Theme
-----
As they say, “all tastes and colors are found in nature”. That's why
wallabag allows you to change its appearance through the use of themes,
in order to please everyone.
Select the theme of your choice from the drop down list and confirm by
clicking on **Update**.
Language
--------
Select the language of your choice in the drop down list and confirm by
clicking on **Update**.
Import
------
Please refer to `Import/Export <import_export.html>`__ for more details.
Export
------
Please refer to `Import/Export <import_export.html>`__ for more details.
Clear the cache
---------------
The cache allows wallabag perform certain functions faster.
After updating wallabag, it is advised to clear the cache.
Click on “delete cache” to do so (no confirmation will be asked).
Password
--------
Fill in your new password in the two dedicated fields and confirm by
clicking on **Update**.
You will be disconnected and will have to enter your new password to
access your wallabag.
User
----
Add a user here by entering their name, password and (optionnaly) email
in the corresponding fields.
You may not be able to add a user if don't have the rights to do so.
Remind newly created users to change their password the first time they
connect to wallabag!
Delete
------
Delete your user account on wallabag here.
If there is only one account, you won't be able to delete the account.
Upgrade
-------
Wallabag will check its curent version and if there is a new version
available and display this information here.

View file

@ -0,0 +1,32 @@
.. _`ePub conversion`:
ePub conversion
===============
To enable you to read your articles on a e-reader, wallabag can convert
them to the ePub format, and hence create an eBook for your long winter
evenings.
A word of caution
-----------------
Be careful, the creation of ePub files can be very resource demanding
for the server on which wallabag is installed. It depends on the number
of articles and on their length. Do not create a really big eBook if
this is not necessary.
Where to convert the articles
-----------------------------
You can convert your articles at various places in wallabag:
- on the reading page of an article: the ePub link will convert this
article only
- from the list of articles (unread, favorite or archived articles,
articles with a tag): a link at the bottom of the page allows you to
convert all the article of this category
- from a search: the link is at the bottom of the page
- from the configuration page: you can convert all your articles,
whatever the category to which they belong
TODO talk about calibre

View file

@ -0,0 +1,49 @@
.. _`Framabag account creation`:
Framabag account creation
=========================
If you do not want to install and update wallabag, or if you do not have
the know-how to install it, it is possible to create an account for free
at `Framabag.org <https://www.framabag.org>`__.
Account creation
----------------
Click on the button **Créez votre compte / Create your account**.
You have to input some information: your username, your password and
your email address. Your address is used only to validate your account,
except if you check the box to subscribe the newsletter (3 to 4 messages
per year).
Once this form validated, you will receive an email with the
confirmation link. Click on it to create your account.
You will receive a last email with the address of your Framabag account,
which will look like ``https://www.framabag.org/u/Your-username``.
Information storage
-------------------
Framabag use one database per user. We do not and will not use your
stored data.
You have forgotten your password
--------------------------------
| If you have forgotten your password to get connected to Framabag, a
form is available `on the main page of the
service <https://www.framabag.org>`__.
| Fill it, and a confirmation will be sent to you and will allow you to
input a new password.
Account deletion
----------------
If you wish to delete your account, contact us by email:
hello@wallabag.org using the address your created your account with, and
state your username.
We will answer you after your account has been deleted: then, no
information about you will be stored by Framabag.

View file

@ -0,0 +1,107 @@
.. _`Import / Export`:
Import and export data
======================
Import
------
To import data in wallabag, go to the page **Configuration**.
Caution
~~~~~~~
Data import can be a **demanding process** for your server. Hence, it is
done in two steps:
- Insertion of the URL in the wallabag database
- in the second step, the retrieval, for each article, of its full
content.
These two steps cannot be done concurrently, because it let us the
possibility to import thousands of links, but today, wallabag does not
have sufficient technical capabilities to do this task automatically.
From Pocket
~~~~~~~~~~~
Export your data from Pocket
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
From your Pocket account, go to the options. TODO
Import your Pocket data
^^^^^^^^^^^^^^^^^^^^^^^
From the configuration page of wallabag, section **Import**, select the
file ``ril_export.html`` generated by Pocket, then click on **Import**.
Wallabag only insert these links in the database. Now, you have to get
the content of each article.
For this, click on ``Click to finish import``: wallabag will fetch the
content of 10 articles at a time.
TODO
TODO new ticket: why when a click is done, this does not load in a loop?
I believe this was doing this ping @mariroz
From Instapaper
~~~~~~~~~~~~~~~
Export your data from Instapaper
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO
Import your Instapaper data
^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO
From Readability
~~~~~~~~~~~~~~~~
Export your data from Readability
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO
Import your Readability data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO
From wallabag
~~~~~~~~~~~~~
Since you can export your data from wallabag (see below), it is of
course possible to re-import them.
In the import form, select your wallabag-exported file (format JSON).
Start the import, et voilà.
Unlike the above imports, this process is shorter because all the data
(title and content of the articles) are already included in the file.
Hence wallabag does not have to access each URL. However, the import
file is necessarily bigger.
From a HTML or JSON file
~~~~~~~~~~~~~~~~~~~~~~~~
TODO
Export
------
It is possible to export your data from the page **Configuration** of
wallabag. Several reasons to do this:
- re-install of wallabag
- leave the Framabag service to install your own wallabag
- a user with an account on a multi-user wallabag want to have his/her
own wallabag installation
- ...
This will lead you to download a file `at the JSON
format <http://en.wikipedia.org/wiki/JavaScript_Object_Notation>`__. As detailed above, you can import this file in wallabag.

View file

@ -0,0 +1,36 @@
.. _`Article is not displayed properly`:
My article is not displayed properly in wallabag
================================================
If you think wallabag do not copy well the content of an article (empty
or incomplete text), here are some suggestions.
Ask for help
------------
Via an email or a ticket, do not forget to give some information that
are important for us to better solve the problem:
- The URL of the article
- What wallabag displays
- What you were expecting
- The wallabag version of if you use Framabag
Open a ticket on github
~~~~~~~~~~~~~~~~~~~~~~~
To open a new ticket, you should `go to
github <https://github.com/wallabag/wallabag/issues/new>`__. An account
is required. Do not forget to send us the information listed above.
Send us an email
~~~~~~~~~~~~~~~~
Send us the link in a email to the address
`hello@wallabag.org <mailto:hello@wallabag.org?subject=Wrong%20display%20in%20wallabag>`__. Do not forget to send us the information listed above.
Solve this display problem
--------------------------
TODO

View file

@ -0,0 +1,109 @@
.. _`Organize articles`:
Organize articles
=================
To be able to find more easily your articles, several methods are
available.
Tags
----
Assign a tag
~~~~~~~~~~~~
When saving an article
^^^^^^^^^^^^^^^^^^^^^^
To tag an article when saving it, just click on the tag icon next to the
URL field before hitting the Save button. At the moment, it is possible
only to do this from the web interface, but it could come to some apps
or extensions.
From the article
^^^^^^^^^^^^^^^^
To tag an already-saved article, go to the reading page of the article.
There is a part ``tags`` followed with a pencil. Click on the pencil.
Input in the box the tags you want to assign. Add as many tags as you
want. They need to be separated by commas and not spaces.
Auto-completion is available here: when you type the first letters of an
existing tag, it is not necessary to type the whole word. Select it in
the drop-down list. Once all your tags are inputted, click on the button
**Tag**.
Then, you can go back to your article and read it.
From the search
^^^^^^^^^^^^^^^
A full chapter on search is available. Here, we will describe only how
to assign a tag from your search.
When your search displays results, there is a link
``Apply the tag ABCD to this search`` at the bottom of the page. Click
on it: a tad depending on your search (here ``ABCD``) will be assigned
to all the articles found.
Find all the articles with a given tag
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the wallabag menu, click on **Tags**. Then, all the tags you have
created are displayed, sorted by the number of articles for each tag.
Click on one of these tags to find all the articles with this tag.
Preferred articles
------------------
When you wish to set aside an article, you can mark it as preferred.
Set an article as favorite
~~~~~~~~~~~~~~~~~~~~~~~~~~
From the reading page of an article, or from a list of articles (such as
the list of unread articles), you can set an article as favorite simply
by a click on the star which is displayed. Click again on the star will
remove the **favorite** status of this article.
Find all the favorite articles
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the wallabag menu, click on **Favorites** to display the list of all
the articles that you have set as favorite.
Archived articles
-----------------
When you have read an article, you can archive it: hence it will not be
displayed in your list of unread articles.
Archiving an article does not remove it from wallabag.
Archive an article
~~~~~~~~~~~~~~~~~~
| From the reading page of an article, or from a list of articles (such
as the list of unread articles), you can archive an article simply by
clicking on the icon ✓.
| Click again on this icon will set back the **unread** status of the
article.
Find all the archived articles
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the wallabag menu, click on **Archive** to find all the articles that
you have archived.
Delete an article
-----------------
Be cautious: the deletion of an article is **definitive**. It is deleted
from the wallabag database.
To delete an article, a trash icon is displayed on the page of an
article or of a list of articles (unread articles, favorites or
archived, for example).
We trust you: that is why there is no confirmation message during the
deletion.

View file

@ -0,0 +1,63 @@
Read an article
===============
Reading an article is not difficult in wallabag: you only have to click on the title of the article for it to be displayed.
Back to where you left the article
----------------------------------
If you stop reading an article halfway through, the next time wallabag will open it right where you left off.
This feature only works with web applications and not with smartphone applications.
Possible actions in an article
------------------------------
The following actions can be performed through the icons displayed at the top of the page. We assume here that you are using the Baggy theme (see the section on :ref:`Howto change theme`). Icons in other themes are very similar.
Here are the actions, in the order of appearance of the icons.
Read the original article
~~~~~~~~~~~~~~~~~~~~~~~~~
Open the article on its original location.
Mark the article as read
~~~~~~~~~~~~~~~~~~~~~~~~
Archive the article, which will be placed into the **Archive** category of the wallabag menu. Clicking again on this button will move the article back to the **unread** category.
Mark the article as favorite
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Mark the article as favorite, and it will be placed into the **Favorites** category of the wallabag menu. Clicking again on this button will remove the favorite status.
Delete the article
~~~~~~~~~~~~~~~~~~
Delete the article from wallabag permanently. It cannot be restored. Be careful: no confirmation message is displayed.
Share through twitter
~~~~~~~~~~~~~~~~~~~~~
Share the title and the original link of the article on twitter.
Share via email
~~~~~~~~~~~~~~~
Share the title and the original link of the article via e-mail.
Print the article
~~~~~~~~~~~~~~~~~
Open the print window of the browser.
Convert into ePub
~~~~~~~~~~~~~~~~~
Convert the article into ePub format: see the section on :ref:`ePub conversion`.
Notify us that the article appears wrong
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Notify the wallabag developers that an article is not displayed as expected (see the section on :ref:`Article is not displayed properly`).

41
docs/en/User/rss_feed.rst Normal file
View file

@ -0,0 +1,41 @@
.. _`RSS feeds`:
RSS feeds
=========
The RSS feeds allow you to:
- read your articles from your favorite RSS feed reader.
- to activate the reading features for smartphone softwares
| First, you must activate the RSS feature by generating a feed token.
| Go to **config** in wallabag and generate a token in the section
**Feeds**. You can generate a new token at any time.
Read articles
-------------
Once the token created, you have access to three RSS feeds:
- the one of the unread articles
- the one of the favorites articles
- the one of the archived articles
Add the feed you want to your RSS feed reader. Be careful: when you will
be reading an article from your feed reader, this will not set it as
read in wallabag.
Share your readings
~~~~~~~~~~~~~~~~~~~
If you wish to share your readings with somebody, send him for example
the RSS feed of your favorite articles. Hence, as soon as an article
will be set as favorite in wallabag, this person will be able to read it
too.
Activate the features for smartphones
-------------------------------------
You ave created an RSS feed token. It will also be useful to you to
configure your smartphone software. For more information about
smartphone sofwares, you can read :ref:`Save your first article`.

View file

@ -0,0 +1,226 @@
.. _`Save your first article`:
Save your first article
=======================
Once connected on wallabag, you have many ways to save an article.
From the web application
------------------------
Lets see first how to do from the web application. In the menu, you
have a link **save a link**. Clicking on it, a form shows up: you simply
have to type the web adress of the article you want to save.
Confirm to store the content of the article.
By default, only the text is saved. If you want to store a copy of the
images on your server, you have to enable the setting
*DOWNLOAD\_PICTURES*. Read the chapter on hidden options for more
information.
From the bookmarklet
--------------------
From `Wikipedias definition`_
A bookmarklet is a `bookmark`_ stored in a `web browser`_ that
contains `JavaScript`_\ commands to extend the browsers
functionality.
Bookmarklets are unobtrusive scripts stored as the URL of a bookmark
in a web browser or as a hyperlink on a web page.
When clicked, a bookmarklet performs some function, one of a wide
variety such as a search query or data extraction. Bookmarklets are
usually `JavaScript programs`_.
From the wallabags menu, click on **settings**. On the first part of
this page, we have listed all the ways to save an article. Youll find
the bookmarklet (its the ``Bag it!`` link) to drag and drop in the
bookmarks bar of your web browser. From now on, when you want to save
the article you are browsing, you just have to click on this bookmarklet
and the article will be automatically saved.
From your smartphone
--------------------
Above all else
~~~~~~~~~~~~~~
To use a smartphone application, you have to enable RSS feeds from the
settings panel of wallabag. Then some information will be displayed,
like your security token. Read the chapter on RSS feeds for more
information.
Android
~~~~~~~
Installation and configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can download the android application from the `Google Play Store`_
and from `F-droid`_. Its the exact same application on those two
stores.
Once installed, start the application, go to the **settings** part et
fill in the **URL (complete address of your wallabag installation or
your Framabag account)** and **User ID (in most cases, youll have to
put 1)** fields. If you have created multiple accounts from wallabag,
you will have to to fill the user account you want to connect to your
application and your security **Token** (enter properly all the tokens
letters as seen in the settings part of wallabag).
Saving of an article
^^^^^^^^^^^^^^^^^^^^
Now that everything is correctly set up, as soon as you browse on your
smartphones web browser, you can share an article in wallabag at any
time from the **Share** menu: youll find a **Bag it!** entry which will
add your article in wallabag.
Reading
^^^^^^^
When you open the application, click on Synchronize: your recently saved
articles will be downloaded on your smartphone.
You dont need an internet connection anymore: click on **List
articles** to start your reading.
At the end of each article, a **Mark as read** button allows you to
archive the article.
To date, the synchronisation occurs in one direction (from wallabag to
the application), thus preventing mark as read an article on wallabag
from your smartphone.
iOS
~~~
Installation and configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can download the iOS application from the `AppStore`_.
Once installed, configure the app by filling following fields inside the
settings: the **URL (complete address of your wallabag installation or
your Framabag account)** and **User ID (in most cases, youll have to
put 1)** field. If you have created multiple accounts from wallabag, you
will have to to fill the user account you want to connect to your
application and your security **Token** (enter properly all the tokens
letters as seen in the settings part of wallabag).
Usage
^^^^^
If the app is configured correctly, the app will automatically download
the articles from your wallabag (use **pull-to-refresh** to trigger this
update manually). Once an article is downloaded, itll be available
offline from your app.
Unfortunately you can only locally mark an article as read (it will not
synchronise to your online wallabag).
Saving articles
~~~~~~~~~~~~~~~
If youre browsing a website and want to add the current article to your
wallabag, simply tap the **Share**-button and select **Bag it!** (if you
dont find the wallabag icon, have a look in the **more**-menu). If
everything is set up correctly, your article will be saved (you may have
to login from time to time).
Windows Phone
~~~~~~~~~~~~~
Installation and configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can download the Windows Phone application from the `Windows Store`_
or directly from your smartphones Store.
Once installed, the application will show you a notification on the
first launch, asking the configuration of your wallabag server. Go to
the **Settings** part of the application by pressing the three dots menu
at the bottom of the screen, then fill in the **URL (complete address of
your wallabag installation or your Framabag account)** and **User ID (in
most cases, youll have to put 1)** fields.
If you have created multiple accounts from wallabag, you will have to to
fill the user account you want to connect to your application and your
security **Token** (enter properly all the tokens letters as seen in
the setting part of wallabag).
From your web browser
---------------------
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-ons 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. Its 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.
Chrome
~~~~~~
Download the Chrome add-on `on the dedicated website`_ and install it
like any other Chrome add-on.
In the add-ons settings, fill the complete URL of your installation of
wallabag or your Framabag account.
During the addons installation, a new icon appear in Chrome toolbar (a
**W** icon). When you find an article you want to save, click on this
icon: a popup will appear to confirm that your article has been saved.
Opera
~~~~~
The recent versions of Opera (15+) allow to install add-ons compatible
with Chrome.
First, install the add-on named `Download Chrome Extensions`_ which will
allow you to install add-ons from the Chrome Web Store. Then, go `to to
Google site`_ and get the Chrome add-on by clicking on *Add to Opera*. A
message will invite you to confirm this action because this add-on is
not coming from a certified source. The behavior will be the same as for
Chrome (see above).
.. _Wikipedias definition: http://fr.wikipedia.org/wiki/Bookmarklet
.. _bookmark: http://en.wikipedia.org/wiki/Internet_bookmark
.. _web browser: http://en.wikipedia.org/wiki/Web_browser
.. _JavaScript: http://en.wikipedia.org/wiki/JavaScript
.. _JavaScript programs: http://en.wikipedia.org/wiki/Computer_program
.. _Google Play Store: https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche
.. _F-droid: https://f-droid.org/app/fr.gaulupeau.apps.InThePoche
.. _AppStore: https://itunes.apple.com/app/id828331015
.. _Windows Store: https://www.microsoft.com/en-us/store/apps/wallabag/9nblggh11646
.. _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
.. _on the dedicated website: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj
.. _Download Chrome Extensions: https://addons.opera.com/en/extensions/details/download-chrome-extension-9/
.. _to to Google site: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj

21
docs/en/User/search.rst Normal file
View file

@ -0,0 +1,21 @@
Search content in wallabag
==========================
To enable you to find an article quickly, we set up a full search
engine.
Click on **Search** in the wallabag menu. Then, enter your search terms.
Wallabag will go through all your articles, and lists the ones
containing the search terms in their title, their content or their URL.
Convert this search into ePub format
------------------------------------
You can convert the listed articles to the ePub format, so that you can
read them in your e-reader, for example. Look at :ref:`ePub conversion` for more about this.
Assign a tag to your search results
-----------------------------------
You can create a tag based on your search criteria. Loot at :ref:`Organize articles` for more about this.