diff options
author | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-11-22 15:58:00 +0100 |
---|---|---|
committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-11-22 17:32:24 +0100 |
commit | d51093a7d964ca720793d0cfcf4af601f2de448a (patch) | |
tree | 7bc700ebc3ba7f7eb160c6c6fc23f8af6acb04b1 /docs | |
parent | d64bf7953b0e4e793d7f75ec50bf6e42652560b2 (diff) | |
download | wallabag-d51093a7d964ca720793d0cfcf4af601f2de448a.tar.gz wallabag-d51093a7d964ca720793d0cfcf4af601f2de448a.tar.zst wallabag-d51093a7d964ca720793d0cfcf4af601f2de448a.zip |
Added documentation and missing translations
Diffstat (limited to 'docs')
-rw-r--r-- | docs/de/developer/paywall.rst | 56 | ||||
-rw-r--r-- | docs/de/index.rst | 1 | ||||
-rw-r--r-- | docs/en/developer/paywall.rst | 56 | ||||
-rw-r--r-- | docs/en/index.rst | 1 | ||||
-rw-r--r-- | docs/fr/developer/paywall.rst | 56 | ||||
-rw-r--r-- | docs/fr/index.rst | 1 |
6 files changed, 171 insertions, 0 deletions
diff --git a/docs/de/developer/paywall.rst b/docs/de/developer/paywall.rst new file mode 100644 index 00000000..365027b4 --- /dev/null +++ b/docs/de/developer/paywall.rst | |||
@@ -0,0 +1,56 @@ | |||
1 | Articles behind a paywall | ||
2 | ========================= | ||
3 | |||
4 | wallabag can fetch articles from websites which use a paywall system. | ||
5 | |||
6 | Enable paywall authentication | ||
7 | ----------------------------- | ||
8 | |||
9 | In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1). | ||
10 | |||
11 | Configure credentials in wallabag | ||
12 | --------------------------------- | ||
13 | |||
14 | Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites: | ||
15 | |||
16 | .. code:: yaml | ||
17 | |||
18 | sites_credentials: | ||
19 | mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} | ||
20 | arretsurimages.net: {username: "myASILogin", password: "mypassword"} | ||
21 | |||
22 | .. note:: | ||
23 | |||
24 | These credentials will be shared between each user of your wallabag instance. | ||
25 | |||
26 | Parsing configuration files | ||
27 | --------------------------- | ||
28 | |||
29 | .. note:: | ||
30 | |||
31 | Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files. | ||
32 | |||
33 | Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, | ||
34 | ``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. | ||
35 | |||
36 | Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated | ||
37 | on a website where the login form is loaded after the page (by ajax for example). | ||
38 | |||
39 | ``login_uri`` is the action URL of the form (``action`` attribute in the form). | ||
40 | ``login_username_field`` is the ``name`` attribute of the login field. | ||
41 | ``login_password_field`` is the ``name`` attribute of the password field. | ||
42 | |||
43 | For example: | ||
44 | |||
45 | .. code:: | ||
46 | |||
47 | title://div[@id="titrage-contenu"]/h1[@class="title"] | ||
48 | body: //div[@class="contenu-html"]/div[@class="page-pane"] | ||
49 | |||
50 | requires_login: yes | ||
51 | |||
52 | login_uri: http://www.arretsurimages.net/forum/login.php | ||
53 | login_username_field: username | ||
54 | login_password_field: password | ||
55 | |||
56 | not_logged_in_xpath: //body[@class="not-logged-in"] | ||
diff --git a/docs/de/index.rst b/docs/de/index.rst index c1ce7d4b..1c3e4873 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst | |||
@@ -46,6 +46,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar : | |||
46 | 46 | ||
47 | developer/api | 47 | developer/api |
48 | developer/docker | 48 | developer/docker |
49 | developer/paywall | ||
49 | developer/documentation | 50 | developer/documentation |
50 | developer/translate | 51 | developer/translate |
51 | developer/asynchronous | 52 | developer/asynchronous |
diff --git a/docs/en/developer/paywall.rst b/docs/en/developer/paywall.rst new file mode 100644 index 00000000..365027b4 --- /dev/null +++ b/docs/en/developer/paywall.rst | |||
@@ -0,0 +1,56 @@ | |||
1 | Articles behind a paywall | ||
2 | ========================= | ||
3 | |||
4 | wallabag can fetch articles from websites which use a paywall system. | ||
5 | |||
6 | Enable paywall authentication | ||
7 | ----------------------------- | ||
8 | |||
9 | In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1). | ||
10 | |||
11 | Configure credentials in wallabag | ||
12 | --------------------------------- | ||
13 | |||
14 | Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites: | ||
15 | |||
16 | .. code:: yaml | ||
17 | |||
18 | sites_credentials: | ||
19 | mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} | ||
20 | arretsurimages.net: {username: "myASILogin", password: "mypassword"} | ||
21 | |||
22 | .. note:: | ||
23 | |||
24 | These credentials will be shared between each user of your wallabag instance. | ||
25 | |||
26 | Parsing configuration files | ||
27 | --------------------------- | ||
28 | |||
29 | .. note:: | ||
30 | |||
31 | Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files. | ||
32 | |||
33 | Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, | ||
34 | ``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. | ||
35 | |||
36 | Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated | ||
37 | on a website where the login form is loaded after the page (by ajax for example). | ||
38 | |||
39 | ``login_uri`` is the action URL of the form (``action`` attribute in the form). | ||
40 | ``login_username_field`` is the ``name`` attribute of the login field. | ||
41 | ``login_password_field`` is the ``name`` attribute of the password field. | ||
42 | |||
43 | For example: | ||
44 | |||
45 | .. code:: | ||
46 | |||
47 | title://div[@id="titrage-contenu"]/h1[@class="title"] | ||
48 | body: //div[@class="contenu-html"]/div[@class="page-pane"] | ||
49 | |||
50 | requires_login: yes | ||
51 | |||
52 | login_uri: http://www.arretsurimages.net/forum/login.php | ||
53 | login_username_field: username | ||
54 | login_password_field: password | ||
55 | |||
56 | not_logged_in_xpath: //body[@class="not-logged-in"] | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index 54a1eef8..2e20aee6 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -46,6 +46,7 @@ The documentation is available in other languages: | |||
46 | 46 | ||
47 | developer/api | 47 | developer/api |
48 | developer/docker | 48 | developer/docker |
49 | developer/paywall | ||
49 | developer/documentation | 50 | developer/documentation |
50 | developer/translate | 51 | developer/translate |
51 | developer/asynchronous | 52 | developer/asynchronous |
diff --git a/docs/fr/developer/paywall.rst b/docs/fr/developer/paywall.rst new file mode 100644 index 00000000..c1c410b1 --- /dev/null +++ b/docs/fr/developer/paywall.rst | |||
@@ -0,0 +1,56 @@ | |||
1 | Articles derrière un paywall | ||
2 | ============================ | ||
3 | |||
4 | wallabag peut récupérer le contenu des articles des sites qui utilisent un système de paiement. | ||
5 | |||
6 | Activer l'authentification pour les paywall | ||
7 | ------------------------------------------- | ||
8 | |||
9 | Dans les paramètres internes, section **Article**, activez l'authentification pour les articles derrière un paywall (avec la valeur 1). | ||
10 | |||
11 | Configurer les accès dans wallabag | ||
12 | ---------------------------------- | ||
13 | |||
14 | Éditez le fichier ``app/config/parameters.yml`` pour modifier les accès aux sites avec paywall. Voici un exemple pour certains sites : | ||
15 | |||
16 | .. code:: yaml | ||
17 | |||
18 | sites_credentials: | ||
19 | mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} | ||
20 | arretsurimages.net: {username: "myASILogin", password: "mypassword"} | ||
21 | |||
22 | .. note:: | ||
23 | |||
24 | Ces accès seront partagés entre chaque utilisateur de votre instance wallabag. | ||
25 | |||
26 | Fichiers de configuration pour parser les articles | ||
27 | -------------------------------------------------- | ||
28 | |||
29 | .. note:: | ||
30 | |||
31 | Lisez `cette documentation <http://doc.wallabag.org/fr/master/user/errors_during_fetching.html>`_ pour en savoir plus sur ces fichiers de configuration. | ||
32 | |||
33 | Chaque fichier de configuration doit être enrichi en ajoutant ``requires_login``, ``login_uri``, | ||
34 | ``login_username_field``, ``login_password_field`` et ``not_logged_in_xpath``. | ||
35 | |||
36 | Attention, le formulaire de connexion doit se trouver dans le contenu de la page lors du chargement de celle-ci. | ||
37 | Il sera impossible pour wallabag de se connecter à un site dont le formulaire de connexion est chargé après coup (en ajax par exemple). | ||
38 | |||
39 | ``login_uri`` correspond à l'URL à laquelle le formulaire est soumis (attribut ``action`` du formulaire). | ||
40 | ``login_username_field`` correspond à l'attribut ``name`` du champ de l'identifiant. | ||
41 | ``login_password_field`` correspond à l'attribut ``name`` du champ du mot de passe. | ||
42 | |||
43 | Par exemple : | ||
44 | |||
45 | .. code:: | ||
46 | |||
47 | title://div[@id="titrage-contenu"]/h1[@class="title"] | ||
48 | body: //div[@class="contenu-html"]/div[@class="page-pane"] | ||
49 | |||
50 | requires_login: yes | ||
51 | |||
52 | login_uri: http://www.arretsurimages.net/forum/login.php | ||
53 | login_username_field: username | ||
54 | login_password_field: password | ||
55 | |||
56 | not_logged_in_xpath: //body[@class="not-logged-in"] | ||
diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 8a4c600a..e3f14b04 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst | |||
@@ -47,6 +47,7 @@ La documentation est disponible dans d'autres langues : | |||
47 | 47 | ||
48 | developer/api | 48 | developer/api |
49 | developer/docker | 49 | developer/docker |
50 | developer/paywall | ||
50 | developer/documentation | 51 | developer/documentation |
51 | developer/translate | 52 | developer/translate |
52 | developer/asynchronous | 53 | developer/asynchronous |