Modul:Tools/Doku

Dies ist eine nachgeordnete Seite der Dokumentation von Modul:Tools.
Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Modul-Seite ist.

Dieses Modul ist getestet und für den projektweiten Gebrauch geeignet. Es kann in Vorlagen benutzt und auf Hilfeseiten erläutert werden. Entwicklungen an dem Modul sollten auf Tools/Test und die Anwendung auf der Spielwiese getestet werden, da wiederholte Trial-and-Error-Edits die Resourcen stark belasten können.

Das Modul stellt eine Reihe von Funktionen zur Verfügung, die häufig in anderen Modulen oder Vorlagen gebraucht werden könnten.

Funktionen zur Verwendung intern und in anderen Modulen

Die folgenden Funktionen können innerhalb des Moduls verwendet und sind nicht von Vorlagen aus aufrufbar.

strtok

In Anlehnung an die gleichnamige Funktion im PHP zerlegt diese Funktion eine Zeichenkette an einem anzugebenden Trennzeichen. Es wird eine Tabelle mit allen einzelnen Zeichenketten zurückgegeben.

function strtok ( stringStr, delimiterStr )

Beispiel:

-- Zerlegung der Zeichenkette
liste = strtok ( 'Januar;Februar;März', ';' )
-- Inhalt der Liste:
liste = { 'Januar', 'Februar', 'März' }

rmNamespace

Entfernt aus einem Artikelnamen den Namensraum

function rmNamespace ( pageName  )

Beispiel:

-- Entfernung des Namensraums
seite = rmNamespace ( 'Modul:Zeit/Params/Doku' )
-- Inhalt der Variablen:
seite = 'Zeit/Params/Doku'

rmBRTag

Entfernt BR-Tags aus einem Text

function rmBRTag ( text )

Beispiel:

-- Entfernung des BR-Tags
text = rmNamespace ( 'Text mit<br />einem Zeilenumbruch' )
-- Inhalt der Variablen:
text = 'Text mit einem Zeilenumbruch'

Funktionen

Die folgenden Funktionen können in Vorlagen und Artikeln benutzt werden

firstBasepagename – filtert aus Artikelnamen den Namen der obersten Seite heraus und entfernt den Modulnamen. Aus Modul:Zeit/Params/Doku wird Zeit. Es wird der erste übergebene Parameter verwendet. Optional kann auch ein Parameter mit der Bezeichnung |page= verwendet werden.

Einbindung in anderen Modulen

Folgende Module verwenden dieses Modul. Bei Änderung an diesem Modul sollte die Funktionsfähigkeit der anderen Module nicht beeinträchtigt werden.

Verwendung in anderen Vorlagen

Folgende Vorlagen verwenden dieses Modul:

{{FIRSTBASEPAGENAME}} – benutzt die Funktion firstBasepagename