]> git.immae.eu Git - github/wallabag/wallabag.git/commitdiff
Added documentation and missing translations 2317/head
authorNicolas Lœuillet <nicolas@loeuillet.org>
Tue, 22 Nov 2016 14:58:00 +0000 (15:58 +0100)
committerNicolas Lœuillet <nicolas@loeuillet.org>
Tue, 22 Nov 2016 16:32:24 +0000 (17:32 +0100)
18 files changed:
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.da.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.de.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.es.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.fa.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.fr.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.it.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.oc.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.pl.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.pt.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.ro.yml
app/Resources/CraueConfigBundle/translations/CraueConfigBundle.tr.yml
docs/de/developer/paywall.rst [new file with mode: 0644]
docs/de/index.rst
docs/en/developer/paywall.rst [new file with mode: 0644]
docs/en/index.rst
docs/fr/developer/paywall.rst [new file with mode: 0644]
docs/fr/index.rst
src/Wallabag/CoreBundle/Helper/HttpClientFactory.php

index fac3b4f876fa380943f8fb5a073af9765061b025..c65463dba3269ffdf574482b8f44230fabd83c10 100644 (file)
@@ -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
index d382733c53315829aa46bcacbde50453b25e5aa4..bc378147b2242ddd3d0addf1fcc3b0a031d73f2b 100644 (file)
@@ -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
index ff1dd04ff6abbd704cfe134725aac85f9caaf444..dbec0e81853d8b5f70add3fed4c770ab9e571dbe 100644 (file)
@@ -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
index 4e712fdde5d6ae0a4a4c974bd52f09b5955ac578..7a341e0b71d6c532f5aa665f5c3f6c893307c014 100644 (file)
@@ -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
index cae4c662dd382eca296cdab154dba7c71ff52cfd..f5c886d6ecf9b07b06f85292ba39bcaa30cd057d 100644 (file)
@@ -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
index f94f834f6693455e8e0cd0468e3f71deae05a5d9..88a1b4f6f601e6a3d31723c702ce17f1467b4c76 100644 (file)
@@ -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
index de60a194856d58194881f859680357be8450cae2..00deeade078a203b5a8e006545ef4d05b8e425f3 100644 (file)
@@ -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
index 1157974516287d2614b69f7f15bb488e4831cb29..744031e8ec9c6431fad812414149f4d864deee17 100644 (file)
@@ -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
index 74ae5a44f3af6a07d615e126ffe811d72f3439eb..1edde87ac7f126bb1f1d29dc027be23f224a8e6b 100644 (file)
@@ -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
index 5095dfa00417331be346bded4bb2ad34a7c4e61e..f0c935d3fd65a24758886a42016456323b24f4cf 100644 (file)
@@ -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
index cd42e595d4524b8f6e86caf894065f66e1de8869..eb40fc5ed16d7d4ec983023e8179ffaac5f46d12 100644 (file)
@@ -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
diff --git a/docs/de/developer/paywall.rst b/docs/de/developer/paywall.rst
new file mode 100644 (file)
index 0000000..365027b
--- /dev/null
@@ -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"]
index c1ce7d4b4b7b315eaac2801e16de1cf8ae3d561c..1c3e4873bbd46cc01d1acef258bb40ae229b9d17 100644 (file)
@@ -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 (file)
index 0000000..365027b
--- /dev/null
@@ -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"]
index 54a1eef8829b676e5e368b3966632936cb0ad88b..2e20aee628aca03a592f18c9c94a9a9a89c353a4 100644 (file)
@@ -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 (file)
index 0000000..c1c410b
--- /dev/null
@@ -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"]
index 8a4c600a964830d33e409e8803e94080a1f666d8..e3f14b048dd69d15473ba320c256ae362e200807 100644 (file)
@@ -47,6 +47,7 @@ La documentation est disponible dans d'autres langues :
 
    developer/api
    developer/docker
+   developer/paywall
    developer/documentation
    developer/translate
    developer/asynchronous
index ca84c8da232e9ea539cf8f9d5e71bfc9bd078ba0..8891887b6e97d1a68ad3f783f130ac49879261d6 100644 (file)
@@ -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)
     {