inhaus-plugin-monatsspruch/README.md

54 lines
2.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Inhaus-Plugin „Monatsspruch“
Zeigt den **Monatsspruch der Ökumenischen Arbeitsgemeinschaft für Bibellesen (ÖAB)**
als Kachel auf der Startseite des Inhaus-Mitarbeiterportals.
- Lädt die Monatssprüche eines Jahres automatisch von
[oeab.de/monatssprueche](https://www.oeab.de/monatssprueche) (einmal im Monat; ab Dezember
auch das kommende Jahr) und speichert sie – fällt oeab.de aus, bleibt der Spruch stehen.
- Kachel mit Text, Bibelstelle, Übersetzung und Quellenhinweis; Position und Sichtbarkeit wie
jede Kachel unter **Administration → Portal → Startseite**.
- **Administration → Portal → Monatsspruch:** Übersicht des Jahres, „Jetzt laden“ und eigene
Angaben für einzelne Monate (z. B. bei Abruffehlern).
> oeab.de bietet keine Schnittstelle; gelesen wird die öffentliche Jahresseite. Ändert sich deren
> Aufbau, meldet die Admin-Seite den Fehler, und der zuletzt geladene Spruch bleibt sichtbar.
> Bitte klären Sie die Nutzung der Bibeltexte (Übersetzungen) mit der ÖAB bzw. den Verlagen.
## Voraussetzungen
Inhaus **0.12.0** oder neuer (nutzt die allgemeine Kachel `core::Quote` – kein eigener Build nötig).
## Installation
1. `bin/package` erzeugt `dist/monatsspruch-<version>.zip`
(oder das ZIP aus den Releases dieses Repositorys verwenden).
2. Im Portal unter **Administration → Plugins → Plugin hochladen** das ZIP wählen.
3. Plugin aktivieren – die Sprüche werden sofort geladen.
## Updates
Ab Version 1.1.0 aktualisiert sich das Plugin über Inhaus (ab 0.24.0): Inhaus prüft täglich
die Releases dieses Repositorys (`update_url` in `plugin.json`) und zeigt unter
**Administration → Plugins** „Update verfügbar“ mit „Jetzt aktualisieren“.
Neue Version veröffentlichen: Version in `plugin.json` erhöhen, `bin/package`, Release
`v<version>` mit dem ZIP als Anhang anlegen.
## Entwicklung und Tests
Das Plugin in eine Inhaus-Entwicklungsumgebung nach `plugins/monatsspruch` kopieren oder
verlinken, dort aktivieren und die Tests aus dem Inhaus-Verzeichnis ausführen:
vendor-dev/bin/phpunit plugins/monatsspruch/tests
Aufbau:
| Datei | Zweck |
|---|---|
| `plugin.json` | Manifest (Name, Version, Mindestversion von Inhaus) |
| `src/MonatsspruchPlugin.php` | Kachel und Hintergrundaufgabe registrieren |
| `src/OeabParser.php` | Monatssprüche aus der Jahresseite lesen |
| `src/Verses.php` | Laden, Speichern, eigene Angaben |
| `src/Filament/Pages/MonatsspruchSettings.php` | Admin-Seite |
| `tests/` | Tests inkl. gespeicherter Beispielseite |