Plugin Tutorial für Einsteiger - 1.2 Konfigurations Variablen

Hallo Welt - 1.2 Konfigurations Variablen

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


Konfigurationsvariablen für das Plugin Hallo Welt



Beschreibung


In diesem Tutorial wollen wir dem Admin die Möglichkeit geben, die Schriftgröße sowie die Ausrichtung des angezeigten Textes zu verändern.


Wie kann das funktionieren?
Über Konfigurationsvariablen, die vom Admin eingestellt werden und danach vom Plugin ausgelesen werden können.


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
- für diesen Teil des Tutorials benötigen wir keine zusätzlichen Template-Elemente

Konfigurations Variablen
wir benötigen 2 Einstellmöglichkeiten: Die Position und die Schriftgröße des Textes

Wir wählen also in der Plugin-Entwicklung zunächst neue Config-Variable und legen dort eine Variable mit folgenden Werten an:
Name: hallowelt_ausrichtung
Gewichtung: 1
Titel: Ausrichtung des Willlkommens-Textes
Beschreibung: Bitte wählen Sie hier die Ausrichtung des Textes (left, right oder center)
Hidden: Nein
Type: Chars
Chars: center //standardwert

Tipp: Um Probleme mit Variablen anderer Plugins zu vermeiden sollte ein eindeutiger Name vergeben werden. In diesem Fall wird einfach die PluginID und ein Unterstrich vor den eigentlichen Varablennamen hinzugefügt
Hinweis



Die zweite Variable soll die Schriftgröße speichern und wird dafür mit folgenden Werten erstellt:

Name: hallowelt_schriftgroesse
Gewichtung: 2
Titel: Schriftgröße des Willlkommens-Textes
Beschreibung: Bitte geben Sie hier die gewünschte Schriftgröße ein. (z.B. 12px)
Hidden: Nein
Type: Chars
Chars: 12px //standardwert

screenshot
Abbildung 1: Konfigurations-Variablen im "Plugin bearbeiten"-Modus


Zwischenergebnis:
Der Administrator kann nun in den Einstellungen des Plugin die Werte der Konfigurationsvariablen bei Bedarf anpassen:
screenshot
Abbildung 2: Konfigurations-Variablen aus Sicht des Administrators




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


Damit die Einstellungen des Administrators auch umgesetzt werden, müssen wir natürlich das Plugin Template "obere leiste" entsprechend bearbeiten.

Genau wie andere Template-Variablen werden Plugin-Variablen immer über doppelte geschweifte Klammern gekennzeichnet. Der Name der Variable wird dabei immer nach dem gleichen Muster erzeugt:
{{plugin_pluginid_variablentyp_variablenname}}

Auf die Konfigurationsvariable hallowelt_schriftgroesse können wir daher über folgenden aufruf zugreifen:
{{plugin_hallowelt_config_hallowelt_schriftgroesse}}

Damit man sich diese langen Variablennamen nicht merken muss gibt es eine einfache Möglichkeit, den Namen ins Template zu übernehmen.
Dazu muss man nur mit der Maus über den Text "Config Variablen" in der oberen rechten Ecke fahren - schon öffnet sich ein Fenster, welches alle Konfigurationsvariableen auflistet.
Durch einen Klick auf TPL-Insert wird der Template-Code automatisch in das Plugin-Template eingefügt.
JS-Insert erzeugt übrigens einen Javascript-Code, der die Variable per Javascript zur Laufzeit lädt. Das ist aber Teil eines anderen Tutorials
screenshot
Abbildung 3: Konfigurations-Variablen einfügen


Damit die Einstellungen des Admins auch greifen übernehmen wir die Werte der Config-Variablen in den Code:

1
2
3
4
5
6
7
8
9
10
11
 

<div style="text-align:{{plugin_hallowelt_config_hallowelt_ausrichtung}}">
{{user_registered==true.start}}
Hallo {{user_name}}<br/>
Willkommen im Forum<br/><br/>
{{user_registered==true.else}}
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:
Hinweis





Login
Activity Feed
forum_message forum_message
zickzack und Ingmar haben 2 neue Beiträge im Thema Die top 500 Seite funktioniert nicht mehr geschrieben.
Sag ich ja., 😜Die Seite funktioniert schon, aber zeigt halt seit Tagen das selbe Bild.
forum_topic forum_topic
zickzack hat das Thema Die top 500 Seite funktioniert nicht mehr erstellt
Seit ein paar Tagen?!
forum_message forum_message
spotter46 und Hannah haben 2 neue Beiträge im Thema Log in klappt nicht geschrieben.
Hat sie meine Tipps denn wenigstens ausprobiert ?
rating rating
Gabriella hat sich bedankt!
Beitrag: Plugin audio_msg - mp3 im Beitrag abspielen
%usernames% hat sich bedankt!
rating rating
l2otbart_57 hat sich bedankt!
Beitrag: Mehrere Talk-Themen
%usernames% hat sich bedankt!
forum_message forum_message
l2otbart_57 hat einen neuen Beitrag im Thema Plugin audio_msg - mp3 im Beitrag abspielen geschrieben.
Danke Ingmar,das Plugin ist freigeschaltet.zur Erinnerung: um Audio-Dateien hochladen zu können, ist ein Premiumtarif notwendig.
rating rating
Ingmar hat sich bedankt!
Beitrag: Log in klappt nicht
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Keine E-Mail mehr an ...@outlook.de
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Keine E-Mail mehr an ...@outlook.de
%usernames% hat sich bedankt!
forum_message forum_message
spotter46 und TripleM haben 2 neue Beiträge im Thema Keine E-Mail mehr an ...@outlook.de geschrieben.
Zitat von TripleM im Beitrag #4Hallo Mike, hätte mich gewundert, denn ich bekomme die in Outlook. Allerdings auch im Junkmail Ordner.Egal wie ich vorgehe, bisher habe ich das noch nicht hin bekommen die Normal im Postfach zu erhalten. Nun gut ich weiß es und schaue öffter rein.Dir noch einen schönen...
forum_message forum_message
spotter46 hat einen neuen Beitrag im Thema Log in klappt nicht geschrieben.
Gerade beim kleinen Smartphone-Display kommt es häufiger zu Tippfehlern und/oder die Groß-/Kleinschreibung wird nicht beachtet.Mobil lässt sich das Passwort anzeigen, siehe mit Pfeil gekennzeichnetes Symbol.[[File:Screenshot_20250717_174502_Chrome.jpg|none|auto]]Denn außer dem Geschilderten habe ich...
rating rating
balea hat sich bedankt!
Beitrag: Favicon nur bei Xobor-Homepage?
%usernames% hat sich bedankt!
forum_topic forum_topic
Hannah hat das Thema Log in klappt nicht erstellt
Hallo und einen guten Tag euch Allen.Ein Mitglied unseres Forums hat sich an ihrem Laptop registriert mit allen erforderlichen Daten. eMail, Benutzernamen, Kennwort.Am Laptop kann sie sich ohne Probleme wieder anmelden/einloggen.Sie hat aber noch ein Tablet und ein Handy und da klappt es mit der Anm...
rating rating
Wolfgang hat sich bedankt!
Beitrag: Blog Probleme, Pagination
%usernames% hat sich bedankt!
rating rating
Wolfgang hat sich bedankt!
Beitrag: Blog Probleme, Pagination
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Favicon nur bei Xobor-Homepage? geschrieben.
Zitat von pasdoe im Beitrag #25Hattest du dazu schon Gelegenheit? Google hat nach Reindex über Search Console weiterhin euer Favicon drinnen..Sorry hatte vergessen hier zu antworten:Ja, ich habe mir das angeschaut und das Problem gefunden:Wenn man ein "altes" Template verwendet, die mobile Ansicht a...
rating rating
Wolfgang, l2otbart_57 und JanB haben sich bedankt!
Beitrag: Blog Probleme, Pagination
%usernames% haben sich bedankt!
rating rating
Wolfgang hat sich bedankt!
Beitrag: Blog Probleme, Pagination
%usernames% hat sich bedankt!
rating rating
balea hat sich bedankt!
Beitrag: Favicon nur bei Xobor-Homepage?
%usernames% hat sich bedankt!
forum_message forum_message
pasdoe hat einen neuen Beitrag im Thema Favicon nur bei Xobor-Homepage? geschrieben.
Zitat von Ingmar im Beitrag #24Ich habe gerade gemerkt, dass in der mobilen Version die Standard-Icons verwendet werden, wenn kein V6 Template aktiv ist. Eventuell ist das ein Problem für die Anzeige bei Google. Ich versuche das morgen zu beheben.Hattest du dazu schon Gelegenheit? Google hat nach Re...
forum_message forum_message
Ingmar und l2otbart_57 haben 3 neue Beiträge im Thema Blog Probleme, Pagination geschrieben.
Zitat von l2otbart_57 im Beitrag #3kurze Nachfrage, im Grunde kenne ich mit dem Blogsystem gar nicht aus.Alles gut. Um ehrlich zu sein geht es mir da ähnlich. Das war damals nicht "meine Baustelle".Zitat von l2otbart_57 im Beitrag #3wenn ich als Gast einen Artikel ansehe https://test-2022.xobor.de/b...
rating rating
Ingmar hat sich bedankt!
Beitrag: Keine E-Mail mehr an ...@outlook.de
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 hat 2 neue Beiträge im Thema Keine E-Mail mehr an ...@outlook.de geschrieben.
Berichtigungoutllook.de kommen doch an. Sind allerdings im Junk Ordner gelandet. Den habe ich leider übersehen obwohl eigentlich nicht blind bin, sondern nur schwerhörig.
forum_message forum_message
Nochmals vielen Dank.
rating rating
JanB hat sich bedankt!
Beitrag: Blog Probleme, Pagination
%usernames% hat sich bedankt!
forum_message forum_message
spotter46 und 3 weitere haben 6 neue Beiträge im Thema Mehrere Talk-Themen geschrieben.
Hallo Bernd,zumindest in V3 tut sich nichts.Habe beide Scripts probiert.
forum_message forum_message
Muenggi hat einen neuen Beitrag im Thema Schriftgrösse im Talk geschrieben.
Oh Schande über mich. Klar meinte ich Chat. Habe auch schon geantwortet und berichtigt.Aber wohl nicht abgeschickt.
forum_topic forum_topic
l2otbart_57 hat das Thema Blog Probleme, Pagination erstellt
Blog Probleme, PaginationBlogs spielen derzeit nur eine Nebenrolle in Foren. Liegt vielleicht dadran, weil einiges nicht so funktioniert, wie es erwartet wird.als Beispiel habe ich im V4 einen Userblog für userid=2 aufgemacht und mit 11 Artikeln gefüllt. in den Blogeinstellungen habe ich 5 Artikel/S...
forum_topic forum_topic
Mike48 hat das Thema Keine E-Mail mehr an ...@outlook.de erstellt
Ich bekomme schon länger keine E-Mails mehr an mein E-Mail Konto bei outlook.de
forum_message forum_message
Hannah und 2 weitere haben 3 neue Beiträge im Thema Themen zu einem bestimmten Termin (späteren Zeitpunkt) veröffentlichen geschrieben.
Vielen Dank ihr Zwei, das hilft mir schon sehr weiter
rating rating
%usernames% hat sich bedankt!
rsummary rsummary
Gabriella und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Ingmar und 1 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Wolfgang hat 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Wolfgang und 3 weitere haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
4 Mitglieder und 662 Gäste sind Online
Besucher Statistiken
666 Aktive User
4 Mitglieder und 662 Gäste sind Online:
Johannes, nobody, Ingmar, Bussinchen

Heute waren Online
Johannes, kacz, nobody, spotter46, zickzack

Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 1342 Gäste und 5 Mitglieder, gestern 4156 Gäste und 22 Mitglieder online.

Statistiken
Themen 42027
Beiträge 307820
Mitglieder 12.586
Forum empfehlen