Benutzer:Rene/SGPack: Unterschied zwischen den Versionen

<user>*</user>

SGPack ist eine Sammlung von Mediawiki Erweiterungen die speziell für Stargate-Wiki programmiert wurden. Es ist möglich auch nur einzelnen dieser Erweiterungen zu benutzen. Die Vorgehensweise wird im Abschnitt Installation erklärt.

Die Erweiterung muss in ein eigenes Verzeichnis zB SGPack im Verzeichnis extensions abgelegt werden. Dann muss die Datei Localsettings.php um die Zeile

<pre>include_once("$IP/extensions/SGPack/SGPack.php");</pre>

ergänzt werden.

Die Erweiterung unterliegt der GPL (Version 2). Das bedeutet der Einsatz in anderen MediaWikis ist erlaubt solange der Hinweis auf den Author 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 System 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.  

BlockSpammer ist eine Mediawiki Erweiterung die verhindert das unangemeldete Benutzer (IPs) externe Links in Artikel eintragen. Die Erweiterung prüft Änderungen von nicht angemeldeten Benutzern. Wenn diese einen verdächtigen Eintrag machen wird die Übername der Änderungen verweigert. Momentan prüft die Erweiterung nur auf externe Links.  

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 [[Hilfe:Artikelvorlagen|Artikelvorlagen]] zu erleichtern.

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 Javascriptfunktion.

'''''Hinweis''' Es wird geprüft ob es sich um einen neuen Artikel handelt, d.h. ein bereits gespeicherte Artikel ohne Inhalt wird nicht als neu angesehen.''

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 das zB auch Vorlagen eingebunden werden können. Zur Erstellung der Auswahlliste der möglichen Vorlagen werden diese nach dem folgenden Schema definiert:

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

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

:'''Achtung Veraltet''': Die Umwandlung der Pfeile wird nicht mehr unterstützt. Statt dessen gibt es die Vorlagen <nowiki>{{Hoch}} {{Runter}} {{Links}} {{Rechts}}</nowiki>

Um die Erweiterung zu benutzen müssen die Bilder für die Pfeile in das Verzeichnis ''skins/common/images/16x16'' gespeichert werden. Am einfachsten ist es dazu die Bilder auf dieser Seite mit dem Browser zu speichern und sie dann auf den Server zu laden.

   

Die Erweiterung benutzt die MediaWiki Hooks '''OutputPageBeforeHTML''', '''PersonalUrls''' und '''BeforePageDisplay'''.

Mit dieser Erweiterung können Benutzer bestimmen wer auf ihrer Seiten schreiben darf. Geschützt sind nur die Seiten im Benutzernamensraum (z.B. Benutzer:Name). Möchte man das andere diese Seite bearbeiten können gibt man sie mit dem user-tag frei.

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

Die Idee zu DropDownInsert basiert auf der bekannten [http://www.mediawiki.org/wiki/Extension:CharInsert CharInsert-Erweiterung]. DDInsert geht aber über die Möglichkeiten von CharInsert hinaus. Die Erweiterung stellt die folgenden Befehle bereit:  

* <nowiki><ddselect titel="TITEL" size="SIZE" name="NAME">... ddvalue ...</ddselect></nowiki>

:Entspricht ddvalue, allerdings werden die Button ohne Auswahlliste, als einzelne Elemente, benutzt.

Mit JSButton kann man einen HTML-Button ([http://de.selfhtml.org/html/formulare/klickbuttons.htm#modern <button>]) erzeugen. Mit diesem Button kann man eine Javascript-Funktion aufrufen welche in Stargate Wiki definiert sein muss.  

<pre><nowiki><jsbutton id="" name="" value="" class="" style="" click="" mover="" mout="">BText</jsbutton></nowiki></pre>

Die Definition der Javascript-Funktion(en) muss entweder in der Datei '''[[Mediawiki:Monobook.js|Mediawiki:<Skin>.js]]''' oder '''[[Benutzer:{{userinfo:name}}/monobook.js|Benutzer:<Name>/<Skin>.js]]''' erfolgen.

Die Parser-Erweiterung CacheArray ermöglicht das anlegen und auslesen von Arrays. Das besondere dabei ist das 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.''

* '''carray'''

:Der Befehl zum setzen, auslesen und löschen der Arrays

* '''keys'''

:Mehrere Index-Keys zu einem einzigen Verbinden

   <pre><nowiki>{{carray:<Name_des_Array>|<Kommando>[''Parameter''…''Array-Werte'']}}</nowiki></pre>

* '''Name_des_Array'''

: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.

<pre><nowiki>{{carray:EpName|d}}</nowiki></pre>

   <pre><nowiki>{{keys:[<Mod>:]<Key>[|[<Mod>:]<Key>…]}}</nowiki></pre>

* '''Key'''

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

Die Erweiterung kann, richtig eingesetzt, den Aufbau von Seiten beschleunigen die häufig eine Vorlage aufrufen die 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.

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

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.

<pre><nowiki>{{ #in: ELEMENT | LISTE | TRENNER | MODUS | RÜCKGABE }}</nowiki></pre>

* 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.

<pre><nowiki>{{ #in: b,c,d | a,b,c ||e}}</nowiki></pre>

Die Suche (Modus==e) nach b,c,d in der Liste a,b,c liefert: '''{{ #in: b,c,d | a,b,c ||e}}'''

Die Suche nach b,d in der Liste a,b,c liefert: '''{{ #in: b,d | a,b,c |||ja,nein}}'''

Entfernen von führenden oder nachfolgenden Leerzeichen.

   <pre><nowiki>{{trim:PARAMETER}}}</nowiki></pre>

: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 das der Wert einer Variablen ein führendes Leerzeichen enthält.

Liefert einige Informationen zum aktuellen Benutzer.

   <pre><nowiki>{{userinfo:PARAMETER}}</nowiki></pre>

:name - Benutzername

:id - Benutzernummer

::'''Hinweis''' Diese Funktion setzt die Erweiterung [http://www.mediawiki.org/wiki/Extension:WhosOnline WhosOnline] voraus. Ist die Erweiterung nicht installiert liefert der Aufruf ''unknown''.

Wandelt einen Ausdruck so um das 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.

   <pre><nowiki>{{#recursiv:VORLAGE|TEXT|PARAMETER}}</nowiki></pre>

* PARAMETER

:Dieser Parameter wird, falls vorhanden, an die Vorlage weitergegeben.

<pre><nowiki>{{#recursiv:Kürzel/Organisation|(sg1) (sga)}}</nowiki></pre>

Ergibt: {{#recursiv:Kürzel/Organisation|(sgc) (sga)}}

<pre><nowiki>{{Kürzel/Organisation:sg1}} {{Kürze/Organisation:sga}}</nowiki></pre>

<pre><nowiki>{{#tocmod:<Parameter>|<Default>}}</nowiki></pre>

Mit dieser Anweisung wird gesteuert ob und wie das Inhaltsverzeichnis angezeigt wird. Die Erweiterung entspricht den Original Wiki Befehlen <nowiki>__TOC__</nowiki>, <nowiki>__NOTOC__</nowiki>, <nowiki>__FORCETOC__</nowiki> 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.

:Kein Inhaltsverzeichnis, entspricht <nowiki>__NOTOC__</nowiki>

:Erzwingt das Inhaltsverzeichnis, entspricht <nowiki>__FORCETOC__</nowiki>

:Setzt das Inhaltsverzeichnis an diese Stelle, entspricht <nowiki>__TOC__</nowiki>

:Das Inhaltsverzeichnis wird verdeckt ausgegeben, unabhängig von den Benutzereinstellungen.

:Das Inhaltsverzeichnis wird aufgedeckt ausgegeben, unabhängig von den Benutzereinstellungen.

: Erzwingt das Inhaltsverzeichnis und verdeckt es.

: Benutzt entweder den Wert der Variable oder wenn diese nicht belegt ist den angegebenen Defaultwert. ''Bei der Variable ist der Trenner | wichtig da nur so bei undefinierter Variable auch ein Leerstring übergeben wird.''

Bei AddWhosOnline handelt es sich um Zusatzfunktionen der Erweiterung [http://www.mediawiki.org/wiki/Extension:WhosOnline 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.

Download des Codes: [http://www.stargate-wiki.de/download/SGPack.txt SGPack.php], [http://www.stargate-wiki.de/download/SGPack.i18n.txt SGPack.i18n.php]