aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/developer/api.rst7
-rw-r--r--docs/en/index.rst1
-rw-r--r--docs/en/user/configuring_mobile.rst13
-rw-r--r--docs/en/user/first_article.rst66
-rw-r--r--docs/en/user/installation.rst17
-rw-r--r--docs/en/user/share.rst17
6 files changed, 35 insertions, 86 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
index b6c9ed3f..80c96025 100644
--- a/docs/en/developer/api.rst
+++ b/docs/en/developer/api.rst
@@ -8,7 +8,7 @@ Requirements
8 8
9* wallabag freshly (or not) installed on http://localhost:8000 9* wallabag freshly (or not) installed on http://localhost:8000
10* ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. 10* ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget.
11* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_ 11* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_
12 12
13Creating a new API client 13Creating a new API client
14------------------------- 14-------------------------
@@ -263,8 +263,9 @@ Third party resources
263 263
264Some applications or libraries use our API. Here is a non-exhaustive list of them: 264Some applications or libraries use our API. Here is a non-exhaustive list of them:
265 265
266- `Java wrapper for the wallabag API <https://github.com/Strubbl/jWallabag>`_ by Strubbl. 266- `Java wrapper for the wallabag API <https://github.com/di72nn/wallabag-api-wrapper>`_ by Dmitriy Bogdanov.
267- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster. 267- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster.
268- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_. 268- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_.
269- `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ designed for `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ that makes use of the wallabag v2 API. By Josh Panter. 269- `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ designed for `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ that makes use of the wallabag v2 API. By Josh Panter.
270- `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ by Strubbl, for his project `wallabag-stats graph <https://github.com/Strubbl/wallabag-stats>`_. 270- `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ by Strubbl, for his projects `wallabag-stats graph <https://github.com/Strubbl/wallabag-stats>`_ and the command line tool `wallabag-add-article <https://github.com/Strubbl/wallabag-add-article>`_.
271- Tool to automatically download Wallabag articles into your local computer or Kobo ebook reader `wallabako <https://gitlab.com/anarcat/wallabako>`_ by anarcat.
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 2e20aee6..89f61d6d 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -33,6 +33,7 @@ The documentation is available in other languages:
33 user/errors_during_fetching 33 user/errors_during_fetching
34 user/filters 34 user/filters
35 user/tags 35 user/tags
36 user/configuring_mobile
36 user/android 37 user/android
37 user/parameters 38 user/parameters
38 user/backup 39 user/backup
diff --git a/docs/en/user/configuring_mobile.rst b/docs/en/user/configuring_mobile.rst
new file mode 100644
index 00000000..7229aed6
--- /dev/null
+++ b/docs/en/user/configuring_mobile.rst
@@ -0,0 +1,13 @@
1Configuring mobile apps to work with wallabag
2=============================================
3
4Steps to configure the app
5--------------------------
6
7- First *create a new client* in the ``API clients management`` section. The name of your app doesn't matter as much as the ``Client ID`` and the ``Client secret``. Write these two values down.
8- When you download a mobile app, it's going to ask for the server address of the hosted wallabag instance. For example, with wallabag.it that is: ``https://app.wallabag.it``.
9- It's also going to ask for the aforementioned ``Client ID`` and ``secret``. Please insert those in the text fields, when asked.
10- Lastly you need to provide your ``username`` and ``password``. These are the same credentials you use to login in to wallabag.
11
12Please also have a look at `Android <android.html>`_ page. Especially the section on *known limitations*.
13
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst
deleted file mode 100644
index 1400e1e8..00000000
--- a/docs/en/user/first_article.rst
+++ /dev/null
@@ -1,66 +0,0 @@
1Save your first article
2=======================
3
4The main purpose of wallabag is to save web articles. You have many ways to do it.
5
6.. note::
7
8 A quickstart will be displayed in the application until you save your first article.
9
10By using a bookmarklet
11----------------------
12
13On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!``
14link to your bookmarks bar of your browser.
15
16Now, each time you're reading an article on the web and you want to save it,
17click on the ``bag it!`` link in your bookmarks bar. The article is saved.
18
19By using the classic form
20-------------------------
21
22In the top bar of your screen, you have 3 icons. With the first one, a plus sign,
23you can easily save a new article.
24
25.. image:: ../../img/user/topbar.png
26 :alt: Top bar
27 :align: center
28
29Click on it to display a new field, paste the article URL inside and press your
30``Return`` key. The article is saved.
31
32By using a browser add-on
33-------------------------
34
35Firefox
36~~~~~~~
37
38*This addon is not yet available for wallabag v2*.
39
40Chrome
41~~~~~~
42
43*This addon is not yet available for wallabag v2*.
44
45By using your smarphone application
46-----------------------------------
47
48Android
49~~~~~~~
50
51*This application is not yet available for wallabag v2*.
52
53Firefox OS
54~~~~~~~~~~
55
56*This application is not yet available for wallabag v2*.
57
58Windows Phone
59~~~~~~~~~~~~~
60
61*This application is not yet available for wallabag v2*.
62
63iOS
64~~~
65
66*This application is not yet available for wallabag v2*.
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 7d3bcf61..7fb81aeb 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -149,6 +149,23 @@ Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you w
149 ErrorLog /var/log/apache2/wallabag_error.log 149 ErrorLog /var/log/apache2/wallabag_error.log
150 CustomLog /var/log/apache2/wallabag_access.log combined 150 CustomLog /var/log/apache2/wallabag_access.log combined
151 </VirtualHost> 151 </VirtualHost>
152
153
154.. tip:: Note for Apache 2.4, in the section `<Directory /var/www/wallabag/web>` you have to replace the directives :
155
156::
157
158 AllowOverride None
159 Order Allow,Deny
160 Allow from All
161
162
163by
164
165::
166
167 Require All granted
168
152 169
153After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. 170After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
154 171
diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst
deleted file mode 100644
index e99e51ab..00000000
--- a/docs/en/user/share.rst
+++ /dev/null
@@ -1,17 +0,0 @@
1Share articles
2==============
3
4When you're reading an article, you can share it. Just click on the share button:
5
6.. image:: ../../img/user/share.png
7 :alt: share article
8 :align: center
9
10Now, you can share the article:
11
12- with a public URL (you'll have a light view of the article)
13- with a tweet
14- into your Shaarli
15- with a post in Diaspora*
16- to Carrot
17- with an email