In diesem Tutorial beschreiben wir verschiedene Möglichkeiten festzulegen, wo ein Plugin im Forum sichtbar werden soll.Zur Startseite des Tutorials

Plugin Hallo Welt - Positionen

Beschreibung

In diesem Tutorial sollen die verschiedenen Positionierungsmöglichkeiten erlernt werden.
Dazu werden verschiedene Template-Elemente angelegt, die an unterscheidlichen Stellen angezeigt werden.

Allgemeines

Beim Anlegen eines Plugin-Template-Elements muss immer ein zugehöriges Foren-Template bestimmt werden.
Immer dann, wenn das Foren-Template geladen wird, wir später auch das Plugin angezeigt.

Eine Foren-Seite besteht in der Regel aus drei Template-Elementen

Kopfzeile
In der Kopfzeile befinden sich der Foren-Header und das Menü. Sie ist auf jeder Seite des Forums identisch. Das verwendete Template Element heißt obere Leiste

Hauptbereich
Dieser Bereich ist auf jeder Seite unterschiedlich. Auf der Startseite wird z.B. das Template-Element Forum Übersicht geladen. In der Themen-Ansicht das Template-Element Thread Flat
Es kann auch vorkommen, dass im Hauptbereich mehrere Template-Elemente geladen werden. So gibt es z.b. ein Template Element Umfragen welches bei Bedarf von anderen Template-Elementen eingebunden wird.

Fußzeile
Auch dieser Teil ist auf jeder Seite des Forums identisch. Er enthält i.d.R. die Fußzeile und die Links zur Mitgliederliste und FAQ. Das Verwendete Template Element lautet Untere Leiste


Für die Anzeige von Plugin-Elementen bedeutet das also folgendes:
Soll ein Plugin-Template auf jeder Seite des Forums ausgeführt werden, macht es Sinn, es den Template Elementen obere Leiste oder untere Leiste zuzuordnen, da nur diese Elemente überall angezeigt werden.
Soll ein Plugin dagegen auf bestimmten Seiten des Forums angezeigt werden, muss das Plugin-Element dem entsprechenden Template-Element zugeordnet sein. Ein Plugin, welches neben Beiträgen zusätzliche Informationen anzeigt wird also dem Element Thread Flat zugeordnet.

Platzierung innerhalb des zugeordneten Templates

ist das passende Template-Element erst einmal gefunden muss man sich entscheiden, wo genau das Plugin-Template angezeigt werden soll.
Dabei stehen drei Optionen zur Auswahl:

Header
Das Plugin-Template wird VOR dem zugeordneten Foren-Template geladen

Footer
Das Plugin-Template wird NACH dem zugeordneten Foren-Template geladen

Inline-Element
Das Plugin-Template wird INNERHALB des zugeordneten Foren-Template geladen.
Diese Einstellung ermöglicht es, auch komplexere Plugin-Aufgaben zu realisieren. Das Plugin-Template wird dabei einer bestimmmten Markierung innerhalb des Foren-Templates zugeordnet.
Immer, wenn diese Markierung erreicht wird, wird auch das Plugin-template geladen. So kann ein und das selbe Plugin-Element auch innerhalb von Schleifen (z.B. nach jedem Beitrag) ausgeführt werden.

Sobald ein zugehöriges Plugin-Element gewählt wird, aktualisiert sich die Liste der vorhandenen Markierungen automatisch.

Beispiele

Wir wollen für das "Hallo Welt" Plugin einige Template-Elemente anlegen um die verschiedenen Positionierungen zu testen.

Wir legen dafür drei neue Template-Elemente an:

Feldname	Wert
Template	Obere Leiste
Ausführung	Header
Template-Name	test_oben

Feldname	Wert
Template	Untere Leiste
Ausführung	Footer
Template-Name	test_unten

Feldname	Wert
Template	Thread Flat
Ausführung	Inline Element
Element	thread_after_message
Template-Name	test_beitrag

Inhalt
Die neuen Elemente müssen wir nun noch mit Inhalten befüllen. Da es hier nicht um die Funktionalität, sondern nur um das Verständnis der Anzeige geht reichen uns einfache Textausgaben:

Inhalt für das Element test_oben

Inhalt für das Element test_unten

Inhalt für das Element test_beitrag

Testen

jetzt können wir überprüfen, ob alles richtig angezeigt wird.

Elemente löschen

Dieses Tutorial diente nur der Vertiefung des Verständnisses der Positionierung vom Plugin-Template-Elementen. Die angelegten Elemente samt der zugehörigen Seiten können jetzt wieder gelöscht werden.
Dazu löschen wir zunächst die Zuordnungen, welche festlegen welche Pllugin-Elemente bei welchen Foren-Elementen ausgeführt werden:


Dann löschen wir die eigentlichen Plugin-Elemente: