Vorlage:Str mid/Doku
Dies ist eine nachgeordnete Seite der Dokumentation von Vorlage:Str mid. Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Vorlage-Seite ist. |
Diese Vorlage wurde am 16. November 2013 von Template:Str mid der englischen Wikipedia importiert. Statt Änderungen hier auf Wikivoyage vorzunehmen, sollte eine neuer Import vorgezogen werden, falls im originalen Wiki neue Funktionen hinzugekommen sind. Stimme dich dazu bitte mit der Community in der Vorlagenwerkstatt ab. |
Diese Vorlage benutzt Module:String, Skripte geschrieben in der Programmiersprache Lua. Bitte informiere dich dort, wenn du mehr über die Sprache und ihren Einsatz erfahren willst. Diese Vorlagen sollte im Regelfall nicht ersetzt werden. |
Funktion
[Bearbeiten]Die Funktion gibt einen gewünschten Teilstring einer Zeichenkette zurück
Verwendung
[Bearbeiten]Die Zeichen in der Quellzeichenkette werden gezählt. Die Zählung startet bei 1
, der letzte Index entspricht der Länge der Zeichenkette. Die Teilzeichenkette wird durch den Anfangs und Endindex oder auch durch die Länge der Teilzeichenkette definiert werden.:
{{Str mid|<Quellstring>|<index Start>|<Länge Teilzeichenkette>|<index Ende>}}
Rückgabe unter Angabe von Startposition und Länge:
{{Str mid|Abcdefghijklmnopqrstuvwxyz|5|3}}
→efg
Fehlt die Startposition, wird am Anfang gestartet:
{{Str mid|Abcdefghijklmnopqrstuvwxyz||5}}
→Abcde
Fehlt die Länge, wird der gesamte Rest ausgegeben:
{{Str mid|Abcdefghijklmnopqrstuvwxyz|15}}
→opqrstuvwxyz
Zählung vom Ende
[Bearbeiten]Negative Angaben zählen vom Ende der Zeichenkette aus rückwärts:
{{Str mid|Abcdefghijklmnopqrstuvwxyz|-7|4}}
→tuvw
{{Str mid|Abcdefghijklmnopqrstuvwxyz|-7}}
→tuvwxyz
Benutzung einer Endposition
[Bearbeiten]Anstelle der Länge der Zeichenkette kann auch eine Endposition angegeben werden:
{{Str mid|Abcdefghijklmnopqrstuvwxyz|5||7}}
→efg
Leerzeichen
[Bearbeiten]Der Rückgabestring wird getrimmt:
{{Str mid|I like this.|2|6}}
→>like<
Leerzeichen am Anfang und Ende der AUsgangszeichenkette werden abgeschnitten:
{{Str mid| I like this.|2|6}}
→>like<
Fehlermeldungen
[Bearbeiten]Werden unmgliche oder nicht auswertbare Parameter angegeben, wird eine Fehlermeldung ausgegeben:
{{Str mid|Abcdefghijklmnopqrstuvwxyz|30}}
→ String Module Error: Indexangaben für Teilzeichenkette außerhalb des Bereichs
Die Fehlermeldung kann durch Angabe von |ignore errors=true
unterdrückt werden. Dann wird nur eine leer Zeichenkette ausgegeben:
{{Str mid|Abcdefghijklmnopqrstuvwxyz|30}}
→
Fehlerkategorien
[Bearbeiten]|no category=true
– Unterdrückt die Einsortierung in eine Fehlerkategorie.|error category=[[Category:Your category name]]
– Setzt die Bezeichnung der Fehlerkategorie im Falle von Fehlern.
- Standard ist Kategorie:Fehlerberichte des Moduls String.