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 ++++++ docs/de/index.rst | 52 +++++ docs/de/user/android.rst | 107 +++++++++++ docs/de/user/annotations.rst | 24 +++ docs/de/user/configuration.rst | 119 ++++++++++++ docs/de/user/create_account.rst | 25 +++ docs/de/user/download_articles.rst | 17 ++ docs/de/user/errors_during_fetching.rst | 28 +++ docs/de/user/faq.rst | 45 +++++ docs/de/user/filters.rst | 49 +++++ docs/de/user/first_article.rst | 68 +++++++ docs/de/user/import.rst | 46 +++++ docs/de/user/installation.rst | 326 ++++++++++++++++++++++++++++++++ docs/de/user/login.rst | 13 ++ docs/de/user/migration.rst | 62 ++++++ docs/de/user/tags.rst | 2 + docs/de/user/upgrade.rst | 32 ++++ docs/en/user/configuration.rst | 2 +- docs/fr/user/configuration.rst | 2 +- 23 files changed, 1443 insertions(+), 2 deletions(-) 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 create mode 100644 docs/de/index.rst create mode 100644 docs/de/user/android.rst create mode 100644 docs/de/user/annotations.rst create mode 100644 docs/de/user/configuration.rst create mode 100644 docs/de/user/create_account.rst create mode 100644 docs/de/user/download_articles.rst create mode 100644 docs/de/user/errors_during_fetching.rst create mode 100644 docs/de/user/faq.rst create mode 100644 docs/de/user/filters.rst create mode 100644 docs/de/user/first_article.rst create mode 100644 docs/de/user/import.rst create mode 100644 docs/de/user/installation.rst create mode 100644 docs/de/user/login.rst create mode 100644 docs/de/user/migration.rst create mode 100644 docs/de/user/tags.rst create mode 100644 docs/de/user/upgrade.rst (limited to 'docs') 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. diff --git a/docs/de/index.rst b/docs/de/index.rst new file mode 100644 index 00000000..5311150f --- /dev/null +++ b/docs/de/index.rst @@ -0,0 +1,52 @@ +wallabag Dokumentation +====================== + +.. image:: ../img/wallabag.png + :alt: wallabag Logo + :align: center + +**wallabag** ist eine Read-it-later Applikation: es speichert Websites, +indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht. + +.. tip:: + + Diese Dokumentation ist über wallabag v2. Wenn du die Dokumentation für wallabag v1 lesen willst, `siehe dir bitte das hier an `__. + +Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organisiert: + +* :ref:`user-docs` +* :ref:`dev-docs` + +.. _user-docs: + +.. toctree:: + :maxdepth: 2 + :caption: Nutzerdokumentation + + user/faq + user/installation + user/upgrade + user/migration + user/import + user/create_account + user/login + user/configuration + user/first_article + user/errors_during_fetching + user/annotations + user/download_articles + user/filters + user/tags + user/android + +.. _dev-docs: + +.. toctree:: + :maxdepth: 2 + :caption: Entwicklerdokumentation + + developer/api + developer/docker + developer/documentation + developer/translate + developer/maintenance diff --git a/docs/de/user/android.rst b/docs/de/user/android.rst new file mode 100644 index 00000000..8573bcb8 --- /dev/null +++ b/docs/de/user/android.rst @@ -0,0 +1,107 @@ +Android App +=========== + + +Zweck dieses Dokuments +---------------------- + +Dieses Dokument beschreibt wie du deine Android App einrichtest, damit sie mit deiner Wallabaginstanz zusammenarbeitet. Es gibt hierbei keinen Unterschied im Vorgang - egal ob du Wallabag v1 oder v2 einsetzt. + + +Schritte, um dein App zu einzurichten +------------------------------------- + +Wenn du das erste Mal die App startest, siehst du den Willkommensbildschirm, wo du angewiesen wirst zunächst deine App mit deiner Wallabaginstanz einzurichten. + +.. image:: ../../img/user/android_welcome_screen.de.png + :alt: Willkommensbildschirm + :align: center + +Bestätige nur diese Nachricht und du wirst zum Einstellungsbildschirm weitergeleitet. + +.. image:: ../../img/user/android_configuration_screen.de.png + :alt: Einstellungsbildschirm + :align: center + +Trage deine Wallabagdaten ein. Du musst deine Wallabagadresse eintragen. Es ist wichtig, dass die URL nicht mit einem Schrägstrich endet. Füge auch deine Wallabagzugangsdaten in das Nutzer- und Passwortfeld ein. + +.. image:: ../../img/user/android_configuration_filled_in.de.png + :alt: Eingetragene Einstellungen + :align: center + +Nachdem du deine Daten eingetragen hast, drücke den Button Verbindung testen und warte auf das Fertigstellen des Tests. + +.. image:: ../../img/user/android_configuration_connection_test.de.png + :alt: Verbindungstest mit deinen Wallabagdaten + :align: center + +Der Verbindungstest sollte mit Erfolg ausgehen. Falls nicht, musst du zunächst deine Daten korrigieren bevor du zum nächsten Schritt gehst. + +.. image:: ../../img/user/android_configuration_connection_test_success.de.png + :alt: Verbindungstest war erfolgreich + :align: center + +Nach dem Verbindungstest erfolgreich war, kannst du den Button zum Feedzugangsdaten abholen drücken. Die App versucht nun sich bei deiner Wallabaginstanz einzuloggen und die Nutzer ID und den dazugehörigen Token für die Feeds zu laden. + +.. image:: ../../img/user/android_configuration_get_feed_credentials.de.png + :alt: Feedzugangsdaten abholen + :align: center + +Wenn der Prozess des Abholens deiner Feedzugangsdaten erfolgreich beendet wurde, siehst du eine Toastnachricht, dass die User ID und der Token automatisch in das Formular eingetragen wurden. + +.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.de.png + :alt: Feedzugangsdaten erfolgreich abgeholt + :align: center + +Jetzt scrollst du bis zum unteren Rand des Einstellungsbildschirms. Natürlich kannst du die Einstellungen dort deinen Wünschen anpassen. Schließe die Einrichtung mit dem Drücken des Speicherbuttons ab. + +.. image:: ../../img/user/android_configuration_scroll_bottom.de.png + :alt: unterer Rand des Einstellungsbildschirms + :align: center + +Nachdem du den Speicherbutton gedrückt hast, kommst du in den folgenden Bildschirm. Die App schlägt vor, eine initiale Synchronisation der Artikelfeeds durchzuführen. Hier ist es empfohlen, dies zu bestätigen und Ja zu drücken. + +.. image:: ../../img/user/android_configuration_saved_feed_update.de.png + :alt: Einstellung erstmals gespeichert + :align: center + +Schließlich nach der ersten erfolgreichen Synchronisation, wird dir die Liste der ungelesenen Artikel präsentiert. + +.. image:: ../../img/user/android_unread_feed_synced.de.png + :alt: Gefüllte Artikellist da Feeds erfolgreich synchronisiert sind + :align: center + + + +Bekannte Limitierungen +--------------------- + +2FA +~~~ + +Zur Zeit unterstützt die App keine Zwei-Faktor Authentifizierung. Du solltest sie deaktivieren damit die App funktioniert. + + +Begrenzte Anzahl Artikel mit Wallabag v2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In deiner Wallabaginstanz kannst du einstellen, wie viele Artikel Teil deiner RSS Feeds sind. Diese Option existierte in Wallabag v1 nicht, wo immer alle Artikel Teil des Feeds waren. Also wenn du die Anzahl der Artikel, die in der App angezeigt werden sollen, größer einstellst als die Anzahl Artikel in deinem Feed, wirst du nur die Anzahl an Artikel deines Feeds sehen. + + +SSL/TLS Verschlüsselung +~~~~~~~~~~~~~~~~~~~~~~~ + +Wenn du deine Wallabaginstanz per HTTPS erreichen kannst, solltest du das so konfigurieren. Besonders dann, wenn deine HTTP URL nach HTTPS umleitet. Im Moment kann die App mit dieser Weiterleitung nicht korrekt umgehen. + + +Referenzen +---------- + +`Quellcode der Android Applikation `_ + +`Android Applikation auf F-Droid `_ + +`Android Applikation auf Google Play `_ + +`Support Chat auf English `_ + diff --git a/docs/de/user/annotations.rst b/docs/de/user/annotations.rst new file mode 100644 index 00000000..4b4d58b0 --- /dev/null +++ b/docs/de/user/annotations.rst @@ -0,0 +1,24 @@ +Anmerkungen +=========== + +In jedem Artikel, den du liest, kannst du Anmerkungen hinzufügen. Es ist einfacher mit ein paar Bilder erklärt. + +Wähle den Teil des Artikels aus, den du kommentieren willst und klicke auf den Bleistift: + +.. image:: ../../img/user/annotations_1.png + :alt: Wähle den Text + :align: center + +Schreibe deinen Kommentar: + +.. image:: ../../img/user/annotations_2.png + :alt: Schreibe deinen Kommentar + :align: center + +Der Text ist nun hervorgehoben und du kannst deine Anmerkung lesen, wenn du den Mauspfeil darüber fährst. + +.. image:: ../../img/user/annotations_3.png + :alt: lese deine Anmerkung + :align: center + +Du kannst so viele Anmerkungen erstellen wie du möchtest. diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst new file mode 100644 index 00000000..67695ff1 --- /dev/null +++ b/docs/de/user/configuration.rst @@ -0,0 +1,119 @@ +Konfiguration +============= + +Nun, da du eingeloggt bist, ist es Zeit, deinen Account so zu konfigurieren, +wie du möchtest. + +Klicke auf ``Konfiguration`` im Menü. Du hast fünf Karteireiter: ``Einstellungen``, +``RSS``, ``Benutzer-Informationen``, ``Kennwort`` und ``Tagging-Regeln``. + +Einstellungen +------------- + +Theme +~~~~~ + +wallabag ist anpassbar. Du kannst dein bevorzugtes Theme hier auswählen. Du kannst +auch ein neues erstellen, ein extra Kapitel wird dem gewidmet sein. Das Standardtheme +ist ``Material``, es ist das Theme, dass in den Dokumentationsbildschirmfotos genutzt wird. + +Artikel pro Seite +~~~~~~~~~~~~~~~~~ + +Du kannst die Anzahl der dargestellten Artikel pro Seite ändern. + +Lesegeschwindigkeit +~~~~~~~~~~~~~~~~~~~ + +wallabag berechnet die Lesezeit für jeden Artikel. Du kannst hier definieren, dank dieser Liste, ob du +ein schneller oder langsamer Leser bist. wallabag wird die Lesezeit für jeden Artikel neu berechnen. + +Sprache +~~~~~~~ + +Du kannst die Sprache von der wallabag Benutzeroberfläche ändern. Du musst die ausloggen, damit diese +Änderung Wirkung zeigt. + +RSS +--- + +wallabag stellt RSS Feeds für jeden Artikelstatus bereit: ungelesen, Favoriten und Archiv. + +Als erstes musst du einen persönlciehn Token erstellen: Klicke auf ``Token generieren``. +Es ist möglich deinen Token zu ändern, indem du auf ``Token zurücksetzen`` klickst. + +Jetzt hast du drei Links, einen für jeden Status: Füge sie in deinem liebsten Feedreader hinzu. + +Du kannst auch definieren wie viele Artikel du in deinem RSS Feed (Standardwert: 50) haben willst. + +Benutzer-Informationen +---------------------- + +Du kannst deinen Namen ändern, deine E-Mail-Adresse und die Zwei-Faktor-Authentifizierung aktivieren. + +Zwei-Faktor-Authentifizierung +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Die Zwei-Faktor-Authentifizierung (2FA) dient dem Identitätsnachweis eines Nutzers mittels der + Kombination zweier verschiedener und insbesondere unabhängiger Komponenten (Faktoren). + +https://de.wikipedia.org/wiki/Zwei-Faktor-Authentifizierung + +Wenn du 2FA aktivierst, erhälst du jedes Mal, wenn du dich bei wallabag einloggen willst, einen Code per +Mail. Du musst den Code in das folgende Formular eingeben. + +.. image:: ../../img/user/2FA_form.png + :alt: Zwei-Faktor-Authentifizierung + :align: center + +Wenn du nicht jedes Mal, wenn du dich einloggen willst, einen Code zugesendet bekommen möchtest, kannst du +die Checkbox ``Ich bin an einem persönlichen Computer`` anhaken: wallabag wird sich an dich für 15 Tage +erinnern. + +Passwort +-------- + +Du kannst dein Passwort hier ändern (8 Zeichen Minimum). + +Tagging-Regeln +-------------- + +Wenn du automatisch einen Tag zu einem neuen Artikel zuweisen lassen möchtest, ist dieser Teil der +Konfiguration, was du suchst. + +Was ist mit Tagging-Regeln gemeint? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Dies sind Regeln, die von wallabag genutzt werden, um neue Artikel automatisch zu taggen +Jedes Mal, wenn ein neuer Artikel hinzugefügt wird, werden alle Tagging-Regeln genutzt, um deine +konfigurierten Tags hinzuzufügen, folglich um dir den Aufwand zu sparen, die Artikel manuell einzuteilen. + +Wie benutze ich sie? +~~~~~~~~~~~~~~~~~~~~ + +Nehmen wir an, du möchtest neuen Artikeln einen Tag *schnell gelesen*, wenn du die Lesezeit kleiner als +3 Minuten ist. +In diesem Fall solltest du in das Regelfeld "readingTime <= 3" eintragen und *schnell gelesen* in das Tags-Feld. +Mehrere Tags können gleichzeitig hinzugefügt werden, wenn man sie mit einem Komma trennt: +*schnell gelesen, Pflichtlektüre*. +Komplexe Regeln können mit vordefinierten Operatoren geschrieben werden: +Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu lesen, github*. + +Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen: + +=========== ============================================== ======== ========== +Variable Bedeutung Operator Bedeutung +----------- ---------------------------------------------- -------- ---------- +title Titel des Artikels <= Kleiner gleich als… +url URL des Artikels < Kleiner als… +isArchived Ob der Artikel archiviert ist oder nicht => Größer gleich als… +isStarred Ob der Artikel favorisiert ist oder nicht > Größer als… +content Inhalt des Eintrags = Gleich zu… +language Sprache des Eintrags != Nicht gleich zu… +mimetype MIME-Typ des Eintrags OR Eine Regel oder die andere +readingTime Die geschätzte Lesezeit in Minuten AND Eine Regel und die andere +domainName Der Domain-Name des Eintrags matches Testet, dass ein Feld einer Suche (unabhängig von Groß- und Kleinschreibung) übereinstimmt. Z.B.: title matches "Fußball" +=========== ============================================== ======== ========== diff --git a/docs/de/user/create_account.rst b/docs/de/user/create_account.rst new file mode 100644 index 00000000..ce1b02a4 --- /dev/null +++ b/docs/de/user/create_account.rst @@ -0,0 +1,25 @@ +Account erstellen +================= + +Klicke auf der Loginseite auf den ``Registrieren`` Button- + +.. image:: ../../img/user/registration_form.png + :alt: Registrierungsformular + :align: center + +Du musst das Formular ausfüllen. Bitte stelle sicher, dass du eine gültige +E-Mail-Adresse eingibst, wir werden dir eine Aktivierungsmail schicken. + +.. image:: ../../img/user/sent_email.png + :alt: E-Mail wurde gesendet, um Account zu aktivieren + :align: center + +Überprüfge deinen Posteingang, du hast jetzt eine neue Mail mit einem Link wie diesen +``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. +Klicke auf den Link, um deinen Account zu aktivieren. + +Dein Account ist nun aktiviert. + +.. image:: ../../img/user/activated_account.png + :alt: Willkommen! + :align: center diff --git a/docs/de/user/download_articles.rst b/docs/de/user/download_articles.rst new file mode 100644 index 00000000..6f5384b2 --- /dev/null +++ b/docs/de/user/download_articles.rst @@ -0,0 +1,17 @@ +Artikel herunterladen +===================== + +Du kannst jeden Artikel in verschiedenen Formaten herunterladen: ePUB, MOBI, PDF, XML, JSON, CSV. + +In der Artikelansicht, klickst du auf dieses Icon in der Seitenleiste: + +.. image:: ../../img/user/download_article.png + :alt: Artikel herunterladen + :align: center + +Du kannst auch eine ganze Kategorie (ungelesen, Favoriten, Archiv) in diesen Formaten herunterladen. +Zum Beispiel, in der Ansicht **Ungelesen**, klickst du auf das Icon in der oberen Leiste: + +.. image:: ../../img/user/download_articles.png + :alt: Artikel herunterladen + :align: center diff --git a/docs/de/user/errors_during_fetching.rst b/docs/de/user/errors_during_fetching.rst new file mode 100644 index 00000000..b8e3e999 --- /dev/null +++ b/docs/de/user/errors_during_fetching.rst @@ -0,0 +1,28 @@ +Fehler während des Artikelladens +================================ + +Warum schlägt das Laden eines Artikels fehl? +-------------------------------------------- + +Das kann verschiedene Ursachen haben: + +- Netzwerkprobleme +- wallabag kann den Inhalt aufgrund der Websitestruktur nicht laden + +Wie kann ich helfen das zu beheben? +----------------------------------- + +- `indem du uns eine Mail mit der URL des Artikels sendest `_ +- indem du versuchst das Laden des Artikels durch Erstellen einer Datei für den Artikel + selbst zu beheben + Du kannst `dieses Tool `__ nutzen. + +Wie kann ich versuchen, einen Artikel erneut zu laden? +------------------------------------------------------ + +Wenn wallabag beim Laden eines Artikels fehlschlägt, kannst du auf den erneut laden Button +klicken (der dritte in dem unteren Bild). + +.. image:: ../../img/user/refetch.png + :alt: Inhalt neu laden + :align: center diff --git a/docs/de/user/faq.rst b/docs/de/user/faq.rst new file mode 100644 index 00000000..1a199c1c --- /dev/null +++ b/docs/de/user/faq.rst @@ -0,0 +1,45 @@ +Häufig gestellte Fragen +========================== + +Während der Installation sehe ich den Fehler ``Error Output: sh: 1: @post-cmd: not found`` +------------------------------------------------------------------------------------------ + +Es scheint, dass du ein Problem bei deiner ``composer`` Installation hast. Versuche es zu deinstallieren und neu zu installieren. + +`Lies die Dokumentation über composer, um zu erfahren wie es installiert wird +`__. + +Ich kann das Registrierungsformular nicht validieren +---------------------------------------------------- + +Stelle sicher, dass alle Felder ausgefüllt sind: + +* valide E-Mail-Adresse +* das gleiche Passwort in zwei Feldern + +Ich erhalte meine Aktivierungsmail nicht +---------------------------------------- + +Bist du sicher, dass deine eingegebene E-Mail-Adresse korrekt war? Hast du deinen Spamordner überprüft? + +Wenn du dann immer noch nicht deine Aktivierungsmail siehst, stelle bitte sicher, dass du einen MTA +korrekt installiert und eingerichtet hast. Prüfe, dass deine Firewallregel existiert, z.B. für firewalld: + +:: + firewall-cmd --permanent --add-service=smtp + firewall-cmd --reload + +Schließlich, falls du SELinux aktiviert hast, setze folgende Regel: + +``setsebool -P httpd_can_sendmail 1`` + +Wenn ich den Aktivierungslink klicke, bekomme ich die Nachricht ``Der Nutzer mit dem Bestätigungstoken "DtrOPfbQeVkWf6N" existiert nicht`` +------------------------------------------------------------------------------------------------------------------------------------------ + +Du hast deinen Account schon aktiviert oder die URL der Aktivierungsmail ist falsch. + +Ich habe mein Passwort vergessen +-------------------------------- + +Du kannst dein Passwort zurücksetzen, indem du auf den Link ``Kennwort vergessen?`` auf der Loginseite klickst. Fülle dann das Formular mit deiner E-Mail-Adresse oder deinem Nutzernamen aus +und du wirst eine E-Mail zum Passwort zurücksetzen erhalten. diff --git a/docs/de/user/filters.rst b/docs/de/user/filters.rst new file mode 100644 index 00000000..c9cda6b6 --- /dev/null +++ b/docs/de/user/filters.rst @@ -0,0 +1,49 @@ +Filter +====== + +Um Artikel leichter zu erreichen, kannst du sie filtern. +Klicke auf das dritte Symbol in der oberen Leiste. + +.. image:: ../../img/user/topbar.png + :alt: Obere Leiste + :align: center + +Alle diese Filter können kombiniert werden. + +.. image:: ../../img/user/filters.png + :alt: Kombiniere alle Filter + :align: center + +Status +------ + +Nutze die Checkboxen, um einen archivierten oder favorisierten Artikel zu finden. + +Vorschaubild +--------------- + +Hake diesen Filter an, wenn du Artikel mit einem Vorschaubild erhalten willst. + +Sprache +------- + +wallabag (via graby) kann die Artikelsprache erkennen. Es ist einfach für dich, Artikel +in einer bestimmten Sprache zu filtern. + +Lesezeit +-------- + +wallabag schätzt wieviel Zeit du brauchst, um einen Artikel zu lesen. Mit diesem Filter +kannst du zum Beispiel Artikel mit einer Lesezeit zwischen 2 und 5 Minuten finden. + +Domainname +---------- + +Dank dieses Filters, kannst ud Artikel von der gleichen Domain finden. +Zum Beispiel tippst du in diesem Feld ``bbc.co.uk``, um Artikel dieser Website zu finden. + +Erstellungsdatum +---------------- + +Wenn du Artikel speicherst, merkt sich wallabag das aktuelle Datum. So praktisch, um Aritkel, die +zwischen dem 1. und 31. Januar geschrieben sind, zu finden. diff --git a/docs/de/user/first_article.rst b/docs/de/user/first_article.rst new file mode 100644 index 00000000..b8ceda07 --- /dev/null +++ b/docs/de/user/first_article.rst @@ -0,0 +1,68 @@ +Speichere deinen ersten Artikel +=============================== + +Der Hauptzweck von wallabag ist es Webartikel zu speichern. Du hast viele Wege das zu tun. + +.. note:: + + Eine Schnellstartanleitung wird in der Anwendung angezeigt bis du deinen ersten + Artikel gespeichert hast. + +Durch Nutzung eines Bookmarklets +-------------------------------- + +Auf der ``How-To`` Seite, hast du einen Reiter ``Bookmarklet``. Ziehe und lasse den +``bag it!`` Link in die Lesezeichenleiste deines Browser los. + +Jetzt kannst du immer wenn du einen Artikel im Web liest und ihn du ihn speichern +willst, klicke auf den ``bag it!`` Link in deiner Lesezeichenleiste. Der Artikel +wird gespeichert. + +Durch Nutzung des klassischen Formulars +--------------------------------------- + +In der oberen Leiste auf deinem Bildschirm, hast du drei Icons. Mit dem ersten, einem +Pluszeichen, kannst du einfach neue Artikel speichern. + +.. image:: ../../img/user/topbar.png + :alt: obere Leiste + :align: center + +Klick darauf, um ein neues Feld anzeigen zu lassen, füge deine Artikel URL ein und +drücke die ``Enter`` Taste. Der Artikel wird gespeichert. + +Durch Nutzung eines Browser Add-ons +----------------------------------- + +Firefox +~~~~~~~ + +*Dieses Addon ist noch nicht für wallbag v2 verfügbar*. + +Chrome +~~~~~~ + +*Dieses Addon ist noch nicht für wallbag v2 verfügbar*. + +Durch Nutzung deiner Smartphone App +----------------------------------- + +Android +~~~~~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. + +Firefox OS +~~~~~~~~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. + +Windows Phone +~~~~~~~~~~~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. + +iOS +~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. diff --git a/docs/de/user/import.rst b/docs/de/user/import.rst new file mode 100644 index 00000000..ecd3134b --- /dev/null +++ b/docs/de/user/import.rst @@ -0,0 +1,46 @@ +Migration von einem Drittanbieter +================================= + +Von Pocket +----------- + +Erstelle eine neue Applikation in Pocket +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Um deine Daten von Pocket zu importieren, nutzen wir die Pocket API. Du musst +eine neue Applikation auf ihrer Entwicklerwebsite erstellen, um fortzufahren. + +* Erstelle eine neue Applikation `auf der Entwicklerwebsite `_ +* Fülle die erforderlichen Felder aus: Name, Beschreibung, Berechtigungen (nur **abrufen**), Plattform + (**web**), akzeptiere die Nutzungsbedingungen und reiche deine neue Applikation ein + +Pocket wird dir einen **Consumer Key** geben (z.B. `49961-985e4b92fe21fe4c78d682c1`). +Du musst den ``pocket_consumer_key`` in dem Abschnitt ``Import`` in dem ``Interne Einstellungen`` Menü +konfigurieren. + +Jetzt ist alles in Ordnung, um von Pocket zu migrieren. + +Importiere deine Daten in wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Klicke auf den ``Importieren`` Link im menü, auf ``Inhalte importieren`` in dem Pocketabschnitt und +dann auf ``Verbinde mit Pocket und importieren Daten``. + +Du musst wallabag erlauben, mit deinem Pocketaccount zu interagieren. +Deine Daten werden importiert. Datenimport kann ein sehr anspruchsvoller Prozess für deinen Server +sein (wir müssen daran arbeiten, um diesen Import zu verbessern). + +Von Instapaper +-------------- + +*Funktion noch nicht implementiert in wallabag v2.* + +Von Readability +--------------- + +*Funktion noch nicht implementiert in wallabag v2.* + +Von einer HTML oder JSON Datei +------------------------------ + +*Funktion noch nicht implementiert in wallabag v2.* diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst new file mode 100644 index 00000000..37a80170 --- /dev/null +++ b/docs/de/user/installation.rst @@ -0,0 +1,326 @@ +Installation von wallabag +========================= + +Voraussetzungen +--------------- + +wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. + +Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell +nicht alle folgenden Pakete installieren. + +- php-session +- php-ctype +- php-dom +- php-hash +- php-simplexml +- php-json +- php-gd +- php-mbstring +- php-xml +- php-tidy +- php-iconv +- php-curl +- php-gettext +- php-tokenizer + +wallabag nutzt PDO, um sich mit der Datenbank zu verbinden, darum benötigst du eines der folgenden Komponenten: + +- pdo_mysql +- pdo_sqlite +- pdo_pgsql + +und dessen dazugehörigen Datenbankserver. + +Installation +------------ + +Auf einem dedizierten Webserver (empfohlener Weg) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. + +Composer installieren: + +:: + + curl -s http://getcomposer.org/installer | php + +Du kannst eine spezifische Anleitung `hier `__ finden: + +Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: + +:: + + git clone https://github.com/wallabag/wallabag.git + cd wallabag + git checkout 2.0.5 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console wallabag:install --env=prod + +Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: + +:: + + php bin/console server:run --env=prod + +Und wallabag unter http://deineserverip:8000 erreichen + +.. tip:: + + Um Parameter mit Umgebungsvariable zu definieren, musst du die Variable mit dem ``SYMFONY__`` Präfix setzen. Zum Beispiel ``SYMFONY__DATABASE_DRIVER``. Du kannst einen Blick die `Symfony Dokumentation `__ werfen. + +Auf einem geteilten Webhosting +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Wir stellen ein Paket inkl. aller Abhängigkeiten bereit. +Die Standardkonfiguration nutzt SQLite für die Datenbank. Wenn du diese Einstellung ändern willst, ändere bitte ``app/config/parameters.yml``. + +Wir haben bereits einen Nutzer erstellt: Login und Passwort sind ``wallabag``. + +.. caution:: Mit diesem Paket überprüft wallabag nicht die von der Applikation gebrauchten Exentions (diese Tests werden während ``composer install`` durchgeführt wenn du einen dedizierten Webserver hast, siehe oben). + +Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacken: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. +Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. + +Installation mit Docker +------------------------ + +Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub `__, um mehr Informationen zu erhalten. + +Kommando, um den Container zu starten +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: bash + + docker pull wallabag/wallabag + +Virtualhosts +------------ + +Konfiguration von Apache +~~~~~~~~~~~~~~~~~~~~~~~ + +Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag: + +:: + + + ServerName domain.tld + ServerAlias www.domain.tld + + DocumentRoot /var/www/wallabag/web + + AllowOverride None + Order Allow,Deny + Allow from All + + + Options -MultiViews + RewriteEngine On + RewriteCond %{REQUEST_FILENAME} !-f + RewriteRule ^(.*)$ app.php [QSA,L] + + + + # uncomment the following lines if you install assets as symlinks + # or run into problems when compiling LESS/Sass/CoffeScript assets + # + # Options FollowSymlinks + # + + # optionally disable the RewriteEngine for the asset directories + # which will allow apache to simply reply with a 404 when files are + # not found instead of passing the request into the full symfony stack + + + RewriteEngine Off + + + ErrorLog /var/log/apache2/wallabag_error.log + CustomLog /var/log/apache2/wallabag_access.log combined + + +Nach dem du Apache neugeladen oder neugestartet hast, solltest du nun wallabag unter http://domain.tld erreichen. + +Konfiguration von Nginx +~~~~~~~~~~~~~~~~~~~~~~~ + +Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag: + +:: + + server { + server_name domain.tld www.domain.tld; + root /var/www/wallabag/web; + + location / { + # try to serve file directly, fallback to app.php + try_files $uri /app.php$is_args$args; + } + location ~ ^/app\.php(/|$) { + fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_split_path_info ^(.+\.php)(/.*)$; + include fastcgi_params; + # When you are using symlinks to link the document root to the + # current version of your application, you should pass the real + # application path instead of the path to the symlink to PHP + # FPM. + # Otherwise, PHP's OPcache may not properly detect changes to + # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126 + # for more information). + fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name; + fastcgi_param DOCUMENT_ROOT $realpath_root; + # Prevents URIs that include the front controller. This will 404: + # http://domain.tld/app.php/some-path + # Remove the internal directive to allow URIs like this + internal; + } + + error_log /var/log/nginx/wallabag_error.log; + access_log /var/log/nginx/wallabag_access.log; + } + +Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen. + +.. tip:: + + When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. + Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``. + +Konfiguration von lighttpd +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein): + +:: + + server.modules = ( + "mod_fastcgi", + "mod_access", + "mod_alias", + "mod_compress", + "mod_redirect", + "mod_rewrite", + ) + server.document-root = "/var/www/wallabag/web" + server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) + server.errorlog = "/var/log/lighttpd/error.log" + server.pid-file = "/var/run/lighttpd.pid" + server.username = "www-data" + server.groupname = "www-data" + server.port = 80 + server.follow-symlink = "enable" + index-file.names = ( "index.php", "index.html", "index.lighttpd.html") + url.access-deny = ( "~", ".inc" ) + static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" ) + compress.cache-dir = "/var/cache/lighttpd/compress/" + compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" ) + include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port + include_shell "/usr/share/lighttpd/create-mime.assign.pl" + include_shell "/usr/share/lighttpd/include-conf-enabled.pl" + dir-listing.activate = "disable" + + url.rewrite-if-not-file = ( + "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2", + "^/([^?]*)" => "/app.php?=$1", + ) + +Rechte, um das Projektverzeichnis zu betreten +--------------------------------------------- + +Testumgebung +~~~~~~~~~~~~ + +Wenn wir nur wallabag testen wollen, führen wir nur das Kommando ``php bin/console server:run --env=prod`` aus, um unsere wallabag Instanz zu starten und alles wird geschmeidig laufen, weil der Nutzer, der das Projekt gestartet hat, den aktuellen Ordner ohne Probleme betreten kann. + +Produktionsumgebung +~~~~~~~~~~~~~~~~~~~ + +Sobald wir Apache oder Nginx nutzen, um unsere wallabag Instanz zu erreichen, und nicht das Kommando ``php bin/console server:run --env=prod`` nutzen, sollten wir dafür sorgen, die Rechte vernünftig zu vergeben, um die Ordner des Projektes zu schützen. + +Um dies zu machen, muss der Ordner, bekannt als ``DocumentRoot`` (bei Apache) oder ``root`` (bei Nginx), von dem Apache-/Nginx-Nutzer zugänglich sein. Sein Name ist meist ``www-data``, ``apache`` oder ``nobody`` (abhängig vom genutzten Linuxsystem). + +Der Ordner ``/var/www/wallabag/web`` musst dem letztgenannten zugänglich sein. Aber dies könnte nicht genug sein, wenn wir nur auf diesen Ordner achten, weil wir eine leere Seite sehen könnten oder einen Fehler 500, wenn wir die Homepage des Projekt öffnen. + +Dies kommt daher, dass wir die gleichen Rechte dem Ordner ``/var/www/wallabag/var`` geben müssen, so wie wir es für den Ordner ``/var/www/wallabag/web`` gemacht haben. Somit beheben wir das Problem mit dem folgenden Kommando: + +.. code-block:: bash + + chown -R www-data:www-data /var/www/wallabag/var + +Es muss analog für die folgenden Ordner ausgeführt werden + +* /var/www/wallabag/bin/ +* /var/www/wallabag/app/config/ +* /var/www/wallabag/vendor/ +* /var/www/wallabag/data/ + +durch Eingabe der Kommandos + +.. code-block:: bash + + chown -R www-data:www-data /var/www/wallabag/bin + chown -R www-data:www-data /var/www/wallabag/app/config + chown -R www-data:www-data /var/www/wallabag/vendor + chown -R www-data:www-data /var/www/wallabag/data/ + +ansonsten wirst du früher oder später folgenden Fehlermeldung sehen: + +.. code-block:: bash + + Unable to write to the "bin" directory. + file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied + file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied + +Zusätzliche Regeln für SELinux +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Wenn SELinux in deinem System aktiviert ist, wirst du zusätzliche Kontexte konfigurieren müssen damit wallabag ordentlich funktioniert. Um zu testen, ob SELinux aktiviert ist, führe einfach folgendes aus: + +``getenforce`` + +Dies wird ``Enforcing`` ausgeben, wenn SELinux aktiviert ist. Einen neuen Kontext zu erstellen, erfordert die folgende Syntax: + +``semanage fcontext -a -t `` + +Zum Beispiel: + +``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"`` + +Dies wird rekursiv den httpd_sys_content_t Kontext auf das wallabag Verzeichnis und alle darunterliegenden Dateien und Ordner anwenden. Die folgenden Regeln werden gebraucht: + ++-----------------------------------+----------------------------+ +| Vollständiger Pfad | Kontext | ++===================================+============================+ +| /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` | ++-----------------------------------+----------------------------+ + +Nach dem diese Kontexte erstellt wurden, tippe das folgende, um deine Regeln anzuwenden: + +``restorecon -R -v /var/www/wallabag`` + +Du kannst deine Kontexte in einem Verzeichnis überprüfen, indem du ``ls -lZ`` tippst und alle deine aktuellen Regeln mit ``semanage fcontext -l -C`` überprüfst. + +Wenn du das vorkonfigurierte latest-v2-package installierst, dann ist eine weitere Regel während der Installation nötig: + +``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"`` + +Nachdem du erfolgreich dein wallabag erreichst und die Installation fertiggestellt hast, kann dieser Kontext entfernt werden: + +:: + + semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var" + retorecon -R -v /var/www/wallabag/var diff --git a/docs/de/user/login.rst b/docs/de/user/login.rst new file mode 100644 index 00000000..cf1cdc4c --- /dev/null +++ b/docs/de/user/login.rst @@ -0,0 +1,13 @@ +Login +===== + +Dein Account ist nun aktiviert, Glückwünsch! + +Um dich bei wallabag einzuloggen, fülle das Formular auf der Loginseite aus. + +Wenn du an deinem persönlichen Computer arbeitest und verbunden bleiben willst, +kannst du die Checkbox ``Angemeldet bleiben`` anhaken: wallabag wird sich für ein Jahr an deinen Login erinnern. + +.. image:: ../../img/user/login_form.png + :alt: Loginformular + :align: center diff --git a/docs/de/user/migration.rst b/docs/de/user/migration.rst new file mode 100644 index 00000000..bc8a61b0 --- /dev/null +++ b/docs/de/user/migration.rst @@ -0,0 +1,62 @@ +Migration von v1 oder v2 +======================== + +Von wallabag 1.x +----------------- + +Wenn du bisher wallabag v1.x genutzt hast, musst du deine Daten exportieren bevor du zu wallabag v2.x migrierst, weil die Applikation und ihre Datenbank sich stark geändert haben. In deiner alten wallabag Installation kannst du deine Daten auf der Konfigurationsseite exportieren. + +.. image:: ../../img/user/export_v1.png + :alt: Export von wallabag v1 + :align: center + +.. note:: + Wenn du mehrere Accounts auf der gleichen Instanz von wallabag hast, muss jeder Nutzer von v1 exportieren und in v2 seine Daten importieren. + +.. note:: + Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen `__. + +Wenn du eine JSON Datei mit deinen Artikeln erhalten hast, kannst du wallabag v2 installieren falls benötigt durch Befolgen `der Standardprozedur `__. + +Nachdem du einen Nutzerkonto auf deiner neuen wallabag v2 Instanz eingerichtet hast, kannst du zu dem Abschnitt `Import` springen und `Import von wallabag v1` auswählen. Wähle deine JSON Datei aus und lade sie hoch. + +.. image:: ../../img/user/import_wallabagv1.png + :alt: Import von wallabag v1 + :align: center + +Import via command-line interface (CLI) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Wenn du CLI Zugang zu deinem Webserver hast, kannst du dieses Kommando ausführen, um deine Aritkel vom wallabag v1 Export zu importieren: + +:: + + bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod + +Bitte ersetze folgende Werte: + +* ``1`` ist die Nutzer ID in der Databank (Die ID von dem ersten erstellten Nutzer in wallabag ist 1) +* ``~/Downloads/wallabag-export-1-2016-04-05.json`` ist der Pfad zu deinem wallabag v1 Export + +Du wirst eine solche Ausgabe erhalten: + +:: + + Start : 05-04-2016 11:36:07 --- + 403 imported + 0 already saved + End : 05-04-2016 11:36:09 --- + +Von wallabag 2.x +---------------- + +In der vorherigen wallabag Instanz, gehe zu `Alle Artikel` und exportiere diese Artikel als JSON. + +.. image:: ../../img/user/export_v2.png + :alt: Export von wallabag v2 + :align: center + +In deiner neuen wallabag Instanz erstellst du ein Nutzerkonto und klickst auf den Link im Menü, um den Import fortzusetzen. Wähle Import von wallabag v2 aus und lade deine JSON Datei hoch. + +.. note:: + Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen `__. diff --git a/docs/de/user/tags.rst b/docs/de/user/tags.rst new file mode 100644 index 00000000..8ddc0f40 --- /dev/null +++ b/docs/de/user/tags.rst @@ -0,0 +1,2 @@ +Tags +==== \ No newline at end of file diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst new file mode 100644 index 00000000..13e3104f --- /dev/null +++ b/docs/de/user/upgrade.rst @@ -0,0 +1,32 @@ +Wallabag updaten +================ + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.3`` mit der neuesten Releasenummer): + +:: + + git fetch origin + git fetch --tags + git checkout 2.0.3 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index f681d874..f4c55dea 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst @@ -108,7 +108,7 @@ Variable Meaning Operator Meaning title Title of the entry <= Less than… url URL of the entry < Strictly less than… isArchived Whether the entry is archived or not => Greater than… -isStared Whether the entry is starred or not > Strictly greater than… +isStarred Whether the entry is starred or not > Strictly greater than… content The entry's content = Equal to… language The entry's language != Not equal to… mimetype The entry's mime-type OR One rule or another diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst index 89305998..278f0022 100644 --- a/docs/fr/user/configuration.rst +++ b/docs/fr/user/configuration.rst @@ -110,7 +110,7 @@ Variable Sens Opérateur Sens title Titre de l'article <= Inférieur ou égal à … url URL de l'article < Strictement inférieur à … isArchived Si l'article est archivé ou non => Supérieur ou égal à … -isStared Si l'article est en favori ou non > Strictement supérieur à … +isStarred Si l'article est en favori ou non > Strictement supérieur à … content Le contenu de l'article = Égal à … language La langue de l'article != Différent de … mimetype The type MIME de l'article OR Telle règle ou telle autre règle -- cgit v1.2.3