Hilfe zur Systemintegration

Das vorliegende System zur Webseitenverwaltung wurde mit besonderem Fokus auf die einfache Integration in bestehende Webprojekte entwickelt. Alle Dateien des Systems befinden sich ordentlich strukturiert innerhalb eines Verzeichnisses. Informationen zum verwendeten Verzeichnissystem finden Sie unter Verzeichnis- und Datenstrukturen. Da keine Datenbank benötigt wird, entfallen aufwendige Datenbankinitialisierungen. Ein Backup des gesamten Systems - inklusive hinterlegter Inhalte und Einstellungen - kann einfach durch Kopieren des Systemverzeichnissens erfolgen.

Die Anleitungen und Hilfestellungen auf den folgenden Seiten sind für Integratoren des Systemes bestimmt, also diejenigen Nutzer, welche das System innerhalb Ihrer eigenen Projekte nutzen wollen. Aber auch die Nutzer, welche das System "stand-alone" betreiben wollen finden hier wichtige Informationen.

Vom Nutzer wird hierbei erwartet, daß er bereits einige Grunderfahrungen mit Webseitenerstellung (HTML-Seitenerstellung, FTP-Nutzung ...) gemacht hat und typischerweise auch Kenntnisse von PHP erworben hat.

Weitergehende Kenntnisse sind zur Nutzung des yappadoo-Systems nicht notwendig. Wir hoffen, diese Onlinehilfe ist verständlich geschrieben und bringt Sie bei der Installation, Konfiguration und Anwendung des Systems voran. Sollten Sie Probleme mit dem System haben, bei deren Lösung die Onlinedokumentation nicht weiterhilft, oder andere unbeantwortete Fragen zum System haben, wenden Sie sich bitte einfach per E-Mail an support@yappadoo.org. Wir werden versuchen Ihr Problem möglichst schnell gemeinsam zu lösen.

Konfiguration

Alle Einstellungen am System werden zentral in der Datei "config/config.php" vorgenommen. Informationen zur Konfiguration finden Sie unter dem Menüpunkt Konfiguration.

Eigene Layoutanpassungen

Das grundsätzliche Erscheinungsbild (Anordnung der Seitenelemente) legen Sie in einer Seitenvorlagen-Datei fest. Eine Seitenvorlage ist dabei ähnlich einer Maske, weche die Position aller genutzten Seitenelemente festlegt.
Die einzelnen Seitenelemente "liefern" die Benutzerfunktionen des yappadoo-Systems. Das Aussehen der einzelnen Seitenelemente kann einfach per CSS an Ihre vorhandene Seite angepasst werden.

Bei Nutzung des yappadoo-internen Templatesystems ist finden sie die Vorlagendatei unter "yappadoo/etc/template.php". Diese Datei kann Ihnen auch als Vorbild für die Erstellung einer eigenen Seitenvorlage dienen.

Informationen zur Erstellung eigener Seitenvorlagen finden Sie unter dem Menüpunkt Anpassung und Integration.

Das System ist layoutseitig sehr einfach anpassbar. Wenn weitergehende Änderungen an der Erscheinungsweise einzelner Seitenelemente erforderlich ist, können diese leicht vorgenommen werden. Im System wird strikt auf die Trennung von Funktionalität und Layout geachtet. Alle Dateien, welche das Design der ausgegebenen HTML-Inhalte bestimmen, befinden sich deshalb ausschließlich unterhalb des Verzeichnisses "yappadoo/etc". Hier finden sich die Standard-Vorlagedateien ("Templates") als auch die include-Dateien mit den Ausgabefunktionen für die einzelnen Seitenelemente. Alle Seitenelemente-Ausgabefunktionen, welche individuell änderbaren HTML-Code erzeugen (z.B. Aussehen des Navigationsmenüs) finden sich dabei in der Datei "yappadoo/etc/dynamics.php".

Seitenelemente

Eine Seite aus dem yappadoo-System besteht aus diversen Seitenelementen. Solche Elemente sind beispielsweise:

  • der Ausgabebereich für Inhalte
  • das Navigationsmenü
  • das Administrationsmenü
  • das Suchformular
  • die Fußzeile
  • ... e.t.c. ...

Diese Elemente werden über sog. Benutzerfunktionen in Ihr Seitentemplate integriert. Ein Aufruf dieser Benutzerfunktionen führt zu einer Ausgabe des HTML-Codes des jeweiligen Elementes.
Da nicht alle Elemente auf jeder Seite erscheinen (z.B. Administrationsmenü), gibt es auch Benutzerfunktionen zum Testen der aktuellen Ausgabemöglichkeit ("Existenz") bestimmter Elemente.

Variablen und Funktionsnamen

Das yappadoo-System speichert seine Systemvariablen im globalen Variablenraum und seine Benutzerfunktionen im globalen Funktionsraum. Um Seiteneffekte bei der Integration zu vermeiden, wurden spezielle Namenskonventionen bei der Variablen- und Funktionsnamensvergabe beachtet. Das System speichert alle Variablen als Array in die globale Variable

$GLOBALS['yap'].

So befinden sich die Konfigurationseinstellungen des Systems zur Ausführungszeit beispielsweise in der Variable

$GLOBALS['yap']['config'].

Alle globalen Funktionen und Klassennamen des Systems beginnen mit "yap_". So werden Überschneidungen mit Ihrem bestehenden Projekten vermieden. Alle von yappadoo genutzten CSS-Klassennamen beginnen ebenfalls mit dem Prefix "yap_". Auch bei den HTTP-Aufrufparametern gilt diese Konvention - wurde jedoch noch nicht vollständig umgesetzt (v0.5)! Weitergehende Informationen zu den Konventionen finden Sie unter dem Menüpunkt Erweiterungen und Konventionen.

[ Seite drucken ] [ nach oben ]
Zuletzt bearbeitet am 2007-07-03 17:59 von StefanSorg.
Ausgegeben in 0.0103 sec