Plugin Tutorial für Einsteiger - 1.0 Erste Schritte
Hallo Welt - 1.0 Erste Schritte
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
Allgemeiner Hinweis:
Es empfiehlt sich, dieses Tutorial in einem Testforum auszuprobieren, um den laufenden Betrieb im Hauptforum nicht zu beinträchtigen.
Erstellen Sie dazu einfach bei Bedarf ein neues Forum unter www.xobor.de
Es empfiehlt sich, dieses Tutorial in einem Testforum auszuprobieren, um den laufenden Betrieb im Hauptforum nicht zu beinträchtigen.
Erstellen Sie dazu einfach bei Bedarf ein neues Forum unter www.xobor.de
Hinweis
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.
Eine Übersicht über die Template-Variabeln, die auf jeder Seite des Forums zur Verfügung stehen findest du hier
Hinweis
Dieses Tutorial geht davon aus, dass das Plugin "Hallo Welt" bereits angelegt wurde. Klicken Sie hier für eine Anleitung zur Plugin-Erstellung hier
Hinweis
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-Dokumentation: Übersicht der Plugin-Elemente
Plugin API
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.
Position eines Plugin-Elements
Die Position eines Plugin-Templates legt fest, wann genau der code des Plugins ausgeführt wird.
Header: bei dieser Einstellung wird das Plugin VOR dem augewähltem Template ausgeführt
Footer: bei dieser Einstellung wird das Plugin NACH dem augewähltem Template ausgeführt
Inline-Element: bei dieser Einstellung wird das Plugin innerhalb des Templates bei einer bestimmten Markierung ausgeführt.
So kann z.B. ein Plugin-Element auch innerhalb einer Schleife eines anderen Templates mehrfach ausgeführt werden. Dazu wird in Kürze ein eigenes Tutorial veröffentlicht.
Die Position eines Plugin-Templates legt fest, wann genau der code des Plugins ausgeführt wird.
Header: bei dieser Einstellung wird das Plugin VOR dem augewähltem Template ausgeführt
Footer: bei dieser Einstellung wird das Plugin NACH dem augewähltem Template ausgeführt
Inline-Element: bei dieser Einstellung wird das Plugin innerhalb des Templates bei einer bestimmten Markierung ausgeführt.
So kann z.B. ein Plugin-Element auch innerhalb einer Schleife eines anderen Templates mehrfach ausgeführt werden. Dazu wird in Kürze ein eigenes Tutorial veröffentlicht.
Hinweis
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.
Abbildung 1: Leeres Plugin Template Element "obere Leiste"
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.
Tipp: Plugin-Templates können auch mit der Tastenkombination Strg-S abgespeichert werden.
Hinweis
Template 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.
Anzeige im Forum
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.
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
<div style="text-align:center"><!-- hier öffnen wir ein HTML-Element von Typ div und erklären, dass der Inhalt zentriert angezeigt werden soll-->
{{user_registered==true.start}}<!-- der jetzt folgende Teil wird nur für angemeldete Benutzer ausgegeben -->
Hallo {{user_name}}<br/>
Willkommen im Forum<br/><br/>
{{user_registered==true.else}}<!-- der jetzt folgende Teil wird nur für nicht angemeldete Benutzer ausgegeben -->
Hallo lieber Besucher<br/>
Bitte <a href="/anmeldung.php">melde dich an</a>, um alle Bereiche des Forum zu sehen.<br/><br/>
{{user_registered==true.end}}
</div>
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.
Fertige Anzeige im Forum
Du willst es noch genauer wissen?
Weiter geht's im zweiten Teil des Tutorials: Positionierung
Weiter geht's im zweiten Teil des Tutorials: Positionierung
Hinweis
Login
Activity Feed
Gestern 11:50
Dieter Weißbach hat das Thema Verschieben von Beiträgen an ein vorhandenes Thema - Zielthema schlecht zu finden erstellt
Hallo in die Runde,wir sind bei uns im Historischen Modellbahnforum auf ein unschönes Verhalten beim Verschieben von Beiträgen an ein vorhandenes Thema gestoßen.Zur Erläuterung:Es gibt bei uns die öffentlichen Unterforen, wo relativ unstrukturiert gepostet wird.Manchmal ist ein neues Thema so intere...
Hallo Ihr,gibt es die Möglichkeit das sich normale Mitglieder einen Textbaustein erstellen?Bitte keine Diskussion über Sinn oder Unsinn! Ein sehr aktives Mitglied bei uns möchte sich gerne ein Paar Textbausteine anlegen die er dann nach dem Einfügennur noch personalisiert.Ich habe aber keinen Plan o...
27.01.2025 16:18
Silberfischchen hat das Thema Umlaute nur von und bei einer einzige Userin als Hieroglyphen angezeigt. erstellt
Hallo, liebe Supporter.Eine Userin bei uns nickname bleutje berichtet hier inkl. Screenshots vom Problem falsch dekodierter Umlaute, was erst seit 2 oder 3 Tagen so ist und nach Aussage der Userin ausschließlich in unserem Forum auftritt. https://www.haar-hausen.de/t34f41196-Fra...0.html#msg69669Was...
Im Wike ist alles noch auf die alte Admin ausgerichtet, die Beschreibungen und die Bilder.Wenn ihr aber bald nur noch die neue Admin haben wollt, dann sollte auch möglichst bald das Wiki auch die neue Admin zeigen und beschreiben. Würde bestimmt vielen den Wechsel in die neue Admin erleichtern. Waru...
@Ingmar Es dürfte wohl kein wirklich großes Problem sein, aber vielleicht kannst du bei Gelegenheit mal kurz draufschauen. Es könnte ja auch häufiger passieren, nur bei größeren Zählerständen fällt das dann nicht mehr aufBei einem User werden 4 Beiträge laut Zähler gezeigt, in seinem Profil sind jed...
%usernames% hat sich bedankt!
%usernames% hat sich bedankt!
%usernames% hat sich bedankt!
Wer ist Online?
1 Mitglied und 14 Gäste sind OnlineBesucher Statistiken
Statistiken
Themen | 41779 |
Beiträge | 305809 |
Mitglieder | 12.472 |
Forum empfehlen