Integration von Events
Admin (Diskussion | Beiträge) |
Admin (Diskussion | Beiträge) |
||
| (65 dazwischenliegende Versionen von 35 Benutzern werden nicht angezeigt) | |||
| Zeile 11: | Zeile 11: | ||
|- | |- | ||
!Funktionen | !Funktionen | ||
| − | |<code>[[Event::getByID|getByID]]<br />[[Event::getByKey|getByKey]]<br />[[Event::getRSSHeader|getRSSHeader]]<br />[[Event::getRSSLink|getRSSLink]]</code> | + | |<code>[[Event::getByID|getByID]]<br />[[Event::getByKey|getByKey]]<br />''getArchive''<br />[[Event::getRSSHeader|getRSSHeader]]<br />[[Event::getRSSLink|getRSSLink]]</code> |
|} | |} | ||
Bitte beachten Sie die Angaben unter [[Modulintegration]]. | Bitte beachten Sie die Angaben unter [[Modulintegration]]. | ||
| + | |||
| + | ==Funktionen== | ||
| + | {|class="functions" | ||
| + | |+Übersicht der verfügbaren Funktionen | ||
| + | !<code>[[Event::getByID|getByID]]</code> | ||
| + | |Ausgabe eines speziellen Events anhand der Event-ID | ||
| + | |- | ||
| + | !<code>[[Event::getByKey|getByKey]]</code> | ||
| + | |Ausgabe einer Gruppe von Events als Liste anhand eines Musters | ||
| + | |- | ||
| + | !<code>[[Event::getArchive|getArchive]]</code> | ||
| + | |Ausgabe alter Events als Archiv anhand eines Musters nach Zeiträumen gegliedert | ||
| + | |- | ||
| + | !<code>[[Event::getRSSHeader|getRSSHeader]]</code> | ||
| + | |Ausgabe eines Verweises auf den RSS-Feed in den Meta-Daten | ||
| + | |- | ||
| + | !<code>[[Event::getRSSLink|getRSSLink]]</code> | ||
| + | |Ausgabe eines Links auf den RSS-Feed | ||
| + | |} | ||
==EventTypen== | ==EventTypen== | ||
| Zeile 44: | Zeile 63: | ||
* <code>EVT_SUMMARY</code><br />kurze Darstellung mit Zusammenfassung | * <code>EVT_SUMMARY</code><br />kurze Darstellung mit Zusammenfassung | ||
* <code>EVT_COMPLETE</code><br />komplette Darstellung | * <code>EVT_COMPLETE</code><br />komplette Darstellung | ||
| + | |||
| + | ==RSS== | ||
| + | Dieses Modul ermöglicht Ihnen, Events über einen RSS-Feed zur Verfügung zu stellen. Eingebunden werden ausschließlich Events der betroffenen Gliederung, wenn sie einem Typ zugeordnet sind, der für RSS aktiviert ist. Die Aktualisierung des Feeds erfolgt, sobald ein betroffenes Event erstellt, geändert oder gelöscht wird. Die Ausgabe erfolgt in der RSS-Version 2.0. | ||
| + | |||
| + | ===Voraussetzungen=== | ||
| + | Zur Aktivierung und Nutzung dieser Funktion müssen Sie folgende Voraussetzungen erfüllen: | ||
| + | *Hinterlegen der FTP-Zugangsdaten im Modul [[Units]] | ||
| + | *Hinterlegen von Root- und RSS-Verzeichnis sowie der MasterDatei im Modul [[Units]] (siehe Hinweise) | ||
| + | *Intergration der RSS-Elemente (Links etc.) im Internetauftritt (Funktionen [[Event::getRSSHeader|getRSSHeader]], [[Event::getRSSLink|getRSSLink]]) | ||
| + | *Hinterlegen von Events, die einem RSS-Typ zugeordnet sind | ||
| + | |||
| + | ===Hinweise=== | ||
| + | *Der Feed wird in die Datei <code>news.rss</code> geschrieben. Diese kann grundsätzlich in jedem Verzeichnis abgelegt werden. Sie können hierfür (per FTP) auch ein eigenes Verzeichnis anlegen. | ||
| + | *Die „MasterDatei“ ist diejenige Datei, auf die ein Feed-Eintrag (Item) verlinkt ist und die das Item vollständig anzeigt. Nehmen Sie hierfür diejenige Datei, über die Ihre Events auf der WebSite vollständig anzeigt werden (siehe [[Event::getByID#file|getByID]] oder [[Event::getByKey#file|getByKey]]). Systembedingt hat diese die Endung <code>.php</code>. Sie können hierfür auch eine eigene Datei erstellen unter Nutzung der Funktion [[Event::getByID#file|getByID]] erstellen. Als Parameter bekommt die MasterDatei die ID des Events übergeben. | ||
[[Category:Webmaster]] | [[Category:Webmaster]] | ||
[[Category:Module]] | [[Category:Module]] | ||
[[Category:Events]] | [[Category:Events]] | ||
Aktuelle Version vom 21. November 2011, 11:45 Uhr
| Name | Event |
|---|---|
| Voraussetzungen | keine JavaScript empfohlen |
| Basis-URL | http://lib.itrack.de/event/
|
| Funktionen | getByID
|
Bitte beachten Sie die Angaben unter Modulintegration.
Inhaltsverzeichnis |
[Bearbeiten] Funktionen
getByID
|
Ausgabe eines speziellen Events anhand der Event-ID |
|---|---|
getByKey
|
Ausgabe einer Gruppe von Events als Liste anhand eines Musters |
getArchive
|
Ausgabe alter Events als Archiv anhand eines Musters nach Zeiträumen gegliedert |
getRSSHeader
|
Ausgabe eines Verweises auf den RSS-Feed in den Meta-Daten |
getRSSLink
|
Ausgabe eines Links auf den RSS-Feed |
[Bearbeiten] EventTypen
[Bearbeiten] HauptTypen
Grundsätzlich liegt jedem Event dieselbe Datenstruktur zugrunde. Für das sinnvolle Arbeiten werden Events jedoch verschiedenen HauptTypen zugeordnet, wodurch sie sich in Bearbeiung und Ausgabe unterscheiden. Nicht alle davon müssen in Ihrem Sytem vorkommen. Es wird zwischen folgenden HauptTypen unterschieden:
- News
- Termine
- Beschlüsse
- FAQs
- Jobs
[Bearbeiten] MasterDateien
Wenn Sie für die Ausgabe der Events nicht den Darstellungsmodus EVT_COMPLETE gewählt haben, wird ein Event in einer Kurzform ausgegeben. Sind dabei für dieses Event noch weitere Informationen gespeichert, wird die Anzeige um einen Link ergänzt, über den man auf die Seite für die vollständige Anzeige eines Events gelangt.
Wo diese Seite liegt, können Sie frei innerhalb Ihres Internetauftritts wählen. Die Adresse der Seite müssen Sie dann beim Aufruf einer Funktion durch einen Parameter übergeben (siehe jeweilge Funktionsbeschreibung).
Diese Seite muß innerhalb Ihrer WebSite angelegt werden wie folgt:
- Erstellen Sie die Datei innerhalb Ihrer WebSite mit der Endung
php. - Öffnen Sie die Datei in Ihrem Editor.
- Bearbeiten Sie die Seite, bis sie in Optik und Funktionalität Ihrem Bedarf entspricht.
- Wechseln Sie in Ihrem Editor ggf. zur Codeansicht.
- Bewegen Sie den Cursor an die Stelle, an der die Ausgabe des Events erfolgen soll.
- Rufen Sie die gewünschte Funktion an dieser Stelle mit folgendem Code auf:
<?php include("http://lib.itrack.de/event/?getById&id=".$_GET['id']) ?>
Grundsätzlich können Sie auf derselben Seite auch mehrere Aufrufe nach obigem Muster einfügen. I.A. dürfte dies aber nicht zweckdienlich sein.
[Bearbeiten] Darstellungsmodus
Neben dem Typ werden die ausgegebenen Daten im Wesentlichen durch den Darstellungsmodus bestimmt. Für die Ausgabe von Events gibt es drei Darstellungmodi:
-
EVT_SHORT
kurze Darstellung -
EVT_SUMMARY
kurze Darstellung mit Zusammenfassung -
EVT_COMPLETE
komplette Darstellung
[Bearbeiten] RSS
Dieses Modul ermöglicht Ihnen, Events über einen RSS-Feed zur Verfügung zu stellen. Eingebunden werden ausschließlich Events der betroffenen Gliederung, wenn sie einem Typ zugeordnet sind, der für RSS aktiviert ist. Die Aktualisierung des Feeds erfolgt, sobald ein betroffenes Event erstellt, geändert oder gelöscht wird. Die Ausgabe erfolgt in der RSS-Version 2.0.
[Bearbeiten] Voraussetzungen
Zur Aktivierung und Nutzung dieser Funktion müssen Sie folgende Voraussetzungen erfüllen:
- Hinterlegen der FTP-Zugangsdaten im Modul Units
- Hinterlegen von Root- und RSS-Verzeichnis sowie der MasterDatei im Modul Units (siehe Hinweise)
- Intergration der RSS-Elemente (Links etc.) im Internetauftritt (Funktionen getRSSHeader, getRSSLink)
- Hinterlegen von Events, die einem RSS-Typ zugeordnet sind
[Bearbeiten] Hinweise
- Der Feed wird in die Datei
news.rssgeschrieben. Diese kann grundsätzlich in jedem Verzeichnis abgelegt werden. Sie können hierfür (per FTP) auch ein eigenes Verzeichnis anlegen. - Die „MasterDatei“ ist diejenige Datei, auf die ein Feed-Eintrag (Item) verlinkt ist und die das Item vollständig anzeigt. Nehmen Sie hierfür diejenige Datei, über die Ihre Events auf der WebSite vollständig anzeigt werden (siehe getByID oder getByKey). Systembedingt hat diese die Endung
.php. Sie können hierfür auch eine eigene Datei erstellen unter Nutzung der Funktion getByID erstellen. Als Parameter bekommt die MasterDatei die ID des Events übergeben.
