From 9d8975f6b6e1998cff86a0198b247a5c1708bc59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 17 Feb 2017 13:12:09 +0100 Subject: Moved :it: documentation into it folder --- docs/it/developer/api.rst | 269 ++++++++++++++++++++++++++++++++++++ docs/it/developer/asynchronous.rst | 162 ++++++++++++++++++++++ docs/it/developer/docker.rst | 41 ++++++ docs/it/developer/documentation.rst | 12 ++ docs/it/developer/paywall.rst | 52 +++++++ docs/it/developer/testsuite.rst | 6 + docs/it/developer/translate.rst | 55 ++++++++ 7 files changed, 597 insertions(+) create mode 100644 docs/it/developer/api.rst create mode 100644 docs/it/developer/asynchronous.rst create mode 100644 docs/it/developer/docker.rst create mode 100644 docs/it/developer/documentation.rst create mode 100644 docs/it/developer/paywall.rst create mode 100644 docs/it/developer/testsuite.rst create mode 100644 docs/it/developer/translate.rst (limited to 'docs/it/developer') diff --git a/docs/it/developer/api.rst b/docs/it/developer/api.rst new file mode 100644 index 00000000..fc19a175 --- /dev/null +++ b/docs/it/developer/api.rst @@ -0,0 +1,269 @@ +Documentazione su API +--------------------- + +Grazie a questa documentazione, vedremo come interagire con l'API di wallabag. + +Requisiti +--------- + +* wallabag appena (o no) installato su http://localhost:8000 +* ``httpie`` installato sul vostro computer (`guardate il sito del progetto `__). Da notare che potete anche adattare i comandi usando curl o wget. +* tutti i metodi API documentati qui http://localhost:8000/api/doc (sulla vostra istanza) e `sulla nostra istanza d'esempio `_ + +Creare un nuovo client API +-------------------------- + +Sul vostro account wallabag potete creare un nuovo client API presso questo URL http://localhost:8000/developer/client/create. + +Date solamente l'URL per il reindirizzamento della vostra applicazione e create il vostro client. Se la vostra applicazione è desktop, inserite l'URL che preferite. + +Toverete informazioni come queste: + +:: + + Client ID: + + 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc + + Client secret: + + 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 + + +Ottenere un token per il ricaricamento +-------------------------------------- + +Per ogni chiamata API avrete bisogno di un token. Creiamolo con questo comando (rimpiazzate ``client_id``, ``client_secret``, ``username`` and ``password`` con i loro valori): + +:: + + http POST http://localhost:8000/oauth/v2/token \ + grant_type=password \ + client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ + client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ + username=wallabag \ + password=wallabag + +Otterrete questo risultato: + +:: + + HTTP/1.1 200 OK + Cache-Control: no-store, private + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:44:33 GMT + Host: localhost:8000 + Pragma: no-cache + X-Debug-Token: 19c8e0 + X-Debug-Token-Link: /_profiler/19c8e0 + X-Powered-By: PHP/7.0.4 + + { + "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA", + "expires_in": 3600, + "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ", + "scope": null, + "token_type": "bearer" + } + +Lavoreremo con il valore ``access_token`` nelle nostre prossime chiamate. + +esempio di cURL: + +:: + + curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" + +Ottenere voci esistenti +----------------------- + +Documentazione per questo metodo: http://localhost:8000/api/doc#get--api-entries.{_format} + +Mentre lavoriamo su una nuova installazione di wallabag, non otterremo risultati con questo comando: + +:: + + http GET http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +restituisce: + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:51:32 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly + X-Debug-Token: 4fbbc4 + X-Debug-Token-Link: /_profiler/4fbbc4 + X-Powered-By: PHP/7.0.4 + + { + "_embedded": { + "items": [] + }, + "_links": { + "first": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "last": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "self": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + } + }, + "limit": 30, + "page": 1, + "pages": 1, + "total": 0 + } + +L'insieme ``items`` è vuoto. + +esempio di cURL: + +:: + + curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +Aggiungere la vostra prima voce +------------------------------- + +Documentazione per questo metodo: http://localhost:8000/api/doc#post--api-entries.{_format} + +:: + + http POST http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \ + url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" + +restituisce: + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:07:54 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly + X-Debug-Token: e01c51 + X-Debug-Token-Link: /_profiler/e01c51 + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/1" + } + }, + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "id": 1, + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +Ora, se eseguite il comando precedente (vedere **Ottenere voci esistenti**), avrete dei dati. + +esempio di cURL: + +:: + + curl "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA&url=http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" + +Eliminare una voce +------------------ + +Documentazione per questo metodo: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} + +:: + + http DELETE http://localhost:8000/api/entries/1.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +restituisce + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:19:07 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly + X-Debug-Token: 887cef + X-Debug-Token-Link: /_profiler/887cef + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/" + } + }, + "annotations": [], + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +E se volete elencare le voci esistenti (vedere **Ottenere voci esistenti**), l'insieme è vuoto. + +esempio di cURL: + +:: + + curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +Altri metodi +------------ + +Non scriveremo esempi per ogni metodo API. +Guardate l'elenco qui : http://localhost:8000/api/doc per ogni metodo conosciuto. + +Risorse di terze parti +---------------------- + +Alcune applicazioni o librerie usano le nostre API. Ecco una lista non esaustiva: + +- `Wrapper Java per l'API di wallabag `_ di Strubbl. +- `Libreria .NET per l'API di wallabag v2 `_ di Julian Oster. +- `API di Python per wallabag `_ di FoxMaSk, per il suo progetto `Trigger Happy `_. +- `Un plugin `_ creato per `Tiny Tiny RSS `_ questo usa l'API di wallabag v2. Di Josh Panter. +- `Wrapper Golang per l'API di wallabag `_ di Strubbl, per il suo progetto `wallabag-stats graph `_. diff --git a/docs/it/developer/asynchronous.rst b/docs/it/developer/asynchronous.rst new file mode 100644 index 00000000..d753bd23 --- /dev/null +++ b/docs/it/developer/asynchronous.rst @@ -0,0 +1,162 @@ +Compiti Asincroni +================= + +Per avviare compiti asincroni (utile ad esempio per grandi importazioni), Possiamo usare RabbitMQ o Redis. + +Installare RabbitMQ per compiti asincroni +----------------------------------------- + +Requisiti +^^^^^^^^^ + +Dovete avere RabbitMQ installato sul vostro server. + +Installazione +^^^^^^^^^^^^^ + +.. code:: bash + + wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc + apt-key add rabbitmq-signing-key-public.asc + apt-get update + apt-get install rabbitmq-server + +Configurazione ed avvio +^^^^^^^^^^^^^^^^^^^^^^^ + +.. code:: bash + + rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) + rabbitmq-server -detached + +Fermare RabbitMQ +^^^^^^^^^^^^^^^^ + +.. code:: bash + + rabbitmqctl stop + + +Configurare RabbitMQ in wallabag +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Modificate il vostro file ``app/config/parameters.yml`` per modificare la configurazione di RabbitMQ. Quella di default dovrebbe andare bene: + +.. code:: yaml + + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + rabbitmq_prefetch_count: 10 # read http://www.rabbitmq.com/consumer-prefetch.html + +Abilitare RabbitMQ su wallabag +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Su Strumenti, nella sezione **Importa**, abilitate RabbitMQ (con il valore 1). + +Avviare RabbitMQ consumer +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Dipendendo da quale servizio vogliate importare, dovrete abilitare uno (o più se volete supportare molti) o più cronjob: + +.. code:: bash + + # per importare da Pocket + bin/console rabbitmq:consumer -e=prod import_pocket -w + + # per importare da Readability + bin/console rabbitmq:consumer -e=prod import_readability -w + + # per importare da Instapaper + bin/console rabbitmq:consumer -e=prod import_instapaper -w + + # per importare da wallabag v1 + bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w + + # per importare da wallabag v2 + bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w + + # per importare da Firefox + bin/console rabbitmq:consumer -e=prod import_firefox -w + + # per importare da Chrome + bin/console rabbitmq:consumer -e=prod import_chrome -w + +Installare Redis per compiti asincroni +-------------------------------------- + +Per avviare compiti asincroni (utile ad esempio per grandi importazioni), Possiamo usare Redis. + +Requisiti +^^^^^^^^^ + +Dovete avere Redis installato sul vostro server. + +Installazione +^^^^^^^^^^^^^ + +.. code:: bash + + apt-get install redis-server + + +Avvio +^^^^^ + +Il server dovrebbe già essere attivo dopo l'installazione, altrimenti potete avviarlo usando: + +.. code:: bash + + redis-server + + +Configurare Redis su wallabag +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Modificate il vostro file ``app/config/parameters.yml`` per modificare la configurazione di Redis. Quella di default dovrebbe andare bene: + +.. code:: yaml + + redis_host: localhost + redis_port: 6379 + +Abilitare Redis su wallabag +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Su Strumenti, nella sezione **Importa**, abilitate Redis (con il valore 1). + +Avviare Redis consumer +^^^^^^^^^^^^^^^^^^^^^^ + +Dipendendo da quale servizio vogliate importare, dovrete abilitare uno (o più se volete supportare molti) o più cronjob: + +.. code:: bash + + # per importare da Pocket + bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + + # per importare da Readability + bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log + + # per importare da Instapaper + bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log + + # per importare da wallabag v1 + bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log + + # per importare da wallabag v2 + bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log + + # per importare da Firefox + bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log + + # per importare da Chrome + bin/console wallabag:import:redis-worker -e=prod chrome -vv >> /path/to/wallabag/var/logs/redis-chrome.log + +Se volete avviare l'importazione solamente per alcuni messaggi e non tutti, potete specificare questo numero (qui 12) e il programma si fermerà dopo il dodicesimo messaggio: + +.. code:: bash + + bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 + diff --git a/docs/it/developer/docker.rst b/docs/it/developer/docker.rst new file mode 100644 index 00000000..f07df20d --- /dev/null +++ b/docs/it/developer/docker.rst @@ -0,0 +1,41 @@ +Eseguite wallabag in docker-compose +=================================== + +Per eseguire la vostra propria istanza di sviluppo di wallabag, dovreste usare i file docker compose preconfigurati. + +Requisiti +--------- + +Assicuratevi di avere `Docker +` e `Docker +Compose `__ disponibili sul vostro sistema e aggiornati. + +Cambiate DBMS +------------- + +Per default, wallabag inizierá con un database SQLite. +Visto che wallabag supporta Postgresql e MySQL, i container di docker sono disponibili anche per questi. + +In ``docker-compose.yml``, per il DBMS scelto, togliete i commenti: + +- la definizione del container (blocco a livello root ``postgres`` o ``mariadb``) +- il link del container nel container``php`` +- il file env del container nel container ``php`` + +Per far continuare ad eseguire i comandi Symfony sul vostro host (come ``wallabag:install``), dovreste anche: + +- caricare i file env appropriati sulla vostra riga di comando, in modo che possano esistere variabili come ``SYMFONY__ENV__DATABASE_HOST``. +- creare un ``127.0.0.1 rdbms`` sul vostro file di sistema ``hosts`` + +Eseguite wallabag +----------------- + +#. Fate un fork o clonate il progetto +#. Modificate ``app/config/parameters.yml`` per rimpiazzare le proprietá di ``database_*`` con quelle commentate (con valori con prefisso ``env.``) +#. ``composer install`` per installare le dipendenze del progetto +#. ``php bin/console wallabag:install`` per creare lo schema +#. ``docker-compose up`` per eseguire i containers +#. Infine, andate su http://localhost:8080/ per trovare il vostro wallabag appena installato. + +Durante i vari passi potreste incontrare problemi di permessi UNIX, percorsi sbagliati nella cache generata, etc... +Operazioni come cambiare i file della cache o cambiare i proprietari dei file potrebbero essere richiesto frequentemente, per cui non abbiate paura! diff --git a/docs/it/developer/documentation.rst b/docs/it/developer/documentation.rst new file mode 100644 index 00000000..d4b63bb6 --- /dev/null +++ b/docs/it/developer/documentation.rst @@ -0,0 +1,12 @@ +Contribuite a questa documentazione +=================================== + +Le fonti della nostra documentazione sono qui https://github.com/wallabag/wallabag/tree/master/docs + +Usiamo `ReadTheDocs +`__ per generarla. + +Le pagine sono scritte nel formato `Restructured Text +`__. Potete usare strumenti online come http://rst.aaroniles.net/ o http://rst.ninjs.org/ per vedere un'anteprima dei vostri articoli. + +Se create una nuova pagina, non scordatevi di modificare il file `index.rst `__ per aggiungere un link nella barra laterale. diff --git a/docs/it/developer/paywall.rst b/docs/it/developer/paywall.rst new file mode 100644 index 00000000..2c4e1bf7 --- /dev/null +++ b/docs/it/developer/paywall.rst @@ -0,0 +1,52 @@ +Articoli dietro ad un paywall +============================= + +wallabag puó acquisire articoli da siti web che usano un sistema paywall + +Abilitate l'autenticazione paywall +---------------------------------- + +Su impostazioni interne, nella sezione **Articolo**, abilitate l'autenticazione per siti con paywall (con il valore 1). + +Configurate le credenziali in wallabag +-------------------------------------- + +Modificate il vostro file ``app/config/parameters.yml`` per modificare le credenziali per ogni sito con paywall. Ecco un esempio di alcuni siti francesi: + +.. 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. + +Fate il parsing dei file di configurazione +------------------------------------------ + +Leggete `questa parte della documentazione *link mancante*` per capire i file di configurazione. + +Ogni file di configurazione del parsing deve essere migliorato aggiungendo ``requires_login``, ``login_uri``, ``login_username_field``, ``login_password_field`` e ``not_logged_in_xpath``. + +Fate attenzione, il modulo di login deve essere nel contenuto della pagina quando wallabag lo carica. É impossibile per wallab essere autenticato su un sito dove il modulo di login é caricato dopo la pagina (da ajax per esempio). + +``login_uri`` é l'URL di azione del modulo (l'attributo ``action`` del modulo). +``login_username_field`` é l'attributo ``name`` nel campo di login. +``login_password_field`` é l'attributo ``name`` nel campo password. + +Per esempio: + +.. 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/it/developer/testsuite.rst b/docs/it/developer/testsuite.rst new file mode 100644 index 00000000..fdb72401 --- /dev/null +++ b/docs/it/developer/testsuite.rst @@ -0,0 +1,6 @@ +Testsuite +========= +Per assicurare la qualità di sviluppo di wallabag, abbiamo scritto i test con `PHPUnit `_. +Se contribuite al progetto (traducendo l'applicazione, risolvendo i bug o aggiungendo nuove funzioni), si prega di scrivere i propri test. + +Per avviare la testsuite di wallabag dovete installare `ant `_. Poi, eseguite il comando ``make test``. \ No newline at end of file diff --git a/docs/it/developer/translate.rst b/docs/it/developer/translate.rst new file mode 100644 index 00000000..c0b8e265 --- /dev/null +++ b/docs/it/developer/translate.rst @@ -0,0 +1,55 @@ +Tradurre wallabag +================= + +wallabag web app +---------------- + +File per la traduzione +~~~~~~~~~~~~~~~~~~~~~~ + +.. note:: + + Visto che wallabag é principalmente sviluppato da un team francese, si prega di considerare che la traduzione francese é la più aggiornata, e si prega di copiarla e di creare la vostra propria traduzione. + +Potete trovare qui i file per la traduzione: +https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations. + +Dovrete creare ``messages.CODE.yml`` e ``validators.CODE.yml``, dove CODE é il codice ISO 639-1 della vostra lingua (`guardate wikipedia `__). + +Altri file da tradurre: + +- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. +- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations. + +Dovete creare i file ``THE_TRANSLATION_FILE.CODE.yml``. + +File di configurazione +~~~~~~~~~~~~~~~~~~~~~~ + +Dovete modificare `app/config/config.yml +`__ per mostrare il vostro linguaggio nella pagina di configurazione di wallabag (per consentire agli utenti di passare a questa nuova traduzione). + +Nella sezione ``wallabag_core.languages``, dovete aggiungere una nuova linea con la vostra traduzione. Per esempio: + +:: + + wallabag_core: + ... + languages: + en: 'English' + fr: 'Français' + +Nella prima colonna (``en``, ``fr``, etc.), dovete aggiungere il codice ISO 639-1 della vostra lingua (vedete sopra). + +Nella seconda colonna, aggiungete solamente il nome della vostra lingua. + +documentazione di wallabag +-------------------------- + +.. note:: + Contrariamente alla web app, il linguaggio principale per la documentazione é l'inglese. + +I file della documentazione sono memorizzati qui: https://github.com/wallabag/wallabag/tree/master/docs + +Dovete rispettare la struttura della cartella ``en`` quando create la vostra traduzione. + -- cgit v1.2.3