Modulintegration

Version vom 17. November 2009, 11:46 Uhr

Bitte beachten Sie zum Einbinden die Systemvoraussetzungen.

Allgemeines

Um die Systemfunktionen verwenden zu können, muß die Adresse Ihrer WebSite auf dem iTrack-Server hinterlegt werden. Den Eintrag können Sie für Ihre Gliederung über die Verwaltungsoberfläche vornehmen.

Im Allgemeinen ist bei der Integration auf die Groß- und Kleinschreibung zu achten.

Funktionsaufruf

Um einen Informationsblock in Ihre Seite einzubinden, gehen Sie wie folgt vor:

1. Öffnen Sie Ihren Editor.
2. Ändern Sie die Endung Ihrer Datei in php. (Passen Sie ggf. die Links auf diese Seite an die neue Endung an.)
3. Öffnen Sie die Datei.
4. Wechseln Sie in Ihrem Editor ggf. zur Codeansicht.
5. Bewegen Sie den Cursor an die Stelle, an der die Ausgabe erfolgen soll.
6. Rufen Sie die gewünschte Funktion an dieser Stelle mit folgendem Code auf:

   <?php @include("http://lib.itrack.de/MODULE/?FUNCTION&PARAMETER1=VALUE1&PARAMETER2=VALUE2") ?>

   Beispiele:

   <?php @include("http://lib.itrack.de/unit/?getImprint") ?>

   Anzeige des Impressums (ohne Parameter)

   <?php @include("http://lib.itrack.de/event/?getByKey&type=EVT_DATES&display=EVT_SHORT&limit=2&file=dates.php") ?>

   Anzeige der letzten zwei Termine in Kurzform

Die großgeschriebenen Wörter sind durch individuelle Angaben zu ersetzen wie folgt:

• MODULE: jeweiliger Modulname
• FUNCTION: Funktionsname
• PARAMETERn: Name des n. Parameters
• VALUEn: Wert des n. Parameters
  Die Anzahl der Parameter ist abhängig von der verwendeten Funktion. Optionale Parameter können auch weggelassen werden. Die Reihenfolge ist beliebig.

Die Angaben für die eine Funktion entnehmen Sie bitte der zugehörigen Funktionsbeschreibung im jeweiligen Modul.

HIER ANGABEN FÜR SONDERZEICHEN: ' ','&','=','/','?',etc. ERGÄNZEN

Funktionsausgabe

HTML

Die Ausgabe einer Funktion besteht aus einer reinen XHTML-Struktur. Je nach Funktion befindet sich diese Struktur in einem DIV oder UL-TAG. Dieses TAG ist mit einer HTML-ID versehen. Innerhalb der XHTML-Struktur sind einzelne Bereiche über CSS-Klassen strukturiert. Die Auflistung ist in der jeweiligen Funktion beschrieben.

Micro-Formats

CSS

Damit die Darstellung der XHTML-Struktur auch ohne eigene Stylesheet-Angaben bereits ordentlich aussieht, werden diese bei manche Funktionen mittels CSS-Definitionen vorformatiert. Dabei findet die jeweilige HTML-ID Verwendung. Die Definitionen können an die eigenen Bedürfnisse angepaßt werden. Eine Auflistung der Definitionen Angaben finden Sie jeweils in der Beschreibung des Moduls.[1]

Wenn Sie Ihre CSS-Definitionen an einer beliebeigen Stelle in der Datei plazieren wollen, müssen Sie Selektoren mit höherer Priorität verwenden (z.B. durch Einschließen in ein HTML-TAG mit ID). Sie können dieselben Selektoren verwenden, wenn Sie Ihre CSS-Definitionen in der Datei hinter den Funktionsaufruf plazieren.

JavaScript

Beinhaltet die Ausgabe ein Formular, wird in manchen Funktionen bei der Ausgabe eine JavaScript-Funktion mitgeliefert, die bei aktiviertem JavaScript die Formulareingaben überprüft.

ÜBERSCHREIBEN DER INIT-FUNKTION VERHINDERN
ÜBERSCHREIBEN DER INIT-VARIABLEN VERHINDERN
VORGEHEN BEI EIGENEM onLoad-EVENT ERGÄNZEN
Die JS-Unterstützung benötigt eine Initialisierung per window.onload-Event.
Was ist mit eigenen window.onload-Initialisierungen?
Z.B. UserFunktion initUser mit 1 array für Parameter?
Wenn man die JS-Unterstützung nutzen will, dürfen die nachfolgend aufgelisteten, vordefinierten Objekte nicht überschrieben werden.

Fehlermeldungen

Fehlermeldungen haben folgende Struktur:

<div class="info error">
  <h3>Fehlertyp</h3>
  <p>Fehlermeldung</p>
</div>

Desweitern können in der weitern Ausgabe die Fehlerstellen genauer markiert sein.

Sie werden durch folgende Stylesheet-Angaben vorformatiert:

<style>
.info h3 {
  margin-bottom: 0;
}
.info p {
  margin-top: 0;
}
.error p,
.error label,
p.error,
td.error,
span.error,
label.error {
  color: red;
  font-weight: bold;
}
</style>

Diese Definitionen können nach eigenen Bedürfnissen überschrieben werden.[1]

• [1] Zur Anpassung der Stylesheet-Angaben sollten Sie mit CSS vertraut sein. Eine gute Hilfestellung gibt das Kapitel Stylesheets (CSS) von SELFHTML.