WELT2000 RSS-Feed Script

Das WELT2000-RSS-Feed-Script ist ein sehr einfaches JavaScript, mit dem Du den RSS-Feed "WELT2000 Updates" in eine beliebige Website einbauen kannst. Ein Content-Management-System (CMS) wie Joomla, Drupal oder Typo3 ist dazu nicht erforderlich. Sollte die Site jedoch mit Hilfe eines CMS betrieben werden, ist es besser, statt des WELT2000-RSS-Feed-Scripts dessen Syndication-Funktion zu nutzen.

Features

Mit dem WELT2000-RSS-Feed-Script kannst Du folgende Einzelinformation zu einem Update auf einer Seite anzeigen lassen:

Datum
Titel
Beschreibung
Details-Link Details

Neben den diesen Einzelinformationen, kannst Du auch eine Tabelle mit Informationen zu mehreren Updates erzeugen lassen.

Datum Beschreibung Details

Einbau & Funktion

Dieser Abschnitt beschreibt den Einbau und das Zusammenwirken eines HTML-Dokuments mit dem Feed-Script. Für das Verständnis benötigst Du grundlegende HTML- und JavaScript-Kenntnisse.

Hinweis: We are eating our own dogfood! . Die oben auf dieser Seite angezeigten Update-Informationen sowie die Updates-Tabelle werden mit dem Feed-Script erzeugt. Diese Seite ist also nicht nur Dokumentation sondern gleichzeitig auch ein vollständiges und funktionierendes Beispiel.

Das HTML-Dokument, in dem Du die WELT2000-Update-Informationen angezeigt haben möchtest , muss ein oder mehrere leere HTML-Elemente (z.B. SPAN) enthalten, in denen die Informationen dargestellt werden sollen. Diese Elemente müssen ein ID-Attribut aufweisen. Für jede Einzelinformation (Datum, Titel, Beschreibung und Details-Link) sowie für die Tabelle darf es pro HTML-Dokument jeweils nur ein Element geben. Die Element-ID muss in dem Dokument also einzigartig sein.

Beispiel:

      <html>
        ...
        Datum:   <span id='welt2000UpdatePubDate'></span> 
        Titel:   <span id='welt2000UpdateTitle'></span>
        Details: <a id='welt2000UpdateLink'>hier</a>
        ...
      </html>
    

Damit das Feed-Script weiß, welche Elemente für die Anzeige der Informationen vorgesehen sind, müssen die Element-IDs registriert werden. Dafür stellt das Feed-Script die register-Funktionen zur Verfügung, deren Signaturen wie folgt aussehen:

Der Funktionsname sagt bereits, welche Information in dem jeweiligen Element angezeigt werden soll. Die Funktionen registerUpdateTitle(), registerUpdateDescription() und registerUpdatePubDate() befüllen das gegebene Element mit einer Zeichenkette, letzterer im Format "DD MMM YYYY" (Leerzeichen-getrennt). registerUpdateLink() befüllt nicht das gegebene Element selbst, sondern das HREF-Attribut diese Elements. registerUpdatesTableBody() erwartet ein TBODY-Element und befüllt dieses mit TR-, TD-Elementen sowie den Update-Informationen.

Der Parameter index legt fest, zu welchem Update Informationen angezeigt werden sollen: 0 bezeichnet das letzte, 1 das vorletzte Update usw.. Die Liste der Updates ist auf 10 begrenzt, so dass index nicht größer als 9 werden darf.

Der Parameter count der Funktion registerUpdatesTableBody() legt die Anzahl der Tabellen-Zeilen fest, die dem TBODY hinzugefügt werden. Hier liegt der Wertebereich bei 1 (eine Zeile) bis 10 (10 Zeilen).

Nach dem Hinzufügen der register-Funktionen und zwei weiterer SCRIPT-Elemente (mehr dazu siehe unten) sieht das oben angefangene Beispiel wie folgt aus:

    <html>
      ...
      <script src="http://www.segelflug.de/vereine/welt2000/javascripts/rss-feed.js" 
              type="text/javascript"></script>
    
      Datum:   <span id='welt2000UpdatePubDate'></span>
               <script>registerUpdatePubDate("welt2000UpdatePubDate", 0);</script>
      Titel:   <span id='welt2000UpdateTitle'></span>
               <script>registerUpdateTitle("welt2000UpdateTitle", 0);</script>
      Details: <a id='welt2000UpdateLink'>hier</a>
               <script>registerUpdateLink("welt2000UpdateLink", 0);</script>
      
      <script>load("de");</script>
      ...
    </html>
    

Das erste SCRIPT-Element lädt das Feed-Script, so dass die register-Funktionen verwendet werden können. Die abschließende Funktion load("de") lädt schließlich die Update-Informationen in der angegebenen Sprache (hier: "de" für Deutsch) von der WELT2000-Seite und veranlasst das Befüllen der registrierten Elemente bzw. Element-Attribute.

Wichtig: Das Script muss von der URL http://www.segelflug.de/vereine/welt2000/javascripts/rss-feed.js geladen werden. Sie kann nicht herunter geladen und unter einer anderen Domain (z.B. http://www.lsv-knuffingen.de) abgelegt werden. Der Grund dafür ist eine Sicherheitsmaßnahme (Stichwort "Same-Origin-Policy"), mit der Cross-Site-Scripting (XSS) verhindert werden soll.

Hintergrundinformationen

RSS ist ein Format für die Verteilung von Inhalten und die Nutzung der Inhalte durch andere Personen und Internet-Seiten. RSS ist ein XML Dialekt, dessen Einzelheiten in der RSS-Spezifikation vom RSS Advisory Board festgelegt wurden. Die Validität einer XML-Datei kann z.B. mit Hilfe dessen Feed-Validators überprüft werden. Dazu einfach auf die folgende Grafik klicken.

[Valid RSS]