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
Letzte Aktionen im Forum
forum_message forum_message
Ich habe bei meinem Code in Beitrag #5 etwas übersehen. Im newMsg-Array ist die Variable newmsg:pt leider nicht verfügbar. Der Code wird so nicht funktionieren.Ein anderer Ansatz wäre, den bestehenden Activity Feed mit JavaScript (clone()) zu kopieren und bei diesem die Themen oder Beiträge mit CSS ...
forum_message forum_message
Franzi Lück hat einen neuen Beitrag im Thema Mailadressen kein Zugriff geschrieben.
Hallo, Ich habe seit zwei Wochen das selbe Problem wie Lobbo. Weder ich noch meine Moderatoren können auf ihre Mailadresse zugreifen. LG Forennummer: 852020
forum_message forum_message
River, Bruno und Gabriella haben 8 neue Beiträge im Thema PDF Dateien in einem Ordner sammeln geschrieben.
Zitat von Bruno im Beitrag #8Ist sicherlich eine sache für später.Ja, schau dir das später mal an. Es ist auch Ansichts- und Geschmackssache. Für redaktionelle Inhalte dieser Art finde ich eben den Blog ansprechender, zumal es auch dort Kategorien gibt. Rechteeinstellung ist auch vorhanden.Viele Grü...
forum_message forum_message
Zeigt nun wieder alles richtig an
forum_topic forum_topic
Hallo zusammen, bei mir gibt es für jeden Monat einen Rundbrief. Ich würde gerne diese Rundbriefe in einem Ordner sammeln/archivieren , so dass Mitglieder, die später dazukommen oder den Rundbrief verbummelt haben, ihn nochmals aufrufen können. Lässt sich das umsetzen?
forum_topic forum_topic
Mir ist grade aufgefallen das einige Mitglieder die heute online waren nicht in der Liste der online gewesenen aufgelistet werden.hier ein Bsp.[[File:mgliste.PNG|none|auto]]Es gibt auch noch weitere die heute da waren aber in der Liste nicht aufgeführt sind.Foren-Nummer 526321Business Template (v4)
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Profil in ein anderes Profil gerutscht geschrieben.
Zitat von Charles im Beitrag #3wie kann das überhaupt passieren, das sich ein Profil in ein anderes drängt?Kann es sein, dass du das Plugin "Alter Ego" verwendest und deine Meldungen damit zusammenhängen? Was soll "das sich ein Profil in ein anderes drängt" bedeuten?`Du hattest gemeldet, dass jemand...
forum_message forum_message
Creator, erst einmal DANKE für die schnelle Antwort.Leider funktioniert es nicht so, wie erhofft. Hier der neue Code inkl. Deiner Ergänzungen (oder habe ich etwas falsch gemacht?){{get_new_messages(newmsg,20)}}<ul class="noimage lastactions forums" id="xActivityFeed">{{newmsg.startlist}}{{msgpos.sta...
forum_message forum_message
Es gibt den index pt im messages-Array, mit dem du die relative Position eines Beitrags bestimmen kannst. Position 1 wäre damit der erste Beitrag eines Themas, den du, wenn ich das richtig verstanden habe, ausschließen möchtest. Da der Vergleich nur in einer Variable funktioniert, musst du vorher ei...
forum_message forum_message
Kordi und Ingmar haben 2 neue Beiträge im Thema Fehlerhafte Sortierung im Familiennamen-Forum geschrieben.
Ingmar, Recht herzlichen Dank für die Antwort. Dann werden wir mal sehn, was es nach dem Update macht.Viele Grüße Kordula
rating rating
Charles hat sich bedankt!
Beitrag: Profil in ein anderes Profil gerutscht
%usernames% hat sich bedankt!
forum_message forum_message
Charles und Ingmar haben 2 neue Beiträge im Thema Profil in ein anderes Profil gerutscht geschrieben.
wie kann das überhaupt passieren, das sich ein Profil in ein anderes drängt?hab ich jetzt auch gemacht
forum_message forum_message
Düsseltal hat einen neuen Beitrag im Thema Activity Feed » Eigene Seite » 50 News geschrieben.
Kann man statt new_messages auch die zuletzt eingestellten 20 Themen anzeigen lassen?
forum_message forum_message
Hallo Ingmar,danke für Deine Antwort.Ich verwende das Business Template (v4)Inzwischen habe ich hier im Forum von der Größenveränderung gelesen. Dies ist schon mal eine große Hilfe.Interessiert wäre ich an mehr als 25 Beiträgen in der Activity Feed Box, zudem wäre ich unendlich froh, könnte ich zwei...
forum_message forum_message
Wo genau ist "im Download"?
forum_message forum_message
Jim hat einen neuen Beitrag im Thema Linien-Farbgebung geschrieben.
Herzlichen Dank euch Beiden. Genau Das war's! Jetzt ist's so, wie ich's mir vorstellte.[[File:HeaderBalken.PNG|none|auto]]
rating rating
Jim hat sich bedankt!
Beitrag: Linien-Farbgebung
%usernames% hat sich bedankt!
rating rating
Jim hat sich bedankt!
Beitrag: Linien-Farbgebung
%usernames% hat sich bedankt!
rating rating
844er hat sich bedankt!
Beitrag: Linien-Farbgebung
%usernames% hat sich bedankt!
forum_topic forum_topic
Halloes hört sich wahrscheinlich unglaublich anDoch ein Mitglied wollte sein Profilbild erneuern und nun ist die Dame männlich gewordenWie kann man diesen Fehler beheben?lg
forum_message forum_message
Mike48 und River haben 2 neue Beiträge im Thema Linien-Farbgebung geschrieben.
Admin → Layout → Farben & Einstellungen → CSS123456 /* Top Navi andere Farbe */.topnavigation_wrap { background-image: unset; border-bottom: unset; background-color: #3f444a;} 
forum_message forum_message
Kordi hat einen neuen Beitrag im Thema Fehlerhafte Sortierung im Familiennamen-Forum geschrieben.
Zu meiner Frage, kann da etwas gemacht werden?Viele Grüße,Kordula
forum_message forum_message
Ingmar und Patty haben 2 neue Beiträge im Thema Forum läd langsam geschrieben.
Zitat von Patty im Beitrag #22Das Problem mit den fehlenden Smilies hab ich auch und ich habe eigentlich nur die die schon drin waren ... auch wechseln die Smilies ständig obwohl niemand etwas ändert---mal kleinere, mal gelbe mal durchsichtige.... Und ich bin der einziǵste der etwas ändern könnte......
rating rating
Wolfgang hat sich bedankt!
Beitrag: Forenkonto bzw Forenspende
%usernames% hat sich bedankt!
forum_topic forum_topic
Jim hat das Thema Linien-Farbgebung erstellt
Ich habe es zwar geschafft, einen Farbverlauf für die Logo- und Navigationszeile hinzukriegen,aber ich komm' einfach nicht drauf, wie sich die dunkle Linie nennt, (Siehe Bild)bzw. welchen CSS-Code ich für die Linien-Farbe #3f444a einsetzen müsste.Hätte mir jemand vielleicht einen Tipp?[[File:Navig...
forum_message forum_message
Bruno hat einen neuen Beitrag im Thema Bildergalerie- Reihenfolge der Fotos geschrieben.
Hallo Mike,danke für den Hinweis. Beim Ausprobieren konnte ich feststellen, dass es noch einfacher geht als mit drag & drop. Über Aktionen>>>Reihenfolge ändern>>>Sortieren nach Name habe ich die gewünschte Reihenfolge bekommen, da ich ja vorher meine Bilder durchnummeriert hatte.
rating rating
Bruno und Gabriella haben sich bedankt!
Beitrag: Bildergalerie- Reihenfolge der Fotos
%usernames% haben sich bedankt!
rsummary rsummary
Jim und 844er haben 3 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
0 Mitglieder und 14 Gäste sind Online
Besucher Statistiken
14 Aktive User
0 Mitglieder und 14 Gäste sind Online

Heute waren Online
844er, Ingmar

Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 64 Gäste und 2 Mitglieder, gestern 1585 Gäste und 31 Mitglieder online.

Statistiken
Themen 39360
Beiträge 284551
Mitglieder 11.908
Forum empfehlen