From d51093a7d964ca720793d0cfcf4af601f2de448a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 22 Nov 2016 15:58:00 +0100 Subject: Added documentation and missing translations --- docs/de/developer/paywall.rst | 56 +++++++++++++++++++++++++++++++++++++++++++ docs/de/index.rst | 1 + docs/en/developer/paywall.rst | 56 +++++++++++++++++++++++++++++++++++++++++++ docs/en/index.rst | 1 + docs/fr/developer/paywall.rst | 56 +++++++++++++++++++++++++++++++++++++++++++ docs/fr/index.rst | 1 + 6 files changed, 171 insertions(+) create mode 100644 docs/de/developer/paywall.rst create mode 100644 docs/en/developer/paywall.rst create mode 100644 docs/fr/developer/paywall.rst (limited to 'docs') 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 @@ +Articles behind a paywall +========================= + +wallabag can fetch articles from websites which use a paywall system. + +Enable paywall authentication +----------------------------- + +In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1). + +Configure credentials in wallabag +--------------------------------- + +Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites: + +.. code:: yaml + + sites_credentials: + mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} + arretsurimages.net: {username: "myASILogin", password: "mypassword"} + +.. note:: + + These credentials will be shared between each user of your wallabag instance. + +Parsing configuration files +--------------------------- + +.. note:: + + Read `this part of the documentation `_ to understand the configuration files. + +Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, +``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. + +Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated +on a website where the login form is loaded after the page (by ajax for example). + +``login_uri`` is the action URL of the form (``action`` attribute in the form). +``login_username_field`` is the ``name`` attribute of the login field. +``login_password_field`` is the ``name`` attribute of the password field. + +For example: + +.. code:: + + title://div[@id="titrage-contenu"]/h1[@class="title"] + body: //div[@class="contenu-html"]/div[@class="page-pane"] + + requires_login: yes + + login_uri: http://www.arretsurimages.net/forum/login.php + login_username_field: username + login_password_field: password + + 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 : developer/api developer/docker + developer/paywall developer/documentation developer/translate 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 @@ +Articles behind a paywall +========================= + +wallabag can fetch articles from websites which use a paywall system. + +Enable paywall authentication +----------------------------- + +In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1). + +Configure credentials in wallabag +--------------------------------- + +Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites: + +.. code:: yaml + + sites_credentials: + mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} + arretsurimages.net: {username: "myASILogin", password: "mypassword"} + +.. note:: + + These credentials will be shared between each user of your wallabag instance. + +Parsing configuration files +--------------------------- + +.. note:: + + Read `this part of the documentation `_ to understand the configuration files. + +Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, +``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. + +Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated +on a website where the login form is loaded after the page (by ajax for example). + +``login_uri`` is the action URL of the form (``action`` attribute in the form). +``login_username_field`` is the ``name`` attribute of the login field. +``login_password_field`` is the ``name`` attribute of the password field. + +For example: + +.. code:: + + title://div[@id="titrage-contenu"]/h1[@class="title"] + body: //div[@class="contenu-html"]/div[@class="page-pane"] + + requires_login: yes + + login_uri: http://www.arretsurimages.net/forum/login.php + login_username_field: username + login_password_field: password + + 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: developer/api developer/docker + developer/paywall developer/documentation developer/translate 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 @@ +Articles derrière un paywall +============================ + +wallabag peut récupérer le contenu des articles des sites qui utilisent un système de paiement. + +Activer l'authentification pour les paywall +------------------------------------------- + +Dans les paramètres internes, section **Article**, activez l'authentification pour les articles derrière un paywall (avec la valeur 1). + +Configurer les accès dans wallabag +---------------------------------- + +Éditez le fichier ``app/config/parameters.yml`` pour modifier les accès aux sites avec paywall. Voici un exemple pour certains sites : + +.. code:: yaml + + sites_credentials: + mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} + arretsurimages.net: {username: "myASILogin", password: "mypassword"} + +.. note:: + + Ces accès seront partagés entre chaque utilisateur de votre instance wallabag. + +Fichiers de configuration pour parser les articles +-------------------------------------------------- + +.. note:: + + Lisez `cette documentation `_ pour en savoir plus sur ces fichiers de configuration. + +Chaque fichier de configuration doit être enrichi en ajoutant ``requires_login``, ``login_uri``, +``login_username_field``, ``login_password_field`` et ``not_logged_in_xpath``. + +Attention, le formulaire de connexion doit se trouver dans le contenu de la page lors du chargement de celle-ci. +Il sera impossible pour wallabag de se connecter à un site dont le formulaire de connexion est chargé après coup (en ajax par exemple). + +``login_uri`` correspond à l'URL à laquelle le formulaire est soumis (attribut ``action`` du formulaire). +``login_username_field`` correspond à l'attribut ``name`` du champ de l'identifiant. +``login_password_field`` correspond à l'attribut ``name`` du champ du mot de passe. + +Par exemple : + +.. code:: + + title://div[@id="titrage-contenu"]/h1[@class="title"] + body: //div[@class="contenu-html"]/div[@class="page-pane"] + + requires_login: yes + + login_uri: http://www.arretsurimages.net/forum/login.php + login_username_field: username + login_password_field: password + + 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 : developer/api developer/docker + developer/paywall developer/documentation developer/translate developer/asynchronous -- cgit v1.2.3