Merge pull request #154 from FriendsOfREDAXO/copilot/fix-143

Complete RSS feed documentation with comprehensive examples and usage guide

Author: alxndr-w

README.md

@@ -10,6 +10,7 @@ Mit diesem Addon können News-Beiträge anhand von YForm und YOrm im Backend ver
 * Vollständig mit **YForm** umgesetzt: Alle Features und Anpassungsmöglichkeiten von YForm verfügbar
 * Einfach: Die Ausgabe erfolgt über [`rex_sql`](https://redaxo.org/doku/master/datenbank-queries) oder objektorientiert über [YOrm](https://github.com/yakamara/redaxo_yform/blob/master/docs/04_yorm.md)
 * Flexibel: **Zugriff** über die [YForm Rest-API](https://github.com/yakamara/redaxo_yform/blob/master/docs/05_rest.md)
+* **RSS-Feed** integriert: Vollautomatischer RSS 2.0-Feed mit Kategorie- und Sprachfilterung über `index.php?rex-api-call=neues_rss`
 * Sinnvoll: Nur ausgewählte **Rollen**/Redakteure haben Zugriff
 * Bereit für Multidomain-Newsverwaltung mit YRewrite
 * Bereit für **mehrsprachige** Websites: Reiter für Sprachen auf Wunsch anzeigen oder ausblenden
@@ -27,6 +28,24 @@ Im REDAXO-Installer das Addon `neues` herunterladen und installieren. Anschließ
 
 ![image](https://user-images.githubusercontent.com/3855487/209792457-b6f824dc-7fd8-4295-a7c7-2eab046d19c7.png)
 
+## RSS-Feed
+
+Das Addon bietet einen integrierten RSS 2.0-Feed für News-Einträge:
+
+**Basis-Feed:** `index.php?rex-api-call=neues_rss`
+
+**Mit Filtern:**
+- Nach Kategorie: `index.php?rex-api-call=neues_rss&category_id=3`
+- Nach Sprache: `index.php?rex-api-call=neues_rss&lang_id=2`  
+- Kombiniert: `index.php?rex-api-call=neues_rss&category_id=3&lang_id=2`
+
+**Schöne URLs** können über `.htaccess` eingerichtet werden:
+```apache
+RewriteRule ^feed/?$ index.php?rex-api-call=neues_rss [L]
+```
+
+Detaillierte Dokumentation siehe [docs/07_rss.md](docs/07_rss.md).
+
 ## Lizenz
 
 MIT Lizenz, siehe [LICENSE.md](https://github.com/alexplusde/neues/blob/master/LICENSE)  

docs/07_rss.md

@@ -1,13 +1,105 @@
 # RSS-Feed
 
-> Hinweis: Der RSS-Feed befindet sich noch in Arbeit, es gibt noch kein Datum für die Fertigstellung. Beteilige dich an der Entwicklung, wenn du möchtest.
+Das `Neues`-Addon bietet einen vollständig funktionsfähigen RSS-Feed für News-Einträge über die API-Klasse `FriendsOfRedaxo\Neues\Api\Rss`. Der Feed wird über die URL `index.php?rex-api-call=neues_rss` aufgerufen und liefert einen RSS 2.0-kompatiblen XML-Feed.
 
-Die `rex_api_neues_rss`-Klasse ist Teil des `Neues`-Addons und ermöglicht die Generierung eines RSS-Feeds für News-Einträge. Der Feed wird über die URL `index.php?rex-api-call=neues_rss` aufgerufen. Die Ausgabe wird durch verschiedene URL-Parameter beeinflusst:
+## Grundlegende Verwendung
 
-- `domain_id`: Dieser Parameter ermöglicht es, den Feed auf eine bestimmte Domain zu beschränken. Zum Beispiel wird `index.php?rex-api-call=neues_rss&domain_id=1` verwendet, um den Feed für die Domain mit der ID 1 zu generieren.
+**Standard RSS-Feed (alle Online-Einträge):**
+```
+index.php?rex-api-call=neues_rss
+```
 
-- `lang_id`: Mit diesem Parameter wird der Feed auf eine bestimmte Sprache beschränkt. Zum Beispiel wird `index.php?rex-api-call=neues_rss&lang_id=2` verwendet, um den Feed in der Sprache mit der ID 2 zu generieren.
+## Filteroptionen
 
-- `category_id`: Dieser Parameter ermöglicht es, den Feed auf eine bestimmte Kategorie zu beschränken. Zum Beispiel wird `index.php?rex-api-call=neues_rss&category_id=3` verwendet, um den Feed für die Kategorie mit der ID 3 zu generieren.
+Der RSS-Feed unterstützt verschiedene URL-Parameter zum Filtern der Einträge:
 
-Die Parameter `domain_id`, `lang_id` und `category_id` sind optional und der Feed kann auch ohne diese Parameter generiert werden. Wenn sie nicht angegeben werden, werden alle Domains, Sprachen und Kategorien in den Feed einbezogen.
+### Nach Kategorie filtern
+
+**RSS-Feed für eine bestimmte Kategorie:**
+```
+index.php?rex-api-call=neues_rss&category_id=3
+```
+
+Zeigt nur Einträge aus der Kategorie mit ID 3. Der Feed-Titel und Dateiname werden automatisch an die Kategorie angepasst.
+
+### Nach Sprache filtern
+
+**RSS-Feed mit Spracheinstellung:**
+```
+index.php?rex-api-call=neues_rss&lang_id=2
+```
+
+Setzt die Sprache des RSS-Feeds auf die Sprache mit ID 2. Derzeit beeinflusst dies die `<language>`-Angabe im RSS-Channel.
+
+### Nach Domain filtern
+
+**RSS-Feed mit Domain-Parameter:**
+```
+index.php?rex-api-call=neues_rss&domain_id=1
+```
+
+Parameter für zukünftige Domain-Filterung (noch nicht vollständig implementiert).
+
+### Kombinierte Filter
+
+**RSS-Feed mit mehreren Filtern:**
+```
+index.php?rex-api-call=neues_rss&category_id=3&lang_id=2&domain_id=1
+```
+
+## Schöne URLs mit .htaccess
+
+Für benutzerfreundliche URLs wie `/feed` oder `/rss` kann eine `.htaccess`-Regel verwendet werden:
+
+```apache
+# RSS-Feed auf /feed umleiten
+RewriteRule ^feed/?$ index.php?rex-api-call=neues_rss [L]
+
+# RSS-Feed mit Kategorie auf /feed/kategorie-name umleiten  
+RewriteRule ^feed/([^/]+)/?$ index.php?rex-api-call=neues_rss&category_id=$1 [L]
+
+# Alternativer RSS-Endpunkt
+RewriteRule ^rss/?$ index.php?rex-api-call=neues_rss [L]
+RewriteRule ^rss\.xml$ index.php?rex-api-call=neues_rss [L]
+```
+
+## Beispiel-URLs
+
+```
+# Basis-Feed
+https://example.com/feed
+
+# Feed für Kategorie 1  
+https://example.com/index.php?rex-api-call=neues_rss&category_id=1
+
+# Feed mit deutscher Sprache
+https://example.com/index.php?rex-api-call=neues_rss&lang_id=1
+
+# Feed für Kategorie 3 mit englischer Sprache
+https://example.com/index.php?rex-api-call=neues_rss&category_id=3&lang_id=2
+```
+
+## RSS-Feed-Format
+
+Der generierte RSS-Feed enthält:
+
+- **Channel-Informationen**: Titel (Servername), Beschreibung, Link zur Website
+- **Spracheinstellung**: Automatisch aus `lang_id` wenn angegeben
+- **Einträge**: Titel, Beschreibung (ohne HTML-Tags), Link, Publikationsdatum, GUID
+
+## Programmatische Verwendung
+
+```php
+use FriendsOfRedaxo\Neues\Entry;
+use FriendsOfRedaxo\Neues\Api\Rss;
+
+// Alle Online-Einträge
+$entries = Entry::findOnline();
+$rss = Rss::createRssFeed($entries, 0, 1, 'Mein RSS-Feed');
+
+// Einträge einer bestimmten Kategorie
+$entries = Entry::findOnline(3);
+$rss = Rss::createRssFeed($entries, 0, 1, 'News aus Kategorie 3');
+```
+
+Die Parameter `domain_id`, `lang_id` und `category_id` sind alle optional. Ohne Parameter werden alle Online-Einträge in den Feed einbezogen.