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
Franz-Jupp und 3 weitere haben 5 neue Beiträge im Thema Einige Wochen XOBOR, ein vorläufiges Resümee geschrieben.
@844erDanke, aber leider nicht optimal.Es funktioniert, aber wegen der unterschiedlichen Breite der Bilder sieht's noch nicht wirklich gut aus.@IngmarEs müsste eine Lösung her, dass die unterschiedlichen Maße berücksichtigt werden.Entweder die Thumbnails gleich groß, die dazugehörigen Bilder in dies...
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Einige Wochen XOBOR, ein vorläufiges Resümee
%usernames% hat sich bedankt!
rating rating
844er und 2 weitere haben sich bedankt!
Beitrag: Einige Wochen XOBOR, ein vorläufiges Resümee
%usernames% haben sich bedankt!
rating rating
Rika1 hat sich bedankt!
Beitrag: Schneefall im Forum
%usernames% hat sich bedankt!
rating rating
Rika1 hat sich bedankt!
Beitrag: Schneefall im Forum
%usernames% hat sich bedankt!
rating rating
Rika1 hat sich bedankt!
Beitrag: Schneefall im Forum
%usernames% hat sich bedankt!
forum_message forum_message
Rika1 und 2 weitere haben 10 neue Beiträge im Thema Schneefall im Forum geschrieben.
Du verstehst das richtig Gabriella, so hab ich ja auch geschrieben das ich es im Sommer nicht will. Hab es jetzt deaktiviert.
forum_message forum_message
Franz-Jupp und 2 weitere haben 6 neue Beiträge im Thema Einige Wochen XOBOR, ein vorläufiges Resümee geschrieben.
Zitat von Ingmar im Beitrag #13Aktuell ist die Höhe für die einzelnen Reihen fest vorgegeben. Wenn dann immer gleich viele Bilder in eine "Zeile" kommen kann man entweder die Bilder auf eine feste Breite skalieren - dann würden ggf. Teile des Bildes nicht in der Vorschaugrafik angezeigt werden - ode...
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Einige Wochen XOBOR, ein vorläufiges Resümee
%usernames% hat sich bedankt!
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Einige Wochen XOBOR, ein vorläufiges Resümee
%usernames% hat sich bedankt!
forum_message forum_message
Gemshorn hat einen neuen Beitrag im Thema V6 Hintergrundmuster des Forums geschrieben.
Klappt super!Vielen, vielen Dank dir! :-)
rating rating
Gemshorn hat sich bedankt!
Beitrag: V6 Hintergrundmuster des Forums
%usernames% hat sich bedankt!
forum_message forum_message
Franz-Jupp und 1 weitere haben 5 neue Beiträge im Thema Einige Wochen XOBOR, ein vorläufiges Resümee geschrieben.
addpics ist auch tatsächlich nicht angesprochen, denn das ist im Grunde nur ein Bilder-Host wie andere auch, dreamies etc.Ob ich diesen Service nutze, oder die in der Bildergalerie integrierte Upload-Möglichkeit, mag Geschmackssache sein.In unserem Forum ist addpics nicht aktiviert.LG Franz-Jupp
rating rating
mariekulm hat sich bedankt!
Beitrag: Einige Wochen XOBOR, ein vorläufiges Resümee
%usernames% hat sich bedankt!
forum_message forum_message
Edeltraud hat einen neuen Beitrag im Thema 6 Benachrichtigungen aus dem Forum pro Tag geschrieben.
Danke Ingmar, ist mir nun klar.War halt neu für uns.Ja da ist noch ein Link mit dabei auf den Mails, habe den nur nicht mit kopiert.
rating rating
Edeltraud hat sich bedankt!
Beitrag: 6 Benachrichtigungen aus dem Forum pro Tag
%usernames% hat sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema 6 Benachrichtigungen aus dem Forum pro Tag geschrieben.
Zitat von Edeltraud im Beitrag #1Meine Frage nun, kann es wirklich sein, dass wenn man 6 Benachrigungen aus demForum bereits per Mail bekam, der Mailversandt für diesen Tag eingestellt wird, obwohlich unbegrenzen Speicherplatz im Forum habe (Profi Tarif) ?Das ist durchaus Absicht, um den massenhafte...
forum_message forum_message
Ingmar und 1 weitere haben 2 neue Beiträge im Thema V6 Hintergrundmuster des Forums geschrieben.
Dazu unter Admin→Layout→Farben&Einstellungen→CSS/SCSS Folgendes eintragen:123 body{background-size: cover;}  Das sollte schon reichen ;-)
forum_topic forum_topic
Edeltraud hat das Thema 6 Benachrichtigungen aus dem Forum pro Tag erstellt
Einige meiner Mitglieder und ich selbst auch bekamen heute ein Mail mit demText hier. Das war in all den Jahren noch nie da.Meine Frage nun, kann es wirklich sein, dass wenn man 6 Benachrigungen aus demForum bereits per Mail bekam, der Mailversandt für diesen Tag eingestellt wird, obwohlich unbegren...
rating rating
Franz-Jupp hat sich bedankt!
Beitrag: Einige Wochen XOBOR, ein vorläufiges Resümee
%usernames% hat sich bedankt!
forum_message forum_message
Rika1 hat einen neuen Beitrag im Thema Schneefall im Forum geschrieben.
Zitat von Ingmar im Beitrag #2Hey Rika.Danke für die Erinnerung. Das Update dazu hatte ich schon fertig, das war nur noch nicht freigeschaltet.Du kannst das Plugin jetzt auch im V6 verwenden.Hallo @Ingmar, hab grad das Plugin auf "AUS" gestellt in der Administration, es bleibt aber aktiv. Schneefloc...
rating rating
Edeltraud hat sich bedankt!
Beitrag: 6 Benachrichtigungen aus dem Forum pro Tag
%usernames% hat sich bedankt!
forum_message forum_message
Franz-Jupp und 1 weitere haben 2 neue Beiträge im Thema Einige Wochen XOBOR, ein vorläufiges Resümee geschrieben.
Zitat von Rika1 im Beitrag #2Das wird jetzt einen Hobbyfotografen vermutlich nicht begeistern.Aber ich sags trotzdem. In meinem Forum zeigen sehr viele User ihre Fotos. Ich hab ein Forum "Fotografie" und da haben sie ihre Themen. Jeder zeigt einfach in seinem Thema seine Fotos. Oder auch in anderen ...
forum_message forum_message
l2otbart_57 hat einen neuen Beitrag im Thema Im PI, Exif Viewer, Daten ausblenden ? geschrieben.
die Version 0.016 im V6 (bzw V4 mobil ) hatte noch einen kleinen Schönheitsfehler. Nach dem Schliessen der Exifdaten erschienen sie am Seitenende.Mit dieser Anweisung (am besten im Style-Block des Plugins) läßt sich die Tabelle ausblenden123 <style>#gallery_options_container > #exifdata > #exifdetai...
forum_topic forum_topic
Franz-Jupp hat das Thema Einige Wochen XOBOR, ein vorläufiges Resümee erstellt
Nach ein paar Wochen recht intensiver Nutzung der Xobor-Software möchte ich hier ein vorläufiges Resümee ziehen, insbesondere aber auch Dinge ansprechen, die unbedingt geändert werden müssen und zwar ohne dass den Kunden Zusatzkosten entstehen.Teils habe ich einige dieser Wünsche schon in früheren T...
forum_message forum_message
Gabriella und 2 weitere haben 3 neue Beiträge im Thema Zitat einfügen bei "bearbeiten" von Beiträgen geschrieben.
Hallo Marie,da kann ich Dir aushelfen, denn das Auto zitieren klappt ja nicht immer und überall so, wie man es gerne hätte In Mails z. B. auch nicht, dann benutzt einfach das Kopieren von dem, was Du willst, markierst es und benutzt dazu das Quoteicon in der Iconbar.1 [quote="Ingmar in Beitrag#2"]Hm...
rating rating
mariekulm hat sich bedankt!
Beitrag: Zitat einfügen bei "bearbeiten" von Beiträgen
%usernames% hat sich bedankt!
forum_topic forum_topic
mariekulm hat das Thema Zitat einfügen bei "bearbeiten" von Beiträgen erstellt
Hallo zusammen Im Einfügen von Zitaten bin ich firm. Aber trotzdem stell ich mir schon immer die Frage, wie ich ein Zitat einfügen kann, wenn ich bei einem Beitrag auf "bearbeiten" geh . Jetzt bin ich schon so lang dabei, aber ich habs bis dato noch nicht geschnallt.Wenn ich in einem bereits beste...
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Astrid Hübner hat einen neuen Beitrag im Thema Blog Artikel bearbeiten - Fehlermeldung geschrieben.
Vielen lieben Dank! Ich werde das so versuchen
rsummary rsummary
Franz-Jupp und 3 weitere haben 5 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Franz-Jupp hat 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
1 Mitglied und 126 Gäste sind Online
Besucher Statistiken
127 Aktive User
1 Mitglied und 126 Gäste sind Online:
Lucas Zelasko


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 3733 Gäste und 25 Mitglieder, gestern 3275 Gäste und 26 Mitglieder online.

Statistiken
Themen 40485
Beiträge 292972
Mitglieder 12.177
Forum empfehlen