From 429480357f93f54c04108202efb35e33dcc0f832 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Mon, 23 May 2016 21:41:00 +0200 Subject: translate documentation to German --- docs/de/developer/api.rst | 270 ++++++++++++++++++++++++++++++++++++ docs/de/developer/docker.rst | 57 ++++++++ docs/de/developer/documentation.rst | 10 ++ docs/de/developer/maintenance.rst | 32 +++++ docs/de/developer/translate.rst | 57 ++++++++ 5 files changed, 426 insertions(+) create mode 100644 docs/de/developer/api.rst create mode 100644 docs/de/developer/docker.rst create mode 100644 docs/de/developer/documentation.rst create mode 100644 docs/de/developer/maintenance.rst create mode 100644 docs/de/developer/translate.rst (limited to 'docs/de/developer') diff --git a/docs/de/developer/api.rst b/docs/de/developer/api.rst new file mode 100644 index 00000000..f8911181 --- /dev/null +++ b/docs/de/developer/api.rst @@ -0,0 +1,270 @@ +API DoKumentation +================= + +Dank dieser Dokumentation werden wir sehen, wie wir mit der wallabag API interagieren. + +Voraussetzungen +--------------- + +* wallabag frisch (oder nicht) installiert auf http://localhost:8000 +* ``httpie`` installiert auf deinem Computer (`siehe Projektwebsite `__). Beachte, dass du die Kommandos auch mit curl oder wget nutzen kannst. +* alle API Methoden sind hier dokumentiert http://localhost:8000/api/doc + +Einen neuen API Client erstellen +-------------------------------- + +In deinem wallabag Account, kannst du einen neuen API Client unter dieser URL http://localhost:8000/developer/client/create erstellen. + +Gib dazu nur die Umleitungs-URL deiner Appliaktion an und erstelle deinen Client. Wenn deine Applikation eine Desktopapplikation ist, trage die URL, die dir am besten passt, ein. + +Du bekommst Informationen wie diese: + +:: + + Client ID: + + 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc + + Client secret: + + 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 + + +Einen Aktualisierungstoken erhalten +----------------------------------- + +Für jeden API Aufruf brauchst du einen Token. Lass uns einen erstellen mit diesem Kommando (ersetze ``client_id``, ``client_secret``, ``username`` und ``password`` mit ihren Werten): + +:: + + http POST http://localhost:8000/oauth/v2/token \ + grant_type=password \ + client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ + client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ + username=wallabag \ + password=wallabag + +Du bekommst folgendes zurück: + +:: + + 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" + } + +Wir werden mit dem ``access_token`` Wert in unseren nächsten Aufrufen arbeiten. + +cURL Beispiel: + +:: + + curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" + +Existierende Einträge erhalten +------------------------------ + +Dokumentation für diese Methode: http://localhost:8000/api/doc#get--api-entries.{_format} + +Da wir auf einer neuen wallabag Installation arbeiten, bekommen wir keine Ergebnisse mit diesem Kommando: + +:: + + http GET http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +gibt zurück: + +:: + + 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 + } + +Das Array ``items`` ist leer. + +cURL Beispiel: + +:: + + curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +Deinen ersten Eintrag hinzufügen +-------------------------------- + +Dokumentation für diese Methode: 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" + +gibt zurück: + +:: + + 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" + } + +Wenn du jetzt das vorherige Kommando (siehe **Existierende Einträge erhalten**), wirst du Daten erhalten. + +cURL Beispiel: + +:: + + 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" + +Eintrag löschen +----------------- + +Dokumentation für diese Methode: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} + +:: + + http DELETE http://localhost:8000/api/entries/1.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +gibt zurück: + +:: + + 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" + } + +Und wenn du die existierenden Einträge nun listen willst (siehe **Existierende Einträge erhalten**), ist das Array wieder leer. + +cURL Beispiel: + +:: + + curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +Andere Methoden +--------------- + +Wir werden nicht für jede API Methode Beispiele schreiben. + +Wirf einen Blick in die Liste http://localhost:8000/api/doc, um alle Methode kennenzulernen. + + +Drittanbieter Ressourcen +------------------------ + +Einige Applikationen oder Bibliotheken nutzen unsere API. Hier ist eine nicht abschließende Aufzählung von ihnen: + +- `Java wrapper for the wallabag API `_ von Strubbl. +- `.NET library for the wallabag v2 API `_ von Julian Oster. +- `Python API for wallabag `_ von FoxMaSk, für sein Projekt `Trigger Happy `_. +- `A plugin `_ entworfen für `Tiny Tiny RSS `_, das die wallabag v2 API nutzt. Von Josh Panter. diff --git a/docs/de/developer/docker.rst b/docs/de/developer/docker.rst new file mode 100644 index 00000000..c63194aa --- /dev/null +++ b/docs/de/developer/docker.rst @@ -0,0 +1,57 @@ +Lasse wallabag in docker-compose laufen +======================================= + +Um deine eigene Entwicklungsinstanz von wallabag laufen zu lassen, +möchtest du vielleicht die vorkonfigurierten docker compose Dateien +nutzen. + +Voraussetzungen +--------------- + +Stelle sicher `Docker +`__ und `Docker +Compose `__ auf deinem +System verfügbar und aktuell zu haben. + +Wechsel des DBMS +---------------- + +Standardmäßig startet wallabag mit einer SQLite Datenbank. +Da wallabag Unterstützung für Postgresql und MySQL bietet, gibt es +auch docker Container für diese. + +In der ``docker-compose.yml`` kommentierst du für das gewählte DBMS +aus: + +- die Container Definition (``postgres`` oder ``mariadb`` root + Level Block) +- den Container Link in dem ``php`` Container +- die Container Umgebungsdatei in dem ``php`` Container + +Um mit Symfony Kommandos auf deinem Host auszuführen (wie z.B. +``wallabag:install``), sollst du außerdem: + +- die richtige Umgebungsdatei auf deiner Kommandozeile einlesen, + sodass Variablen wie ``SYMFONY__ENV__DATABASE_HOST`` existieren +- eine Zeile ``127.0.0.1 rdbms`` in deiner ``hosts`` Datei auf dem + System erstellen + +wallabag laufen lassen +---------------------- + +#. Forke und klone das Projekt +#. Bearbeite ``app/config/parameters.yml`` um ``database_*`` + Eigenschaften mit den kommentierten zu ersetzen (mit Werten + mit ``env.`` Präfix) +#. ``composer install`` die Projektabhängigkeiten +#. ``php app/console wallabag:install``, um das Schema zu erstellen +#. ``docker-compose up`` um die Container laufen zu lassen +#. Schließlich öffne http://localhost:8080/, um dein frisch + installiertes wallabag zu finden. + +In den verschiedenen Schritten wirst du vielleicht in verschiendene +Probleme laufen wie UNIX Berechtigungsprobleme, falschen Pfaden im +generierten Cache, etc.… +Operationen wie das Löschen der Cachedateien oder das Ändern der +Dateibesitzer können öfter gebraucht werden, darum habe keine Angst +sie anzupassen. diff --git a/docs/de/developer/documentation.rst b/docs/de/developer/documentation.rst new file mode 100644 index 00000000..41e19363 --- /dev/null +++ b/docs/de/developer/documentation.rst @@ -0,0 +1,10 @@ +Wirke an dieser Dokumentation mit +================================= + +Quellen der Dokumentation sind hier zu finden https://github.com/wallabag/wallabag/tree/master/docs + +Wir nutzen `ReadTheDocs `__, um sie zu generieren. + +Seiten werden in `reStructuredText `__ geschrieben. Du kannst Onlinetools wie http://rst.aaroniles.net/ oder http://rst.ninjs.org/ nutzen, um eine Vorschau deiner Artikel zu betrachten. + +Wenn du eine neue Seite erstellst, vergiss nicht die `index.rst `__ zu bearbeiten, um dort einen Link für die Seitenleiste hinzuzufügen. diff --git a/docs/de/developer/maintenance.rst b/docs/de/developer/maintenance.rst new file mode 100644 index 00000000..2a9070e1 --- /dev/null +++ b/docs/de/developer/maintenance.rst @@ -0,0 +1,32 @@ +Wartungsmodus +============= + +Wenn du längere Aufgaben auf deiner wallabag Instanz ausführen willst, kannst du den Wartungsmodus aktivieren. +Keiner wird dann Zugang zu deiner Instanz haben. + +Aktivieren des Wartungsmodus +---------------------------- + +Um den Wartungsmodus zu aktivieren, führe folgendes Kommando aus: + +:: + + bin/console lexik:maintenance:lock --no-interaction + +Du kannst deine IP Adresse in ``app/config/config.yml`` setzen, wenn du Zugriff zu wallabag haben willst, auch wenn der Wartungsmodus aktiv ist. Zum Beispiel: + +:: + + lexik_maintenance: + authorized: + ips: ['127.0.0.1'] + + +Deaktivieren des Wartungsmodus +------------------------ + +Um den Wartungsmodus zu deaktivieren, führe dieses Kommando aus: + +:: + + bin/console lexik:maintenance:unlock diff --git a/docs/de/developer/translate.rst b/docs/de/developer/translate.rst new file mode 100644 index 00000000..50e136ea --- /dev/null +++ b/docs/de/developer/translate.rst @@ -0,0 +1,57 @@ +Übersetze wallabag +================== + +wallabag Webapplikation +----------------------- + +Übersetzungsdateien +~~~~~~~~~~~~~~~~~~~ + +.. note:: + + Da wallabag hauptsächlich von einem französischem Team entwickelt wird, betrachte + die französische Übersetzung als die aktuellste und kopiere sie, um deine eigene Übersetzung zu starten. + +Du kannst die Übersetzungsdateien hier finden: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations. + +Du musst die ``messages.CODE.yml`` und ``validators.CODE.yml`` erstellen, wobei CODE +der ISO 639-1 Code deiner Sprache ist (`siehe Wikipedia `__). + +Andere Dateien zum Übersetzen: + +- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. +- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations. + +Du musst die ``THE_TRANSLATION_FILE.CODE.yml`` Dateien erstellen. + +Konfigurationsdatei +~~~~~~~~~~~~~~~~~~~ + +Du musst die `app/config/config.yml `__ bearbeiten, +um deine Sprache auf der Konfigurationsseite in wallabag anzuzeigen (um Nutzern zu erlauben zu dieser neuen Übersetzung zu wechseln). + +Unter dem Abschnitt ``wallabag_core.languages`` musst du eine neue Zeile mit deiner Übersetzung hinzufügen. Zum Beispiel: + +:: + + wallabag_core: + ... + languages: + en: 'English' + fr: 'Français' + + +Für die erste Spalte (``en``, ``fr``, etc.) musst du den ISO 639-1 Code deiner Sprache hinzufügen (siehe oben). + +Für die zweite Spalte trägst du den Namen deiner Sprache ein. Nur den. + +wallabag Dokumentation +---------------------- + +.. note:: + + Im Gegensatz zur Webapplikation ist die Hauptsprache für die Dokumentation Englisch. + +Documentationsdateien sind hier gespeichert: https://github.com/wallabag/wallabag/tree/master/docs + +Du musst die Ordnerstruktur des Ordners ``en`` beachten, wenn du deine eigene Übersetzung startest. -- cgit v1.2.3