NB-Public
/
WolKal3000
Archived
11
1
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity
This repository has been archived on 2024-01-12. You can view files and clone it, but cannot push or open issues or pull requests.
WolKal3000/README.md

85 lines
5.1 KiB
Markdown
Raw Normal View History

Fork to WolKal3000 and rename project occurences accordingly Signed-off-by: willi.junga <willi.junga@gruene-treptow-koepenick.de>
2020-05-30 14:01:34 +02:00
# WolKal3000
initial version.
2019-03-27 11:07:40 +01:00
Fork to WolKal3000 and rename project occurences accordingly Signed-off-by: willi.junga <willi.junga@gruene-treptow-koepenick.de>
2020-05-30 14:01:34 +02:00
Ein Wordpress-Plugin, das auf das Grüne Wordpress-Theme <a href="https://www.urwahl3000.de/">Urwahl3000</a> aufsetzt und eine Integration beliebig vieler öffentlicher ICS-Kalender ermöglicht.
version 0.2.0 redactions
2019-04-01 15:56:15 +02:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
Version: 0.3.9
added work in progress warning
2019-03-27 11:30:55 +01:00
## Warnung
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
Das hier ist noch in einem frühen Entwicklungsstadium aber durch die Begrenzung auf eine (vertrauenswürdige!) Quelle, sollte sich möglicher Schaden in Grenzen halten.
initial version.
2019-03-27 11:07:40 +01:00
## Motivation
Für eine solche Integration gibt es eine Reihe von Motivatoren:
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
* Termine werden in Regel bereits in einem Kalender gepflegt. Die Arbeit diese auch noch manuell in das CMS zu übernehmen entfällt.
* Der Umgang mit Terminen im Quellsystem (z.B. der Wolke) ist u.U. leichter handzuhaben als im CMS
initial version.
2019-03-27 11:07:40 +01:00
* So schön Urwahl3000 ist - der auf wpCalendar basierende kal3000 Kalender unterstützt keine Serientermine. Mit diesem Plugin ist das kein Problem mehr, da es Serientermine im Google Kalender automatisch als Serie von Einzelterminen anlegt.
## Eigenschaften
* Administration in Wordpress über die Admin-Oberfläche.
Fork to WolKal3000 and rename project occurences accordingly Signed-off-by: willi.junga <willi.junga@gruene-treptow-koepenick.de>
2020-05-30 14:01:34 +02:00
* Einbinden beliebig vieler ICS-Kalender.
* Zuordnung dieser ICS-Kalender zu bereits angelegten Terminkategorien, beispielsweise KV Allgemein, AG Klima etc..
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
* Multi-Site fähig
initial version.
2019-03-27 11:07:40 +01:00
## Voraussetzungen / Installation
1. Um eine auf Urwahl3000 und Wordpress basierende KV- oder OV-Seite betreiben zu können, braucht man zunächst eine irgendwo gehostete aktuelle Wordpress-Umgebung. Dazu wird auf die Dokumentation von Urwahl3000 verwiesen.
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
2. Als nächstes holt man sich das Plugin unter <a href="https://git.verdigado.com/NB-Public/WolKal3000/releases">https://git.verdigado.com/NB-Public/WolKal3000/releases</a> und installiert es über die WP-Oberfläche wie gewohnt.
initial version.
2019-03-27 11:07:40 +01:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
Hinweis: WolKal3000 nutzt für das Parsen von ICAL-Files und -Feeds das PHP-Modul icalparser (https://github.com/OzzyCzech/icalparser). Bei einem Clone des Repositories sollte daher rekursiv inkl. Submodules gecloned werden, alternativ muss icalparserer manuell im WolKal3000-Plugin-Verzeichnis installiert werden.
initial version.
2019-03-27 11:07:40 +01:00
some editorial additions and changes
2019-03-29 00:26:17 +01:00
## Konfiguration
initial version.
2019-03-27 11:07:40 +01:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
1. In der Konfiguration (wolkal3000-config.php) sind die globalen Konfigurationsvariablen WOLKAL_PREFIX und WOLKAL_SUFFIX ggf. anzupassen. Für die Grüne Wolke der Netzbegrünung sind die Default Werte ausreichend:
define ('WOLKAL_PREFIX', 'https://wolke.netzbegruenung.de/remote.php/dav/public-calendars/');
define ('WOLKAL_SUFFIX', '?export');
initial version.
2019-03-27 11:07:40 +01:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
2. in WP legt man Terminkategorien an, z.B. eine pro Kampagne oder Verband aus dem die Nachrichten kommen.
initial version.
2019-03-27 11:07:40 +01:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
3. Im Admin-Teil des Plugins unter "Einstellungen / WolKal3000" erscheinen die angelegten Terminkategorien. Jeder Kategorie weist man dann einen öffentlichen (keine Authentifizierung möglich!) Kalender in Form der 16-stelligen öffentlichen Kalender Freigabe-ID zu, beispielsweise "SEZ0123456789ABC".
initial version.
2019-03-27 11:07:40 +01:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
4. Im Admin-Teil kann man das Zeitintervall einstellen, mit dem die Kalender synchronisiert werden. Standardeinstellung ist 60 Minuten. Bitte beachten, dass der Wordpress-Scheduler die Zeitintervalle nur ungefähr und abhängig von der Seitenaktivität einhält.
initial version.
2019-03-27 11:07:40 +01:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
5. Im Admin-Teil kann man das Geocoding aktivieren. Derzeit ist nur ein experimenteller Weg über OpenStreetMap verfügbar.
6. Speichern und fertig.
some editorial additions and changes
2019-03-29 00:26:17 +01:00
added debugging settings
2019-04-08 14:21:11 +02:00
Unter "Debugging" finden sich zwei weitere Einstellungen:
bumped to v. 0.3.1
2019-04-09 21:15:18 +02:00
1. zum einen kann man ein Debug-Logging aktivieren, mit dem das Plugin Einträge in ${APACHE_LOG_DIR}/error.log schreibt. NONE schreibt nichts, CRIT (critical) am wenigsten, INFO (alles) am meisten.
added debugging settings
2019-04-08 14:21:11 +02:00
2. Die zweite Einstellung löscht den Geocoding-Cache bei jedem Plugin-Neustart, um das Geocoding für jede Lokation neu zu erzwingen, beispielsweise wenn man die Geocoding-Methode geändert hat.
some editorial additions and changes
2019-03-29 00:26:17 +01:00
## Benutzung
Fork to WolKal3000 and rename project occurences accordingly Signed-off-by: willi.junga <willi.junga@gruene-treptow-koepenick.de>
2020-05-30 14:01:34 +02:00
Um die Termine in WP anzuzeigen, gibt es zwei Wege:
* Das Termine-Widget in der rechten Spalte zeigt immer alle Termine an.
* Darüber hinaus kann man beispielsweise pro OV eine Unterseite mit dem
Titel "OV Termine" anlegen, in der folgender Shortcode steht:
`[wpcalendar kat=TERMINKATEGORIE]`.
Auf dieser Seite werden dann nur die Termine des dazugehörigen OV angezeigt.
some editorial additions and changes
2019-03-29 00:26:17 +01:00
Mit "Aktivieren" beginnt das Plugin sofort mit der Synchronisation.
initial version.
2019-03-27 11:07:40 +01:00
added proxy section
2019-03-27 13:48:32 +01:00
## Proxy-Konfiguration
initial version.
2019-03-27 11:07:40 +01:00
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
Das Plugin benötigt den Zugriff nach "draußen", um ICAL-Feeds zu holen oder auf OpenStreetMap zuzugreifen. Wenn Du mit Deinem Wordpress-Server hinter einer Firewall bist, musst Du möglicherweise über einen Proxy nach draußen gehen. In Wordpress werden Proxy-Einstellungen in <code>/usr/share/wordpress/wp-config.php</code> bzw. auf Ubuntu / Debian in <code>/etc/wordpress/config-SIT
E.php</code> festgelegt. Zur Dokumentation bitte <a href="https://developer.wordpress.org/reference/classes/wp_http_proxy/">hier entlang</a>.
initial version.
2019-03-27 11:07:40 +01:00
## Support
Fork to WolKal3000 and rename project occurences accordingly Signed-off-by: willi.junga <willi.junga@gruene-treptow-koepenick.de>
2020-05-30 14:01:34 +02:00
Bitte ein Ticket (issue) auf https://git.verdigado.com/NB-Public/WolKal3000/issues
initial version.
2019-03-27 11:07:40 +01:00
minor changes
2019-03-28 16:37:03 +01:00
## Bekannte Fehler
vorkonfiguriert fuer die Wolke (#13) * redundante readme.txt entfernt * GCAL namespace auf wolkal3000 geändert (Dateinamen, WP options) (dadurch ggf. Co-Existenz mit dem ursprüinglichen GCal-Plugin möglich!) * Vorkonfiguration für die Wolke, man braucht nur die 16-stellige Kalender ID (dadurch Security Verbesserung: kein dynamisches Laden von potentiell nicht vertrauenswürdigen Inhalten) * Google Maps Funktionen entfernt **Bei Migration von <= 0.3.8 bitte das alte Plugin per "uninstall" deinstallieren, damit die Daten im alten Namespace gelöscht werden. Achtung: Die Konfiguration muss (im neuen Namespace) neu vorgenommen werden!** Co-authored-by: Christian Tramnitz <christian.tramnitz@gruene-hochtaunus.de> Reviewed-on: https://git.verdigado.com/NB-Public/WolKal3000/pulls/13 Co-Authored-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com> Co-Committed-By: Christian Tramnitz <christian.tramnitz@git@verdigado.com>
2021-01-18 17:26:45 +01:00
siehe Support
initial version.
2019-03-27 11:07:40 +01:00
added internationalization section.
2019-03-27 11:10:04 +01:00
## Internationalization
initial version.
2019-03-27 11:07:40 +01:00
version 0.2.0 redactions
2019-04-01 15:56:15 +02:00
Since this plugin is only relevant for people using the Urwahl3000 theme, and this includes only members of Bündnis 90 / Die Grünen, the user interface of the plugin will only be available in German. Should a demand for other languages arise, feel free to contact me - contributions welcome! :-)
initial version.
2019-03-27 11:07:40 +01:00