Modul:Str/Doku
Dies ist die Dokumentationsseite für Modul:Str
Dieses Modul dient der Implementierung der Stringfunktionen in andere Vorlagen.
Exportierte Funktionen
[ännern]len
[ännern]Gibt die Länge eines Strings zurück
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: der String.
Rückgabewert
[ännern]Die Länge des Strings.
left
[ännern]- 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
cropzu finden.
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: Der String.
- 2: Anzahl der restlichen Zeichen
Rückgabewert
[ännern]Entsprechend gekürzter String.
crop
[ännern]- 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
leftzu finden.
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: Der String.
- 2: Anzahl der abzutrennenden Zeichen
Rückgabewert
[ännern]Der gekürzte String.
right
[ännern]Gibt die letzten n Zeichen eines Strings wieder. Diese Funktion entspricht nicht der Vorlage:Str_right. Siehe dazu auch Funktion cropleft.
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: Der String.
- 2: Anzahl der restlichen Zeichen
Rückgabewert
[ännern]Entsprechend gekürzter String.
cropleft
[ännern]- 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
rightzu finden. - Diese Funktion entspricht im Wesentlichen der Vorlage:Str_right.
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: Der String.
- 2: Anzahl der abzutrennenden Zeichen
Rückgabewert
[ännern]Entsprechend gekürzter String.
index
[ännern]Gibt das Zeichen an einer bestimmten Position im String wieder.
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: Der String.
- 2: Position des Zeichens
Rückgabewert
[ännern]Das Zeichen an der gegebenen Position.
sub
[ännern]- Gibt einen Teil eines Strings wieder.
- Das ist die allgemeine Teilstringfunktion
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: Der String.
- 2: Position des ersten Zeichens des Teilstrings.
- 3: Länge des Teilstrings.
Rückgabewert
[ännern]Entsprechender Teilstring.
hex2dez
[ännern]Wandelt eine als String übergebene Hexadezimalzahl in eine Dezimalzahl um. Im Fehlerfall wird Null zurückgegeben.
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 1: Der String.
Rückgabewert
[ännern]Die Zahl
match
[ännern]Filtert einen Teilstring aus einem übergebenen String mittels eines regulären Ausdrucks (Regex) heraus. Die unterstützten Sprachelemente des regulären Ausdrucks finden sich unter , erweitert unter die in beschriebenen Unicode-Eigenschaften. Die wichtigste Einschränkung ist das Lua-Regexe keine Alternativen (|-Sprachelement) unterstützen.
Parameter
[ännern]- frame: Frame, der die Argumente der Invoke-Funktion bereithält.
Argumente
[ännern]- 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
[ännern]Ein 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 |
Kiek ok
[ännern]- Quelle: Düütsche Wikipedia 18.09.2016 https://de.wikipedia.org/wiki/Vorlage:Str_left