aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorSven Fischer <git-dev@linux4tw.de>2016-05-04 23:25:49 +0200
committerSven Fischer <git-dev@linux4tw.de>2016-05-04 23:25:49 +0200
commit3bd50951be29ce94e7d32e4f88d7e02fc4f4f832 (patch)
treeda6f9c38445069262977e03eee0a1fd54c7317f1 /docs
parent8ae9a3f52f6359b2f9170a46298719020f38b928 (diff)
downloadwallabag-3bd50951be29ce94e7d32e4f88d7e02fc4f4f832.tar.gz
wallabag-3bd50951be29ce94e7d32e4f88d7e02fc4f4f832.tar.zst
wallabag-3bd50951be29ce94e7d32e4f88d7e02fc4f4f832.zip
add first draft of Android app documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/en/index.rst1
-rw-r--r--docs/en/user/android.rst107
-rw-r--r--docs/img/user/android_configuration_connection_test.de.pngbin0 -> 82341 bytes
-rw-r--r--docs/img/user/android_configuration_connection_test_success.de.pngbin0 -> 83238 bytes
-rw-r--r--docs/img/user/android_configuration_feed_credentials_automatically_filled_in.de.pngbin0 -> 111017 bytes
-rw-r--r--docs/img/user/android_configuration_filled_in.de.pngbin0 -> 97206 bytes
-rw-r--r--docs/img/user/android_configuration_get_feed_credentials.de.pngbin0 -> 83141 bytes
-rw-r--r--docs/img/user/android_configuration_saved_feed_update.de.pngbin0 -> 52034 bytes
-rw-r--r--docs/img/user/android_configuration_screen.de.pngbin0 -> 91377 bytes
-rw-r--r--docs/img/user/android_configuration_scroll_bottom.de.pngbin0 -> 103860 bytes
-rw-r--r--docs/img/user/android_unread_feed_synced.de.pngbin0 -> 108605 bytes
-rw-r--r--docs/img/user/android_welcome_screen.de.pngbin0 -> 47710 bytes
12 files changed, 108 insertions, 0 deletions
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 590c234a..f4b8628a 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -37,6 +37,7 @@ The main documentation for this application is organized into a couple sections:
37 user/download_articles 37 user/download_articles
38 user/filters 38 user/filters
39 user/tags 39 user/tags
40 user/android
40 41
41.. _dev-docs: 42.. _dev-docs:
42 43
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
new file mode 100644
index 00000000..89ed362b
--- /dev/null
+++ b/docs/en/user/android.rst
@@ -0,0 +1,107 @@
1Android App
2===========
3
4
5Purpose of this document
6------------------------
7
8This document describes how you can setup your Android application to work with your Wallabag instance. There is no difference in this procedure for Wallabag v1 or v2.
9
10
11Steps to configure your app
12---------------------------
13
14When you first start the app, you see the welcome screen, where you are adviced to configure the app for your Wallabag instance at first.
15
16.. image:: ../../img/user/android_welcome_screen.de.png
17 :alt: Welcome screen
18 :align: center
19
20Just confirm that message and you get redirected to the settings screen.
21
22.. image:: ../../img/user/android_configuration_screen.de.png
23 :alt: Settings screen
24 :align: center
25
26Fill in your Wallabag data. You need to enter your Wallabag address. It is important that this URL does not end with a slash. Also add your Wallabag credentials to the user name and password field.
27
28.. image:: ../../img/user/android_configuration_filled_in.de.png
29 :alt: Filled in settings
30 :align: center
31
32After you have filled in your data, push the button Connection test and wait for the test to finish.
33
34.. image:: ../../img/user/android_configuration_connection_test.de.png
35 :alt: Connection test with your Wallabag data
36 :align: center
37
38The connection test shall finish with success. If not, you need to fix this first until you proceed.
39
40.. image:: ../../img/user/android_configuration_connection_test_success.de.png
41 :alt: Connection test successful
42 :align: center
43
44After the connection test was successful, you can push the button to get your feed credentials. The app now tries to login to your Wallabag instance and get the user id and the corresponding token for the feeds.
45
46.. image:: ../../img/user/android_configuration_get_feed_credentials.de.png
47 :alt: Getting the feed credentials
48 :align: center
49
50When the process of getting your feed credentials finishes with success you see a toast message that the user id and the token were automatically filled in to the form.
51
52.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.de.png
53 :alt: Getting feed credentials successful
54 :align: center
55
56Now you need to scroll to the bottom of the settings menu. Of course you can adjust the given settings to your needs. Finish the configuration of your app with pushing the save button.
57
58.. image:: ../../img/user/android_configuration_scroll_bottom.de.png
59 :alt: Bottom of the settings screen
60 :align: center
61
62After hitting the save button, you get the following screen. The app proposes to initiate a syncronisation process to update your feeds of articles. It is recommended to acknowledge this action and press Yes.
63
64.. image:: ../../img/user/android_configuration_saved_feed_update.de.png
65 :alt: Settings saved the first time
66 :align: center
67
68Finally after the syncronisation finished successfully, you are presented the list of unread articles.
69
70.. image:: ../../img/user/android_unread_feed_synced.de.png
71 :alt: Filled article list cause feeds successfully syncronized
72 :align: center
73
74
75
76Known limitations
77----
78
792FA
80~~~
81
82Currently the does not support two-factor authentication. You should disable that to get the app working.
83
84
85Limited amount of articles with Wallabag v2
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87
88In your Wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in Wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed.
89
90
91SSL/TLS encryption
92~~~~~~~~~~~~~~~~~~
93
94If you can reach your Wallabag web instance via HTTPS, you should use that. Especially if your HTTP URL redirects you to the HTTPS one. Currently, the app cannot handle that redirect properly.
95
96
97References
98----------
99
100`Source code of the Android application <https://github.com/wallabag/android-app>`_
101
102`Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
103
104`Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
105
106`Support chat <https://gitter.im/wallabag/wallabag>`_
107
diff --git a/docs/img/user/android_configuration_connection_test.de.png b/docs/img/user/android_configuration_connection_test.de.png
new file mode 100644
index 00000000..63394f87
--- /dev/null
+++ b/docs/img/user/android_configuration_connection_test.de.png
Binary files differ
diff --git a/docs/img/user/android_configuration_connection_test_success.de.png b/docs/img/user/android_configuration_connection_test_success.de.png
new file mode 100644
index 00000000..f5c1971e
--- /dev/null
+++ b/docs/img/user/android_configuration_connection_test_success.de.png
Binary files differ
diff --git a/docs/img/user/android_configuration_feed_credentials_automatically_filled_in.de.png b/docs/img/user/android_configuration_feed_credentials_automatically_filled_in.de.png
new file mode 100644
index 00000000..a191a6ee
--- /dev/null
+++ b/docs/img/user/android_configuration_feed_credentials_automatically_filled_in.de.png
Binary files differ
diff --git a/docs/img/user/android_configuration_filled_in.de.png b/docs/img/user/android_configuration_filled_in.de.png
new file mode 100644
index 00000000..4cd8d709
--- /dev/null
+++ b/docs/img/user/android_configuration_filled_in.de.png
Binary files differ
diff --git a/docs/img/user/android_configuration_get_feed_credentials.de.png b/docs/img/user/android_configuration_get_feed_credentials.de.png
new file mode 100644
index 00000000..1c401cba
--- /dev/null
+++ b/docs/img/user/android_configuration_get_feed_credentials.de.png
Binary files differ
diff --git a/docs/img/user/android_configuration_saved_feed_update.de.png b/docs/img/user/android_configuration_saved_feed_update.de.png
new file mode 100644
index 00000000..2af41025
--- /dev/null
+++ b/docs/img/user/android_configuration_saved_feed_update.de.png
Binary files differ
diff --git a/docs/img/user/android_configuration_screen.de.png b/docs/img/user/android_configuration_screen.de.png
new file mode 100644
index 00000000..7bf72182
--- /dev/null
+++ b/docs/img/user/android_configuration_screen.de.png
Binary files differ
diff --git a/docs/img/user/android_configuration_scroll_bottom.de.png b/docs/img/user/android_configuration_scroll_bottom.de.png
new file mode 100644
index 00000000..82108324
--- /dev/null
+++ b/docs/img/user/android_configuration_scroll_bottom.de.png
Binary files differ
diff --git a/docs/img/user/android_unread_feed_synced.de.png b/docs/img/user/android_unread_feed_synced.de.png
new file mode 100644
index 00000000..a3b6ed00
--- /dev/null
+++ b/docs/img/user/android_unread_feed_synced.de.png
Binary files differ
diff --git a/docs/img/user/android_welcome_screen.de.png b/docs/img/user/android_welcome_screen.de.png
new file mode 100644
index 00000000..4d3543d8
--- /dev/null
+++ b/docs/img/user/android_welcome_screen.de.png
Binary files differ