In diesem Tutorial beschreiben wir den Weg der Plugin-Erstellung anhand eines Beispiels in verständlichen Worten und mit vielen ergänzenden Informationen.Zur Startseite des Tutorials

Plugin Hallo Welt

Beschreibung

Das "Hallo Welt" Plugin soll einen Begrüßungstext für das Mitglied über dem Forum anzeigen.


Wie kann das funktionieren?
Über ein Plugin-Template, welches auf jeder Seite des Forums ausgeführt wird.
Innerhalb des Plugin-Templates können wir auf verschiedene Template-Variablen zurückgreifen. Darunter auch z.B. {{username}} - der Name des Mitglieds, welches das Forum gerade besucht.

Bedarfsanalyse

Für die Planung unseres Plugins müssen wir zunächst überlegen, welche Plugin-Elemente wir benötigen.

• Template-Elemente
  - an welchen Stellen im Forum soll das Plugin später ausgeführt werden?
• Konfigurations-Variablen
  - welche Einstellungen soll der Admin später vornehmen können.
• Daten/Globale Variablen
  - welche Daten müsssen vom Plugin gespeichert werden

Plugin Elemente erstellen

Template-Elemente
Das Plugin soll auf allen Seiten des Forums angeziegt werden. Da wir einen Text ÜBER dem restlichen Forum anzeigen wollen, empfiehlt es sich ein Plugin-Template immer NACH dem Element "Obere Leiste" auszuführen.
Weitere Elemente werden vorerst nicht benötigt. Verschiedene Möglichkeiten der Positionierung und Anzeige des Plugin werden in Teil 3 dieses Tutorials - Positionierung - behandelt.

In der Plugin-Entwicklung wählen wir also
Neues Element erstellen->Template-Element, um die Maske für die Erstellung eines neuen Template-Elementes zu öffnen.
Wir wählen als Template das Element Obere Leiste
Als Position wählen wir footer (siehe Kasten Position eines Plugin-Elements)
Den Template-Namen vergeben wir automatisch.

nach dem Klick auf Hinzufügen wird das Plugin-element angelegt und erschient nun in der Liste der Pages eines Plugins.



Konfigurations Variablen
In dieser ersten Version des Plugins können keine Einstellungen durch den Admin vorgenommen werden - wir benötigen daher auch vorerst keine Konfigurations-Variablen.

Daten/Globale Variablen
In dieser Version des Plugins werden auch keine Daten gespeichert. Es werden daher auch keine Datenvariablen benötigt.

Plugin Elemente füllen

Mit einem Klick auf den Bleistift in der Plugin-Elemente-Liste können wir das Template zur Bearbeitung öffnen.
Testweise schreiben wir hier einfach nur "Hallo Welt" und speichern das Element.







Ein kurzer Test auf der Foren-Startseite sollte uns bestätigen, dass dort nun unser Plugin-Element ausgeführt wird und der Text "Hallo Welt" erscheint.




Jetzt, da unser Plugin ausgeführt wird können wir den ausgebenen Text verfeinern.

Für dieses Tutorial beschränken wir uns zunächst auf die Anzeige des Benutzernamens (bei Mitgliedern) bzw. dem Hinweis für Gäste, dass diese sich registrieren sollen:

Die Kommentare (<!-- Kommentar ->) dienen nur zur Erklärung und werden für die Lauffähigkeit des Plugins nicht benötigt.

Fertig

Nun sollte auf jeder Seite des Forums ein Text ausgegeben werden.
Mitglieder werden mit ihrem Benutzernamen begrüßt, Gästen wird der Link zur Anmeldung angezeigt.