mirror of
https://github.com/wallabag/wallabag.git
synced 2024-09-24 12:29:59 +00:00
Added documentation and missing translations
This commit is contained in:
Nicolas Lœuillet
parent
d64bf7953b
commit
d51093a7d9
18 changed files with 183 additions and 1 deletions
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Aktiver demo-indstilling? (anvendes kun til wallabags offent
|
|||
demo_mode_username: "Demobruger"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Test-Modus aktivieren? (nur für die öffentliche wallabag-D
|
|||
demo_mode_username: "Test-Benutzer"
|
||||
share_public: Erlaube eine öffentliche URL für Einträge
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Activar modo demo (sólo usado para la demo de wallabag)"
|
|||
demo_mode_username: "Nombre de usuario demo"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ modify_settings: "اعمال"
|
|||
# demo_mode_username: "Demo user"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Activer le mode démo ? (utiliser uniquement pour la démo p
|
|||
demo_mode_username: "Utilisateur de la démo"
|
||||
share_public: Autoriser une URL publique pour les articles
|
||||
download_images_enabled: Télécharger les images en local
|
||||
restricted_access: Activer l'authentification pour les articles derrière un paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Abilita modalità demo ? (usato solo per la demo pubblica di
|
|||
demo_mode_username: "Utente Demo"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Activar lo mode demostracion ? (utilizar solament per la dem
|
|||
demo_mode_username: "Utilizaire de la demostracion"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Włacz tryb demo? (używany wyłącznie dla publicznej demon
|
|||
demo_mode_username: "Użytkownik Demonstracyjny"
|
||||
share_public: Zezwalaj na publiczny adres url dla wpisow
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ demo_mode_enabled: "Habilitar modo demo? (somente usado para o demo público do
|
|||
demo_mode_username: "Usuário demo"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@ modify_settings: "aplică"
|
|||
# demo_mode_username: "Demo user"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
|
|
@ -32,3 +32,4 @@
|
|||
# demo_mode_username: "Demo user"
|
||||
# share_public: Allow public url for entries
|
||||
# download_images_enabled: Download images locally
|
||||
# restricted_access: Enable authentication for websites with paywall
|
||||
|
|
|
|||
56
docs/de/developer/paywall.rst
Normal file
56
docs/de/developer/paywall.rst
Normal file
|
|
@ -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 <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ 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"]
|
||||
|
|
@ -46,6 +46,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
|
|||
|
||||
developer/api
|
||||
developer/docker
|
||||
developer/paywall
|
||||
developer/documentation
|
||||
developer/translate
|
||||
developer/asynchronous
|
||||
|
|
|
|||
56
docs/en/developer/paywall.rst
Normal file
56
docs/en/developer/paywall.rst
Normal file
|
|
@ -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 <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ 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"]
|
||||
|
|
@ -46,6 +46,7 @@ The documentation is available in other languages:
|
|||
|
||||
developer/api
|
||||
developer/docker
|
||||
developer/paywall
|
||||
developer/documentation
|
||||
developer/translate
|
||||
developer/asynchronous
|
||||
|
|
|
|||
56
docs/fr/developer/paywall.rst
Normal file
56
docs/fr/developer/paywall.rst
Normal file
|
|
@ -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 <http://doc.wallabag.org/fr/master/user/errors_during_fetching.html>`_ 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"]
|
||||
|
|
@ -47,6 +47,7 @@ La documentation est disponible dans d'autres langues :
|
|||
|
||||
developer/api
|
||||
developer/docker
|
||||
developer/paywall
|
||||
developer/documentation
|
||||
developer/translate
|
||||
developer/asynchronous
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ class HttpClientFactory
|
|||
*
|
||||
* @param \GuzzleHttp\Event\SubscriberInterface $authenticatorSubscriber
|
||||
* @param \GuzzleHttp\Cookie\CookieJar $cookieJar
|
||||
* @param string $restrictedAccess
|
||||
* @param string $restrictedAccess this param is a kind of boolean. Values: 0 or 1
|
||||
*/
|
||||
public function __construct(SubscriberInterface $authenticatorSubscriber, CookieJar $cookieJar, $restrictedAccess)
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in a new issue