Vorlagenprogrammierung | Diskussionen | Lua | Unterseiten | |||
Modul | Deutsch | English
|
Modul: | Dokumentation |
Dieses Modul dient der Implementierung der Stringfunktionen in andere Vorlagen.
Exportierte Funktionen
Bearbeitenlen
BearbeitenGibt die Länge eines Strings zurück.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
Rückgabewert
BearbeitenDie Länge des Strings.
left
Bearbeiten- Gibt die ersten N Zeichen eines Strings wieder.
- Hier wird die Restlänge als Argument übergeben.
- Eine Funktion mit der Anzahl der abzutrennenden Zeichen als Argument ist unter
crop
zu finden.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
- 2: Anzahl der restlichen Zeichen
Rückgabewert
BearbeitenEntsprechend gekürzter String.
right
BearbeitenGibt die letzten n Zeichen eines Strings wieder. Diese Funktion entspricht nicht der Vorlage:Str right. Siehe dazu auch Funktion cropleft
.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
- 2: Anzahl der restlichen Zeichen
Rückgabewert
BearbeitenEntsprechend gekürzter String.
crop
Bearbeiten- Kürzt einen String rechts um eine bestimmte Anzahl Zeichen.
- Hier wird die Länge des abzutrennenden Teilstrings als Argument übergeben.
- Eine Funktion mit der Anzahl der übrigbleibenden Zeichen als Argument ist unter
left
zu finden.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
Bearbeiten- 1: der String
- 2: Anzahl der abzutrennenden Zeichen
Rückgabewert
BearbeitenDer gekürzte String.
cropleft
Bearbeiten- Kürzt einen String links um eine bestimmte Anzahl Zeichen.
- Hier wird die Länge des abzutrennenden Teilstrings als Argument übergeben.
- Eine Funktion mit der Anzahl der übrigbleibenden Zeichen als Argument ist unter
right
zu finden. - Diese Funktion entspricht im Wesentlichen der Vorlage:Str right.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
- 2: Anzahl der abzutrennenden Zeichen
Rückgabewert
BearbeitenEntsprechend gekürzter String.
index
BearbeitenGibt das Zeichen an einer bestimmten Position im String wieder.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
- 2: Position des Zeichens
Rückgabewert
BearbeitenDas Zeichen an der gegebenen Position.
sub
Bearbeiten- Gibt einen Teil eines Strings wieder.
- Das ist die allgemeine Teilstringfunktion.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
- 2: Position des ersten Zeichens des Teilstrings
- 3: Länge des Teilstrings
Rückgabewert
BearbeitenEntsprechender Teilstring.
hex2dez
BearbeitenWandelt eine als String übergebene Hexadezimalzahl in eine Dezimalzahl um. Im Fehlerfall wird Null zurückgegeben.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
Rückgabewert
BearbeitenDie Zahl.
replace
BearbeitenErsetzt in einem String einen Teilstring durch einen anderen.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der String
- 2: der zu suchende Teilstring
- 3: der einzusetzende Teilstring
- 4: (maximale) Anzahl der Ersetzungen
Rückgabewert
BearbeitenDer geänderte String.
round
BearbeitenRundet eine als Zeichenkette übergebene Zahl auf die angegebene Dezimalstelle und gibt im Unterschied zur Parserfunktion auch abschließende Nullen zurück. Ist der Eingabestring nicht als Zahl interpretierbar, wird "NaN" (für "not a Number") zurückgegeben.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der Eingabestring
- 2: die Dezimalstelle, auf die gerundet werden soll. Ganze Zahl, negative Zahl bedeutet vor dem Komma.
Rückgabewert
BearbeitenDie gerundete Zahl als String.
match
BearbeitenFiltert einen Teilstring aus einem übergebenen String mittels eines regulären Ausdrucks (Regex) heraus. Die unterstützten Sprachelemente des regulären Ausdrucks finden sich unter mw:Extension:Scribunto/Lua reference manual #Patterns, erweitert unter die in mw:Extension:Scribunto/Lua reference manual #Ustring patterns beschriebenen Unicode-Eigenschaften. Die wichtigste Einschränkung ist das Lua-Regexe keine Alternativen (|
-Sprachelement) unterstützen.
Parameter
Bearbeiten- frame: Frame, der die Argumente der Invoke-Funktion bereithält
Argumente
Bearbeiten- 1: der Eingabestring
- 2: der anzuwendende reguläre Ausdruck
- 3 (optional): Wenn mittels Klammerung mehrere Gruppen definiert wurden, kann die zurückzugebende Gruppe hier angegeben werden. Falls nicht angegeben, wird 0 (= alle Teilstrings) angenommen.
Rückgabewert
BearbeitenEin gemäß dem angegebenen Regex gefilterter Teilstring.
Beispiele:
Eingabe | Ausgabe | Erklärung |
---|---|---|
{{#invoke:Str|match|eine Zeichenkette als Test|%u%l+}}
|
Zeichenkette | erstes Wort, das mit einem Großbuchstaben beginnt |
{{#invoke:Str|match|Russische Sprache (русский язык)|[Ѐ-ӿ]+}}
|
русский | erste Zeichenfolge aus dem Unicodeblock Kyrillisch |
{{#invoke:Str|match|Beispieltext|(Bei).+(text)|2}}
|
text | zweite Gruppe zurückgeben |
{{#invoke:Str|match|Beispieltext|(Bei).+(text)|0}}
|
Beitext | alle Gruppen zurückgeben |