MODxBB Installations- & Konfigurationsleitfaden

Willkommen zum MODxBB "Handbuch". Diese Seiten sind sowohl dem MODxBB-Paket beigefügt als auch online unter modxbb.net/documentation abrufbar.
Diese Anleitung (aktuelle Seite) enthält ein verlinktes Inhaltsverzeichnis im rechten Abschnitt. Dort sind auch Informationen bezüglich Erstellungsdatum und letzter Aktualisierung zur jeweiligen Seite zu finden. Dies erleichtert das schnelle Überprüfen ob und wann eine Seite geändert wurde.
Für Nutzer, die lieber vom Papier, als vom Bildschirm ablesen, habe ich eine Druck-CSS erstellt, die den Ausdruck sinnvoller gestaltet.

1. Über MODxBB und diesen Leitfaden

1.1 MODxBB

MODxBB ist eine wechselseitige, skalierbare Intergration von MODx und phpBB.
MODx ist ein Content Management System, das ein hohes Maß and Individualisierung erlaubt und auch als Content Management Framework genutzt werden kann.
Die Forumsoftware phpBB ist auch ein sehr leistungsfähiges Community Management System. Genutzt wird es überwiegend als Kommunikationsplattform, verfügt allerdings über Potential für weitaus mehr als das.
Administratoren, die gerne MODx und phpBB gleichzeitig nutzen würden, sehen sich mit dem Problem konfrontiert, dass Mitglieder sich zweimal für dieselbe Seite registrieren müssten. Einer der Hauptaufgaben von MODxBB ist es, dieses Problem zu lösen, indem es beide Systeme verbindet.
MODxBB ist jedoch mehr als nur eine Brücke für Userkonten. Es ermöglicht Entwicklern den zugang zu den Schnittstellen beider Systeme, sowohl auf beliebiger MODx als auch phpBB Seite.
Mehr über MODxBB und dessen Funktionen kann man im Artikel Welcome to MODxBB auf modxbb.net lesen.

1.2 Dieser Leitfaden

Dieses "Handbuch" ist wesentlich detaillierter geworden als ursprünglich geplant. Deshalb auch die zusätzliche Verzögerung der Veröffentlichung. Es sollte auch für weniger erfahrene Anwender verständlich sein, allerdings gilt, umso besser die Kenntnisse in (X)HTML, CSS und PHP desto mehr kann man aus dem Potential von MODxBB machen.
Dieser Leitfaden deckt alle Installationstypen ab, d.h. es ist nicht notwendig ihn komplett zu lesen. Die optionalen Abschnitte starten mit dem Hinweis in welchem Fall sie gelesen werden sollten.
Auch wenn der Installations- und Konfigurationsvorgang etwas aufwendig sein mag, ist MODxBB dennoch, erstmal Installiert, recht einfach zu handhaben. Ein Interface für eine benutzerfreundlichere Installation und Konfiguration ist für zukünftige Versionen vorgesehen. HINWEIS: Page ist eine einzelne Seite einer Webseite, damit die Wörter "Seite" und "Webseite" nicht verwechselt werden, wird hier das Wort "Page" benutzt.

1.3 Zusätzliche Tutorien

Ausführlichere Tutorien, Tipps und Beispiele zu den verschiedenen Themen werden später im modxbb.net Blog veröffentlicht.

2. Installation

2.1 Voraussetzungen für die Installation

- MODx Evolution 1.0.0 - 1.0.5 • empfohlen: 1.0.5
- phpBB 3.0.4 - 3.0.9 • empfohlen: 3.0.9
- MODxBB 0.9.4 (Teil dieses Pakets)

- Ein Webserver oder Webspace auf dem sowohl phpBB als auch MODx läuft bzw. laufen kann.

2.2 MODx installieren

Zuerst wird MODx Evolution installiert. Sollte eine solche Installation bereits vorhanden sein, wird dringend empfohlen diese auf die neuste Version zu aktualisieren, wenn nicht schon geschehen. Auf der MODx Downloadpage kann man erfahren, welche die neueste Version ist und gegebenenfalls herunterladen.
Während des Installationsvorgangs sollte man die Webseite in den "Offline"-Modus setzten: In den Manager einloggen --> "Configuration" klicken --> Auf dem "Site" Tab zu "Site status" runterscrollen und dort "Offline" wählen.

2.3 phpBB installieren

Zunächst erstellt man einen Unterordner, nennt ihn 'forum' (man kann auch einen anderen Namen wählen, 'forum' ist jedoch empfohlen) und installiert phpBB in diesen. Dasselbe wie im vorigen Kapitel gilt auch hier: Ist bereits eine Installation vorhanden, sollte man erst die phpBB Downloadpage besuchen, um sicherzustellen, dass man eine Aktuelle Version hat.
Es wird dringend empfohlen den Forumordner als Unterordner von MODx (d.h. dem "Site Root") zu erstellen. Alles andere sollte nur von Erfahrenen Administratoren versucht werden.

Diejenigen, welche ihr Forum, wie auf MODxBB.net, optisch an dem Rest der Webseite anpassen wollen, müssen die phpBB Haupttemplates editieren (overall_header und overall_footer). Eine detallierte Beschreibung, wie das funktioniert findet sich im entsprechenden phpBB.com Thread.

TIPP: Die bei manchen Browsern zum Umfang zugehörigen Webentwicklungstools (z.B. Firebug in Firefox oder DragonFly in Opera) sind sehr hilfreich beim visuellen gestalten des Forums, weil sie das Finden von CSS-Selektoren und Eigenschaften des Themes erheblich vereinfachen. Ich empfehle auch das Freewaretool Colour To HTML, da es viel Zeit sparen kann, wenn man zum Beispiel eine bestimmte Farbe im ganzen Forum gegen eine andere tauschen möchte (Color-picker -> find in CSS).
Ein weiterer Tipp, der helfen könnte eine menge Zeit zu sparen: overall_header.html und overall_footer.html ergeben zusammengesetzt eine komplette HTML-Page. Man kann sie zusammensetzen (z.B. in einem Code- oder Texteditor) während man sie bearbeitet und später wieder teilen, wenn man mit dem Editieren fertig ist.

Das Einfügen der phpBB-Templates als Teil eines MODx-Templates oder Dokuments ist übrigens theoretisch möglich, aber alles andere als Sinnvoll.

2.4 MODxBB installieren

HINWEIS: Die function_user.php im MODxBB-Paket beinhaltet einen phpBB Bugfix [von Hedgehog, phpBB] in Zeile 2186 der einen Fehler bezüglich der Gallery-Avatars behebt, welche nicht richtig sortiert wurden. Den Bugfix habe ich zusammen mit der MODxBB-Unterstützung von Gallery-Avatars eingefügt.

2.4.1 Backup erstellen

WICHTIG: Von jeder Datei die editiert oder überschrieben wird sollte vorher ein Backup erstellt werden!
Aufschluss darüber welche Dateien bei einer vollständigen Installation von MODxBB verändert werden, gibt sowohl die Dateiliste, als auch der "Documents" Ordner inklusive Unterordner.

Wer es vorzieht kann gleich den ganzen Site-Root mit allen Unterordnern sichern, das ist jedoch nicht notwendig. Wie oben erwähnt kann man problemlos herausfinden welche Dateien betroffen sind.

2.4.2 Minimale Installation

Wer nur daran interessiert ist, seine Chunks oder Snippets auf dem phpBB-Forum zu platzieren, kopiert die Datei modxapi.php (im MODxBB-Paket beinhaltet) in den Site-Root und liest weiter bei Kapitel 2.4.6

2.4.3 Schnellinstallation

Es gibt drei Voraussetzungen für die Schnellinstallation:
1. phpBB 3.0.9
2. MODx Evo 1.0.5
3. Die zu ersetzenden Dateien sind im Originalzustand (sonst verliert man Änderungen, die vor der MODxBB-Installation an diesen Dateien vorgenommen wurden).

BACKUP NICHT VERGESSEN!

Einfach alle Dateien von MODxBB\Documents in den Site-Root kopieren und dabei die Ordnerstruktur beibehalten.
HINWEIS:Dies setzt voraus, dass der Forumordner "forum" heißt. Außerdem, wenn man JOT nicht dem MODxBB Style anpassen will, braucht man den JOT-Ordner im MODxBB-Paket nicht mitzukopieren.

2.4.4 Manuelle Installation

Die manuelle Installation ist die richtige Wahl, wenn man eine ältere Version von phpBB oder MODx nutzt, man vorher eigene Änderungen an mindestens einen von beiden vorgenommen hat, die man behalten will oder wenn man einfach wissen möchte, welche Änderungen genau, MODxBB vornimmt.
Das ursprüngliche Vorhaben, Schritt für Schritt durch jede einzelne Änderung zu gehen, habe ich verworfen, da dies wegen der, abhängig von Versionen und Änderungen, stark variierenden Zeilennummern Verwirrung stiften würde und nur eingeschränkt durchführbar ist.
Stattdessen wird hier eine sicherere und eindeutigere Methode beschrieben: Von der WinMerge Homepage lädt man sich die neuste Version von WinMerge herunter. Das ist ein sehr nützliches Freewaretool, welches Dateien und Ordner vergleichen kann und die Unterschiede zeigt. Eine Liste von Alternativen für Linux oder Mac gibt es in diesem Artikel.
Jetzt braucht man nur noch die Dateien im Ordner "Original" mit denen im Ordner "Documents" zu vergleichen. So kann man erkennen welche Veränderungen man an welchen Stellen vornehmen muss. Man darf sich jedoch nicht auf die Zeilennummern verlassen! Als richtige Orientierung dienen stattdessen die Zeilen vor und nach der von MODxBB eingefügten Zeile(n).
Beispiel:
Nach dessen Installation, startet man WinMerge und klickt File -> Open um die Datei index.php im Ordner "Documents" und die im Ordner "Original" des MODxBB-Pakets hinzuzufügen (drag & drop funktioniert auch).
Nun lädt man die index.php der Webseite herunter und fügt die Unterschiede der anderen zwei, in WinMerge geöffneten Dateien dort ein (backup nicht vergessen!). Wenn man alle Änderungen eingefügt hat, speichert man die Datei und lädt sie zurück auf dem Webserver hoch. Mit den anderen Dateien verfährt man genauso.

2.4.5 Installieren der Elemente [Snippets, Plug-in]

Das Installieren der MODxBB "Elemente" ist optional. Man kann selbst entscheiden wieviele man davon installiert. Wer keine von ihnen nutzen möchte, kann dieses Kapitel überspringen. Nachfolgende Tabelle listet alle mitgelieferten Elemente auf:

NAME	TYP	BESCHREIBUNG
LatestTopicsBB	snippet	Listet die neuesten Forumbeiträge
LoginBB	snippet	MODxBB Mitgliederlogin und -statistik
OnlineListBB	snippet	Zeigt wer gerade online ist (einfahrbar)
PrevPollsBB	snippet	Auflistung voriger Titelumfragen (konfigurierbar)
SitePollBB	snippet	Stellt phpBB Umfragen auf beliebiger Page der Webseite dar
PluginBB	plug-in	Generiert link in "Web User" Profilen zum phpBB-Profil

Um einen der obengenannten Snippets zu installieren, loggt man sich in den MODx Manager ein und geht zu: Elements -> Manage Elements -> Snippets und klickt "New Snippet". Der einzutragende Name entspricht dem Dateinamen (txt) bzw. den obengenannten in der Tabelle. Für "description" (beschreibung) trägt man ein: <strong>0.9.4 </strong>, gefolgt von der in der Tabelle angegebenen, entsprechenden Beschreibung. Die Versionsnummer ist wichtig, um die Elemente von späteren Versionen unterscheiden zu können.
Nun fügt man den Inhalt der gleichnamigen Snippet-Textdatei ein, die man im "Documents" Ordner des MODxBB-Pakets findet. Das Speichern des Snippets nicht vergessen!
Um PluginBB zu installieren geht man zu Elements -> Manage Elements -> Plugins und klickt "New Plugin". Beim Eintragen von Name, Beschreibung und Code, geht man vor wie oben beim Snippet.
Jetzt klickt man auf "System Events" und aktiviert die Kästchen für "OnUserFormRender" und "OnWUsrFormRender". Speichern, schließen, fertig.

2.4.6 Anpassen der phpBB Templates

Wer das Design seines phpBB-Forums dem Rest der Seite anpassen will, geht zunächst vor wie in Kapitel 2.3 beschrieben.
Der nachfolgende Schritt ist nur notwendig, wenn man MODx Elemente (Snippets, Chunks) oder MODx-Fehlermeldungen auf seinem phpBB-Forum platzieren will. Wer das nicht möchte, kann bei 3.Konfiguration weiterlesen.
Zunächst öffnet man die Datei overall_header.html. Das kann man entweder im phpBB Admin Control Panel tun (General -> Style -> Templates) oder indem man die Datei in forum\styles\YourTheme\template findet (angenommen das Forum wurde in "forum/" installiert und der Theme heißt "YourTheme"). Dann fügt man folgende Zeilen an dessen ANFANG ein:


<!-- PHP -->
if (!defined('ADMIN_START'))
{
	require_once($phpbb_root_path . '../modxapi.php');
}
else {
	require_once($phpbb_root_path . '../../modxapi.php');
}

global $modx;
$modx = new MODxAPI();
$modx->connect();
$modx->getSettings();
<!-- ENDPHP -->


Der nächste Schritt ist nur erforderlich, wenn man MODx-Fehlermeldungen
auf dem phpBB-Forum angezeigt haben will.
Folgende Zeilen am ENDE der Datei einfügen:


<!-- PHP -->
$MODx_output = '';
global $MODx_output;
if ($MODx_output) {
 echo $MODx_output;
}
<!-- ENDPHP -->


Jetzt öffnet man overall_footer.html (befindet sich im selben Ordner) und
fügt folgende Zeilen an dessen ANFANG:


<!-- PHP -->
global $modx;
<!-- ENDPHP -->

3. Konfiguration

3.1 MODx konfigurieren

Wer die minimale Installation gewählt hat, kann zum Abschnitt 3.1.4 springen.

3.1.1 WebLogin entfernen oder deaktivieren

Wer diese installiert hatte, sollte das WebLogin Registrierungsformular und die dazugehörigen Einlog-Panele entfernen oder deaktivieren, da nun phpBB den entsprechenden Teil übernimmt und die Daten intern an MODx weiterleitet. Wer Einlog-Panele auf seiner Seite haben will, kann das LoginBB-Snippet nutzen (im MODxBB-Paket enthalten).

3.1.2 Eine Spalte für JOT-Beiträge in die MODx Datenbank einfügen

Diesen Schritt braucht man nur, wenn man sein JOT dem MODBxBB-Stil, wie im Einführungsartikel und im MODx-Forum dargestellt, anpassen will.
Im phpMyAdmin eingeloggt, wählt man dort die MODx-Datenbank und klickt modx_web_user_attributes (das Präfix kann auch anders als "modx_" lauten). Jetzt geht man auf "Structure" bwz. bei gewählter deutscher Sprache, "Struktur" (obere Leiste), scrollt zum Abschnitt wo "Add" bzw. "Felder hinzufügen" steht (abhängig vom gewählten phpMyAdmin-Theme kann dieser auch oben sein). Dort fügt man 1 Feld ein, wählt "At End of Table" bzw. "An das Ende der Tabelle" und klickt "Go" bzw. "OK".
Nun gibt man folgende Werte ein:

Field bzw. Feld: postcount
Type bzw. Typ: int(11)
Default bzw. Standard: 0 ["As defined:" bzw. "Benutzerdefiniert" wählen]
Comments bzw. Kommentare: jot comments

Save bzw. Speichern klicken!

3.1.3 Einen Gäste- und Standardavatar für JOT eintragen

Auch dieser Abschnitt ist nur erforderlich, wenn man die MODxBB änderungen an JOT nutzen möchte.
Man öffnet chunk.comment.inc.html im Ordner jot\templates (den man beim installieren von MODxBB hochgeladen hat) und ersetzt assets/images/YourDefaultAvatar.png in Zeile 8 mit der URL zum Standardavatar und assets/images/YourGuestAvatar.png in Zeile 10 mit der URL zum Gästeavatar, das man nutzen möchte.
Man kann frei wählen, wo man die Avatare hochlädt, jeoch ist es empfehlenswert jeweils ein Gruppenavatar für Gäste (Anonyme User) sowie Registrierte User einzutragen und diese zu nutzen.
Dazu geht man im phpBB "Admin Control Panel" (ACP) zu "Users and Groups --> Manage groups --> Settings".

3.1.4 Einen "Weblink" für das Forum erstellen

Um das Forum in Listen wie die von Wayfinder (z.B. in einer Sitemap) einzutragen, sollte man dafür einen Weblink erstellen. Dies kann man im MODx Manger tun. Mehr informationen zum Thema Weblinks findet man in Dokumentationen und im Forum von MODx.

3.2 phpBB konfigurieren

3.2.1 PHP für templates aktivieren

Dieser Abschnit ist nur notwendig, wenn man MODx Elemente und Fehlermeldungen auf dem Forum anzeigen möchte, sonst kann man bei Kapitel 3.2.2 weiterlesen.
Im phpBB ACP geht man auf das "Genral" Tab und klickt auf "Security settings" im Abschnit "Server configuration". Für "Allow php in templates:" wählt man "Yes" und klickt Submit. Das wird benötigt, um die MODx-Befehle zu parsen, die man vorher eingetragen hatte.

SICHERHEITSHINWEIS: Man sollte phpBB Themes nur von vollständig vertrauenswürdigen Seiten herunterladen während diese Einstellung aktiviert ist. Es wird allgemein ohnehin empfohlen Themes nur von phpBB.com oder anderen vertrauenswürdigen Seiten herunterzuladen.

3.2.2 Wählen mit "Guest-Sessions"

Dieser Abschnit wird nur benötigt, wenn man nicht eingeloggten Nutzern, das Teilnehmen an, mit SitePollBB eingefügten, Umfragen auf den MODx-Pages erlauben will.
Man geht zunächst auf dieselbe Page wie in 3.2.1 (ACP -> General -> Server configuration -> Security settings). Dort sucht man "Tie forms to guest sessions:" (sollte sich am Ende befinden), wählt "No" und klickt Submit.

3.2.3 Automatische Aktualisierung von phpBB Änderungen

Dieser Teil ist nur erforderlich, wenn man plant Chunks und Snippets auf dem phpBB-Forum zu platzieren. Er stellt sicher, dass das Forum Änderung von diesen erkennt und darstellt.
Im ACP eingeloggt geht man auf das "General" Tab und scrollt zum Abschnit "Server configuration". Dort klickt man auf "Load settings". Nun sucht man "Recompile stale style components:" und wählt "Yes". Submit klicken und fertig.

3.2.4 MODx Elemente in den phpBB Template(s) eintragen

Jetzt kann man Befehle hinzufügen, um MODx Elemente (Chunks, Snippets) im Forum einzufügen. Man kann sie zu jeder Template hinzufügen, die man in 2.4.6 angepasst hat, aber auch zu jedem beliebigen anderen Template, welches zum selben Theme gehört. Empfohlen wird jedoch, die Befehle in der Datei overall_header.html einzufügen.
Dies ist ein effektiver weg um Live-Ticker, Bekanntmachungen wie auf MODxBB.net, Werbebanner (während ich Werbebannern in Foren gegenüber eher abgeneigt bin) oder alles andere worauf man die Besucher aufmerksam machen will, einzufügen.
Beispiele: Um einen MODx Chunk für Bekanntmachungen auf dem Forum anzuzeigen, öffnet man overall_header.html vom Verzeichnis forum\styles\YourTheme\template und fügt folgende Zeilen am Ende, innerhalb der in 2.4.6 eingefügten PHP-Tags, ein:


echo $modx->getChunk('Announcement');

"Announcement" ist der Name des Chunks.
Wenn man vorher die Zeilen für die MODx-Fehlermeldungen eingtragen hat,
sieht es nun wie folgt aus:


<!-- PHP -->
echo $modx->getChunk('Announcement');
$MODx_output = '';
global $MODx_output;
if ($MODx_output) {
 echo $MODx_output;
}
<!-- ENDPHP -->


ansonsten:


<!-- PHP -->
echo $modx->getChunk('Announcement');
<!-- ENDPHP -->

Dies kann man auch an beliebiger anderer Stelle oder in einem anderen
Template einfügen.


Um ein Snippet einzufügen nutzt man:

echo $modx->runSnippet('SomeSnippet');


Wenn das Snippet Parameter hat, geht man so vor:

echo 
$modx->runSnippet("MySnippet", array('column'=>'3', 'tpl'=>'MyTemplate')

Wobei 'column' und 'tpl' die Parameter, '3' und 'MyTemplate' die Werte
sind.


Zur besseren Lesbarkeit, kann man auch zuerst einen Array erstellen:


$parameters['column']=3;
$parameters['tpl']=MyTemplate;

echo $modx->runSnippet('snippet_name', $parameters);


Beim Eintragen in das Template, nicht die PHP-Tags vergessen:


<!-- PHP -->
$parameters['column']=3;
$parameters['tpl']=MyTemplate;

echo $modx->runSnippet('snippet_name', $parameters);
<!-- ENDPHP -->

3.3 MODxBB Elemente konfigurieren

Um die mitgelieferten Snippets zu konfigurieren, öffnet man sie und editiert die Variablen im Konfigurationsabschnitt. Bei späteren Versionen wird man Parameter für die Snippets angeben können.

3.3.1 LatestTopicsBB

Es gibt drei Variablen, die man für dieses Snippet Configurieren kann. Die erste ist $num_post und legt die Anzahl an neuesten Beiträgen fest, die von diesem Snippet angezeigt werden. Die zweite, $num_chars, bestimmt die Anzahl der Zeichen die pro Beitrag wiedergegeben werden und die letzte, $DefaultAvatar, erlaubt einen Standardavatar einzustellen, für Benutzer, die keinen Avatar eingestellt haben.

3.3.2 LoginBB

Hier gibt es zwei Einstellungen, die man vornehmen kann. Für den Wert der $phpBB_folder Variable im ersten Abschnitt gibt man den Namen des Forumhauptordners an. Wenn dieser - wie empfohlen - 'forum' ist, lässt man diesen Wert unverändert.
Um die auf den Userpanel angezeigten Ränge zu konfigurieren, scrollt man zu
"switch ($phpBB_rank)". Die Case-Anweisungen sind visuell nach Eintretungs-
wahrscheinlichkeit geordnet. Die Nummern dagegen, werden von phpBB genutzt um den entsprechenden Rang zu identifizieren.

3.3.3 OnlineListBB

Bei diesem Snippet muss ebenfalls der Wert von $phpBB_folder geändert werden, falls der Forumordner nicht "forum" heißt.
Wenn man das SitePollBB Snippet NICHT auf der selben Page hat, muss man die Kommentarzeichen ( /* und */ ) im zweiten Paragraphen entfernen.

OnlineListBB nutzt jQuery. Wenn man mehr darüber erfahren möchte, sollte man die jQuery Dokumentation lesen. Dies ist allerdings nichts kompliziertes. Man braucht in der Regel nur eine Zeile um jQuery zu aktivieren, welche in etwo so aussieht:

<script type="text/javascript" src="js/jquery-1.5.min.js"></script>

In dieser Zeile wird davon ausgegangen, dass man jQuery heruntergeladen und in den Ordner "js" kopiert hat.
Es ist zu beachten, dass man dies möglicherweise nicht braucht, wenn jQuery schon für ein anderes Script läuft. Es könnte auch sein, dass man den Kompatibilitätsmodus braucht, wenn man z.B. gleichzeitig Mootools nutzt.

3.3.4 PrevPollsBB

Dieses Snippet bildet ein Umfragenarchiv. Es kann beispielsweise benutzt werden, um alle vorigen und aktuellen, von SitePollBB angezeigten, Umfragen auf einer Page aufzulisten.
Wenn der Name des Forumordners vom Standard abweicht, muss man dies auch hier anpassen. Im ersten Abschnitt muss man dafür den Wert der Variablen $phpbb_root_path ersetzten. Wenn der Forumordner beispielsweise "board" heißt, ändert man './forum/' in './board/' um.
Dieses Snippet erlaubt es durch fünf Variablen (im zweiten Abschnitt) konfiguriert zu werden.
$forum_ids bestimmt die Forum-ID von dessen Forum automatisch Umfragen auf der Page mit PrevPollsBB angezeigt werden.
$num_posts bestimmt die Gesamtanzahl der Umfragen, die von diesem Snippet angezeigt werden.
$per_page bestimmt die Anzahl der Umfragen per Page.
$page_start setzt den Startwert für die Seitenzahlen. Wobei request_var eine phpBB-Funktion ist, die es erlaubt Anfragewerte sicher weiterzugeben. Die Empfehlung ist es diese Werte unverändert zu lassen.

3.3.5 SitePollBB

Die Konfiguration dieses Snippets wird in der PHP-Datei poll.php, die sich im Ordner modxbb befindet, vorgenommen.

3.4 MODxBB Dokumente konfigurieren

3.4.1 poll.php

Dies ist der Hauptverarbeitende Teil des SitePollBB-Snippets. Es stellt zwei Optionen zur Konfiguration bereit.
Den Wert von $prevpollID auf Zeile 20 setzt man auf die ID der MODx-Page, auf der das PrevPollsBB-Snippet angezeigt wird, das mit SitePollBB-Snippet verbunden ist.
Erläuterung: Das Ziel des "Previous polls" links auf dem SitePollBB Umfragesnippet wird hier festgelegt.
In Zeile 54 kann man festlegen, von welchen Forumabschnitten die Umfragen genommen werden, die durch SitePollBB auf die entsprechende MODx Page platziert werden. Dort kann man entweder eine oder mehrere Angaben machen.
Wenn man zum Beispiel die neuste Umfrage von den Foren mit den IDs 12 und 13 als Titelumfrage auf der Titelseite haben will, ändert man Zeile 54 wie folgt:
$CFG['poll_forum'] = array(12,13);
Zeilen 57-59 legen fest ob BBcode, Smilies und URLs interpretiert werden.

3.4.2 edit.php

MODxBB unterstützt in phpBB selbsterstellte Profilfelder (Custom Profile Fields). Man kann (braucht aber nicht) diese auf den Web-User-Profilen des MODx-Managers anzeigen lassen.
Dafür ist eine Anpassung von edit.php und signup.php (beide im Ordner modxbb) nötig. Ein Beispiel für "fullname" ist dort bereits enthalten. Wenn man also ein Custom Profile Field in phpBB mit "fullname" als "Field Identification" erstellt, wird man den Inhalt dieses Feldes automatisch in den entsprechenden Web-User-Profilen unter "Full name" angezeigt bekommen.
Um ein Custom Profile Field (CPF) zu erstellen, loggt man sich in den ACP ein, klickt das "Users and Groups" Tab und dann auf "Custom profile fields" im Abschnitt "Users".
Diese Datei leitet Änderungen, die von innerhalb phpBB's vorgenommen werden, an MODx weiter, deshalb müssen CPF eingetragen werden, wenn man auch diese in den MODx-Profilen haben möchte. Die Zeilen 38-47 zeigen wie das funktioniert. Das Präfix pf_ wird immer vorangestellt, der Rest (hier "fullname") ist die "Field Identification" des CPF's.
Ein Artikel, der detailliert beschreibt, wie man Custom Profile Fields erstellt und verwaltet, sowie MODx Web-User-Profile anpasst, wird eventuell später im MODxBB.net Blog erscheinen.

3.4.3 signup.php

Dies ist die zweite Datei, die editiert werden muss, wenn man Custom Profile Fields in MODx nutzen möchte.
Zeile 26 zeigt ein Beispeil für "fullname":
$fields["fullname"] = $cp_data['pf_fullname'];
Hier wird das CPF pf_fullname in die Spalte "fullname" unter "Web User" der MODx-Datenbank eingetragen. Man kann es natürlich auch in einer anderen Spalte eintragen lassen oder eine neue Spalte für das CPF hinzufügen.
Zeile 28 übergibt die phpBB Nutzer-ID and das MODx-Feld "phone". Das Nutzen eines vorhandenen Feldes ist zeitsparender und unkomplizierter, man kann jedoch auch ein dediziertes Feld in der MODx-Datenbank erstellen (z.B. phpBB_ID). Genutzt wird das Feld, um die jeweiligen Links zu den phpBB-Profilen auf den Web-User-Profilen von MODx einzufügen. Daher ist es notwendig auch PluginBB anzupassen, wenn man ein anderes als das vorher eingetragen Feld nutzt (einfach "phone" im Code finden und durch den Namen des gewählten Feldes ersetzen).
In Zeile 29 kann man "forum/download/file.php?avatar=g2_1266363854.png" durch die URL zum Standardavatar ersetzen (für Nutzer, die kein Avatar gewählt haben). Diese Zeile zeigt auch, wie es aussieht, wenn man ein Standardavatar für eine phpBB-Gruppe festlegt und dieses auch in MODx nutzt. Dies ist der empfohlene Weg.
Wenn man keine Privaten Willkommensnachrichten (Welcome PM) and neuregistrierte Nutzer versenden möchte kommentiert man Zeile 33 aus, indem man ein // and deren Anfang setzt.

3.4.4 welcome.php

Diese Datei erlaubt es die "Welcome PM's", welche (einmalig) an neuregistrierte Nutzer versendet werden, zu konfigurieren und individualisieren.
Wie in Zeile 25 kann man $BridgeUser als Platzhalter für den Nick des Empfängers verwenden. Man kann theoretisch auch jeden beliebigen anderen, zum Nutzer gehörenden, Wert verwenden, der entweder in MODx oder in phpBB gespeichert ist. Smilies und BBcode werden auch unterstützt.
In Zeile 45 wird $fields["phone"] die phpBB-Nutzer-ID zugewiesen. Wenn man, wie im vorigem Kapitel beschrieben, ein anderes Feld gewählt hat, ersetzt man "phone" durch den Namen des gewählten Feldes.
Die restlichen Werte des Arrays sollten selbsterklärend sein.

4. Allgemeine TIPPS & HINWEISE

4.1 Mit CSS die Ausgabe der Snippets individualisieren

Alle MODxBB-Snippets unterstützten CSS, d.h. sie erlauben es die Ausgabe optisch anzupassen. Es wird empfohlen ein CSS-Reset zu nutzen, um sicherzustellen, dass die Ausgabe auf allen Browsern identisch ist (das ist auch eine allgeimeine CSS-Empfehlung, nicht nur MODxBB-bezogen).
Die Page CSS Selektoren listet alle Selektoren, die man in der CSS-Datei anpassen kann, um das Aussehen der Ausgaben zu bestimmen, die von den MODxBB-Snippets generiert werden. Die Beispielwerte entsprechen den Werten, die auf MODxBB.net genutzt werden.

4.2 Separates Avatar fur den Blog bestimmen

Es ist möglich ein separates Avatar für den Blog zu bestimmen (unterschiedlich vom Forumavatar). Dasselbe gilt für alle anderen Profildaten. Denn Änderungen, die auf dem phpBB "Control Panels" vorgenommen werden, werden intern an MODx weitergeleitet, umgekeht ist dies jedoch nicht der Fall.
WICHTIG: Wenn man manuelle Änderungen im ADMIN Control Panel vornehmen muss (z.B. um den Benutzernamen eines Mitglieds zu ändern), muss dies auch manuell im MODx-Manager getan werden, da dies in dieser Version noch nicht automatisiert ist.

4.3 Inhalte vielseitig individuell anpassen

MODxBB erlaubt individuell vielfach anpassbare Inhalte. Man kann Inhalte für jeden Nutzer von Level, Rang und jeder anderen beliebigen, in MODx oder phpBB gespeicherten Eigenschaft abhängig machen.
Beispiele:
- Es ist möglich Inhalte nur für eingeloggte Benutzer sichtbar zu machen.
- Man kann ein Snippet schreiben, das jedem Werbung Anzeigt, außer Benutztern mit 1000 oder mehr Forumbeiträgen, oder denen mit einem bestimmten Rang, zum Beispiel "Premium Mitglied" (Individuelle Ränge können im phpBB-ACP erstellt werden).
- Man kann Mitglieder, die ihren Geburtstag feiern mit einer personalisierten Glückwunschnachricht begrüßen (z.B. Einen Happy-Birthday-Banner mit Namen und Geburtstag).

Mehr Details und Bespiele hierzu werden später auf dem MODxBB.net Blog veröffentlicht.

4.4 Authentifizierungssystem

Manche Leser mögen sich Fragen, warum man nicht einfach ausschließlich das phpBB-Authentifizierungssystem nutzt, wenn phpBB auf dieser Weise in den MODx-Pages integriert ist. Das ist in der Tat möglich, jedoch wenn man die Authentifizierung und damit die Nutzerkonten auf MODx-Seite komplett weglässt, werden manche für MODx geschriebene Add-Ons unbrauchbar. Das gilt auch für das Permission- und Rollen-System im MODx-Manager. Man könnte die Benutzterkonten (WebUser) auch nicht mehr im MODx-Manger verwalten..
Für wen das alles kein Problem darstellt und gleichzeitig vertraut mit PHP ist, kann dieses Vorhaben jedoch angehen. Es müssen lediglich die Zeilen deaktiviert werden, welche Aktualisierungen zu den MODx-Konten schicken.
Bei ausreichend Anfragen könnte ich irgendwann in der Zukunft auch ein Tutorium zu diesem Thema schreiben.

4.5 PluginBB-Links

Dies ist nur ein simpler Kurzhinweis der für manche trotzdem nützlich sein könnte. Die Links zu den phpBB-Profilen, welche von PluginBB in den MODx-Profilen generiert werden, kann man innerhalb des Frames öffnen. Wenn man ein Vollbild vorzieht, kann man den Link einfach in einem neuen Tab öffenen (mittlere Maustaste oder linke Maustaste + Shifttaste).

4.6 MODxBB-Logs

MODxBB generiert Logs, die man im MODx-Manager lesen kann (Reports -> System Events). Sie sollen dabei Helfen potentielle Probleme und Hackversuche schnell zu erkennen. Die wichtigsten Informationen werden Angezeigt, ohne dass man den Link für mehr Details klickt. Das spart Zeit und verbessert die Lesbarkeit. Login-Fehler werden in der Form "Fehlertyp - IP - Benutzername" angegeben, wobei P-fail bedeutet, dass ein falsches Passwort eingegeben wurde und U-fail bedeutet, dass ein falscher Benutzername eingegeben wurde.

4.7 Maßnahmen zum Eindämmen von SPAM

Dieses Thema bezieht sich nicht direkt auf MODxBB oder phpBB. Jeder, der ein Forum betreibt, wurde mit hoher Wahrscheinlichkeit schon einmal mit dem Spam-Problem konfrontiert. Besonders seit Anfang dieses Jahres scheint die Flut von Spamangriffen deutlich zugenommen zu haben.
Es gibt verschiedene Wege ein Forum vor Spam zu schützen. Dieses Kapitel sollte ursprünglich einige von ihnen vorstellen, da es aber bei phpBB.com schon einige hilfreiche Threads zu diesem Thema gibt, werde ich hier einfach links angeben:
Preventing Spam in phpBB3 - Die meisten der Empfehlungen sind auch für andere Forumsysteme brauchbar.
Spam Discussion - Zugehörige Diskussion, die zusätzliche Tipps beinhaltet.

4.8 Web-User mit Web2Manager befördern

Wenn sich ein Benutzer anmeldet, erstellt MODxBB ein entsprechendes Web-User-Konto in MODx. Web2Manager ist ein sehr nützliches Plug-in um bequem Web-User zu Manger-Usern zu befördern. Umgekehrt kann man damit auch eineWeb-User-Konto aus einem Manger-User erstellen. Konten die bereits existieren, werden aktualisiert.
Die neueste Version kann man hier herunterladen: Web2Manager-0.3.3.zip

5. Bekannte Probleme

5.1 Editieren von Titelumfragen

In sehr seltenen Fällen, kann ein Editieren einer existierenden Titelumfrage "ungefragt" zwei neue Optionen hinzufügen. Das passiert allerdings nur, wenn Gästen das wählen erlaubt ist UND Gäste ihre wahl ändern dürfen UND mehrere Optionen gewählt werden dürfen. Das in Erscheinung treten dieses Bugs ist sehr unwahrscheinlich, aber nicht unmöglich.
Lösung: Einfach die zwei hinzugefügten Optionen wieder löschen.

5.2 LoginBB-Logout

Wenn man sich ausloggt indem man den "logout" link von LoginBB benutzt, wird man zum Forumindex weitergeleitet und nicht zu der Seite, die man vor dem Logout besucht hat. Das ist beim Einloggen anders.
HINWEIS: Dies ist KEIN Bug. Die Besucher zurückzuschicken, wo sie vor dem Logout waren, würde das Editieren einer zusätzlichen Core-Datei bedeuten, während es Besuchern, die sich ausloggen in den meisten Fällen ohnehin egal ist, wohin sie weitergeleitet werden.
Lösung: Um Benutzer zurückzuschicken, wo sie vor dem Logout waren, muss man Änderungen an der phpBB-Funktion meta_refresh vornehmen.

5.3 Pagetags

MODx Pagetags ([~ID~]) werden auf Pages des phpBB-Forums nicht interpretiert. Das wird sich voraussichtlich in einer der Zukünftigen Versionen ändern.

N!Ce aka A.S. (translated by N!Ce)

Page-Informationen

Letzte Änderung:	20. November 2011
Page-Version:	1.2.2
Erste Version:	17. Mai 2011