Anlage 4: Handbuch für den Administrator

Content Syndication für nightloop.de
Handbuch für den Administrator
Version 1.0, März 2003
Inhaltsverzeichnis
Content Syndication für nightloop.de 1
Handbuch für den Administrator 1
1.Übersicht 3
2.Vorraussetzungen 3
3.Installation 3
4.Erweiterungen 3
4.1Kategorien 3
5.Web-Interface: Programmiersprachen 4
6.De-Installation 4

1. Übersicht
Hinweis: Dieses Paket ist für die Nutzung auf dem Webserver „nightloop.de“ vorgesehen. Eine Anwendung auf einem anderen System bedarf einiger Anpassungen. Bitte wenden Sie sich bei Fragen an support@team.nwn.de.
Das Programmpaket „Content Syndication für nightloop.de“ wird durch das Kopieren weniger Dateien in das Skript­verzeichnis des Webservers installiert. Es sind keine weiteren Änderungen am System notwendig.
Das Systempaket besteht aus folgenden Komponenten:
backend.php:
Modul für den Zugriff über eine URL.
backend_soap.php:
Modul für den Zugriff über ein SOAP-Interface.
backend_base.php
Modul zur Erzeugung der XML- und RDF-Dateien.
include/sql_*
Module zur Einbindung der Datenbankanbindung.
syndic8.php
Web-Interface zur interaktiven Erstellung von Skripten, 1. Teil
template.php
Web-Interface zur interaktive Erstellung von Skripten, 2. Teil
vorlage.*.txt
Skriptvorlagen

2. Vorraussetzungen
Das Paket basiert auf PHP und auf dem SOAP-Interface „nusaop“. Die Datenbankanbindung geschieht über die MySQL-DB-Klasse von Eike Bernhardt.
Folgende Vorraussetzungen müssen auf dem System gegeben sein:
PHP ab Version 4.3.0 mit einkompilierter DOM- und MySQL-Unterstützung.
Das Modul nusoap.php muss im Include-Pfad vorliegen.
(siehe http://dietrich.ganx4.com/nusoap/index.php)
Das Modul NWN_DB.class.php muss im Include-Pfad liegen.

3. Installation
Die Dateien backend.php, backend_soap.php, backend_base.php, syndic8.php sowie template.php werden in das Skriptverzeichnis kopiert.
Die SQL-Dateien (sql_*) und Skriptvorlagen (vorlage.*.txt) werden in das Unterverzeichnis include des Skriptver­zeichnisses kopiert. Das Format dieser Dateien ist in Kapitel XXX zu finden.
4. Erweiterungen
4.1 Kategorien
Die Anzahl der Kategorien lässt sich auf einfache Weise erweitern:
Im Unterverzeichnis include muss für jede Kategorie eine Datei vorhanden sein. Der Name der Datei richtet sich nach folgendem Schema:
sql_.php
Der Kategoriename kann unabhängig von den tatsächlichen Gegebenheiten der Datenbank vergeben werden; er wird von den Clients als Parameter zur Kategorieauswahl genutzt. Es sollte aber darauf geachtet werden, dass keine Zeichen benutzt werden, die bei der Benutzung innerhalb eine URL Schwierigkeiten ergeben könnten (z.B. „?“ oder „&“).
Die Datei muss die Variable $db zur Verfügung stellen, die den Namen der Datenbank enthält. Desweiteren muss eine Variable $sql exportiert werden, die das SQL-Query enthält. Dieses Query muss die Felder title, description und href definieren, wobei href die Form „href=“URL““ haben muss.

Listing 1: Beispiel einer SQL-Datei

5. Web-Interface: Programmiersprachen
Das Angebot des Web-Interaces für Programmiersprachen lässt sich durch eine Vorlage-Datei im include-Verzeichnis des Moduls erweitern. Der Dateiname muss folgender Konvention entsprechen:
vorlage..txt, z.B. vorlage.perl.txt
Die Datei muss verschiedene Variablen aus dem Formular übernehmen. Die Variablen entsprechen folgender Kon­vention:
//$//, z.B. //$kategorie//.

Folgende Variablen sind definiert:
Variable
Bedeutung
$neuerlink
Farbe eines nicht besuchten Links
$besuchterlink
Farbe eines besuchten Links.
$hoverlink
Farbe beim Anwählen des Links.
$borderwidth
Breite des Tabellenrandes in Pixel.
$tabellenrand
Farbe des Tabellenrandes.
$titelfarbe
Textfarbe der Titelzeile.
$titelhintergrund
Hintergrundfarbe der Titelzeile
$textfarbe
Textfarbe der Schlagzeilen.
$hintergrund
Hintergrundfarbe der Schlagzeilen.
$items
Anzahl der anzuzeigenden Schlagzeilen.
$kategorie
Anzuzeigende Kategorie.
Tabelle1: Variablen in vorlage.*.txt
6. De-Installation
Das Programmpaket lässt sich durch das Löschen der gespeicherten Dateien deinstallieren.