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
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 10 Gäste sind Online
Besucher Statistiken
11 Aktive User
1 Mitglied und 10 Gäste sind Online:
nobody

Heute waren Online
nobody

Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

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

Statistiken
Themen 41779
Beiträge 305809
Mitglieder 12.472
Forum empfehlen