Benutzer:Rene/SGPack

aus Stargate Wiki, dem deutschsprachigen Stargate-Lexikon
< Benutzer:Rene(Weitergeleitet von Benutzer:Rene/SGHtml)
Wechseln zu: Navigation, Suche

SGPack ist eine Sammlung von Mediawiki-Erweiterungen die speziell für Stargate-Wiki programmiert wurden. Es ist zudem möglich die Erweiterungen einzeln zu benutzen. Die Vorgehensweise wird im Abschnitt Installation erklärt. Die Erweiterung benötigt MediaWiki in der Version 1.17 oder später. Die Erweiterung SGHtml benötigt die Version 1.24.

80px

^Installation

Die Erweiterung muss in ein eigenes Verzeichnis z.B. SGPack im Verzeichnis extensions entpackt werden. Dann muss die Datei Localsettings.php um die Zeile

require_once("$IP/extensions/SGPack/SGPack.php");

ergänzt werden. Standardmäßig sind nach der Installation alle Erweiterungen, außer SGHTML und AddWhosOnline, aktiviert. Um einzelne Erweiterungen auszuschließen muss nach der require_once Anweisung der entsprechende Parameter auf false gesetzt werden.
Die neue Version unterstützt nun vollständig das MediaWiki Messagesystem. Alle Texte sind in der Datei SGPack.i18n.php definiert, momentan in Deutsch und Englisch und daher auch in den MediaWiki-Systemnachrichten zu finden. Die Bezeichnung der einzelnen Texte bitte der Datei SGPack.i18n.php entnehmen.

Parameter

Parameter Default Bedeutung
$wgSgpBlockSpammer true Aktivieren bzw. deaktivieren der Erweiterung BlockSpammer
$wgBlockSpammerStayEdit false Gibt an ob nach einer Spam Erkennung der Editor wieder erscheint oder dieser geschlossen wird und damit die Eingabe gelöscht wird.
$wgSgpPageProtection true Aktivieren bzw. deaktivieren der Erweiterung PageProtection
$wgPageProtectBlockNamespaces array(NS_USER) Geschütze Namensräume. In diesen darf nur der Besitzer selbst schreiben.
$wgPageProtectOpenNamespaces array(NS_USER_TALK) Freie Namensräume. In diesen ist das Schreiben für alle erlaubt.
$wgPageProtectOwnerAlways true Wenn true, kann der Besitzer in den Namensräumen USER und USER_TALK nicht ausgesperrt werden.
$wgSgpDDInsert true Aktivieren bzw. deaktivieren der Erweiterung DDInsert
$wgSgpUseIE9Hack true Aktivieren bzw. deaktivieren die Erweiterungen IE9 Hack
$wgSgpNewArticle true Aktivieren bzw. deaktivieren der Erweiterung NewArticle
$wgSgpParserAdds true Aktivieren bzw. deaktivieren der Erweiterung ParserAdds
$wgSgpCacheArray true Aktivieren bzw. deaktivieren der Erweiterung CacheArray
$wgSgpSGHTML false Aktivieren bzw. deaktivieren der Erweiterung SGHTML
$wgSGHTMLImageTop Pfad und Name des Bildes für den Sprung nach oben Button z.B. $wgScriptPath.'/skins/common/images/16x16/blue_up.gif'
$wgSGHTMLImageEdit Pfad und Name des Bildes für den Bearbeiten-Button z.B. $wgScriptPath.'/skins/common/images/16x16/edit.png'
$wgSgpAddWhosOnline false Aktivieren bzw. deaktivieren der Erweiterung AddWhosOnline
$wgSgpVideoPlayer true Aktivieren bzw. deaktivieren der Erweiterung VideoPlayer
$wgSgpVideoPlayerCacheOff false Angabe ob der MW-Cache für Video Seiten deaktiviert werden soll
$wgSgpVideoPlayerEngine "jwplayer" Erlaubt die Auswahl des Videoplayers
80px

^Copyright

Die Erweiterung unterliegt der GPL (Version 2). Das bedeutet der Einsatz in anderen MediaWikis ist erlaubt, solange der Hinweis auf den Autor und die GPL erhalten bleibt. Dazu genügt, in diesem Falle, bereits der von der Erweiterung selbst erzeugte Link auf der System-Seite Spezial:Version. Natürlich kann die Erweiterung auch in anderen Systemen benutzt werden, unter Beachtung der GPL.

Über einen kleinen Hinweis (auf der Diskussionsseite) in welchem Wiki die Erweiterung eingesetzt wird würde ich mich freuen, ist aber keine Pflicht.

80px

^Download - Aktuell: V 1.5.01

Datei:Bullet go.pngSGPack.zip
Achtung! BlockSpammer enthält einen Fehler. Dieser kann wie folgt behoben werden: Fehler in BlockSpammer

Version 1.2.97

Datei:Bullet go.pngSGPack.php
Datei:Bullet go.pngSGPack.i18n.php
Hinweis: Die Dateien werden jeweils mit der Endung .txt angezeigt bzw. heruntergeladen. Um sie zu benutzen müssen sie mit der Endung .php gespeichert werden

^Veränderungen seit Version 1.2.94

Pfeil blau.svg Versionsgeschichte
  • 1.2.95: Sonderzeichenfehler in DropDownInsert behoben - Funktion PHP utf8_decode wird benutzt.
  • 1.2.96: Funktionsaufruf wfLoadExtensionMessage entfernt - Wird seit 1.16 nicht mehr benötigt, seit 1.21 nicht mehr unterstützt.
Fehler in NewArticle - Artikelinhalt mit fetchContent() auslesen statt aus Artikel-Objekt.
Anpassung der HTML-Erweiterung an die neue Vector-Seiten
Funktion addKeywords wird in MW 1.22 durch addMeta ersetzt
userinfo: Fehler abfangen wenn HTTP_USER_AGENT nicht gesetzt.
#rekursiv: Nicht ersetzte Ausdrücke werden jetzt immer in Klammern zurückgegeben. Zusätzliche Parameter werden richtig weitergegeben.
  • 1.5.00: Aufteilung des Pack in einige zusätzliche Dateien (Anpassung an MW Vorgaben):
SGPack.php: Die Einstellungen und Einbindung in MW
SGPack_body.php: Die eigentlichen Funktionen (Klassen).
SGPack.js, SGPack.css: Javascript und CSS Funktionen und Definitionen.
Die Javascript Funktionen sind nun so weit möglich ausgelagert und werden im HTML Dokument nur noch aufgerufen und nicht mehr definiert.
Anpassung einiger Anweisungen an MW Standards. Unter anderem: Benutzung der Klasse WikiPage,
Default Bilder für SGHTML liegen jetzt im SGPack Verzeichnis, es können aber über die entsprechenden Variablen auch andere Bilder verwendet werden.
SGHTML: Die Vorgabe für die Metakeywords ist jetzt leer. Vermeidet falsche Keywords bei nichts Stargate Wikis.
Neue Erweiterung: VideoPlayer
  • 1.5.01: #recursiv: Fehler das nicht geklammerte Einzelparameter nicht ersetzt werden behoben.

^BlockSpammer

BlockSpammer ist eine Erweiterung, die verhindert, dass unangemeldete Benutzer (IPs) unerwünschte Ausdrücke in den Artikeltext oder die Zusammenfassung eintragen.

Die Erweiterung prüft nur Änderungen von nicht angemeldeten Benutzern. Wenn diese einen verbotenen Eintrag machen, wird die Übername der Änderungen verweigert. Die Ausdrücke werden anhand von Regex Anweisungen ermittelt. Die Definition der Anweisungen erfolgt in der Systemnachricht blockspammer-regex (Komma getrennte Liste) Beispiel.

Wird ein Spammausdruck gefunden, so wird das Speichern des Artikels verhindert und der Benutzer auf den Fehler hingewiesen. Die Meldungen können über die Systemnachrichten spamprotectiontitle, spamprotectiontext, spamprotectionmatch, blockspammer-stayedit angepasst werden.

LocalSettings-Parameter
  • $wgBlockSpammerStayEdit

Ist dieser Parameter auf true (Vorgabe) gesetzt so bleibt der Editor aktiv, inklusive der bemängelten Eingaben. Ist der Wert des Parameters dagegen false so wird die Eingabe verworfen und der Editor geschlossen.

^NewArticle

Die Erweiterung NewArticle erzeugt, immer wenn ein neuer Artikel angelegt wird, eine Auswahl an Vorlagen. Wird eine dieser Vorlagen ausgewählt so wird die Vorlage in das Editorfeld eingefügt. Sinn ist es, das Erstellen von Artikeln nach den Artikelvorlagen zu erleichtern.

Technik

NewArticle ist eine MediaWiki-Erweiterung, die sich an den Hook AlternateEdit anhängt. Dabei wird bei jedem Aufruf des Editors geprüft, ob es sich um einen neuen Artikel handelt. Ist dies der Fall, so wird geprüft, ob es zum Namensraum, in dem der neue Artikel erstellt werden soll, eine Steuerdatei MediaWiki:NewArticle-<NS> gibt. <NS> steht dabei für die Nummer des Namensraums. In dieser Datei kann neben einem Einleitungstext auch eine Liste an möglichen Vorlagen definiert werden. Das Einfügen einer gewählten Vorlage erfolgt dann über eine JavaScript-Funktion.
Hinweis: Es wird geprüft ob es sich um einen neuen Artikel handelt, d.h. ein bereits gespeicherter Artikel ohne Inhalt wird nicht als neu angesehen.

MediaWiki:NewArticle-<NS>

In der Steuerdatei kann ein Text definiert werden, der als Einleitung über dem neuen Artikel angezeigt wird. Der Platzhalter <NS> wird dabei durch die Nummer des Namensraumes ersetzt, für den die Steuerdatei gültig ist. Der Text kann die normale Mediawiki-Syntax benutzen. Das bedeutet, dass z.B. auch Vorlagen eingebunden werden können. Zur Erstellung der Auswahlliste der möglichen Vorlagen werden diese nach dem folgenden Schema definiert: 

[[[ Einleitung , Vorlagenseite|Beschreibung , Vorlagenseite|Beschreibung , ...]]]
  • Einleitung: Der hier angegebene Text erscheint in der Auswahlliste als Einleitung.
  • Vorlagenseite: Der Seitenname der Vorlage ohne den Namensraum, also nicht Vorlage:Seite sondern nur Seite.
  • Beschreibung: Der Text der für diese Vorlage in der Liste angezeigt wird.

Es gibt keine Begrenzung für die Anzahl an Vorlagen die definiert werden können.

Wird nur eine Vorlage angegeben, besteht die Möglichkeit statt einer Liste einen Button zu erzeugen. In diesem Falle darf nur keine Einleitung angegeben werden. 

[[[ Vorlagenseite|Beschreibung ]]]

Innerhalb des Steuerdatei können beliebig viele Auswahllisten bzw. Buttons definiert werden.

Beispiel
[[[Bitte wählen,Benutzerseite|Benutzer (Vorlage:Benutzerseite)]]]

^SGHtml

Die Erweiterung verändert den HTML Code der von MediaWiki erzeugt wird. Dabei werden die folgenden Anpassungen gemacht:

  • Alle Überschriften der Ebene 2 (==) erhalten am rechten Rand einen SGPack Pfeil hoch.png als Link auf den Seitenanfang.
  • Bild SGPack Edit.png statt Text Bearbeiten um einen Abschnitt zu bearbeiten
  • Zusätzliche Keywords in den Meta Abschnitt der HTML Seite einbauen. Die Wörter werden als Komma getrennte Liste in der MediaWiki Systemnachricht sghtml-keywords gespeichert.
Technik

Die Erweiterung benutzt die MediaWiki-Hooks OutputPageBeforeHTML und BeforePageDisplay.

Da diese Erweiterung speziell für Stargate Wiki geschrieben wurde ist sie in der Grundeinstellung deaktiviert.

MediaWiki-Version: Die Erweiterung manipuliert das Aussehen der HTML Seite vor der Ausgabe. Das funktioniert nur unter MW 1.24. Daher ist die Erweiterung in früheren Version deaktiviert. Das gilt nicht für die Meta-Keyworte, diese werden immer gesetzt.

In der Grundeinstellung nutzt die Erweiterung zwei PublicDomain Bilder aus diesem Iconset.

LocalSettings-Parameter
  • $wgSGHTMLImageTop, $wgSGHTMLImageEdit

Gibt den Pfad zu den angezeigten Bildern an. Diese sollten das Format 16x16 Pixel haben.

^PageProtection

Diese Erweiterung ermöglicht die Kontrolle darüber wer Seiten bearbeiten darf.

Gedacht ist die Erweiterung hauptsächlich für die Namensräume Benutzer (NS_USER) und Benutzer Diskussion (NS_USER_TALK). In der Grundeinstellung dürfen die Seiten im Benutzernamensraum nur vom Besitzer bearbeitet werden. Die Seiten im Namensraum Benutzer Diskussion sind dagegen frei, können aber vom Besitzer gesperrt werden. Um den Schutz einer Seite einzustellen muss die Anweisung <user> benutzt werden.

  • <user>XYZ,ABC</user> gibt die Seite nur für die Benutzer XYZ und ABC frei.
  • <user>*</user> gibt die Seite für alle angemeldeten Benutzer frei.
  • <user>**</user> gibt die Seite für alle angemeldeten und anonymen Benutzer frei.

Um Seiten im Namensraum Benutzer Diskussion zu schützen, muss zumindest eine <user>-Anweisung auf der Seite definiert werden. Um die Seite nur für sich selbst frei zu geben, schreibt man <user>Mein_Benutzername</user> auf die Seite. Den selben Effekt erreicht man auch mit dem kurzen <user>-</user>. Wo auf der Seite die <user>-Anweisung steht spielt keine Rolle. Es empfiehlt sich aber, diese gleich an den Anfang der Seite zu setzen.

Der Besitzer einer Seite kann sich nicht selbst aussperren, das gleiche gilt für die Administratoren.

In anderen als den definierten Namensräumen hat die <user> Anweisung keine Wirkung und wird einfach ignoriert.

LocalSettings-Parameter
  • $wgPageProtectBlockNamespaces
Definiert die geschützten Namensräume für die die Erweiterung aktiviert werden soll. Auf Seiten in diesen Namensräumen kann nur der Besitzer schreibend zugreifen.
  • $wgPageProtectOpenNamespaces
Definiert die freien Namensräume für die die Erweiterung aktiviert werden soll. Dabei ist zu beachten das der Schutz gegen Aussperren nur für den Benutzernamensraum funktioniert.
  • $wgPageProtectOwnerAlways
Über diesen Parameter kann eingestellt werden ob ein Benutzer sich aus der eigenen Seite aussperren kann. Die Vorgabe ist true, der Benutzer kann sich nicht selbst aussperren.
  • $wgGroupPermissions[Gruppe]['pageprotection']
Zur Sicherheit sollte es immer eine Gruppe, in der Regel die Gruppe der Administratoren, geben die auch auf geschützte Seiten zugreifen kann. Dies wird über die Gruppenzugriffsrechte $wgGroupPermissions[Gruppe]['pageprotection'] geregelt. Als Vorgabe ist die Gruppe der Administratoren berechtigt auf geschützt Seiten zu zugreifen $wgGroupPermissions['sysop']['pageprotection'] = true;

^DropDownInsert

Die Idee zu DropDownInsert basiert auf der bekannten CharInsert-Erweiterung. DDInsert geht aber über die Möglichkeiten von CharInsert hinaus. Die Erweiterung stellt die folgenden Befehle bereit:

  • <ddselect titel="TITEL" size="SIZE" name="NAME">... ddvalue ...</ddselect>
Definiert eine Dropdown-Auswahl. Dabei bedeuten die Parameter
  • titel: Name Auswahl. Dieser Wert wird angezeigt wenn noch keine Auswahl erfolgt ist. Vorgabe ist '[ bitte wählen ]'.
  • size: Angabe wie viele Zeilen angezeigt werden sollen. Vorgabe ist 1
  • name: Der Name der Auswahl. Vorgabe ist „Ausgabe“
Die einzelnen Zeilen werden durch ddvalue definiert.
  • <ddvalue show="SHOWTEXT" sample="SAMPLETEXT" picture="NAME">... WERT ...</ddvalue>
Jede ddvalue Definition entspricht einer Zeile in der DropDown-Auswahl. Dabei bedeuten die Parameter:
  • show: Dieser Text wird in der Auswahl angezeigt. Die Vorgabe ist WERT
  • sample: Der SAMPLETEXT wird beim einfügen als markierter Hinweis angegeben.
  • picture: Wird ein Bild angegeben so wird dieses in der Liste angezeigt (als Hintergrund Bild)
  • WERT: Gibt an, was bei der Auswahl in den aktuellen Text eingefügt werden soll. Mit dem Pluszeichen + kann man zudem angeben, wo der Cursor platziert werden soll.
  • <ddbutton show="SHOWTEXT" sample="SAMPLETEXT" picture="NAME">... WERT ...</ddbutton>
Entspricht ddvalue, allerdings werden die Button ohne Auswahlliste, als einzelne Elemente, benutzt.

^JSButton

Mit JSButton kann man einen HTML-Button (<button>) erzeugen. Mit diesem Button kann man eine Javascript-Funktion aufrufen, welche in Stargate Wiki definiert sein muss. 

<jsbutton id="" name="" value="" class="" style="" click="" mover="" mout="">BText</jsbutton>
  • id: Id des Buttons
  • name: Name des Buttons
  • value: Value des Buttons
  • class: Klasse des Buttons
  • style: Style Definition für den Button
  • click: Javascript-Funktion für onclick
  • mover: Javascript-Funktion für onmouseover
  • mout: Javascript-Funktion für onmouseout
  • BText: Beschriftung des Buttons
Hinweis: Momentan wird Wiki-Syntax in BText nur Teilweise unterstützt. Variablen werden erst mit der neuen Mediawiki Version 1.16 ausgewertet. Um Grafiken einzubinden sollten diese selbst keinen Verweis enthalten und müssen daher mit dem Parameter verweis= definiert werden. Beispiel: [[Datei:Bild.jpg|verweis=]]. Wird dies nicht so gemacht funktioniert der Button zwar, erzeugt aber keinen gültigen HTML-Code.

Die Definition der Javascript-Funktion(en) muss entweder in der Datei Mediawiki:<Skin>.js oder Benutzer:<Name>/<Skin>.js erfolgen.

^CacheArray

Die Parser-Erweiterung CacheArray ermöglicht das Anlegen und Auslesen von Arrays. Das besondere dabei ist, dass diese Arrays nur einmal angelegt werden müssen und dann auch von anderen Seiten benutzt werden können. Hinweis: Natürlich bleibt das Array nicht erhalten, wenn die ursprünglich angefragte Seite an den Browser ausgegeben wurde. Es kann nur während des Seitenaufbaus von aufgerufenen Seiten bzw. Vorlagen benutzt werden.

Pfeil blau.svg Befehle
  • carray
Der Befehl zum Setzen, Auslesen und Löschen der Arrays
  • keys
Mehrere Index-Keys zu einem einzigen verbinden

carray

{{carray:<Name_des_Array>|<Kommando>[''Parameter''…''Array-Werte'']}}
  • Name_des_Array
Die Erweiterung ist in der Lage, beliebig viele Arrays zu verwalten. Zur Unterscheidung dient dabei der Array-Name.
  • Kommando

Die Steuerung von carray erfolgt über die folgenden Kommandos.

  • w oder write
Das Kommando write füllt das Array mit den angegebenen Werten. Ist das Array bereits angelegt wird der Befehl ignoriert. Um ein Array erneut anzulegen muss es zuerst gelöscht werden, siehe Befehl delete.
Die Definition der Array-Werte erfolgt analog zur {{#switch:}}-Definition. Ein Beispiel:
{{carray:EpName|w
| #default = <span class="error">Episodencode {{K}} ist unbekannt</span>
| SGA_1x01/02 = Aufbruch in eine neue Welt
| SGA_1x01 = Aufbruch in eine neue Welt, Teil 1
| SGA_1x02 = Aufbruch in eine neue Welt, Teil 2
| SGA_1x03 = Dunkle Schatten
| SGA_1x04 = 38 Minuten
}}
Das Array-Element #default wird immer dann ausgegeben, wenn die Anfrage nach einem nicht definierten Wert gestellt wird, siehe Befehl read. Der Parameter {{K}} im default-Wert wird durch den Index ersetzt.
  • r oder read
Mit dem Kommando read erfolgt die Abfrage des Arrays. Das folgende Beispiel
{{carray:EpName|r|SGA_1x01}}

würde nach der oben angegebenen Definition den Wert 

Aufbruch in eine neue Welt, Teil 1

zurück liefern. Ist kein Wert definiert wird entweder nichts oder, wenn definiert, der Inhalt der Zeile #default ausgegeben.

  • rw oder readwrite
Mit der Kombination der Kommandos read und write wird das Array zuerst gefüllt und dann die entsprechende Zelle ausgelesen. Der Aufruf muss daher lauten:
{{carray:EpName|rw|SGA_1x01
| #default = <span class="error">Episodencode ungültig</span>
| SGA_1x01/02 = Aufbruch in eine neue Welt
| SGA_1x01 = Aufbruch in eine neue Welt, Teil 1
| SGA_1x02 = Aufbruch in eine neue Welt, Teil 2
| SGA_1x03 = Dunkle Schatten
| SGA_1x04 = 38 Minuten
}}
  • f oder file
Das Kommando entspricht write und erzeugt ebenfalls ein Array. Der Unterschied ist, dass die Daten aus einer anderen Seite gelesen werden. Es wird vor dem Erzeugen geprüft, ob das Array schon vorhanden ist und nur wenn dies nicht der Fall ist wird die Datei geladen. Siehe auch #Hinweise zum Einsatz.
{{carray:EpName|f|Vorlage:EpName/Zuordnung}}
  • fr oder fileread
Das Kommando ist eine Kombination aus file und read
{{carray:EpName|fr|Vorlage:EpName/Zuordnung|SG1_1x10}}
  • u oder used
Um zu prüfen ob ein Array bereits angelegt ist, sollte das Kommando used benutzt werden. Ist das Array bereits vorhanden, liefert die Anfrage die Anzahl der definierten Array-Elemente, ansonsten wird nichts zurück geliefert.
{{carray:EpName|u}}
  • c oder count
Das Kommando gibt die Anzahl der definierten Array-Elemente zurück. Ist das Array noch nicht definiert ist das Ergebnis 0.
{{carray:EpName|c}}
  • d oder delete
Mit dem Kommando delete wird das Array gelöscht. Dies ist immer dann nötig, wenn das Array neu geschrieben werden soll, da das Überschreiben nicht möglich ist.
{{carray:EpName|d}}

keys

{{keys:[<Mod>:]<Key>[|[<Mod>:]<Key>…]}}
  • Key
Der Key ist entweder direkt ein Text oder eine Variable. Vor dem Key kann ein Modifierer (Mod) angegeben werden.
  • Mod
Mit dem Modifier kann der Key verändert werden. Definiert sind die Modifier l zum Umwandeln des Keys in Kleinbuchstaben und u zum Umwandeln in Großbuchstaben.

Das Kommando wandelt die Keys entsprechend der Modifier um, entfernt Leerzeichen und fügt zwischen den einzelnen Keys einen Unterstrich _ ein. Das Ergebnis wird dann zurückgeliefert. 

{{keys:u: sg1 | 1x01 }}

Ergibt: SG1_1x01

Hinweis Damit nicht definierte Variablen als solche auch erkannt werden, müssen diese nach dem folgenden Muster eingesetzt werden: Nicht {{{1}}} sondern {{{1|}}}.

Hinweise zum Einsatz

Die Erweiterung kann, richtig eingesetzt, den Aufbau von Seiten beschleunigen, die häufig eine Vorlage aufrufen, welche aus einer großen Anzahl an Werten einen Wert liefert. Dazu sollte eine eigene Seite angelegt werden, die nur das Array füllt. Auf der eigentlichen Vorlagenseite sollte mit dem Befehl used geprüft werden, ob das Array bereits gesetzt wurde. Wenn nicht, kann die "Full"-Vorlage aufgerufen werden. Sonst sollte immer nur das Array ausgelesen werden.

Durch diese Konstruktion erreicht man, dass die große, daher langsame, 'Füll'-Vorlage nur einmal abgearbeitet werden muss und alle weiteren Zugriffe auf das Cache-Array erfolgen.

Die entsprechende Anweisung sollte wie folgt aussehen, definiert in Vorlage:EpName 

{{#if: {{carray:EpName|u}} || {{EpName/Zuordnung}} }}{{carray:EpName|r|{{{1}}}}}

Die Vorlage EpName/Zuordnung füllt das Array EpName mit Werten, die dann von der Vorlage EpName ausgelesen werden.

Wichtiger Hinweis: Die oben angegebene Vorgehensweise führt zu Problemen bei gesichteten Versionen. Wird diese Erweiterung benutzt, sollte alternativ der Befehl file bzw. fileread eingesetzt werden.

^Kleine Parser-Erweiterungen

Pfeil blau.svg #in

Ermittelt ob Elemente in einer Menge enthalten sind. Je nach Suchmodus ist die Suche erfolgreich wenn alle oder mindestens ein Element gefunden wird. Sowohl das Trennzeichen der Elemente als auch die Rückgabe kann definiert werden. 

{{ #in: ELEMENT | LISTE | TRENNER | MODUS | RÜCKGABE }}
  • ELEMENT
Eine Liste der zu suchenden Elemente. Getrennt werden die Elemente durch das TRENNER-Zeichen.
  • LISTE
Eine Aufzählung von Elementen, getrennt durch Komma oder durch den in TRENNER angegebene Ausdruck
  • TRENNER
Definiert das Trennzeichen für die Listen. Wird keine Zeichen angegeben so wird das Komma benutzt
  • MODUS
Auswahl wie gesucht werden soll. Ist der MODUS == e (oder s) genügt es wenn ein Element gefunden wird. Wird kein Wert für MODUS angegeben oder a so müssen alle Elemente in der Liste vorkommen damit die Suche erfolgreich ist.
  • RÜCKGABE
Eine Liste, getrennt durch TRENNER, der möglichen Rückgabewerte. Der erste Wert wird im Erfolgsfall zurückgegeben der zweite Fall wenn die Suche erfolglos war. Es ist möglich auch nur einer der Werte anzugeben. Um nur einen Wert für den Misserfolg anzugeben muss dieser wie folgt definiert werden: ,WERT (wenn TRENNER == ',')
  • Ausgabe

Ist die Suche erfolgreich, so werden alle gefundenen Werte als Liste ausgegeben. Bei einer erfolglosen Suche liefert die Funktion einen leeren String. Dieses Verhalten kann mit dem Parameter RÜCKGABE geändert werden.

Beispiele
{{ #in: b,c,d | a,b,c ||e}}

Die Suche (Modus==e) nach b,c,d in der Liste a,b,c liefert: b,c 

{{ #in: b,d | a,b,c ||e|ja,nein}}

Die Suche (Modus==e) nach b,d in der Liste a,b,c liefert: ja 

{{ #in: b,d | a,b,c |||ja,nein}}

Die Suche nach b,d in der Liste a,b,c liefert: nein

Pfeil blau.svg trim

Entfernen von führenden oder nachfolgenden Leerzeichen. 

{{trim:PARAMETER}}}
  • PARAMETER
Der Parameter kann ein Text oder sinnvoller eine Variable sein.

Als Rückgabe erhält man den angegebenen Wert ohne führende oder nachfolgende Leerzeichen. Der Einsatz der Funktion ist bei der Übergabe des Arraykeys sinnvoll, da es vorkommen kann, dass der Wert einer Variablen ein führendes Leerzeichen enthält.

Pfeil blau.svg userinfo

Liefert einige Informationen zum aktuellen Benutzer. 

{{userinfo:PARAMETER}}
  • PARAMETER - Auswahl der gewünschten Information. Folgende Werte sind erlaubt
    • name - Benutzername oder bei nicht angemeldeten Benutzern die IP-Adresse.
    • id - Benutzernummer. Die id 0 steht für einen nicht angemeldeten Benutzer.
    • realname - Wirklicher Benutzername
    • skin - Name des Skins
    • email [|<benutzer>] - Email-Adresse des aktuellen oder angegebenen Benutzers
    • home [|<benutzer>] - Verweis auf die Benutzerseite des aktuellen oder angegebenen Benutzers
    • talk [|<benutzer>] - Verweis auf die Diskussionsseite des Benutzers des aktuellen oder angegebenen Benutzers
    • groups - Liefert eine Komma getrennte Liste aller Gruppen des Benutzers
    • group|<gname> - Prüft ob der Benutzer der Gruppe <gname> angehört. Ist der Benutzer in der Gruppe wird der Gruppenname <gname> zurück gegeben sonst ist die Rückgabe leer.
    • online|<name> - Prüft ob der Benutzer momentan online ist. Als Resultat liefert der Aufruf: online bzw. offline.
      Hinweis Diese Funktion setzt die Erweiterung WhosOnline voraus. Ist die Erweiterung nicht installiert, liefert der Aufruf unknown.
    • browser [|<kennung>] - Ermittelt die Browserkennung des Benutzers. Wird der Parameter angegeben prüft der Befehl ob der Parameter-Text in der Kennung enthalten ist. Ist dies der Fall wird der Parameter zurückgegeben sonst nichts. Wird vom Aufrufer keine Browserinfo geliefert, wird "undefined" zurückgegeben.
      Beispiel {{userinfo:browser|MSIE 9}} liefert MSIE 9 wenn der Internet Explorer in der Version 9 benutzt wird.
Pfeil blau.svg #link

Mit der Anweisung #link können HTML-Link Anweisungen in den Seitenkopf eingebaut werden. Eine Übersicht der Möglichkeiten findet man auf selfhtml. 

{{#link:ART|SEITE[|TITEL]}}
  • ART: Bezeichnung des Links
  • SEITE: Name der Seite
  • TITLE: Wenn angegeben der Titel, sonst wird SEITE benutzt

Man kann diese Anweisung z.B. benutzen um Episoden zu verknüpfen. In den Artikel Die Invasion, Teil 3 wird dazu eingebaut: 

{{#link:next|Die_Invasion,_Teil_4}}

Durch diese Anweisung wird 

<link rel="next" href="http://www.stargate-wiki.de/wiki/Die_Invasion,_Teil_4" title="Die_Invasion,_Teil_4"/>

in den Seitenkopf eingebaut. Entsprechend kann man die vorhergehende Episode mit "prev" angeben.

Es gibt einige Browser bzw. Browsererweiterungen z.B. für Firefox die diese Angaben auswerten. Außerdem können die Angaben von Maschinen, z.B. der Google-Suche, gelesen und ausgewertet werden.

Achtung Es erfolgt keine Überprüfung des Parameters Art. Es sollten nur die gängigen Bezeichnungen benutzt werden. Diese findet man z.B. bei Selfhtml.

Pfeil blau.svg #recursiv

Wandelt einen Ausdruck so um, dass eine Vorlage auch mehrfach aufgerufen wird, wenn dies nötig ist. Dazu müssen die Werte die an die Vorlage übergeben werden sollen in () geschrieben werden. Erkennt die Vorlage einen Wert nicht so wird der Wert in das Ergebnis kopiert. Geklammerte Ausdrücke in Verweisen, d.h. Ausdrücke in [[]], werden nicht beachtet. 

{{#recursiv:VORLAGE|TEXT|PARAMETER}}
  • VORLAGE
Name der eigentlichen Vorlage. An diese werden alle ermittelten Werte übergeben.
  • TEXT
Einer oder mehrere Werte die an die Vorlage übergeben werden sollen. Handelt es sich um mehrere Werte so müssen dies in Klammern () geschrieben werden. Nicht beachtet werden Ausdrücke in [[]].
  • PARAMETER
Dieser Parameter wird, falls vorhanden, an die Vorlage weitergegeben. Es ist auch möglich beliebig viele weitere Parameter an zu geben, jeweils durch | getrennt. Diese werden alle weitergegeben.
Achtung: Diese Parameter werden ohne Veränderung weitergegeben.
Beispiel
{{#recursiv:Kürzel/Organisation|(sgc) (sga)}}

Ergibt: Stargate-Kommando SGC Atlantis-Expedition Atlantis

Dieser Aufruf entspricht dem folgenden 

{{Kürzel/Organisation|sgc}} {{Kürze/Organisation|sga}}
Pfeil blau.svg #tocmod
{{#tocmod:<Parameter>|<Default>}}

Mit dieser Anweisung wird gesteuert ob und wie das Inhaltsverzeichnis angezeigt wird. Die Erweiterung entspricht den Original Wiki-Befehlen __TOC__, __NOTOC__, __FORCETOC__ und ermöglich das Ein- bzw. Ausblenden des Inhaltsverzeichnisses. Die Ausgabe wird über die folgenden Parameter gesteuert. Sollen mehrere Parameter angegeben werden, müssen diese mit Komma getrennt angegeben werden. Wird der erste Parameter leer übergeben, so wird statt dessen der Defaultwert benutzt. Ist auch dieser nicht angegeben, wird als Parameter set benutzt.

  • no
Kein Inhaltsverzeichnis, entspricht __NOTOC__
  • force
Erzwingt das Inhaltsverzeichnis, entspricht __FORCETOC__
  • set
Setzt das Inhaltsverzeichnis an diese Stelle, entspricht __TOC__
  • hide
Das Inhaltsverzeichnis wird verdeckt ausgegeben, unabhängig von den Benutzereinstellungen.
  • show
Das Inhaltsverzeichnis wird aufgedeckt ausgegeben, unabhängig von den Benutzereinstellungen.
Beispiel
  • {{#tocmod:force,hide}}
Erzwingt das Inhaltsverzeichnis und verdeckt es.
  • {{#tocmod:{{{Register|}}}|set,hide}}
Benutzt entweder den Wert der Variable oder wenn diese nicht belegt ist den angegebenen Defaultwert. Bei der Variable ist der Trenner | (also {{{Register|}}} statt {{{Register}}}) wichtig, da nur so bei undefinierter Variable auch ein Leerstring übergeben wird.

^AddWhosOnline

Bei AddWhosOnline handelt es sich um Zusatzfunktionen der Erweiterung WhosOnline. Die AddWhosOnline erkennt wenn ein Benutzer sich abmeldet und setzt ihn entsprechend auf offline. Außerdem wird ein Eintrag im Persönlichen Menü erzeugt der auf die WhosOnline Spezialseite verweist.

^IE9 Hack

Das Problem

Die MediaWiki JavaScript-Funktion insertTag zeigt mit dem Internet Explorer 9 ein störendes Verhalten. Wird ein Text über die MediaWiki in den Editor eingefügt, so springt der Bildschirm an den Anfang der Seite. Diese Funktion wird von den Modulen NewArticle und DDInsert in SGPack benutzt.

Die Lösung

Um dies zu umgehen, speichert sich der IE9 Hack die Bildschirmposition vor dem Einfügen und setzt sie danach wieder zurück. Somit kann der Benutzer normal weiterarbeiten.

Probleme

Mit dem Internet Explorer kann es dadurch zu einem kurzen Flackern der Darstellung kommen, in anderen Browsern geschieht dies normalerweise nicht.

Hinweis

Die betroffene JavaScript-Funktion wird auch an anderer Stelle, z.B. im Editor, durch die MediaWiki Software benutzt. An diesen Stellen hilft der IE9 Hack nicht, da er nicht eingebunden wird.

^VideoPlayer

VideoPlayer erlaubt das einbinden von externen Videoquellen in Mediawiki. Die Ausgabe der Videos erfolgt mit jwplayer. Das Einbinden erfolgt durch folgende Parser Anweisung. 

{{#vplayer:video="VIDEO"}}

Der einzige notwendige Parameter ist entweder video oder playlist. Ist keiner davon angegeben erfolgt eine Fehlermeldung. Text Parameter sollten mit " oder ' eingeschlossen angegeben werden.

  • video
Angabe der Adresse des Videos. Es muss sich um eine vollständige Netzadresse handeln. Videos aus dem Wiki müssen also vorher umgewandelt werden. Dies kann durch die Mediawiki Funktion {{filepath:Datei}} erfolgen.
  • playlist
Erlaubt die Angabe mehrerer Videos, welche nacheinander abgespielt werden. Rechts vom Video erscheint eine Liste aller Videos aus der eines gewählt werden kann. Die einzelnen Videos werden durch Komma getrennt. Da es Netzadressen mit Komma geben kann ist es notwendig die Adressen in " einzuschließen!.
Zusätzliche Parameter
  • width, height
Breite und Höhe des Videos. Default: 480,270
Erlaubt die Angabe eines Bildes aus dem Wiki das vor dem Start des Videos gezeigt wird. Die Angabe der Datei erfolgt direkt ohne [[Bild:...]]
{{vplayer:video="VIDEO"|poster="SamPhoto.jpg"}}
Titel des Videos. Wird im Playbutton oder auch in der Playliste angezeigt.
Beschreibung der Videos in der Playliste. Wird in der Titelbar angezeigt
  • autostart Funktioniert nicht immer
Die Wiedergabe startet sofort.
  • repeat
Das Video läuft in einer Endlosschleife
  • mute
Das Video wird ohne Ton abgespielt
  • controls Parameter ohne Funktion - Fehler im SGPack
Es werden keine Bedienelemente angezeigt. Eine Sterung des Players ist dann nur noch über die Player API möglich!
  • displaytitle
Unterdrückt die Ausgabe des Titels im Playbutton
  • stretching Funktioniert nicht für alle Videos
Einstellung wie das Video an den Bereich angepasst werden soll. Mögliche Werte: uniform (Vorgabe), fill, exactfit, none
  • css
Erlaubt die Angabe einer CSS-Klasse, welche im DIV-Container des Videos gesetzt wird.
Position der Titelbar. Mögliche Werte: right (Vorgabe), bottom, none
Größe der Titelbar. Vorgabe: 150
Darstellung der Titelbar. Mögliche Werte: basic, extended (Vorgabe) - extended ist mit Vorschau und Beschreibung, Basic eine reine Textliste mit dem Titel
Anmerkungen
  1. ↑ (+) 1,0 1,1 1,2 Diese Parameter enthalten bei einer Playliste Komma getrennte Listen der Werte für die einzelnen Videos.
  2. ↑ (+) 2,0 2,1 2,2 Diese Parameter ist ohne Playliste ohne Funktion.
Beispiele
  • {{#vplayer:video="http://s3.amazonaws.com/sgu-assets/assets/Video/1243990124/604/sg11001-0194ws.flv"|width="250"|height="187"|poster="SamPhoto.jpg"}}
  • {{#vplayer:playlist="https://www.youtube.com/watch?v=6xJl1dGdddw","https://www.youtube.com/watch?v=jfNjgOIoo-c"|title="Video 1","Video 2"|description="text text","hallo video"|width="300"|height="300"|l.position="bottom"|l.size=100|l.layout="basic"}}
  • Weitere Beispiele findet man auf der Seite Benutzer:Rene/SGPack Test.
Hinweise

Die Ausgabe erfolgt in einem <div>-Bereich. Der Bereich kann mit der CSS-Klasse video_player verändert werden, die in allen Bereichen immer gesetzt ist. Als weitere Möglichkeit kann zu jedem Bereich eine eigene Klasse angegeben werden. Jeder Bereich hat einen eigene ID (video_player_NR, wobei NR die laufende Nummer des Players ist, in der Reihenfolge ihrer Angabe im Artikel).

LocalSettings-Parameter
  • $wgSgpVideoPlayerCacheOff
Wird der Parameter auf true gesetzt so wird der MW-Cache für die Seite mit Videoausgaben deaktiviert. In der Voreinstellung ist der Cache aktiv
  • $wgSgpVideoPlayerEngine
Ermöglicht die Auswahl eines Videoplayers. Momentan ist nur der jwplayer installiert.

Javascript Steuerung

Der Player kann mit Hilfe von Javascript gesteuert werden. Eine Einführung findet man im jwplayer Portal. Eine Liste der Funktionen in der API Reference.

Zur Ansteuerung eignen sich z.B. Javascript Button aus der SGPack Erweiterung. Die folgende Anweisung erzeugt einen Startknopf für das erste Video auf der Seite. 

<jsbutton click="jwplayer('video_player_1').play();">Start Video 1</jsbutton>
Von „http://stargate-wiki.de/w/index.php?title=Benutzer:Rene/SGPack&oldid=327956“