Mit Hilfe des CGI-Skriptes import-wiki.pl kann der Inhalt von bestimmten öffentlichen und privaten Wikis in andere Websites eingebettet und angezeigt werden.

Dazu ruft das Skript ein anderes Skript unter http://www.wiki.uni-erlangen.de/api/ auf, das den eigentlichen Export der Inhalte übernimmt. Dieses Skript liest auch zugriffsgeschützte Wikis aus, sofern diese auf dem Wiki-Server des RRZE gehostet werden und

  • die Seite der Kategorie ExportPublic zugeordnet ist oder
  • sich auf der Seite explizit freigegebene Abschnitte befinden.

Diese Abschnitte werden mittels Mediawiki-Vorlagen definiert. Wie das im Quelltext aussieht, sieht man auf den folgenden Beispielseiten:

Die Mediawiki-Vorlagen – wenn man einzelne Abschnitte definieren möchte, müssen diese im Wiki vorhanden sein. Wenn man nur komplette Seiten exportieren möchte, braucht man sie nicht:

Einige Unterprojekte der Wikipedia sind auch für das Import-Skript zugänglich – siehe die Liste unter http://www.wiki.uni-erlangen.de/api/.

Installation

Für neue Webauftritte oder solche, bei denen nicht das gesamte Paket heruntergeladen wurde reicht es das Anwendungsskript import-wiki.pl zu laden und in das eigene CGI-Verzeichnis zu kopieren. Beim Kopieren in das CGI-Verzeichnis muss jedoch darauf geachtet werden, dass die Datei ausführbar ist und nur schreibbar von der Benutzerkennung des Webmasters.

Einbindung in den Webauftritt

Das Skript selbst muss nicht konfiguriert werden. Lediglich der Aufruf des Skriptes und dessen Ausgaben müssen angepasst werden. Webauftritte, welche die aktuellen Vorlagen verwenden, benötigen keine weitere Konfiguration.

Abruf der Inhalte

Zur Einbindung und Ausgabe der Suchergebnisse in einer Webseite wird folgender SSI-Aufruf verwendet: 

<!--#include virtual="/cgi-bin/import-wiki.pl/[Wiki-Kurzname]/[Seitentitel]/[Format]/[Abschnitte]" -->

Dieser Aufruf kann in jeder beliebigen Webseite eingebaut werden, die mit SSI interpretiert wird. (Überlicherweise alle Webseiten, die mit der Endung .shtml enden.)
Damit wird an exakt der Stelle wo diese Anweisung ist der Inhalt des Wikis eingeblendet. Die URL-Parameter hierbei sind folgendermaßen zu verstehen:

Parameter

Alle verfügbaren URL-Parameter
ParameterStandardeinstellungBedeutung
Wiki-Kurzname keine Kurzbezeichnung eines der unter http://www.wiki.uni-erlangen.de/api/ aufgeführten Wikis.
Seitentitel keine Titel der einzubindenden Seite.
Format html Ausgabeformat. Mögliche Werte: html, xml, json und txt. Wenn kein Format angegeben ist, wird html ausgegeben.
Abschnitte kompletter Artikel oder alle öffentlichen Abschnitte Innerhalb der Artikel können zugängliche Abschnitte definiert sein, falls das Wiki ansonsten zugriffsgeschützt ist. Mit diesem Parameter kann man die Abschnitte angeben, die angezeigt werden sollen - entweder als Bereichsangabe (z.B. 4-6) oder als Aufzählung einzelner Abschnitte (z.B. 1_4_11_7_5).