aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas.loeuillet@smile.fr>2015-10-21 14:14:51 +0200
committerNicolas Lœuillet <nicolas.loeuillet@smile.fr>2015-10-21 14:14:51 +0200
commit59e91bc8931a386974a3817e9849aad1ca7fc186 (patch)
tree4bd4f99cff41e32c3820f1770d5500c96630c32f /docs
parenta4e1ddf2d64bba7c7e28459ccc6738a9a9e23e71 (diff)
downloadwallabag-59e91bc8931a386974a3817e9849aad1ca7fc186.tar.gz
wallabag-59e91bc8931a386974a3817e9849aad1ca7fc186.tar.zst
wallabag-59e91bc8931a386974a3817e9849aad1ca7fc186.zip
add docs
Diffstat (limited to 'docs')
-rw-r--r--docs/README.rst0
-rw-r--r--docs/en/Administrator/hidden_options.rst85
-rw-r--r--docs/en/Administrator/install.rst200
-rw-r--r--docs/en/Administrator/multiusers.rst47
-rw-r--r--docs/en/Administrator/sessions.rst26
-rw-r--r--docs/en/Administrator/update.rst30
-rw-r--r--docs/en/Developer/create_new_theme.rst4
-rw-r--r--docs/en/Developer/git_repo.rst29
-rw-r--r--docs/en/Developer/write_config_files.rst52
-rw-r--r--docs/en/User/configure_wallabag.rst118
-rw-r--r--docs/en/User/epub_conversion.rst32
-rw-r--r--docs/en/User/framabag_account_creation.rst49
-rw-r--r--docs/en/User/import_export.rst107
-rw-r--r--docs/en/User/issue_with_article.rst36
-rw-r--r--docs/en/User/organize_articles.rst109
-rw-r--r--docs/en/User/read_an_article.rst63
-rw-r--r--docs/en/User/rss_feed.rst41
-rw-r--r--docs/en/User/save_your_first_article.rst226
-rw-r--r--docs/en/User/search.rst21
-rw-r--r--docs/en/conf.py87
-rw-r--r--docs/en/index.rst57
-rw-r--r--docs/en/requirements.txt2
-rw-r--r--docs/en/user/configuration.rst61
-rw-r--r--docs/en/user/create_account.rst43
-rw-r--r--docs/en/user/first_article.rst79
-rw-r--r--docs/en/user/login.rst20
-rw-r--r--docs/fr/Administrateur/MAJ_wallabag.md22
-rw-r--r--docs/fr/Administrateur/Multi-utilisateurs.md35
-rw-r--r--docs/fr/Administrateur/Options_cachees.md40
-rw-r--r--docs/fr/Administrateur/Telechargement_et_installation.md121
-rw-r--r--docs/fr/Administrateur/sessions.md26
-rw-r--r--docs/fr/Contribuer_au_projet.md52
-rw-r--r--docs/fr/Developpeur/Creer_un_nouveau_theme.md9
-rw-r--r--docs/fr/Developpeur/Depot_git.md23
-rw-r--r--docs/fr/Developpeur/Docker.md9
-rw-r--r--docs/fr/Developpeur/Ecrire_fichier_configuration.md39
-rw-r--r--docs/fr/Developpeur/Vagrant.md34
-rw-r--r--docs/fr/Developpeur/v2.md9
-rw-r--r--docs/fr/Utilisateur/Classer_ses_articles.md68
-rw-r--r--docs/fr/Utilisateur/Configurer_wallabag.md30
-rw-r--r--docs/fr/Utilisateur/Convertir_en_ePub.md25
-rw-r--r--docs/fr/Utilisateur/Flux_RSS.md35
-rw-r--r--docs/fr/Utilisateur/Framabag.md34
-rw-r--r--docs/fr/Utilisateur/Importer_exporter.md78
-rw-r--r--docs/fr/Utilisateur/Lire_un_article.md58
-rw-r--r--docs/fr/Utilisateur/Rechercher.md21
-rw-r--r--docs/fr/Utilisateur/Sauvegarder_son_premier_article.md101
-rw-r--r--docs/fr/Utilisateur/Un_article_est_mal_affiche.md32
-rw-r--r--docs/fr/conf.py87
-rw-r--r--docs/fr/index.rst29
-rw-r--r--docs/fr/requirements.txt2
-rw-r--r--docs/img/user/2FA_form.pngbin0 -> 11013 bytes
-rw-r--r--docs/img/user/activated_account.pngbin0 -> 13519 bytes
-rw-r--r--docs/img/user/login_form.pngbin0 -> 9595 bytes
-rw-r--r--docs/img/user/registration_form.pngbin0 -> 17126 bytes
-rw-r--r--docs/img/user/sent_email.pngbin0 -> 16441 bytes
-rw-r--r--docs/img/user/topbar.pngbin0 -> 1475 bytes
-rw-r--r--docs/img/wallabag.pngbin0 -> 2605 bytes
58 files changed, 2643 insertions, 0 deletions
diff --git a/docs/README.rst b/docs/README.rst
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/README.rst
diff --git a/docs/en/Administrator/hidden_options.rst b/docs/en/Administrator/hidden_options.rst
new file mode 100644
index 00000000..5cf0b22e
--- /dev/null
+++ b/docs/en/Administrator/hidden_options.rst
@@ -0,0 +1,85 @@
1Hidden options
2==============
3
4Caution
5-------
6
7**Be careful**, this section is destined to advanced users. We are going
8to modify an important wallabag configuration file,
9``inc/poche/config.inc.php``. It is therefore advised to do a backup of
10this file before you proceed. **Any error occuring during the
11modification of a wallabag file could lead to malfunctions**.
12
13This file is created when you install wallabag. Install wallabag, do a
14backup copy of the file, then open it in your favorite text editor.
15
16In this file, there are some options that are not, as of now, available
17in the **config** page of wallabag.
18
19Modification of advanced options
20--------------------------------
21
22Each option is defined this way:
23
24::
25
26 @define ('OPTION_NAME', 'Value');
27
28For each line, you can only modify the ``Value`` field.
29
30Here is the list of each option you can change:
31
32- ``HTTP_PORT`` (default: ``80``) : the HTTP port of your web server.
33 You may need to change it if your server is behind a proxy. Accepted
34 values: number
35- ``SSL_PORT`` (default: ``443``) : the HTTP port of your web server.
36 You may need to change it if your server use SSLH. Accepted values:
37 number
38- ``MODE_DEMO`` (default : ``FALSE)``: If you ever wanted to set up a
39 demonstration server… Accepted values: ``TRUE`` or ``FALSE``.
40- ``DEBUG_POCHE`` (default: ``FALSE``) : if you encounter some problems
41 with wallabag, we may ask you to active Debug mode. Accepted values:
42 ``TRUE`` or ``FALSE``. Check the logs in cache/log.txt after
43 activating that.
44- ``ERROR_REPORTING`` (default : ``E_ALL & ~E_NOTICE``) : Set to
45 ``E_ALL`` if needed to look for eventual PHP errors.
46- ``DOWNLOAD_PICTURES`` (default: ``FALSE``) : Allows wallabag to fetch
47 images from the articles you save on your server, instead of fetching
48 only the text. We prefer to let you activate this option yourself.
49 Accepted values: ``TRUE`` or ``FALSE``.
50- ``REGENERATE_PICTURES_QUALITY`` (default : ``75``) : In order to
51 avoid security problems, pictures are regenerated if you activate the
52 download of pictures. This is the percentage of quality at which they
53 are saved. Increase that numbler if you want better quality, lower if
54 you need better performances.
55- ``SHARE_TWITTER`` (default: ``TRUE``) : enables Twitter sharing.
56 Accepted values: ``TRUE`` or ``FALSE``.
57- ``SHARE_MAIL`` (default: ``TRUE``) : enables mail sharing. Accepted
58 values: ``TRUE`` or ``FALSE``.
59- ``SHARE_EVERNOTE``\ (default : ``FALSE``) : enables sharing with your
60 Evernote account. Accepted values: ``TRUE`` or ``FALSE``.
61- ``SHARE_DIASPORA`` (default : ``FALSE``) : enables to share an
62 article on your Diaspora account.
63- ``DIASPORA_URL`` (default : ``http://diasporapod.com``) : The URL of
64 your Diaspora\* pod
65- ``CARROT`` (default : ``FALSE``) : Like Flattr, it’s a service to
66 give small amounts of money to a web page. See http://carrot.org/
67- ``SHARE_SHAARLI`` (default: ``FALSE``) : enables sharing via your
68 Shaarli installation (Shaarli is an open-source bookmark manager).
69 Accepted values: ``TRUE`` or ``FALSE``.
70- ``SHAARLI_URL`` (default: ``'http://myshaarliurl.com'``) : defines
71 your Shaarli installation URL. Accepted values: an URL.
72- ``FLATTR`` (default: ``TRUE``) : enables the possibility to Flattr an
73 article (`Flattr is a microdonation platform`_). If an article is
74 Flattr-able, an icon will be displayed, allowing you to send a
75 microdonation to the author. Accepted values: ``TRUE`` or ``FALSE``.
76- ``SHOW_PRINTLINK`` (default: ``'1'``) : enables the Print button for
77 articles. Accepted values: ``'1'`` to enable or ``'0'`` to disable.
78- ``SHOW_READPERCENT`` (default: ``'1'``) : enables the reading
79 progress on articles (working on the ``default``, ``dark``,
80 ``dmagenta``, ``solarized``, ``solarized-dark`` themes). Accepted
81 values: ``'1'`` to enable or ``'0'`` to disable.
82- ``PAGINATION`` (default: ``'12'``) : defines the number of articles
83 that are displayed on a list. Accepted values: number.
84
85.. _Flattr is a microdonation platform: http://en.wikipedia.org/wiki/Flattr
diff --git a/docs/en/Administrator/install.rst b/docs/en/Administrator/install.rst
new file mode 100644
index 00000000..006d8708
--- /dev/null
+++ b/docs/en/Administrator/install.rst
@@ -0,0 +1,200 @@
1Download and install wallabag
2=============================
3
4I don’t want to install wallabag
5--------------------------------
6
7If you can’t or don’t want to install Wallabag on your server, we
8suggest you create a free account on `Framabag`_ which uses our
9software (see :ref:`Framabag account creation`).
10
11I want to install wallabag
12--------------------------
13
14I want to download wallabag manually
15~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
17`Download the latest wallabag version`_ and unpack it:
18
19::
20
21 wget http://wllbg.org/latest
22 unzip latest
23 mv wallabag-version-number wallabag
24
25Copy the files on your web server. For Ubuntu/Debian, it is the
26directory /var/www/html/ :
27
28::
29
30 sudo mv wallabag /var/www/html/
31
32Then, jump off to next section.
33
34I want to download wallabag via composer
35~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36
37You need to install composer:
38
39::
40
41 curl -s http://getcomposer.org/installer | php
42
43Next, on your web server, run this command:
44
45::
46
47 composer create-project wallabag/wallabag . dev-master
48
49All is downloaded into the current folder.
50
51Prerequisites for your web server
52^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
53
54Wallabag requires that several components to be installed on your web
55server. To make sure your server has all the prerequisites, open in your
56browser the page ``http://monserveur.com/wallabag/install/index.php``.
57
58The components are:
59
60- `PHP 5.3.3 or above`_ **with `PDO`_ support**
61- `XML for PHP`_
62- `PCRE`_
63- `ZLib`_ (otherwise, the processing of compressed pages will be
64 affected)
65- `mbstring`_ anb/or `iconv`_ (otherwise some pages will not be read -
66 even in English)
67- The `DOM/XML`_ extension
68- `Data filtering`_
69- `GD`_ (otherwise, pictures will not be saved)
70- `Tidy for PHP`_ (otherwise, you may encounter problems with some
71 pages)
72- `cURL`_ with ``Parallel URL fetching`` (optionnal)
73- `Parse ini file`_
74- `allow\_url\_fopen`_ (optionnal if cURL is installed)
75- `gettext`_ (required for multi-language support)
76
77Install the missing components before to proceed. For example, to
78install Tidy on Ubuntu/Debian:
79
80::
81
82 sudo apt-get install php5-tidy
83 sudo service apache2 reload
84
85Note : if you’re using IIS as a webserver, you have to disable
86*Anonymous Authentication* and `enable *Basic Authentication*`_ in order
87to be able to login.
88
89Twig installation
90^^^^^^^^^^^^^^^^^
91
92wallabag is build with Twig, a template library. You have to download it
93for wallabag to work. If you cannot install ``composer`` (for example in
94the case of shared hosting), we offer you to download a file which
95includes ``Twig``. This file can be downloaed from the page
96``http://myservur.com/wallabag/install/index.php`` (section TWIG
97INSTALLATION) or directly at http://wllbg.org/vendor. Uncompress it in
98your wallabag directory.
99
100Otherwise, you can use Composer to install ``Twig`` by launching
101``composer`` from your wallabag directory (in the case of Ubuntu/Debian
102too: /var/www/html/wallabag/) by following the commands written on
103screen:
104
105::
106
107 curl -s http://getcomposer.org/installer | php
108 php composer.phar install
109
110Creation of the database.
111^^^^^^^^^^^^^^^^^^^^^^^^^
112
113Wallabag can be installed on different types of databases:
114
115- `SQLite`_. The easiest system of all. No extra configuration needed.
116- `MySQL`_. A well known database system, which is in most cases more
117 efficient than SQLite.
118- `PostgreSQL`_. Some people found it better than MySQL.
119
120We advice you to use MySQL because it is more efficient. In this case,
121you should create a new database (for example ``wallabag``), a new user
122(for example ``wallabag``) and a password (here ``YourPassWord``). To do
123this, you can use ``phpMyAdmin``, or launch the following commands:
124
125::
126
127 mysql -p -u root
128 mysql> CREATE DATABASE wallabag;
129 mysql> GRANT ALL PRIVILEGES ON `wallabag`.* TO 'wallabag'@'localhost' IDENTIFIED BY 'VotreMotdePasse';
130 mysql> exit
131
132*Note:* If you’re using MySQL or Postgresql, you have to **fill all the
133fields**, otherwise the installation will not work and an error message
134will tell you what’s wrong. You must create the database that you will
135use for wallabag manually with a tool like PHPMyAdmin or the console.
136
137Permissions
138~~~~~~~~~~~
139
140Your web server needs a writing access to the ``assets``, ``cache`` and
141``db`` directories. Otherwise, a message will report that the
142installation is impossible:
143
144::
145
146 sudo chown -R www-data:www-data /var/www/html/wallabag
147
148Installation of wallabag. At last.
149~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150
151Access to wallabag from your web browser:
152``http://votreserveur.com/wallabag``. If your server is correctly
153configured, you directly reach the setup screen.
154
155Select the type of database (``sqlite``, ``mysql`` or ``postgresql``)
156and fill the information about your database. In the case of the databse
157MySQL created before, the standard configuration will be:
158
159::
160
161 Database engine: MySQL
162 Server: localhost
163 Database: wallabag
164 Username: wallabag
165 Password: YourPassWord
166
167Finally, Create your first user and his/her password (different from the
168database user).
169
170Wallabag is now installed.
171
172Login
173-----
174
175From your web browser, you reach the login screen: fill your username
176and your password to connect to your account.
177
178Enjoy!
179
180.. _SQLite: http://php.net/manual/fr/book.sqlite.php
181.. _MySQL: http://php.net/manual/fr/book.mysql.php
182.. _PostgreSQL: http://php.net/manual/fr/book.pgsql.php
183.. _Framabag: https://framabag.org/
184.. _Download the latest wallabag version: http://wllbg.org/latest
185.. _PHP 5.3.3 or above: http://php.net/manual/fr/install.php
186.. _PDO: http://php.net/manual/en/book.pdo.php
187.. _XML for PHP: http://php.net/fr/xml
188.. _PCRE: http://php.net/fr/pcre
189.. _ZLib: http://php.net/en/zlib
190.. _mbstring: http://php.net/en/mbstring
191.. _iconv: http://php.net/en/iconv
192.. _DOM/XML: http://php.net/manual/en/book.dom.php
193.. _Data filtering: http://php.net/manual/fr/book.filter.php
194.. _GD: http://php.net/manual/en/book.image.php
195.. _Tidy for PHP: http://php.net/fr/tidy
196.. _cURL: http://php.net/fr/curl
197.. _Parse ini file: http://uk.php.net/manual/en/function.parse-ini-file.php
198.. _allow\_url\_fopen: http://www.php.net/manual/fr/filesystem.configuration.php#ini.allow-url-fopen
199.. _gettext: http://php.net/manual/fr/book.gettext.php
200.. _enable *Basic Authentication*: https://technet.microsoft.com/en-us/library/cc772009%28v=ws.10%29.aspx
diff --git a/docs/en/Administrator/multiusers.rst b/docs/en/Administrator/multiusers.rst
new file mode 100644
index 00000000..a4053aae
--- /dev/null
+++ b/docs/en/Administrator/multiusers.rst
@@ -0,0 +1,47 @@
1.. _`Multi users`:
2
3Multi users
4===========
5
6Create a new account
7--------------------
8
9Administrator mode
10------------------
11
12If you want to use wallabag with several persons, you can create new
13accounts from the configuration page.
14
15At the bottom of this page there is a form where you should input a user
16name and a password.
17
18It is now possible to login to this account from the login page of
19wallabag.
20
21No information are shared among the accounts.
22
23Open registration mode
24----------------------
25
26Starting from version 1.9, the administrator can let users register by
27themselves. This is done by changing the following lines in the
28configuration file:
29
30::
31
32 // registration
33 @define ('ALLOW_REGISTER', FALSE);
34 @define ('SEND_CONFIRMATION_EMAIL', FALSE);
35
36Then, a user will be able to enter his/her user name and password to
37create his/her own account. Depending on the configuration, a
38confimation email can be sent to users who gave an email address.
39
40Remove an account
41-----------------
42
43It is possible to remove your own account from the configuration page.
44You simply have to enter your password and to ask for the removal.
45
46Of course, when there is only one account, it is impossible to remove
47it.
diff --git a/docs/en/Administrator/sessions.rst b/docs/en/Administrator/sessions.rst
new file mode 100644
index 00000000..7dbae257
--- /dev/null
+++ b/docs/en/Administrator/sessions.rst
@@ -0,0 +1,26 @@
1Session issues
2==============
3
4If you end up disconnected even while checking the *Stay signed in
5checkbox*, please run the following commands as root (or with sudo) :
6
7::
8
9 mkdir /var/lib/wallabag-sessions
10 chown www-data:www-data /var/lib/wallabag-sessions
11
12*NOTE : The www-data user and group may not exist, you may use
13``chown http:http /var/lib/wallabag-sessions`` instead*
14
15Then, using apache add:
16``php_admin_value session.save_path /var/lib/wallabag-sessions`` to your
17apache vhost, for instance ``wallabag-apache.conf`` Finally, restart
18apache, for instance like this : ``/etc/init.d/apache2 restart``
19
20If you’re using nginx, add
21``php_admin_value[session.save_path] = /var/lib/wallabag-sessions`` in
22your nginx configuration file. Then, restart nginx :
23``/etc/init.d/nginx restart``
24
25*NOTE : If you’re using systemd, you should do
26``systemctl restart apache2`` (or nginx).*
diff --git a/docs/en/Administrator/update.rst b/docs/en/Administrator/update.rst
new file mode 100644
index 00000000..7b799bb3
--- /dev/null
+++ b/docs/en/Administrator/update.rst
@@ -0,0 +1,30 @@
1Update wallabag
2===============
3
4Update an existing wallabag installation
5----------------------------------------
6
7In order to update your installation, download and unzip the archive
8into your installation folder. For example on Ubuntu/Debian:
9
10::
11
12 wget http://wllbg.org/latest
13 unzip latest
14 rsync -ur wallabag-version-number/* /var/www/html/wallabag/ # could be another location such as /srv/html, /usr/share/nginx/html
15
16After that, just access wallabag in your browser and follow the
17instructions to finish the update.
18
19You can verify at the bottom of the configuration page that you’re
20running the last version.
21
22**If it fails**, just delete the ``install`` folder and clear the cache:
23
24::
25
26 cd /var/www/html/wallabag/
27 rm -r cache/* install/
28
29Clearing the cache is also possible in the configuration page, clicking
30on the link ``Delete Cache``.
diff --git a/docs/en/Developer/create_new_theme.rst b/docs/en/Developer/create_new_theme.rst
new file mode 100644
index 00000000..5731eb11
--- /dev/null
+++ b/docs/en/Developer/create_new_theme.rst
@@ -0,0 +1,4 @@
1Create new theme
2================
3
4TODO
diff --git a/docs/en/Developer/git_repo.rst b/docs/en/Developer/git_repo.rst
new file mode 100644
index 00000000..4fa5c608
--- /dev/null
+++ b/docs/en/Developer/git_repo.rst
@@ -0,0 +1,29 @@
1Git repository
2==============
3
4If you wish to contribute to the project by suggesting new features or
5by fixing some bugs, please follow the recommendations below regarding
6the git repository available at https://github.com/wallabag/wallabag.
7
8Current state
9-------------
10
11To manage the different versions of wallabag, we use Git.
12
13There are multiple branches for the source code of wallabag web app:
14
15- ``master`` branch : this is the stable branch, downloaded by those
16 who wish to install wallabag for their own use.
17- ``dev`` branch : before being added on ``master`` branch, all bug
18 fixes and new features must go on that branch. This branch is not
19 recommended for production use.
20- ``v2`` branch : this is the branch for a revamp of wallabag.
21 A whole chapter is to be focused on it.
22
23Workflow
24--------
25
26All the rules for contributing to the git repository are in the
27`CONTRIBUTING.md file of
28wallabag <https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md>`__.
29Please read carefully this file before you make any change.
diff --git a/docs/en/Developer/write_config_files.rst b/docs/en/Developer/write_config_files.rst
new file mode 100644
index 00000000..c1ea61df
--- /dev/null
+++ b/docs/en/Developer/write_config_files.rst
@@ -0,0 +1,52 @@
1Write config files
2==================
3
4wallabag can use specific site config files to parse website articles.
5These files are stored in the
6```inc/3rdparty/site_config/standard`` <https://github.com/wallabag/wallabag/tree/master/inc/3rdparty/site_config/standard>`__
7folder.
8
9The format used for these files is
10`XPath <http://www.w3.org/TR/xpath20/>`__. Look at some examples in the
11folder.
12
13Automatic config files generation
14---------------------------------
15
16Fivefilters has created a `very useful
17tool <http://siteconfig.fivefilters.org/>`__ to create config files. You
18just type in the adress of the article to work on with, and you select
19the area containing the content you want.
20
21.. figure:: https://lut.im/RNaO7gGe/l9vRnO1b
22 :alt: siteconfig
23
24 siteconfig
25| You should confirm this area by trying with other articles.
26| When you got the right area, just click on *Download Full-Text RSS
27site config* to download your file.
28
29Manual config file generation
30-----------------------------
31
32If Fivefilters tool doesn't work correctly, take a look at the source
33(Ctrl + U on Firefox and Chromium). Search for your content and get the
34``class`` or the ``id`` attribute of the area containing what you want.
35
36Once you've got the id or class, you can write for example one or
37another of these lines:
38
39::
40
41 body: //div[@class='myclass']
42 body: //div[@id='myid']
43
44Then, test you file. If you got the right content but you want to strip
45unnecessary parts, do:
46
47::
48
49 strip: //div[@class='hidden']
50
51You can look at other options for siteconfig files
52`here <http://help.fivefilters.org/customer/portal/articles/223153-site-patterns>`__.
diff --git a/docs/en/User/configure_wallabag.rst b/docs/en/User/configure_wallabag.rst
new file mode 100644
index 00000000..7a0bc95f
--- /dev/null
+++ b/docs/en/User/configure_wallabag.rst
@@ -0,0 +1,118 @@
1.. _`Configure wallabag`:
2
3Configure wallabag
4==================
5
6From the configuration menu, you can change some of wallabag's options.
7
8Some parts won't be detailed here, as they have a dedicated chapter in
9the documentation (:ref:`RSS feeds`, :ref:`Import / Export`, :ref:`ePub conversion` and :ref:`Multi users`).
10
11Saving articles
12---------------
13
14You'll find help about the different ways to save articles to your
15wallabag here.
16
17Save article field
18~~~~~~~~~~~~~~~~~~
19
20Enter a link in the field and click “bag it!” to save.
21
22Browser extensions
23~~~~~~~~~~~~~~~~~~
24
25Links to download extensions for your favourite browser, Firefox or
26Chrome.
27
28Mobile apps
29~~~~~~~~~~~
30
31Links to download mobile apps, Android, iOS or Windows Phone.
32
33For Android, you have the choice to download either from Google's Play
34Store of from the Free and Open Source market
35`F-Droid <https://f-droid.org>`__
36
37Bookmarklet
38~~~~~~~~~~~
39
40Lastly, you can use the bookmarklet. A bookmarklet is a simple link you
41can drag to your browser's bookmarks. Once it's in your bookmarks,
42simply clicking on it will save the webpage you're currently viewing to
43your wallabag.
44
45Feeds
46-----
47
48Plese refer to `RSS feeds <rss_feed.html>`__ for more details.
49
50.. _`Howto change theme`:
51
52Theme
53-----
54
55As they say, “all tastes and colors are found in nature”. That's why
56wallabag allows you to change its appearance through the use of themes,
57in order to please everyone.
58
59Select the theme of your choice from the drop down list and confirm by
60clicking on **Update**.
61
62Language
63--------
64
65Select the language of your choice in the drop down list and confirm by
66clicking on **Update**.
67
68Import
69------
70
71Please refer to `Import/Export <import_export.html>`__ for more details.
72
73Export
74------
75
76Please refer to `Import/Export <import_export.html>`__ for more details.
77
78Clear the cache
79---------------
80
81The cache allows wallabag perform certain functions faster.
82
83After updating wallabag, it is advised to clear the cache.
84
85Click on “delete cache” to do so (no confirmation will be asked).
86
87Password
88--------
89
90Fill in your new password in the two dedicated fields and confirm by
91clicking on **Update**.
92
93You will be disconnected and will have to enter your new password to
94access your wallabag.
95
96User
97----
98
99Add a user here by entering their name, password and (optionnaly) email
100in the corresponding fields.
101
102You may not be able to add a user if don't have the rights to do so.
103
104Remind newly created users to change their password the first time they
105connect to wallabag!
106
107Delete
108------
109
110Delete your user account on wallabag here.
111
112If there is only one account, you won't be able to delete the account.
113
114Upgrade
115-------
116
117Wallabag will check its curent version and if there is a new version
118available and display this information here.
diff --git a/docs/en/User/epub_conversion.rst b/docs/en/User/epub_conversion.rst
new file mode 100644
index 00000000..7b31fe07
--- /dev/null
+++ b/docs/en/User/epub_conversion.rst
@@ -0,0 +1,32 @@
1.. _`ePub conversion`:
2
3ePub conversion
4===============
5
6To enable you to read your articles on a e-reader, wallabag can convert
7them to the ePub format, and hence create an eBook for your long winter
8evenings.
9
10A word of caution
11-----------------
12
13Be careful, the creation of ePub files can be very resource demanding
14for the server on which wallabag is installed. It depends on the number
15of articles and on their length. Do not create a really big eBook if
16this is not necessary.
17
18Where to convert the articles
19-----------------------------
20
21You can convert your articles at various places in wallabag:
22
23- on the reading page of an article: the ePub link will convert this
24 article only
25- from the list of articles (unread, favorite or archived articles,
26 articles with a tag): a link at the bottom of the page allows you to
27 convert all the article of this category
28- from a search: the link is at the bottom of the page
29- from the configuration page: you can convert all your articles,
30 whatever the category to which they belong
31
32TODO talk about calibre
diff --git a/docs/en/User/framabag_account_creation.rst b/docs/en/User/framabag_account_creation.rst
new file mode 100644
index 00000000..bce8cdfd
--- /dev/null
+++ b/docs/en/User/framabag_account_creation.rst
@@ -0,0 +1,49 @@
1.. _`Framabag account creation`:
2
3Framabag account creation
4=========================
5
6If you do not want to install and update wallabag, or if you do not have
7the know-how to install it, it is possible to create an account for free
8at `Framabag.org <https://www.framabag.org>`__.
9
10Account creation
11----------------
12
13Click on the button **Créez votre compte / Create your account**.
14
15You have to input some information: your username, your password and
16your email address. Your address is used only to validate your account,
17except if you check the box to subscribe the newsletter (3 to 4 messages
18per year).
19
20Once this form validated, you will receive an email with the
21confirmation link. Click on it to create your account.
22
23You will receive a last email with the address of your Framabag account,
24which will look like ``https://www.framabag.org/u/Your-username``.
25
26Information storage
27-------------------
28
29Framabag use one database per user. We do not and will not use your
30stored data.
31
32You have forgotten your password
33--------------------------------
34
35| If you have forgotten your password to get connected to Framabag, a
36form is available `on the main page of the
37service <https://www.framabag.org>`__.
38| Fill it, and a confirmation will be sent to you and will allow you to
39input a new password.
40
41Account deletion
42----------------
43
44If you wish to delete your account, contact us by email:
45hello@wallabag.org using the address your created your account with, and
46state your username.
47
48We will answer you after your account has been deleted: then, no
49information about you will be stored by Framabag.
diff --git a/docs/en/User/import_export.rst b/docs/en/User/import_export.rst
new file mode 100644
index 00000000..8cd18bf2
--- /dev/null
+++ b/docs/en/User/import_export.rst
@@ -0,0 +1,107 @@
1.. _`Import / Export`:
2
3Import and export data
4======================
5
6Import
7------
8
9To import data in wallabag, go to the page **Configuration**.
10
11Caution
12~~~~~~~
13
14Data import can be a **demanding process** for your server. Hence, it is
15done in two steps:
16
17- Insertion of the URL in the wallabag database
18- in the second step, the retrieval, for each article, of its full
19 content.
20
21These two steps cannot be done concurrently, because it let us the
22possibility to import thousands of links, but today, wallabag does not
23have sufficient technical capabilities to do this task automatically.
24
25From Pocket
26~~~~~~~~~~~
27
28Export your data from Pocket
29^^^^^^^^^^^^^^^^^^^^^^^^^^^^
30
31From your Pocket account, go to the options. TODO
32
33Import your Pocket data
34^^^^^^^^^^^^^^^^^^^^^^^
35
36From the configuration page of wallabag, section **Import**, select the
37file ``ril_export.html`` generated by Pocket, then click on **Import**.
38Wallabag only insert these links in the database. Now, you have to get
39the content of each article.
40
41For this, click on ``Click to finish import``: wallabag will fetch the
42content of 10 articles at a time.
43
44TODO
45
46TODO new ticket: why when a click is done, this does not load in a loop?
47I believe this was doing this ping @mariroz
48
49From Instapaper
50~~~~~~~~~~~~~~~
51
52Export your data from Instapaper
53^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
54
55TODO
56
57Import your Instapaper data
58^^^^^^^^^^^^^^^^^^^^^^^^^^^
59
60TODO
61
62From Readability
63~~~~~~~~~~~~~~~~
64
65Export your data from Readability
66^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67
68TODO
69
70Import your Readability data
71^^^^^^^^^^^^^^^^^^^^^^^^^^^^
72
73TODO
74
75From wallabag
76~~~~~~~~~~~~~
77
78Since you can export your data from wallabag (see below), it is of
79course possible to re-import them.
80
81In the import form, select your wallabag-exported file (format JSON).
82Start the import, et voilà.
83
84Unlike the above imports, this process is shorter because all the data
85(title and content of the articles) are already included in the file.
86Hence wallabag does not have to access each URL. However, the import
87file is necessarily bigger.
88
89From a HTML or JSON file
90~~~~~~~~~~~~~~~~~~~~~~~~
91
92TODO
93
94Export
95------
96
97It is possible to export your data from the page **Configuration** of
98wallabag. Several reasons to do this:
99
100- re-install of wallabag
101- leave the Framabag service to install your own wallabag
102- a user with an account on a multi-user wallabag want to have his/her
103 own wallabag installation
104- ...
105
106This will lead you to download a file `at the JSON
107format <http://en.wikipedia.org/wiki/JavaScript_Object_Notation>`__. As detailed above, you can import this file in wallabag.
diff --git a/docs/en/User/issue_with_article.rst b/docs/en/User/issue_with_article.rst
new file mode 100644
index 00000000..408403f2
--- /dev/null
+++ b/docs/en/User/issue_with_article.rst
@@ -0,0 +1,36 @@
1.. _`Article is not displayed properly`:
2
3My article is not displayed properly in wallabag
4================================================
5
6If you think wallabag do not copy well the content of an article (empty
7or incomplete text), here are some suggestions.
8
9Ask for help
10------------
11
12Via an email or a ticket, do not forget to give some information that
13are important for us to better solve the problem:
14
15- The URL of the article
16- What wallabag displays
17- What you were expecting
18- The wallabag version of if you use Framabag
19
20Open a ticket on github
21~~~~~~~~~~~~~~~~~~~~~~~
22
23To open a new ticket, you should `go to
24github <https://github.com/wallabag/wallabag/issues/new>`__. An account
25is required. Do not forget to send us the information listed above.
26
27Send us an email
28~~~~~~~~~~~~~~~~
29
30Send us the link in a email to the address
31`hello@wallabag.org <mailto:hello@wallabag.org?subject=Wrong%20display%20in%20wallabag>`__. Do not forget to send us the information listed above.
32
33Solve this display problem
34--------------------------
35
36TODO
diff --git a/docs/en/User/organize_articles.rst b/docs/en/User/organize_articles.rst
new file mode 100644
index 00000000..734e4de6
--- /dev/null
+++ b/docs/en/User/organize_articles.rst
@@ -0,0 +1,109 @@
1.. _`Organize articles`:
2
3Organize articles
4=================
5
6To be able to find more easily your articles, several methods are
7available.
8
9Tags
10----
11
12Assign a tag
13~~~~~~~~~~~~
14
15When saving an article
16^^^^^^^^^^^^^^^^^^^^^^
17
18To tag an article when saving it, just click on the tag icon next to the
19URL field before hitting the Save button. At the moment, it is possible
20only to do this from the web interface, but it could come to some apps
21or extensions.
22
23From the article
24^^^^^^^^^^^^^^^^
25
26To tag an already-saved article, go to the reading page of the article.
27There is a part ``tags`` followed with a pencil. Click on the pencil.
28
29Input in the box the tags you want to assign. Add as many tags as you
30want. They need to be separated by commas and not spaces.
31Auto-completion is available here: when you type the first letters of an
32existing tag, it is not necessary to type the whole word. Select it in
33the drop-down list. Once all your tags are inputted, click on the button
34**Tag**.
35
36Then, you can go back to your article and read it.
37
38From the search
39^^^^^^^^^^^^^^^
40
41A full chapter on search is available. Here, we will describe only how
42to assign a tag from your search.
43
44When your search displays results, there is a link
45``Apply the tag ABCD to this search`` at the bottom of the page. Click
46on it: a tad depending on your search (here ``ABCD``) will be assigned
47to all the articles found.
48
49Find all the articles with a given tag
50~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51
52In the wallabag menu, click on **Tags**. Then, all the tags you have
53created are displayed, sorted by the number of articles for each tag.
54Click on one of these tags to find all the articles with this tag.
55
56Preferred articles
57------------------
58
59When you wish to set aside an article, you can mark it as preferred.
60
61Set an article as favorite
62~~~~~~~~~~~~~~~~~~~~~~~~~~
63
64From the reading page of an article, or from a list of articles (such as
65the list of unread articles), you can set an article as favorite simply
66by a click on the star which is displayed. Click again on the star will
67remove the **favorite** status of this article.
68
69Find all the favorite articles
70~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
72In the wallabag menu, click on **Favorites** to display the list of all
73the articles that you have set as favorite.
74
75Archived articles
76-----------------
77
78When you have read an article, you can archive it: hence it will not be
79displayed in your list of unread articles.
80
81Archiving an article does not remove it from wallabag.
82
83Archive an article
84~~~~~~~~~~~~~~~~~~
85
86| From the reading page of an article, or from a list of articles (such
87as the list of unread articles), you can archive an article simply by
88clicking on the icon ✓.
89| Click again on this icon will set back the **unread** status of the
90article.
91
92Find all the archived articles
93~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
95In the wallabag menu, click on **Archive** to find all the articles that
96you have archived.
97
98Delete an article
99-----------------
100
101Be cautious: the deletion of an article is **definitive**. It is deleted
102from the wallabag database.
103
104To delete an article, a trash icon is displayed on the page of an
105article or of a list of articles (unread articles, favorites or
106archived, for example).
107
108We trust you: that is why there is no confirmation message during the
109deletion.
diff --git a/docs/en/User/read_an_article.rst b/docs/en/User/read_an_article.rst
new file mode 100644
index 00000000..6eef46f8
--- /dev/null
+++ b/docs/en/User/read_an_article.rst
@@ -0,0 +1,63 @@
1Read an article
2===============
3
4Reading an article is not difficult in wallabag: you only have to click on the title of the article for it to be displayed.
5
6Back to where you left the article
7----------------------------------
8
9If you stop reading an article halfway through, the next time wallabag will open it right where you left off.
10
11This feature only works with web applications and not with smartphone applications.
12
13Possible actions in an article
14------------------------------
15
16The 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.
17
18Here are the actions, in the order of appearance of the icons.
19
20Read the original article
21~~~~~~~~~~~~~~~~~~~~~~~~~
22
23Open the article on its original location.
24
25Mark the article as read
26~~~~~~~~~~~~~~~~~~~~~~~~
27
28Archive 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.
29
30Mark the article as favorite
31~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32
33Mark 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.
34
35Delete the article
36~~~~~~~~~~~~~~~~~~
37
38Delete the article from wallabag permanently. It cannot be restored. Be careful: no confirmation message is displayed.
39
40Share through twitter
41~~~~~~~~~~~~~~~~~~~~~
42
43Share the title and the original link of the article on twitter.
44
45Share via email
46~~~~~~~~~~~~~~~
47
48Share the title and the original link of the article via e-mail.
49
50Print the article
51~~~~~~~~~~~~~~~~~
52
53Open the print window of the browser.
54
55Convert into ePub
56~~~~~~~~~~~~~~~~~
57
58Convert the article into ePub format: see the section on :ref:`ePub conversion`.
59
60Notify us that the article appears wrong
61~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
62
63Notify the wallabag developers that an article is not displayed as expected (see the section on :ref:`Article is not displayed properly`).
diff --git a/docs/en/User/rss_feed.rst b/docs/en/User/rss_feed.rst
new file mode 100644
index 00000000..760c2856
--- /dev/null
+++ b/docs/en/User/rss_feed.rst
@@ -0,0 +1,41 @@
1.. _`RSS feeds`:
2
3RSS feeds
4=========
5
6The RSS feeds allow you to:
7
8- read your articles from your favorite RSS feed reader.
9- to activate the reading features for smartphone softwares
10
11| First, you must activate the RSS feature by generating a feed token.
12| Go to **config** in wallabag and generate a token in the section
13**Feeds**. You can generate a new token at any time.
14
15Read articles
16-------------
17
18Once the token created, you have access to three RSS feeds:
19
20- the one of the unread articles
21- the one of the favorites articles
22- the one of the archived articles
23
24Add the feed you want to your RSS feed reader. Be careful: when you will
25be reading an article from your feed reader, this will not set it as
26read in wallabag.
27
28Share your readings
29~~~~~~~~~~~~~~~~~~~
30
31If you wish to share your readings with somebody, send him for example
32the RSS feed of your favorite articles. Hence, as soon as an article
33will be set as favorite in wallabag, this person will be able to read it
34too.
35
36Activate the features for smartphones
37-------------------------------------
38
39You ave created an RSS feed token. It will also be useful to you to
40configure your smartphone software. For more information about
41smartphone sofwares, you can read :ref:`Save your first article`.
diff --git a/docs/en/User/save_your_first_article.rst b/docs/en/User/save_your_first_article.rst
new file mode 100644
index 00000000..e6e884a3
--- /dev/null
+++ b/docs/en/User/save_your_first_article.rst
@@ -0,0 +1,226 @@
1.. _`Save your first article`:
2
3Save your first article
4=======================
5
6Once connected on wallabag, you have many ways to save an article.
7
8From the web application
9------------------------
10
11Let’s see first how to do from the web application. In the menu, you
12have a link **save a link**. Clicking on it, a form shows up: you simply
13have to type the web adress of the article you want to save.
14
15Confirm to store the content of the article.
16
17By default, only the text is saved. If you want to store a copy of the
18images on your server, you have to enable the setting
19*DOWNLOAD\_PICTURES*. Read the chapter on hidden options for more
20information.
21
22From the bookmarklet
23--------------------
24
25From `Wikipedia’s definition`_
26
27 A bookmarklet is a `bookmark`_ stored in a `web browser`_ that
28 contains `JavaScript`_\ commands to extend the browser’s
29 functionality.
30
31 Bookmarklets are unobtrusive scripts stored as the URL of a bookmark
32 in a web browser or as a hyperlink on a web page.
33
34 When clicked, a bookmarklet performs some function, one of a wide
35 variety such as a search query or data extraction. Bookmarklets are
36 usually `JavaScript programs`_.
37
38From the wallabag’s menu, click on **settings**. On the first part of
39this page, we have listed all the ways to save an article. You’ll find
40the bookmarklet (it’s the ``Bag it!`` link) to drag and drop in the
41bookmarks bar of your web browser. From now on, when you want to save
42the article you are browsing, you just have to click on this bookmarklet
43and the article will be automatically saved.
44
45From your smartphone
46--------------------
47
48Above all else
49~~~~~~~~~~~~~~
50
51To use a smartphone application, you have to enable RSS feeds from the
52settings panel of wallabag. Then some information will be displayed,
53like your security token. Read the chapter on RSS feeds for more
54information.
55
56Android
57~~~~~~~
58
59Installation and configuration
60^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
61
62You can download the android application from the `Google Play Store`_
63and from `F-droid`_. It’s the exact same application on those two
64stores.
65
66Once installed, start the application, go to the **settings** part et
67fill in the **URL (complete address of your wallabag installation or
68your Framabag account)** and **User ID (in most cases, you’ll have to
69put 1)** fields. If you have created multiple accounts from wallabag,
70you will have to to fill the user account you want to connect to your
71application and your security **Token** (enter properly all the token’s
72letters as seen in the settings part of wallabag).
73
74Saving of an article
75^^^^^^^^^^^^^^^^^^^^
76
77Now that everything is correctly set up, as soon as you browse on your
78smartphone’s web browser, you can share an article in wallabag at any
79time from the **Share** menu: you’ll find a **Bag it!** entry which will
80add your article in wallabag.
81
82Reading
83^^^^^^^
84
85When you open the application, click on Synchronize: your recently saved
86articles will be downloaded on your smartphone.
87
88You don’t need an internet connection anymore: click on **List
89articles** to start your reading.
90
91At the end of each article, a **Mark as read** button allows you to
92archive the article.
93
94To date, the synchronisation occurs in one direction (from wallabag to
95the application), thus preventing mark as read an article on wallabag
96from your smartphone.
97
98iOS
99~~~
100
101Installation and configuration
102^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
103
104You can download the iOS application from the `AppStore`_.
105
106Once installed, configure the app by filling following fields inside the
107settings: the **URL (complete address of your wallabag installation or
108your Framabag account)** and **User ID (in most cases, you’ll have to
109put 1)** field. If you have created multiple accounts from wallabag, you
110will have to to fill the user account you want to connect to your
111application and your security **Token** (enter properly all the token’s
112letters as seen in the settings part of wallabag).
113
114Usage
115^^^^^
116
117If the app is configured correctly, the app will automatically download
118the articles from your wallabag (use **pull-to-refresh** to trigger this
119update manually). Once an article is downloaded, it’ll be available
120offline from your app.
121
122Unfortunately you can only locally mark an article as read (it will not
123synchronise to your online wallabag).
124
125Saving articles
126~~~~~~~~~~~~~~~
127
128If you’re browsing a website and want to add the current article to your
129wallabag, simply tap the **Share**-button and select **Bag it!** (if you
130don’t find the wallabag icon, have a look in the **more**-menu). If
131everything is set up correctly, your article will be saved (you may have
132to login from time to time).
133
134Windows Phone
135~~~~~~~~~~~~~
136
137Installation and configuration
138^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
139
140You can download the Windows Phone application from the `Windows Store`_
141or directly from your smartphone’s Store.
142
143Once installed, the application will show you a notification on the
144first launch, asking the configuration of your wallabag server. Go to
145the **Settings** part of the application by pressing the three dots menu
146at the bottom of the screen, then fill in the **URL (complete address of
147your wallabag installation or your Framabag account)** and **User ID (in
148most cases, you’ll have to put 1)** fields.
149
150If you have created multiple accounts from wallabag, you will have to to
151fill the user account you want to connect to your application and your
152security **Token** (enter properly all the token’s letters as seen in
153the setting part of wallabag).
154
155From your web browser
156---------------------
157
158Firefox Classic Add-on
159~~~~~~~~~~~~~~~~~~~~~~
160
161Download the Firefox add-on at `addons.mozilla.org`_ and install it like
162any other Firefox add-on.
163
164In the add-on’s settings, fill the complete URL of your installation of
165wallabag or your Framabag account.
166
167Personalize the Firefox toolbar to add wallabag (**W** icon). When you
168find an article you want to save, click on this icon: a new window will
169open to add the article and will close itself automatically.
170
171Firefox Social API Service
172~~~~~~~~~~~~~~~~~~~~~~~~~~
173
174*Available from wallabag v1.9.1 only*
175
176You will need an https connection to use this. It’s a Firefox
177`requirement`_, sorry.
178
179With Firefox 29+ versions, your browser comes with an integrated
180interface to share things to multiple social services directly from your
181browser. In the Firefox interface, it is shown a paper plane-like icon
182that you will use to share a page, which means here, save an article.
183You can add the service by going into the Config page of wallabag, then
184click on Mozilla Services Social API Extension. You must also accept to
185use Firefox Services.
186
187Chrome
188~~~~~~
189
190Download the Chrome add-on `on the dedicated website`_ and install it
191like any other Chrome add-on.
192
193In the add-on’s settings, fill the complete URL of your installation of
194wallabag or your Framabag account.
195
196During the addon’s installation, a new icon appear in Chrome toolbar (a
197**W** icon). When you find an article you want to save, click on this
198icon: a popup will appear to confirm that your article has been saved.
199
200Opera
201~~~~~
202
203The recent versions of Opera (15+) allow to install add-ons compatible
204with Chrome.
205
206First, install the add-on named `Download Chrome Extensions`_ which will
207allow you to install add-ons from the Chrome Web Store. Then, go `to to
208Google site`_ and get the Chrome add-on by clicking on *Add to Opera*. A
209message will invite you to confirm this action because this add-on is
210not coming from a certified source. The behavior will be the same as for
211Chrome (see above).
212
213.. _Wikipedia’s definition: http://fr.wikipedia.org/wiki/Bookmarklet
214.. _bookmark: http://en.wikipedia.org/wiki/Internet_bookmark
215.. _web browser: http://en.wikipedia.org/wiki/Web_browser
216.. _JavaScript: http://en.wikipedia.org/wiki/JavaScript
217.. _JavaScript programs: http://en.wikipedia.org/wiki/Computer_program
218.. _Google Play Store: https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche
219.. _F-droid: https://f-droid.org/app/fr.gaulupeau.apps.InThePoche
220.. _AppStore: https://itunes.apple.com/app/id828331015
221.. _Windows Store: https://www.microsoft.com/en-us/store/apps/wallabag/9nblggh11646
222.. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/
223.. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents
224.. _on the dedicated website: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj
225.. _Download Chrome Extensions: https://addons.opera.com/en/extensions/details/download-chrome-extension-9/
226.. _to to Google site: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj
diff --git a/docs/en/User/search.rst b/docs/en/User/search.rst
new file mode 100644
index 00000000..d2bda8bc
--- /dev/null
+++ b/docs/en/User/search.rst
@@ -0,0 +1,21 @@
1Search content in wallabag
2==========================
3
4To enable you to find an article quickly, we set up a full search
5engine.
6
7Click on **Search** in the wallabag menu. Then, enter your search terms.
8
9Wallabag will go through all your articles, and lists the ones
10containing the search terms in their title, their content or their URL.
11
12Convert this search into ePub format
13------------------------------------
14
15You can convert the listed articles to the ePub format, so that you can
16read them in your e-reader, for example. Look at :ref:`ePub conversion` for more about this.
17
18Assign a tag to your search results
19-----------------------------------
20
21You can create a tag based on your search criteria. Loot at :ref:`Organize articles` for more about this.
diff --git a/docs/en/conf.py b/docs/en/conf.py
new file mode 100644
index 00000000..ae879a61
--- /dev/null
+++ b/docs/en/conf.py
@@ -0,0 +1,87 @@
1# -*- coding: utf-8 -*-
2#
3# wallabag documentation build configuration file, created by
4# sphinx-quickstart on Fri Oct 16 06:47:23 2015.
5
6import sys
7import os
8
9extensions = []
10templates_path = ['_templates']
11source_suffix = '.rst'
12master_doc = 'index'
13project = u'wallabag'
14copyright = u'2013-2015, Nicolas Lœuillet - MIT Licence'
15version = '2.0.0'
16release = version
17exclude_patterns = ['_build']
18pygments_style = 'sphinx'
19html_theme = 'default'
20html_static_path = ['_static']
21htmlhelp_basename = 'wallabagdoc'
22latex_elements = {
23
24}
25
26latex_documents = [
27 ('index', 'wallabag.tex', u'wallabag Documentation',
28 u'Nicolas Lœuillet', 'manual'),
29]
30
31man_pages = [
32 ('index', 'wallabag', u'wallabag Documentation',
33 [u'Nicolas Lœuillet'], 1)
34]
35
36texinfo_documents = [
37 ('index', 'wallabag', u'wallabag Documentation',
38 u'Nicolas Lœuillet', 'wallabag', 'One line description of project.',
39 'Miscellaneous'),
40]
41
42##### Guzzle sphinx theme
43
44import guzzle_sphinx_theme
45html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
46html_theme_path = guzzle_sphinx_theme.html_theme_path()
47html_theme = 'guzzle_sphinx_theme'
48
49# Custom sidebar templates, maps document names to template names.
50html_sidebars = {
51 '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']
52}
53
54# Register the theme as an extension to generate a sitemap.xml
55extensions.append("guzzle_sphinx_theme")
56
57# Guzzle theme options (see theme.conf for more information)
58html_theme_options = {
59
60 # Set the path to a special layout to include for the homepage
61 # "index_template": "homepage.html",
62
63 # Allow a separate homepage from the master_doc
64 # homepage = index
65
66 # Set the name of the project to appear in the nav menu
67 # "project_nav_name": "Guzzle",
68
69 # Set your Disqus short name to enable comments
70 # "disqus_comments_shortname": "my_disqus_comments_short_name",
71
72 # Set you GA account ID to enable tracking
73 # "google_analytics_account": "my_ga_account",
74
75 # Path to a touch icon
76 # "touch_icon": "",
77
78 # Specify a base_url used to generate sitemap.xml links. If not
79 # specified, then no sitemap will be built.
80 #"base_url": "http://guzzlephp.org"
81
82 # Allow the "Table of Contents" page to be defined separately from "master_doc"
83 # tocpage = Contents
84
85 # Allow the project link to be overriden to a custom URL.
86 # projectlink = http://myproject.url
87}
diff --git a/docs/en/index.rst b/docs/en/index.rst
new file mode 100644
index 00000000..6ccfd44c
--- /dev/null
+++ b/docs/en/index.rst
@@ -0,0 +1,57 @@
1wallabag documentation
2======================
3
4.. image:: ../img/wallabag.png
5 :alt: wallabag logo
6 :align: center
7
8**wallabag** is a read-it-later application: it saves a web page by
9keeping content only. Elements like navigation or ads are deleted.
10
11The main documentation for the site is organized into a couple sections:
12
13* :ref:`user-docs`
14* :ref:`admin-docs`
15* :ref:`dev-docs`
16
17.. _user-docs:
18
19.. toctree::
20 :maxdepth: 2
21 :caption: User Documentation
22
23 user/create_account
24 user/login
25 user/configuration
26 user/first_article
27
28user/organize
29user/filters
30User/read_an_article
31User/search
32User/epub_conversion
33User/issue_with_article
34User/rss_feed
35User/import_export
36
37.. _admin-docs:
38
39.. toctree::
40 :maxdepth: 2
41 :caption: Admin Documentation
42
43 Administrator/install
44 Administrator/update
45 Administrator/hidden_options
46 Administrator/multiusers
47 Administrator/sessions
48
49.. _dev-docs:
50
51.. toctree::
52 :maxdepth: 2
53 :caption: Developer Documentation
54
55 Developer/write_config_files
56 Developer/create_new_theme
57 Developer/git_repo
diff --git a/docs/en/requirements.txt b/docs/en/requirements.txt
new file mode 100644
index 00000000..06fc8973
--- /dev/null
+++ b/docs/en/requirements.txt
@@ -0,0 +1,2 @@
1Sphinx>=1.3.0,<1.4.0
2guzzle_sphinx_theme>=0.7.0,<0.8.0
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
new file mode 100644
index 00000000..60aae4e5
--- /dev/null
+++ b/docs/en/user/configuration.rst
@@ -0,0 +1,61 @@
1Configuration
2=============
3
4Now you're logged in, it's time to configure your account as you want.
5
6Click on ``Config`` menu. You have four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``.
7
8Settings
9--------
10
11Theme
12~~~~~
13
14wallabag is customizable. You can choose your prefered theme here. You can also create a new one, a chapter is dedicated for this. The default theme is ``Material``, it's the theme used in the documentation screenshots.
15
16Items per page
17~~~~~~~~~~~~~~
18
19You can change the number of articles displayed on each page.
20
21Language
22~~~~~~~~
23
24You can change the language of wallabag interface.
25
26RSS
27---
28
29wallabag provides RSS feeds for each article status: unread, starred and archive.
30
31Firstly, you need to create a personal token: click on ``Create your token``.
32It's possible to change your token by clicking on ``Reset your token``.
33
34Now you have three links, one for each status: add them into your favourite RSS reader.
35
36You can also define how many articles you want in each RSS feed (default value: 50).
37
38User information
39----------------
40
41You can change your name, your email address and enable ``Two factor authentication``.
42
43Two factor authentication
44~~~~~~~~~~~~~~~~~~~~~~~~~
45
46 Two-factor authentication (also known as 2FA) is a technology patented in 1984 that provides identification of users by means of the combination of two different components.
47
48https://en.wikipedia.org/wiki/Two-factor_authentication
49
50If you enable 2FA, each time you want to login to wallabag, you'll receive a code by email. You have to put this code on the following form.
51
52.. image:: ../../img/user/2FA_form.png
53 :alt: Two factor authentication
54 :align: center
55
56If you don't want to receive a code each time you want to login, you can check the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days.
57
58Password
59--------
60
61You can change your password here.
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst
new file mode 100644
index 00000000..11fe304c
--- /dev/null
+++ b/docs/en/user/create_account.rst
@@ -0,0 +1,43 @@
1Create an account
2=================
3
4On the login page, click on ``Register`` button.
5
6.. image:: ../../img/user/registration_form.png
7 :alt: Registration form
8 :align: center
9
10You have to fill the form. Please sure to type a valid email address, we'll send you an activation email.
11
12.. image:: ../../img/user/sent_email.png
13 :alt: Email was sent to activate account
14 :align: center
15
16Check your inbox, you now have a new mail with a link like this ``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. Click on it to activate your account.
17
18Your account is now activated.
19
20.. image:: ../../img/user/activated_account.png
21 :alt: Welcome on board!
22 :align: center
23
24Frequently asked questions
25--------------------------
26
27I can't valid the registration form
28~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29
30Make sure that all fields are well filled:
31
32* valid email address
33* same passwords in two fields
34
35I don't receive my activation email
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38Are you sure your email address was correct? Did you check your spams folder?
39
40When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
41~~~~~~~~~~~~~~~
42
43You already enabled your account or the URL of the activation email is wrong.
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst
new file mode 100644
index 00000000..4e6735c6
--- /dev/null
+++ b/docs/en/user/first_article.rst
@@ -0,0 +1,79 @@
1Save your first article
2=======================
3
4The main purpose of wallabag is to save web articles. You have many ways to do it.
5
6By using a bookmarklet
7----------------------
8
9On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser.
10
11Now, 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.
12
13By using the classic form
14-------------------------
15
16In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article.
17
18.. image:: ../../img/user/topbar.png
19 :alt: Top bar
20 :align: center
21
22Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved.
23
24By using a browser add-on
25-------------------------
26
27Firefox
28~~~~~~~
29
30Firefox Classic Add-on
31^^^^^^^^^^^^^^^^^^^^^^
32
33Download the Firefox add-on at `addons.mozilla.org`_ and install it like
34any other Firefox add-on.
35
36In the add-on’s settings, fill the complete URL of your installation of
37wallabag or your Framabag account.
38
39Personalize the Firefox toolbar to add wallabag (**W** icon). When you
40find an article you want to save, click on this icon: a new window will
41open to add the article and will close itself automatically.
42
43Firefox Social API Service
44^^^^^^^^^^^^^^^^^^^^^^^^^^
45
46*Available from wallabag v1.9.1 only*
47
48You will need an https connection to use this. It’s a Firefox
49`requirement`_, sorry.
50
51With Firefox 29+ versions, your browser comes with an integrated
52interface to share things to multiple social services directly from your
53browser. In the Firefox interface, it is shown a paper plane-like icon
54that you will use to share a page, which means here, save an article.
55You can add the service by going into the Config page of wallabag, then
56click on Mozilla Services Social API Extension. You must also accept to
57use Firefox Services.
58
59Chrome
60~~~~~~
61
62By using your smarphone application
63-----------------------------------
64
65Android
66~~~~~~~
67
68Firefox OS
69~~~~~~~~~~
70
71Windows Phone
72~~~~~~~~~~~~~
73
74iOS
75~~~
76
77
78.. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/
79.. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst
new file mode 100644
index 00000000..1b6b8875
--- /dev/null
+++ b/docs/en/user/login.rst
@@ -0,0 +1,20 @@
1Login
2=====
3
4Your account is now enabled, congratulations!
5
6To login to wallabag, fill the form on login page.
7
8If you are on your personal computer and you want to stay connected, you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year.
9
10.. image:: ../../img/user/login_form.png
11 :alt: Login form
12 :align: center
13
14Frequently asked questions
15--------------------------
16
17I forgot my password
18~~~~~~~~~~~~~~~~~~~~
19
20You can reset your password by clicking on ``Forgot your password?`` link, on the login page. Then, fill the form with your email address
diff --git a/docs/fr/Administrateur/MAJ_wallabag.md b/docs/fr/Administrateur/MAJ_wallabag.md
new file mode 100644
index 00000000..57929e11
--- /dev/null
+++ b/docs/fr/Administrateur/MAJ_wallabag.md
@@ -0,0 +1,22 @@
1---
2language: Français
3currentMenu: upgrade
4subTitle: Mettre à jour wallabag
5---
6
7# Mettre à jour wallabag
8
9 Pour mettre à jour votre installation, téléchargez et décompressez l’archive dans votre installation (ici `/var/www/html/wallabag/`) :
10
11 wget http://wllbg.org/latest
12 unzip latest
13 rsync -ur wallabag-version-number/* /var/www/html/wallabag/
14
15Supprimez le répertoire `install` et videz le cache :
16
17 cd /var/www/html/wallabag/
18 rm -r cache/* install/
19
20Pour vider le cache, il est également possible d'aller dans la page de configuration et de cliquer sur le lien pour supprimer le cache.
21
22Vérifiez dans le bas de la page de configuration que la dernière version est bien installée.
diff --git a/docs/fr/Administrateur/Multi-utilisateurs.md b/docs/fr/Administrateur/Multi-utilisateurs.md
new file mode 100644
index 00000000..77a48d5e
--- /dev/null
+++ b/docs/fr/Administrateur/Multi-utilisateurs.md
@@ -0,0 +1,35 @@
1---
2language: Français
3currentMenu: multiusers
4subTitle: wallabag multi-utilisateurs
5---
6
7# wallabag multi-utilisateurs
8
9## Créer un nouveau compte
10
11### Mode administrateur
12
13Si vous souhaitez utiliser wallabag pour plusieurs personnes, il est possible de créer de nouveaux comptes depuis la page de configuration.
14
15En bas de cette page se trouve un formulaire où vous devez saisir un nom d'utilisateur et un mot de passe.
16
17Il est maintenant possible de se connecter avec ce compte depuis la page d'identification de wallabag.
18
19Aucune information n'est partagée entre les différents comptes.
20
21### Mode libre
22
23A partir de la version 1.9, l'administrateur peut laisser libre la création de nouveaux comptes. Il doit pour cela l'autoriser en modifiant les lignes suivantes dans le fichier de configuration :
24
25 // registration
26 @define ('ALLOW_REGISTER', FALSE);
27 @define ('SEND_CONFIRMATION_EMAIL', FALSE);
28
29Ensuite, l'utilisateur rentrera lui-même son nom d'utilisateur et son mot de passe pour se créer un compte. Selon la configuration, un courriel de confirmation peut être envoyé aux utilisateurs ayant fourni une adresse électronique.
30
31## Supprimer un compte
32
33Il est possible de supprimer son propre compte, depuis la page de configuration. Il suffit de saisir son mot de passe et de demander la suppression.
34
35Bien évidemment, lorsqu'il ne reste plus qu'un seul compte, il est impossible de le supprimer.
diff --git a/docs/fr/Administrateur/Options_cachees.md b/docs/fr/Administrateur/Options_cachees.md
new file mode 100644
index 00000000..5d4094d4
--- /dev/null
+++ b/docs/fr/Administrateur/Options_cachees.md
@@ -0,0 +1,40 @@
1---
2language: Français
3currentMenu: hidden
4subTitle: Options cachées
5---
6
7# Options cachées
8
9## Mise en garde
10
11**Attention**, cette partie concerne les utilisateurs avancés. Nous allons modifier un fichier important de wallabag, `inc/poche/config.inc.php`, il est donc conseillé de faire une sauvegarde de celui-ci avant toute modification.
12**Toute erreur lors d'une modification d'un fichier de wallabag pourra entrainer des dysfonctionnements**.
13
14Ce fichier est créé lorsque vous installez wallabag.
15Installez donc d'abord wallabag, faites une copie du fichier et ouvrez-le avec ~~Sublime Text~~ votre éditeur de texte préféré.
16
17Dans ce fichier sont définis des paramètres qui ne sont, aujourd'hui, pas encore disponibles dans la page **Configuration** de wallabag.
18
19## Modification des options avancées
20
21Chaque paramètre est défini de cette façon :
22
23 @define ('NOM_DU_PARAMETRE', 'Valeur du paramètre');
24
25Pour chaque ligne, vous ne pouvez modifier que la partie `Valeur du paramètre`.
26
27Listons maintenant les différents paramètres que vous pouvez changer :
28
29* `HTTP_PORT` (par défaut, `80`) : correspond au port HTTP de votre serveur web. À changer si votre serveur web est derrière un proxy. Valeur attendue : un nombre.
30* `SSL_PORT` (par défaut, `443`) : correspond au port SSL de votre serveur web. À changer si votre serveur web utilises SSLH. Valeur attendue : un nombre.
31* `DEBUG_POCHE` (par défaut, `FALSE`) : si vous rencontrez des problèmes avec wallabag, nous vous demanderons peut-être d'activer le mode Debug. Valeurs attendues : `TRUE` ou `FALSE`.
32* `DOWNLOAD_PICTURES` (par défaut, `FALSE`) : permet de télécharger sur votre serveur les images des articles. Ce paramètre est désactivé par défaut pour ne pas surcharger votre serveur web. Nous préférons vous laisser activer vous-même ce paramètre. Valeurs attendues : `TRUE` ou `FALSE`.
33* `SHARE_TWITTER` (par défaut, `TRUE`) : permet d'activer le partage vers twitter. Valeurs attendues : `TRUE` ou `FALSE`.
34* `SHARE_MAIL` (par défaut, `TRUE`) : permet d'activer le partage par email. Valeurs attendues : `TRUE` ou `FALSE`.
35* `SHARE_SHAARLI` (par défaut, `FALSE`) : permet d'activer le partage vers votre installation de Shaarli (gestionnaire de favoris). Valeurs attendues : `TRUE` ou `FALSE`.
36* `SHAARLI_URL` (par défaut, `'http://myshaarliurl.com'`) : définit l'URL de votre installation de Shaarli. Valeur attendue : une URL.
37* `FLATTR` (par défaut, `TRUE`) : permet d'activer la possibilité de flattrer un article ([Flattr est une plateforme de micro-dons](http://fr.wikipedia.org/wiki/Flattr)). Si un article est flattrable, une icône s'affichera et vous permet d'envoyer un micro-don à l'auteur de l'article. Valeurs attendues : `TRUE` ou `FALSE`.
38* `SHOW_PRINTLINK` (par défaut, `'1'`) : permet d'afficher le lien pour imprimer un article. Valeurs attendues : `'0'` pour désactiver ou `'1'` pour activer.
39* `SHOW_READPERCENT` (par défaut, `'1'`) : permet d'afficher (sur les thèmes `default`, `dark`, `dmagenta`, `solarized`, `solarized-dark`) le pourcentage de lecture de l'article. Valeurs attendues : `'0'` pour désactiver ou `'1'` pour activer.
40* `PAGINATION` (par défaut, `'12'`) : définit le nombre d'articles affichés sur une liste. Valeur attendue : un nombre. \ No newline at end of file
diff --git a/docs/fr/Administrateur/Telechargement_et_installation.md b/docs/fr/Administrateur/Telechargement_et_installation.md
new file mode 100644
index 00000000..46eb4619
--- /dev/null
+++ b/docs/fr/Administrateur/Telechargement_et_installation.md
@@ -0,0 +1,121 @@
1---
2language: Français
3currentMenu: install
4subTitle: Télécharger et installer wallabag
5---
6
7# Télécharger et installer wallabag
8
9## Je ne souhaite pas installer wallabag
10
11Puisque vous ne voulez pas ou ne pouvez pas installer wallabag, nous vous proposons de créer un compte gratuit sur [Framabag](https://framabag.org/), lequel utilise notre logiciel. [Lisez la documentation complète](../Utilisateur/Framabag.md).
12
13## Je souhaite installer wallabag
14
15### Je souhaite télécharger wallabag manuellement
16
17[Télécharger la dernière version de wallabag](http://wllbg.org/latest) et décompresser-là :
18
19 wget http://wllbg.org/latest
20 unzip latest
21 mv wallabag-version-number wallabag
22
23Copiez les fichiers sur votre serveur web. Dans le cas d'Ubuntu/Debian, il s'agit de /var/www/html/ :
24
25 sudo mv wallabag /var/www/html/
26
27Puis sautez le paragraphe suivant.
28
29### Je souhaite télécharger wallabag via composer
30
31Vous devez installer composer :
32
33 curl -s http://getcomposer.org/installer | php
34
35Ensuite, sur votre serveur web, exécutez cette commande :
36
37 composer create-project wallabag/wallabag . dev-master
38
39Tout est téléchargé dans le répertoire courant.
40
41#### Pré-requis pour votre serveur web
42
43Wallabag nécessite qu'un certain nombre de composants soient installées sur votre serveur web.
44Pour être sûr que votre serveur possède tous les pré-requis, ouvrez dans votre navigateur la page `http://monserveur.com/wallabag/install/index.php`.
45
46Les composants sont :
47
48* [PHP 5.3.3 ou plus](http://php.net/manual/fr/install.php) **avec support [PDO](http://php.net/manual/en/book.pdo.php)**
49* [XML pour PHP](http://php.net/fr/xml)
50* [PCRE](http://php.net/fr/pcre)
51* [ZLib](http://php.net/en/zlib) (son absence affectera le traitement des pages compressées)
52* [mbstring](http://php.net/en/mbstring) et/ou [iconv](http://php.net/en/iconv) (sinon, certaines pages ne pourront pas être lues - même en anglais)
53* L'extension [DOM/XML](http://php.net/manual/en/book.dom.php)
54* [Filtrage des données](http://php.net/manual/fr/book.filter.php)
55* [GD](http://php.net/manual/en/book.image.php) (son absence empèchera la sauvegarde des images)
56* [Tidy pour PHP](http://php.net/fr/tidy) (son absence peut poser problème avec certaines pages)
57* [cURL](http://php.net/fr/curl) avec `Parallel URL fetching` (optionel)
58* [Parse ini file](http://uk.php.net/manual/en/function.parse-ini-file.php)
59* [allow_url_fopen](http://www.php.net/manual/fr/filesystem.configuration.php#ini.allow-url-fopen) (optionel si cURL présent)
60* [gettext](http://php.net/manual/fr/book.gettext.php) (nécessaire pour le support multilingues)
61
62Installez les composants manquants avant de poursuivre. Par exemple pour installer Tidy sur Ubuntu/Debian :
63
64 sudo apt-get install php5-tidy
65 sudo service apache2 reload
66
67Note : si voux utilisez IIS comme serveur web, vous devez interdire l'*Authentification Anonyme* et [permettre L'*Authentification de base*](https://technet.microsoft.com/fr-fr/library/cc772009%28v=ws.10%29.aspx) pour autoriser la connexion.
68
69#### Twig installation
70
71Pour pouvoir fonctionner, wallabag a besoin de `Twig`, une bibliothèque de modèles.
72Si vous ne pouvez pas installer `composer` (dans le cas d'hébergement mutualisé par exemple), nous vous proposons un fichier
73incluant `Twig`. Ce fichier peut être télécharger depuis la page `http://monserveur.com/wallabag/install/index.php` (section INSTALLATION TWIG) ou directement ici [http://wllbg.org/vendor](http://wllbg.org/vendor). Décompressez-le dans votre répertoire wallabag.
74
75Alternativement, vous pouvez installer `Twig` en lançant `composer` depuis votre dossier wallabag (toujours dans le cas d'Ubuntu/Debian : <code>/var/www/html/wallabag/</code>) en exécutant les commandes :
76
77 curl -s http://getcomposer.org/installer | php
78 php composer.phar install
79
80### Création de la base de données
81
82Wallabag peut s'installer sur différents types de bases de données :
83
84* [SQLite](http://php.net/manual/fr/book.sqlite.php). Le plus simple de tous. Rien de particulier à configurer.
85* [MySQL](http://php.net/manual/fr/book.mysql.php). Un système de base de données bien connu, qui est dans la plupart des cas plus efficace que SQLite.
86* [PostgreSQL](http://php.net/manual/fr/book.pgsql.php). Certaines personnes l'ont trouvé mieux que MySQL.
87
88Nous vous conseillons d'utiliser MySQL, plus performante. Il est alors nécessaire de créer une nouvelle base (par exemple `wallabag`), un nouvel utilisateur (par exemple `wallabag`) et un mot de passe (ici `VotreMotdePasse`). Vous pouvez pour cela utiliser `phpMyAdmin`, ou exécuter les commandes suivantes :
89
90 mysql -p -u root
91 mysql> CREATE DATABASE wallabag;
92 mysql> GRANT ALL PRIVILEGES ON `wallabag`.* TO 'wallabag'@'localhost' IDENTIFIED BY 'VotreMotdePasse';
93 mysql> exit
94
95*Note :* Si vous utilisez MySQL ou Postgresql, vous devrez **remplir tous les champs**, sinon l'installation ne fonctionera pas et un message d'erreur vous dira ce qui ne va pas. Vous devez créer manuellement la base de données qui sera utilisée par wallabag avec un outil comme PHPMyAdmin ou en ligne de commande.
96
97### Permissions
98
99Le serveur web doit avoir accès en écriture aux répertoires `assets`, `cache` et `db`. Sans cela, un message vous indiquera que l'installation est impossible :
100
101 sudo chown -R www-data:www-data /var/www/html/wallabag
102
103### Installation de wallabag. Enfin.
104
105Accédez à wallabag depuis votre navigateur : `http://votreserveur.com/wallabag`. Si votre serveur est bien configuré, vous arrivez sur l'écran d'installation.
106
107Renseignez le type de votre base de données (`sqlite`, `mysql` ou `postgresql`) et les informations de votre base de données. Dans le cas de la base MySQL créée plus haut, la configuration standard sera :
108
109 Database engine: MySQL
110 Server: localhost
111 Database: wallabag
112 Username: wallabag
113 Password: VotreMotdePasse
114
115Créez enfin votre premier utilisateur et son mot de passe (différents de l'utilisateur de la base de données).
116
117wallabag est maintenant installé.
118
119### Connexion
120
121Depuis votre navigateur, vous arrivez sur l'écran d'identification : saisissez votre identifiant et votre mot de passe et vous voici connecté.
diff --git a/docs/fr/Administrateur/sessions.md b/docs/fr/Administrateur/sessions.md
new file mode 100644
index 00000000..717e55e1
--- /dev/null
+++ b/docs/fr/Administrateur/sessions.md
@@ -0,0 +1,26 @@
1---
2language: Français
3currentMenu: sessions
4subTitle: Problème de sessions
5---
6
7Si vous vous retrouvez à être déconnecté même après avoir valider le *Stay signed in checkbox*,
8lancez les commandes suivantes comme administrateur (ou avec sudo) :
9
10```
11mkdir /var/lib/wallabag-sessions
12chown www-data:www-data /var/lib/wallabag-sessions
13```
14
15*NOTE : L'utilisateur et le groupe www-data pourrait ne pas exister.
16Vous pouvez alors utiliser ```chown http:http /var/lib/wallabag-sessions``` à la place.*
17
18Ensuite, en utilisant apache, ajoutez : `php_admin_value session.save_path /var/lib/wallabag-sessions`
19à votre vhost apache, tel que `wallabag-apache.conf`.
20Enfin, redémarrez apache, en lançant par exemple : ```/etc/init.d/apache2 restart```
21
22Si vous utilisez nginx, ajoutez `php_admin_value[session.save_path] = /var/lib/wallabag-sessions`
23à votre fichier de configuration de nginx.
24Ensuite, redémarrez nginx : ```/etc/init.d/nginx restart```
25
26*NOTE : si vous utilisez systemd, vous devriez faire `systemctl restart apache2` (ou nginx).*
diff --git a/docs/fr/Contribuer_au_projet.md b/docs/fr/Contribuer_au_projet.md
new file mode 100644
index 00000000..879cdaaa
--- /dev/null
+++ b/docs/fr/Contribuer_au_projet.md
@@ -0,0 +1,52 @@
1---
2language: Français
3currentMenu: help_us
4subTitle: Contribuer au projet
5---
6
7# Contribuer au projet
8## Soumettre des bugs
9### Demande de support
10
11Si vous avez un problème lors de l'installation ou de l'utilisation de wallabag (que ça soit l'application web ou les applications pour smartphone), utilisez le site de support [http://support.wallabag.org](http://support.wallabag.org).
12
13Nous verrons alors si nous pouvons vous dépanner rapidement ou alors s'il s'agit un nouveau bug qu'il nous faudra corriger.
14
15Il est préférable d'utiliser le site de support plutôt que de nous envoyer un mail : le suivi est plus pratique pour vous comme pour nous et la résolution de votre problème pourra resservir pour un autre utilisateur.
16
17### Créer un nouveau ticket
18
19Si vous avez trouvé un bug lors de votre utilisation de wallabag, merci d'ouvrir un nouveau ticket sur Github (un compte est nécessaire).
20
21**Avant toute chose**, pensez à lire [les recommandations nécessaires pour la rédaction d'un nouveau ticket](https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md). Au mieux vous renseignez votre ticket, au mieux nous pourrons vous aider.
22
23* si c'est un bug avec l'application web, [ouvrez un nouveau ticket ici](https://github.com/wallabag/wallabag/issues/new)
24* si c'est un bug avec l'application Android, [ouvrez un nouveau ticket ici](https://github.com/wallabag/android-app/issues/new)
25* si c'est un bug avec l'application Windows Phone, [ouvrez un nouveau ticket ici](https://github.com/wallabag/windowsphone-app)
26* si c'est un bug avec l'application iOS, [ouvrez un nouveau ticket ici](https://github.com/wallabag/ios-app/issues/new)
27* si c'est un bug avec l'extension Firefox, [ouvrez un nouveau ticket ici](https://github.com/wallabag/firefox-ext/issues/new)
28* si c'est un bug avec l'extension Chrome, [ouvrez un nouveau ticket ici](https://github.com/wallabag/chrome-ext/issues/new)
29
30## Écrire et corriger la documentation
31
32La documentation que vous êtes en train de lire n'est sûrement pas complète, à jour, traduite dans votre langue. C'est pourquoi nous vous invitons à participer à sa rédaction.
33
34Le dépôt Github se trouve ici : [https://github.com/wallabag/documentation](https://github.com/wallabag/documentation).
35
36## Corriger les bugs, résoudre les problèmes : faire du support
37
38Deux possibilités :
39* lorsqu'un utilisateur de wallabag pose une nouvelle question [sur le site de support](http://support.wallabag.org), en tant qu'utilisateur avancé de wallabag, vous pouvez lui répondre.
40* sur Github, des tickets correspondent sûrement à vos compétences. [Parcourez la liste des tickets](https://github.com/wallabag/wallabag/issues) et servez-vous.
41
42Si vous souhaitez proposer une modification dans le code de wallabag, vous êtes le bienvenu. [N'oubliez pas de lire les recommandations pour proposer vos modifications](https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md).
43
44## Communiquer
45
46Rien de compliqué ici, parlez de wallabag autour de vous. Utilisez le mot-clé #wallabag sur tous vos réseaux sociaux préférés : twitter, Facebook, Diaspora*, Google+, etc.
47
48D'ailleurs, voici la liste de nos comptes sur ces réseaux, si jamais vous voulez nous citer dans un de vos messages :
49* [Diaspora*](https://framasphere.org/people/2335ff202f920132196e2a0000053625)
50* [twitter](https:/twitter.com/wallabagapp)
51* [Facebook](https://www.facebook.com/wallabag)
52* [Google+](https://plus.google.com/+WallabagOrg/)
diff --git a/docs/fr/Developpeur/Creer_un_nouveau_theme.md b/docs/fr/Developpeur/Creer_un_nouveau_theme.md
new file mode 100644
index 00000000..15e89ce3
--- /dev/null
+++ b/docs/fr/Developpeur/Creer_un_nouveau_theme.md
@@ -0,0 +1,9 @@
1---
2language: Français
3currentMenu: theme
4subTitle: Créer un nouveau thème
5---
6
7# Créer un nouveau thème
8
9TODO \ No newline at end of file
diff --git a/docs/fr/Developpeur/Depot_git.md b/docs/fr/Developpeur/Depot_git.md
new file mode 100644
index 00000000..458e32ca
--- /dev/null
+++ b/docs/fr/Developpeur/Depot_git.md
@@ -0,0 +1,23 @@
1---
2language: Français
3currentMenu: repo
4subTitle: Dépôt git de wallabag
5---
6
7# Dépôt git de wallabag
8
9Si vous souhaitez contribuer au projet en proposant de nouvelles fonctionnalités ou en corrigeant des bugs, il faut suivre les recommandations que vous lirez ci-dessous concernant le dépôt Git disponible à cette adresse : [https://github.com/wallabag/wallabag](https://github.com/wallabag/wallabag).
10
11## État des lieux
12
13Pour la gestion des différentes versions de wallabag, nous utilisons Git.
14
15Nous utilisons plusieurs branches pour le code source de l'application web de wallabag :
16
17* la branche `master` : c'est la branche stable, celle qui est téléchargée pour tous ceux qui souhaitent installer wallabag pour leur utilisation.
18* la branche `dev` : avant d'être sur la branche `master`, toutes les corrections de bugs et nouvelles fonctionnalités doivent passer par cette branche. Cette branche n'est pas conseillée pour une utilisation en production.
19* la branche `v2-symfony` : c'est la branche de la refonte de wallabag. Un chapitre complet lui est consacré.
20
21## Workflow
22
23Toutes les consignes concernant le dépôt Git se trouve dans [le fichier CONTRIBUTING.md de wallabag](https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md). Merci de le lire attentivement avant toute modification. \ No newline at end of file
diff --git a/docs/fr/Developpeur/Docker.md b/docs/fr/Developpeur/Docker.md
new file mode 100644
index 00000000..b5c9af81
--- /dev/null
+++ b/docs/fr/Developpeur/Docker.md
@@ -0,0 +1,9 @@
1---
2language: Français
3currentMenu: docker
4subTitle: Docker
5---
6
7# Docker
8
9TODO \ No newline at end of file
diff --git a/docs/fr/Developpeur/Ecrire_fichier_configuration.md b/docs/fr/Developpeur/Ecrire_fichier_configuration.md
new file mode 100644
index 00000000..e90b6526
--- /dev/null
+++ b/docs/fr/Developpeur/Ecrire_fichier_configuration.md
@@ -0,0 +1,39 @@
1---
2language: Français
3currentMenu: site_config
4subTitle: Écrire un fichier de configuration
5---
6
7# Écrire un fichier de configuration
8
9wallabag peut utiliser des fichiers de configuration spécifiques à un site pour lire les articles de ce site. Ces fichiers sont stockés dans le répertoire [`inc/3rdparty/site_config/standard`](https://github.com/wallabag/wallabag/tree/master/inc/3rdparty/site_config/standard).
10
11Le format utilisé pour ces fichiers est [XPath](http://www.w3.org/TR/xpath20/). Inspirez-vous des exemples dans le répertoire pour en créer de nouveaux.
12
13## Génération automatique de fichiers de configuration
14
15@FiveFilters a créé un [outil très utile](http://siteconfig.fivefilters.org/) pour créer des fichiers de configuration. Vous devez taper l'adresse d'un article qui vous intéresse. puis vous sélectionnez le contenu que vous souhaitez.
16
17![siteconfig](https://lut.im/RNaO7gGe/l9vRnO1b)
18
19Vous devez confirmer cette zone en essayant avec d'autres articles.
20Quand vous avez trouvé la bonne zone, cliquez simplement sur *Download Full-Text RSS site config* (Téléchargez la configuration du site Full-Text RSS) pour télécharger le fichier à inclure dans le répertoire.
21
22## Génération manuelle de fichiers de configuration
23
24Si l'outil de FiveFilters ne marche pas tel qu´attendu, regardez la source d'un article (Ctrl+U sur Firefox ou Chromium). Cherchez votre contenu parmi le code source et repérez l'attribut `class` ou `id` de la zone que vous souhaitez.
25
26Une fois que vous avez obtenu l'attribut `id` ou `class`, vous pouvez écrire par exemple l'une ou l'autre de ces lignes :
27
28```
29body: //div[@class='myclass']
30body: //div[@id='myid']
31```
32
33Ensuite, testez votre fichier de configuration avec d'autres articles du même site. Si vous avez trouvé le bon contenu mais que vous voulez enlever des parties inutiles, ajoutez la ligne suivante (avec l'attribut `class` correspondant à la partie inutile) :
34
35```
36strip: //div[@class='hidden']
37```
38
39Vous pouvez regarder d'autres options pour les fichiers de configuration de sites [sur l'aide du site de FiveFilters](http://help.fivefilters.org/customer/portal/articles/223153-site-patterns).
diff --git a/docs/fr/Developpeur/Vagrant.md b/docs/fr/Developpeur/Vagrant.md
new file mode 100644
index 00000000..b2f83bc8
--- /dev/null
+++ b/docs/fr/Developpeur/Vagrant.md
@@ -0,0 +1,34 @@
1---
2language: Français
3currentMenu: vagrant
4subTitle: Vagrant
5---
6
7# Vagrant
8
9Pour vous permettre de mettre en place rapidement la configuration requise pour wallabag, nous vous proposons un fichier Vagrantfile.
10
11[Définition Wikipedia](http://fr.wikipedia.org/wiki/Vagrant)
12
13 Vagrant est un logiciel libre et open-source pour la création et la configuration des environnements de développement virtuel. Il peut être considéré comme un wrapper autour du logiciel de virtualisation comme VirtualBox.
14
15## Utiliser Vagrant pour wallabag
16
17Voici la procédure pour exécuter wallabag au sein d'un conteneur Vagrant :
18
19 wget -O wallabag-dev.zip https://github.com/wallabag/wallabag/archive/dev.zip
20 unzip wallabag-dev.zip
21 cd wallabag-dev
22 vagrant up
23
24Accédez maintenant à `http://localhost:8003` et à vous de jouer !
25
26## Qu'a installé le Vagrantfile ?
27
28Le script installe un serveur LAMP, à savoir :
29
30* Ubuntu 14.04
31* Un serveur web Apache2
32* PHP5
33* SQLite ou MySQL ou PostgreSQL pour PHP
34* XDebug pour PHP
diff --git a/docs/fr/Developpeur/v2.md b/docs/fr/Developpeur/v2.md
new file mode 100644
index 00000000..470213d0
--- /dev/null
+++ b/docs/fr/Developpeur/v2.md
@@ -0,0 +1,9 @@
1---
2language: Français
3currentMenu: v2
4subTitle: wallabag v2 / symfony2
5---
6
7# wallabag v2 / symfony2
8
9TODO \ No newline at end of file
diff --git a/docs/fr/Utilisateur/Classer_ses_articles.md b/docs/fr/Utilisateur/Classer_ses_articles.md
new file mode 100644
index 00000000..447db3c8
--- /dev/null
+++ b/docs/fr/Utilisateur/Classer_ses_articles.md
@@ -0,0 +1,68 @@
1---
2language: Français
3currentMenu: sort_article
4subTitle: Classer ses articles
5---
6
7# Classer ses articles
8
9Pour pouvoir retrouver plus facilement vos articles, plusieurs méthodes existent.
10
11## Tags
12### Assigner un tag
13#### Depuis l'article
14
15Aujourd'hui, il n'est pas encore possible d'assigner un tag lorsque vous sauvegardez un nouvel article.
16
17Tout ajout de tag se fera donc sur un article déjà sauvegardé.
18
19Sur la page de lecture de l'article, se trouve une partie `tags` suivie d'un crayon. Cliquez sur ce crayon.
20
21Saisissez dans la case les tags que vous souhaitez assigner. Saisissez autant de tags que vous le voulez. Ils doivent être séparés par des virgules et non par des espaces. L'auto-complétion existe ici : si vous tapez les premières lettres d'un tag déjà existant, inutile de taper le mot en entier, sélectionnez-le dans la liste déroulante. Une fois tous vos tags saisis, cliquez sur le bouton **Tag**.
22
23Vous pouvez ensuite retourner lire votre article.
24
25#### Depuis la recherche
26
27Un chapitre complet sur la recherche existe. Ici, nous verrons uniquement comment assigner un tag depuis votre recherche.
28
29Lorsque votre recherche vous affiche les résultats, vous avez un lien en bas de page `Apply the tag ABCD to this search`. Cliquez dessus : un tag en fonction de la recherche que vous venez d'effectuer (ici `ABCD`) sera assigné à tous les articles trouvés.
30
31### Retrouver tous les articles d'un même tag
32
33Dans le menu de wallabag, cliquez sur **Tags**. Ici s'affichent tous les tags que vous avez créés, triés par nombre d'articles au sein de chaque tag. Cliquez sur l'un de ces tags pour retrouver tous les articles correspondants à ce tag.
34
35## Articles favoris
36
37Lorsque vous souhaitez mettre de côté un article, vous pouvez le marquer comme favori.
38
39### Marquer un article comme favori
40
41Depuis la page de lecture d'un article, ou depuis une liste d'articles (par exemple, la liste des articles non lus), vous pouvez mettre un article comme favori juste en cliquant sur l'étoile qui apparait.
42Recliquer sur cette étoile enlèvera le statut **favori** de cet article.
43
44### Retrouver tous ses articles favoris
45
46Dans le menu de wallabag, cliquez sur **Favoris** pour retrouver tous les articles que vous avez déjà mis en favori.
47
48## Articles archivés
49
50Lorsque vous avez lu un article, vous pouvez l'archiver : ainsi il n'apparaitra plus dans votre liste d'articles non lus.
51Le fait d'archiver un article ne le supprime pas de wallabag.
52
53### Archiver un article
54
55Depuis la page de lecture d'un article, ou depuis une liste d'articles (par exemple, la liste des articles non lus), vous pouvez archiver un article juste en cliquant sur l'icône ✓.
56Recliquer sur cette icône remettra l'article en statut **non lu**.
57
58### Retrouver tous ses articles archivés
59
60Dans le menu de wallabag, cliquez sur **Archive** pour retrouver tous les articles que vous avez déjà archivés.
61
62## Supprimer l'article
63
64Attention, la suppression d'un article est **définitive** : il est supprimé de la base de données de wallabag.
65
66Pour supprimer un article, une icône de corbeille se trouve sur la page d'un article ou sur une liste d'articles (articles non lus, favoris ou archivés par exemple).
67
68Nous vous faisons confiance : c'est pourquoi il n'y a aucune demande de confirmation lors de la suppression.
diff --git a/docs/fr/Utilisateur/Configurer_wallabag.md b/docs/fr/Utilisateur/Configurer_wallabag.md
new file mode 100644
index 00000000..2d95dc90
--- /dev/null
+++ b/docs/fr/Utilisateur/Configurer_wallabag.md
@@ -0,0 +1,30 @@
1---
2language: Français
3currentMenu: configure
4subTitle: Configurer wallabag
5---
6
7# Configurer wallabag
8
9Depuis le menu **configuration**, vous avez la possibilité de changer quelques options de wallabag.
10
11Certaines parties ne seront pas présentées ici car elles bénéficient d'un chapitre complet dans la documentation ([flux RSS](flux_rss.html), [l'import depuis un service tiers](importer_exporter.html), [l'export de vos données](importer_exporter.html), [la conversion en ePub](convertir_en_epub.html) et [le mode multi-utilisateurs](../Administrateur/multi-utilisateurs.html)).
12
13## Thème
14
15Des goûts et des couleurs, on ne discute pas. C'est pourquoi wallabag vous propose de changer son habillage pour plaire à chacun.
16Sélectionnez le thème de votre choix dans la liste déroulante et validez en cliquant sur **Mettre à jour**.
17
18## Langue
19
20Sélectionnez la langue de votre choix dans la liste déroulante et validez en cliquant sur **Mettre à jour**.
21
22## Mot de passe
23
24Saisissez votre nouveau mot de passe dans les deux champs prévus et validez en cliquant sur **Mettre à jour**.
25Vous serez alors déconnecté et devrez saisir votre nouveau mot de passe pour accéder à wallabag.
26
27## Vider le cache
28
29Le cache permet à wallabag d'effectuer certains traitements plus rapidement.
30Après une mise à jour de wallabag, il est conseillé de vider le cache. Vous n'avez qu'un clic à faire pour le vider.
diff --git a/docs/fr/Utilisateur/Convertir_en_ePub.md b/docs/fr/Utilisateur/Convertir_en_ePub.md
new file mode 100644
index 00000000..8172a78c
--- /dev/null
+++ b/docs/fr/Utilisateur/Convertir_en_ePub.md
@@ -0,0 +1,25 @@
1---
2language: Français
3currentMenu: epub
4subTitle: Convertir en ePub
5---
6
7# Convertir en ePub
8
9Pour que vous puissiez lire vos articles sauvegardés depuis votre liseuse, wallabag vous permet de les convertir au format ePub et ainsi vous créer un eBook pour vos longues soirées d'hiver.
10
11## Mise en garde
12
13Attention, la génération de fichiers ePub peut être très consommatrice de ressources pour le serveur sur lequel est installé wallabag. Cela dépend du nombre d'articles et de leur longueur.
14Ne générez pas un eBook trop important si cela n'est pas nécessaire.
15
16## Où convertir les articles
17
18Vous pouvez convertir vos articles depuis différents endroits de wallabag :
19
20* sur la page de lecture d'un article : le lien ePub convertira ce seul article
21* depuis une liste d'articles (articles non lus, favoris ou archivés, articles d'un tag) : un lien en bas de page vous permet de convertir tous les articles de cette catégorie
22* depuis une recherche : le lien se trouve en bas de page
23* depuis la page de configuration : vous allez pouvoir convertir tous vos articles, peu importe la catégorie dans laquelle ils se trouvent
24
25TODO parler de calibre \ No newline at end of file
diff --git a/docs/fr/Utilisateur/Flux_RSS.md b/docs/fr/Utilisateur/Flux_RSS.md
new file mode 100644
index 00000000..78862737
--- /dev/null
+++ b/docs/fr/Utilisateur/Flux_RSS.md
@@ -0,0 +1,35 @@
1---
2language: Français
3currentMenu: rss
4subTitle: Flux RSS
5---
6
7# Flux RSS
8
9Les flux RSS vous permettent :
10
11* de lire vos articles depuis votre lecteur de flux RSS préféré
12* d'activer les fonctionnalités de lecture pour les applications smartphones
13
14Tout d'abord, vous devez activer la fonctionnalité RSS en générant votre jeton de flux.
15Rendez-vous dans **configuration** de wallabag et créez le jeton dans la partie **Flux**.
16À tout moment, vous pouvez générer un nouveau jeton.
17
18## Lire les articles
19
20Une fois le jeton créé, vous avez accès à trois flux RSS :
21
22* celui des articles non lus
23* celui des articles favoris
24* celui des articles archivés
25
26Ajoutez le flux de votre choix dans votre lecteur de flux RSS.
27Attention, lorsque vous lirez un article depuis votre lecteur de flux, ça ne le marquera pas comme lu dans wallabag.
28
29### Partager vos lectures
30
31Si vous souhaitez partager vos lectures avec quelqu'un, envoyez-lui par exemple le flux RSS de vos articles préférés. Ainsi, dès qu'un article sera mis en favori dans wallabag, cette personne pourra également le lire.
32
33## Activer les fonctionnalités pour smartphones
34
35Vous avez créé le jeton de flux RSS : il va vous être utile pour configurer votre application smartphone. Pour en savoir sur les applications smartphones, vous pouvez lire [Sauvegarder son premier article](Sauvegarder_son_premier_article.md). \ No newline at end of file
diff --git a/docs/fr/Utilisateur/Framabag.md b/docs/fr/Utilisateur/Framabag.md
new file mode 100644
index 00000000..258f3dd5
--- /dev/null
+++ b/docs/fr/Utilisateur/Framabag.md
@@ -0,0 +1,34 @@
1---
2language: Français
3currentMenu: framabag
4subTitle: Se créer un compte sur Framabag
5---
6
7# Se créer un compte sur Framabag
8
9Puisque vous ne souhaitez peut-être pas gérer l'installation et la mise à jour de wallabag, ou puisque vous n'avez peut-être pas les connaissances pour l'installer, il vous est possible de vous créer un compte gratuit sur [Framabag.org](https://www.framabag.org).
10
11## Création du compte
12
13Cliquez sur le bouton **Créez votre compte / Create your account**.
14
15Vous devez saisir certaines informations : votre nom d'utilisateur, votre mot de passe et votre adresse email. Votre adresse n'est utilisée que pour la validation de votre compte, sauf si vous cochez la case pour recevoir la newsletter (3 à 4 envois par an).
16
17Une fois ce formulaire validé, vous recevez un email avec un lien de confirmation. Cliquez dessus, votre compte sera alors créé.
18
19Vous recevrez un dernier email avec l'adresse de votre compte Framabag, de la forme `https://www.framabag.org/u/votre-nom-d'utilisateur`.
20
21## Stockage de vos informations
22
23Framabag utilise une base de données par utilisateur. Nous ne faisons et ne ferons aucune utilisation de vos données stockées.
24
25## Vous avez oublié votre mot de passe
26
27Si vous avez oublié votre mot de passe pour vous connecter à Framabag, un formulaire est disponible [depuis la page d'accueil du service](https://www.framabag.org).
28Remplissez-le, un email de confirmation vous sera envoyé et vous permettra de saisir votre nouveau mot de passe.
29
30## Suppression de votre compte
31
32Si vous souhaitez supprimer votre compte, contactez-nous par email : [hello@wallabag.org](mailto:hello@wallabag.org) avec l'adresse de création de votre compte, en nous indiquant votre nom d'utilisateur.
33
34Nous vous répondrons quand votre compte sera supprimé : dès cet instant, plus aucune information vous concernant ne sera stockée sur Framabag.
diff --git a/docs/fr/Utilisateur/Importer_exporter.md b/docs/fr/Utilisateur/Importer_exporter.md
new file mode 100644
index 00000000..f5dda060
--- /dev/null
+++ b/docs/fr/Utilisateur/Importer_exporter.md
@@ -0,0 +1,78 @@
1---
2language: Français
3currentMenu: import
4subTitle: Importer ou exporter ses données
5---
6
7# Importer ou exporter ses données
8## Importer
9
10Pour importer des données dans wallabag, vous devez vous rendre dans la page **Configuration**.
11
12### Mise en garde
13
14L'import de données peut être une **opération gourmande** pour votre serveur. C'est pourquoi elle s'effectue en deux étapes :
15
16* l'insertion des URL dans la base de données de wallabag
17* dans un second temps, la récupération, pour chaque article, du contenu complet
18
19Ces deux actions ne peuvent pas être effectuées simultanément, car nous vous donnons la possibilité d'importer des milliers de liens, mais aujourd'hui, wallabag n'a pas les possibilités techniques nécessaires pour effectuer tout ce travail automatiquement.
20
21### Depuis Pocket
22#### Exporter ses données depuis Pocket
23
24Depuis votre compte Pocket, rendez-vous dans vos options.
25TODO
26
27#### Importer ses données Pocket
28
29Depuis la page de configuration de wallabag, partie **Import**, sélectionnez le fichier `ril_export.html` que Pocket a généré puis cliquez sur **Import**.
30wallabag ne fait qu'insérer les liens dans sa base de données. Il faut maintenant lui faire récupérer le contenu de chaque article.
31
32Pour cela, cliquez sur `Click to finish import` : wallabag récupèrera alors le contenu de 10 articles à la fois.
33
34TODO
35
36TODO nouveau ticket : pourquoi quand on clique une fois, ça ne charge pas en boucle ? Il me semblait que ça faisait ça ping @mariroz
37
38### Depuis Instapaper
39#### Exporter ses données depuis Instapaper
40
41TODO
42
43#### Importer ses données Instapaper
44
45TODO
46
47### Depuis Readability
48#### Exporter ses données depuis Readability
49
50TODO
51
52#### Importer ses données Readability
53
54TODO
55
56### Depuis wallabag
57
58Puisque vous pouvez exporter vos données de wallabag (lire ci-dessous), il est évidemment possible de les réimporter.
59
60Dans le formulaire d'import, sélectionnez votre fichier d'export wallabag (au format JSON). Démarrez l'import et voila.
61
62Contrairement aux imports ci-dessus, le traitement est moins long car toutes les données (titre et contenu des articles) sont déjà présentes dans le fichier, il n'est pas nécessaire pour wallabag d'accéder à chacune des URL.
63Par contre, le fichier d'import est forcément plus conséquent.
64
65### Depuis un fichier HTML ou JSON
66
67TODO
68
69## Exporter
70Il est possible d'exporter ses données depuis la page **Configuration** de wallabag. Plusieurs raisons possibles :
71
72* réinstaller wallabag
73* quitter le service Framabag pour installer soi-même wallabag
74* un compte sur un wallabag multi-utilisateurs souhaite avoir sa propre installation de wallabag
75* ...
76
77Vous téléchargerez alors un fichier [au format JSON](http://fr.wikipedia.org/wiki/JavaScript_Object_Notation).
78Comme nous l'avons vu ci-dessus, il est possible d'importer ce fichier dans wallabag. \ No newline at end of file
diff --git a/docs/fr/Utilisateur/Lire_un_article.md b/docs/fr/Utilisateur/Lire_un_article.md
new file mode 100644
index 00000000..72ebc07e
--- /dev/null
+++ b/docs/fr/Utilisateur/Lire_un_article.md
@@ -0,0 +1,58 @@
1---
2language: Français
3currentMenu: read_article
4subTitle: Lire un article
5---
6
7# Lire un article
8
9Lire un article n'est pas la chose la plus compliquée dans wallabag. Vous n'avez qu'à cliquer sur le titre d'un article pour l'afficher.
10
11## Revenir là où vous avez laissé votre article
12
13Si vous quittez un article alors que vous n'êtes qu'à la moitié de celui-ci par exemple, lorsque vous reviendrez, wallabag vous renverra là où vous avez laissé l'article.
14
15Cette astuce ne fonctionne qu'avec l'application web et pas les applications smartphones.
16
17## Actions possibles depuis l'article
18
19Ces actions sont possibles grâce aux icônes affichés en haut de la page. Nous partons du principe que vous utilisez le thème Baggy ([lire la documentation pour changer de thème](Configurer_wallabag.md)), les icônes dans les autres thèmes sont sensiblement les mêmes.
20Voici donc ces actions, par ordre d'apparition des icônes.
21
22### Lire l'article original
23
24Renvoie vers l'article original.
25
26### Marquer l'article comme lu
27
28Archive l'article, qui se retrouvera dans la catégorie **Archive** du menu de wallabag.
29Recliquer dessus permet de replacer cet article en état non lu.
30
31### Mettre l'article en favori
32
33Marque l'article comme favori, qui se retrouvera dans la catégorie **Favoris** du menu de wallabag.
34Recliquer dessus permet d'enlever le statut de favori.
35
36### Supprimer l'article
37
38Supprime complètement l'article de wallabag. Il ne pourra être restauré. Attention, aucune confirmation n'est demandée.
39
40### Partager vers twitter
41
42Partage le titre et le lien original de l'article sur twitter.
43
44### Partager par email
45
46Partage le titre et le lien original de l'article par email.
47
48### Imprimer l'article
49
50Ouvre la fenêtre d'impression du navigateur.
51
52### Convertir en ePub
53
54Convertit l'article au format ePub. [Un chapitre complet existe](Convertir_en_ePub.md).
55
56### Signaler que l'article s'affiche mal
57
58Permet de signaler qu'un article ne s'affiche pas comme attendu. [Un chapitre complet existe](Un_article_est_mal_affiche.md).
diff --git a/docs/fr/Utilisateur/Rechercher.md b/docs/fr/Utilisateur/Rechercher.md
new file mode 100644
index 00000000..2f84e075
--- /dev/null
+++ b/docs/fr/Utilisateur/Rechercher.md
@@ -0,0 +1,21 @@
1---
2language: Français
3currentMenu: search
4subTitle: Rechercher du contenu dans wallabag
5---
6
7# Rechercher du contenu dans wallabag
8
9Pour que vous puissiez retrouver un article au plus vite, nous avons mis en place un moteur de recherche complet.
10
11Cliquez sur **Rechercher** dans le menu de wallabag. Là, saisissez un terme de recherche.
12
13wallabag ira parcourir tous vos articles et affichera ceux qui contiennent le terme de recherche dans son titre, son contenu ou son URL.
14
15## Convertir cette recherche au format ePub
16
17Vous pouvez convertir les articles retournés au format ePub, pour les lire sur une liseuse par exemple. Lisez [Convertir en ePub](Convertir_en_ePub.md) pour en savoir plus.
18
19## Assigner un tag aux résultats de cette recherche
20
21Vous pouvez créer un tag en fonction du critère de recherche. Lisez [Classer ses articles](Classer_ses_articles.md) pour en savoir plus.
diff --git a/docs/fr/Utilisateur/Sauvegarder_son_premier_article.md b/docs/fr/Utilisateur/Sauvegarder_son_premier_article.md
new file mode 100644
index 00000000..e533f78f
--- /dev/null
+++ b/docs/fr/Utilisateur/Sauvegarder_son_premier_article.md
@@ -0,0 +1,101 @@
1---
2language: Français
3currentMenu: save_article
4subTitle: Sauvegarder son premier article
5---
6
7# Sauvegarder son premier article
8
9Une fois connecté sur wallabag, vous avez plusieurs moyens pour sauvegarder un article.
10
11## Depuis l'application web
12
13Voyons d'abord comment faire depuis l'application web. Dans le menu, vous avez un lien **Sauvegarder un lien**. En cliquant dessus, un formulaire s'affiche : vous n'avez qu'à saisir l'adresse internet de l'article concerné.
14
15Validez et le contenu de l'article est enregistré.
16
17Par défaut, seul le texte est sauvegardé. Si vous souhaitez également conserver une copie des images sur votre serveur, il faut activer le paramètre `DOWNLOAD_PICTURES`. Lisez le chapitre [Les options cachées](../Administrateur/Options_cachees.md) pour en savoir plus.
18
19## Depuis le bookmarklet
20
21[Définition Wikipedia](http://fr.wikipedia.org/wiki/Bookmarklet)
22
23 Un bookmarklet est un petit programme JavaScript pouvant être stocké :
24 * soit en tant qu'URL dans un signet (marque-page ou lien favori) avec la plupart des navigateurs Web ;
25 * soit en tant qu'hyperlien dans une page web.
26
27Depuis le menu de wallabag, cliquez sur **configuration**. Dans la première partie de cette page, nous avons listé les différents moyens de sauvegarder un article. Vous trouverez ainsi le bookmarklet (c'est le lien `bag it !`) à glisser / déposer dans la barre de favoris de votre navigateur.
28
29Dorénavant, lorsque vous souhaitez sauvegarder un article sur lequel vous êtes en train de surfer, vous n'avez qu'à cliquer sur ce bookmarklet et l'article sera automatiquement enregistré.
30
31## Depuis son smartphone
32### Avant toute chose
33
34Pour pouvoir utiliser une application smartphone, vous devez activer les flux RSS depuis la partie **configuration** de wallabag. Certaines informations seront ainsi affichées, comme votre **token** (jeton de sécurité). Lisez le chapitre [Flux RSS](Flux_RSS.md) pour en savoir plus.
35
36### Android
37#### Installation et configuration
38
39Vous pouvez télécharger l'application Android depuis le [Google Play Store](https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche) et depuis [F-droid](https://f-droid.org/app/fr.gaulupeau.apps.InThePoche). C'est exactement la même application sur ces deux plateformes de téléchargement.
40
41Une fois installée, démarrez l'application, rendez-vous dans la partie **settings** et renseignez les champs **URL** (Adresse complète de votre installation de wallabag ou de votre compte Framabag), **User ID** (très souvent, il vous faudra mettre 1 comme valeur). Si vous avez créé plusieurs comptes depuis wallabag, il faudra saisir l'identifiant du compte que vous souhaitez connecter à votre application) et **Token** (recopiez bien tous les caractères du token, disponible dans la **configuration** de wallabag).
42
43#### Sauvegarde d'un article
44
45Maintenant que tout est bien configuré, dès que vous naviguerez avec le navigateur de votre smartphone, vous pourrez à tout moment partager un article dans wallabag depuis le menu **Partager** : vous trouverez une entrée **Bag it!** qui ajoutera l'article dans wallabag.
46
47#### Lecture
48
49Lorsque vous ouvrez l'application, cliquez sur **Synchronize** : vos articles dernièrement sauvegardés seront ainsi téléchargés sur votre smartphone.
50
51Vous n'avez maintenant plus besoin de connexion internet : cliquez sur le bouton **List articles** pour commencer votre lecture.
52
53En bas de chaque article, un bouton **Mark as read** vous permet d'archiver l'article.
54
55Aujourd'hui, la synchronisation ne s'effectue que dans un sens (de wallabag vers l'application), ce qui empêche de marquer comme lu un article sur wallabag depuis votre smartphone.
56
57### iOS
58#### Installation et configuration
59TODO
60
61#### Utilisation
62TODO
63
64### Windows Phone
65#### Installation et configuration
66
67Vous pouvez télécharger l'application Windows Phone depuis le [Windows Store](http://www.windowsphone.com/fr-fr/store/app/wallabag/ff890514-348c-4d0b-9b43-153fff3f7450) ou directement dans le Store de votre smartphone.
68
69Une fois installée, l'application affichera une notification au premier lancement, demandant la configuration du serveur wallabag. Rendez-vous dans la partie **Configuration** de l'application en appuyant sur les 3 petits points du menu en bas de l'écran, puis renseignez les champs **URL** (Adresse complète de votre installation de wallabag ou de votre compte Framabag), **User ID** (très souvent, il vous faudra mettre 1 comme valeur).
70Si vous avez créé plusieurs comptes depuis wallabag, il faudra saisir l'identifiant du compte que vous souhaitez connecter à votre application) et **Token** (recopiez bien tous les caractères du token, disponible dans la **configuration** de wallabag).
71Enfin, sauvegardez les paramètres entrés.
72
73## Depuis son navigateur
74### Extension Firefox classique
75
76Téléchargez l'extension Firefox [sur le site addons.mozilla.org](https://addons.mozilla.org/firefox/addon/wallabag/) et installez-la comme toute autre extension Firefox.
77
78Dans les préférences de l'extension, renseignez l'URL complète de votre installation de wallabag ou de votre compte Framabag.
79
80Personnalisez la barre d'outils de Firefox pour ajouter wallabag (icône `w`). Lorsque vous vous trouvez sur un article que vous souhaitez sauvegarder, cliquez sur cette icône : une nouvelle fenêtre s'ouvrira pour ajouter l'article et elle se refermera automatiquement.
81
82### Extension Mozilla Services (Social API)
83
84*Disponible uniquement à compter de wallabag 1.9.1*
85
86Avec les versions 29 et supérieures de Firefox, votre navigateur possède une interface intégrée permettant le partage direct vers de multiples réseaux sociaux. Dans l'interface de Firefox, elle est symbolisée par un icône en forme d'avion en papier que vous pourrez utiliser pour partager une page, ce qui signifie ici enregistrer un article dans wallabag.
87Vous pouvez ajouter ce service depuis la page de configuration de wallabag en cliquant sur Extension Mozilla Services (Social API). Vous devez aussi accepter l'utilisation des Services Firefox.
88
89### Chrome
90
91Téléchargez l'extension Chrome [sur le site dédié](https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj) et installez-la comme toute autre extension Chrome.
92
93Dans les options de l'extension, renseignez l'URL complète de votre installation de wallabag ou de votre compte Framabag.
94
95Lors de l'installation de l'extension, une nouvelle icône est apparue dans la barre d'outils de Chrome, une icône `w`. Lorsque vous vous trouvez sur un article que vous souhaitez sauvegarder, cliquez sur cette icône : une popup s'ouvrira et vous confirmera que l'article a bien été sauvegardé.
96
97### Opera
98
99Les dernières versions d'Opera (15+) permettent d'installer des extensions compatibles avec Chrome.
100
101Il faut tout d'abord installer l'extension [Download Chrome Extensions](https://addons.opera.com/en/extensions/details/download-chrome-extension-9/) pour installer des extensions à partir du Chrome Web Store. Ensuite, on peut se rendre [sur le site de Google](https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj) et récupérer l'extension Chrome en cliquant sur *Add to Opera*. Vous obtiendrez un message qui vous invitera à confirmer l'action car l'extension ne provient pas d'une source approuvée. Le comportement sera ensuite le même que pour Chrome (ci-dessus).
diff --git a/docs/fr/Utilisateur/Un_article_est_mal_affiche.md b/docs/fr/Utilisateur/Un_article_est_mal_affiche.md
new file mode 100644
index 00000000..70b70cd4
--- /dev/null
+++ b/docs/fr/Utilisateur/Un_article_est_mal_affiche.md
@@ -0,0 +1,32 @@
1---
2language: Français
3currentMenu: issue
4subTitle: Mon article s'affiche mal dans wallabag
5---
6
7# Mon article s'affiche mal dans wallabag
8
9Si vous pensez que wallabag récupère mal le contenu d'un article (texte absent ou incomplet), nous vous proposons plusieurs possibilités.
10
11## Demande d'aide
12
13Que ça soit par mail ou via un ticket, n'oubliez pas de nous donner certaines informations qui sont importantes pour que nous puissions résoudre le problème au mieux :
14
15* l'URL de l'article concerné
16* ce que wallabag affiche
17* ce à quoi vous vous attendiez
18* la version de wallabag ou alors si vous utilisez Framabag
19
20### Ouvrir un ticket sur github
21
22Pour ouvrir un nouveau ticket, il faut [aller sur github](https://github.com/wallabag/wallabag/issues/new). Un compte est nécessaire.
23N'oubliez pas de nous envoyer les informations ci-dessus.
24
25### Nous envoyer un email
26
27Envoyez-nous un lien à l'adresse [hello@wallabag.org](mailto:hello@wallabag.org?subject=Mauvais%20affichage%20dans%20wallabag).
28N'oubliez pas de nous envoyer les informations ci-dessus.
29
30## Résoudre ce problème d'affichage
31
32TODO \ No newline at end of file
diff --git a/docs/fr/conf.py b/docs/fr/conf.py
new file mode 100644
index 00000000..5c3657c0
--- /dev/null
+++ b/docs/fr/conf.py
@@ -0,0 +1,87 @@
1# -*- coding: utf-8 -*-
2#
3# wallabag documentation build configuration file, created by
4# sphinx-quickstart on Fri Oct 16 06:47:23 2015.
5
6import sys
7import os
8
9extensions = []
10templates_path = ['_templates']
11source_suffix = '.rst'
12master_doc = 'index'
13project = u'wallabag-fr'
14copyright = u'2013-2015, Nicolas Lœuillet - MIT Licence'
15version = '2.0.0'
16release = version
17exclude_patterns = ['_build']
18pygments_style = 'sphinx'
19html_theme = 'default'
20html_static_path = ['_static']
21htmlhelp_basename = 'wallabagfrdoc'
22
23latex_elements = {
24}
25
26latex_documents = [
27 ('index', 'wallabag-fr.tex', u'wallabag Documentation',
28 u'Nicolas Lœuillet', 'manual'),
29]
30
31man_pages = [
32 ('index', 'wallabagfr', u'wallabag Documentation',
33 [u'Nicolas Lœuillet'], 1)
34]
35
36texinfo_documents = [
37 ('index', 'wallabagfr', u'wallabag Documentation',
38 u'Nicolas Lœuillet', 'wallabagfr', 'One line description of project.',
39 'Miscellaneous'),
40]
41
42##### Guzzle sphinx theme
43
44import guzzle_sphinx_theme
45html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
46html_theme_path = guzzle_sphinx_theme.html_theme_path()
47html_theme = 'guzzle_sphinx_theme'
48
49# Custom sidebar templates, maps document names to template names.
50html_sidebars = {
51 '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']
52}
53
54# Register the theme as an extension to generate a sitemap.xml
55extensions.append("guzzle_sphinx_theme")
56
57# Guzzle theme options (see theme.conf for more information)
58html_theme_options = {
59
60 # Set the path to a special layout to include for the homepage
61 # "index_template": "homepage.html",
62
63 # Allow a separate homepage from the master_doc
64 # homepage = index
65
66 # Set the name of the project to appear in the nav menu
67 # "project_nav_name": "Guzzle",
68
69 # Set your Disqus short name to enable comments
70 # "disqus_comments_shortname": "my_disqus_comments_short_name",
71
72 # Set you GA account ID to enable tracking
73 # "google_analytics_account": "my_ga_account",
74
75 # Path to a touch icon
76 # "touch_icon": "",
77
78 # Specify a base_url used to generate sitemap.xml links. If not
79 # specified, then no sitemap will be built.
80 #"base_url": "http://guzzlephp.org"
81
82 # Allow the "Table of Contents" page to be defined separately from "master_doc"
83 # tocpage = Contents
84
85 # Allow the project link to be overriden to a custom URL.
86 # projectlink = http://myproject.url
87}
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
new file mode 100644
index 00000000..c48bd7f2
--- /dev/null
+++ b/docs/fr/index.rst
@@ -0,0 +1,29 @@
1Documentation de wallabag
2=========================
3
4**wallabag** est une application de lecture différée : elle permet
5simplement d’archiver une page web en ne conservant que le contenu. Les
6éléments superflus (menu, publicité, etc.) sont supprimés.
7
8Principales fonctionnalités
9---------------------------
10
11- tout le contenu est archivé : le texte et les photos
12- l’application web est entièrement responsive
13- vous pouvez convertir vos articles au format ePub pour les charger
14 sur votre liseuse
15- des applications smartphones vous permettent de lire vos articles
16 tout en étant déconnecté
17- des extensions pour votre navigateur vous permettent d'archiver
18 rapidement un nouvel article
19- plusieurs thèmes graphiques vous permettent d'habiller votre
20 wallabag comme vous le souhaitez
21- et forcément plein d’autres fonctionnalités !
22
23Cette documentation est justement là pour faire découvrir toutes les
24possibilités de wallabag. C’est parti !
25
26.. toctree::
27 :maxdepth: 2
28
29 index
diff --git a/docs/fr/requirements.txt b/docs/fr/requirements.txt
new file mode 100644
index 00000000..06fc8973
--- /dev/null
+++ b/docs/fr/requirements.txt
@@ -0,0 +1,2 @@
1Sphinx>=1.3.0,<1.4.0
2guzzle_sphinx_theme>=0.7.0,<0.8.0
diff --git a/docs/img/user/2FA_form.png b/docs/img/user/2FA_form.png
new file mode 100644
index 00000000..69b4697d
--- /dev/null
+++ b/docs/img/user/2FA_form.png
Binary files differ
diff --git a/docs/img/user/activated_account.png b/docs/img/user/activated_account.png
new file mode 100644
index 00000000..d1ecc3cc
--- /dev/null
+++ b/docs/img/user/activated_account.png
Binary files differ
diff --git a/docs/img/user/login_form.png b/docs/img/user/login_form.png
new file mode 100644
index 00000000..fddfb35d
--- /dev/null
+++ b/docs/img/user/login_form.png
Binary files differ
diff --git a/docs/img/user/registration_form.png b/docs/img/user/registration_form.png
new file mode 100644
index 00000000..127bf2a7
--- /dev/null
+++ b/docs/img/user/registration_form.png
Binary files differ
diff --git a/docs/img/user/sent_email.png b/docs/img/user/sent_email.png
new file mode 100644
index 00000000..0713a404
--- /dev/null
+++ b/docs/img/user/sent_email.png
Binary files differ
diff --git a/docs/img/user/topbar.png b/docs/img/user/topbar.png
new file mode 100644
index 00000000..e20d9fc6
--- /dev/null
+++ b/docs/img/user/topbar.png
Binary files differ
diff --git a/docs/img/wallabag.png b/docs/img/wallabag.png
new file mode 100644
index 00000000..2dada55d
--- /dev/null
+++ b/docs/img/wallabag.png
Binary files differ