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
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 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.
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.

screenshot
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


screenshot
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.

screenshot
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
 

<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.

screenshot
Fertige Anzeige im Forum



Du willst es noch genauer wissen?
Weiter geht's im zweiten Teil des Tutorials: Positionierung
Hinweis





Login
Activity Feed
forum_message forum_message
Ich löse das Problem, indem ich das Zielthema in ein Testforum mit wenigen Fäden verschiebe, danach die gewünschte Aktion durchführe und das Zielthema wieder zurück in das Ursprungsforum transferiere.
forum_message forum_message
Zitat von Olaf im Beitrag #3Das liegt an Windows selber,entweder einen Absturz gehabt (war bei mir) oder ein Update nicht richtig ausgeführt,das eine Datei defekt geworden ist.Ich möchte meine Aussage korrigieren.Nachdem ich den PC nach und nach neu aufgebaut habe,habe ich später festgestellt,das pl...
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
River und Scooter haben 2 neue Beiträge im Thema VIP - Bezahlte Mitgliedschaften - Geld verdienen mit deinem Forum geschrieben.
@Scooter Forenkonto gibt's hier auch Wiki:Tutorial-ForenkontoViele GrüßeRiver
forum_message forum_message
River, spotter46 und m3ontour haben 4 neue Beiträge im Thema Als normales Mitglied Textbausteine erstellen geschrieben.
Zitat von m3ontour im Beitrag #6War den geschätzten Mitgliedern etwas zu aufwändig!Das Problem ist hier, wo der Textbaustein gespeichert wird. Wenn man extra eine Worddatei oder ähnliches öffnen muss, ist das schon ein Umweg.Schneller geht es, wenn man auf 'Notizen' oder im Editor Textbausteine spei...
rating rating
m3ontour hat sich bedankt!
Beitrag: Als normales Mitglied Textbausteine erstellen
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_topic forum_topic
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...
forum_message forum_message
Silberfischchen und Ingmar haben 2 neue Beiträge im Thema Umlaute nur von und bei einer einzige Userin als Hieroglyphen angezeigt. geschrieben.
Danke derweil, ich frage die Rückfragen noch rück und außerdem ob sie noch ein anderes Gerät zur Verfügung hat zum testen.Ihr seid klasse!
rating rating
%usernames% hat sich bedankt!
rating rating
Johannes hat sich bedankt!
Beitrag: Wofür führt ihr euer Forum?
%usernames% hat sich bedankt!
forum_message forum_message
Scooter hat einen neuen Beitrag im Thema Wofür führt ihr euer Forum? geschrieben.
Wir fahren Roller oder auch Scooter in der oberen Liga.Das Forum dient Deutschland weit zum Austausch von Informationen bis zu Reparatur und Umbau Tipps.Letzte Woche habe ich gestartet und mich täglich 14 Stunden damit befasst.Seit heute bin ich auch hier angemeldet und werde als Laie wohl öfter mal...
rating rating
Scooter hat sich bedankt!
Beitrag: Wofür führt ihr euer Forum?
%usernames% hat sich bedankt!
rating rating
Scooter hat sich bedankt!
Beitrag: Wofür führt ihr euer Forum?
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Zitat von sikookis im Beitrag #109Ist es möglich, das Plugin ´Countdown´ auf jeder Forums-seite sichtbar zu machen?Das lässt sich machen.Neues Update:Version 0.100- Countdown auf jeder Seite im Forum sichtbarGrußOlaf
forum_message forum_message
Olaf und Silberfischchen haben 2 neue Beiträge im Thema Umlaute nur von und bei einer einzige Userin als Hieroglyphen angezeigt. geschrieben.
Den Spass hatte ich vor kurzem auch.Das lag bei mir nicht an Xobor und auch an keinen Browser.Alle Browser zeigten das selbe mit den nicht codierten Umlauten an.Selbst der boardeigene Editor in Windows zeigt die nicht codierten Umlauten an.Allerdings nicht bei allen Schriftarten.Meist nur bei kleine...
forum_message forum_message
l2otbart_57, Mike48 und spotter46 haben 3 neue Beiträge im Thema Als normales Mitglied Textbausteine erstellen geschrieben.
ich greife mal Spotters Vorschag aus #2 auf.Falls du noch keine Vorstellung hast, wie so ein Textauswahl aussehen könntein der Iconbar einen HTML-Icon erstellen:Name: txt-bausteinHTML:123456789101112131415161718 <div class="xob_icon_cont" ><select id="icon-sel" style="width:7em" title="Text-Baustei...
rating rating
Ingmar hat sich bedankt!
Beitrag: Web App Einstellungen werden nicht gespeichert
%usernames% hat sich bedankt!
forum_message forum_message
Haze und Ingmar haben 2 neue Beiträge im Thema Web App Einstellungen werden nicht gespeichert geschrieben.
Ja, jetzt klappt es - vielen Dank für die schnelle Hilfe!
forum_topic forum_topic
m3ontour hat das Thema Als normales Mitglied Textbausteine erstellen erstellt
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...
forum_message forum_message
Mike48 und old-smokey haben 3 neue Beiträge im Thema Fehler beim Beitragszähler geschrieben.
von mir gelöscht
forum_topic forum_topic
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...
rating rating
Ingmar hat sich bedankt!
Beitrag: Fehler beim Beitragszähler
%usernames% hat sich bedankt!
forum_topic forum_topic
Mike48 hat das Thema Wiki um die neue Admin erweitern erstellt
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...
forum_topic forum_topic
old-smokey hat das Thema Fehler beim Beitragszähler erstellt
@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...
forum_message forum_message
m3ontour und Ingmar haben 3 neue Beiträge im Thema Gibt es ein Backup für das Xobor Wiki geschrieben.
Hallo Ingmar,die Überschrift bleibt bestehen! Oder wie du sagst Text.Aber die angehängten Daten sind weg!Und das bei allen Beiträgen von "Murkser" Vielen Dank
forum_message forum_message
Rocrail und Ingmar haben 2 neue Beiträge im Thema Private Nachrichten pro Benutzer Ein-/Ausschalten geschrieben.
Hallo Ingmar,ja genau: Diese Einstellungsmöglichkeit wäre supper.
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Web App Einstellungen werden nicht gespeichert geschrieben.
Zitat von Haze im Beitrag #12Ich denke, der Unterschied ist: Ihr seht in der Konfiguration, dass sich was geändert hat. Bei mir klappt das nicht.Ich kann das Problem bei euch im Forum reproduzieren.Warum das so ist sehe ich auf Anhieb nicht. Ich melde mich, sobald ich die Ursache gefunden habe.
rsummary rsummary
m3ontour und Scooter haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Gabriella und Johannes haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Scooter und spotter46 haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
1 Mitglied und 14 Gäste sind Online
Besucher Statistiken
15 Aktive User
1 Mitglied und 14 Gäste sind Online:
nobody

Heute waren Online
nobody

Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 45 Gäste und 5 Mitglieder, gestern 931 Gäste und 24 Mitglieder online.

Statistiken
Themen 41779
Beiträge 305809
Mitglieder 12.472
Forum empfehlen