Module:Text/doc

Text – Modul mit Funktionen für Textpassagen, Wikitext und ggf. HTML.

Funktionen für Vorlagen

All methods have an unnamed parameter containing the text.

The return value is an empty string if the parameter does not meet the conditions. When the condition is matched or some result is successfully found, strings of at least one character are returned.

char

Creates a string from a list of character codes.

1

Space-separated list of character codes

*

Number of repetitions of the list in parameter 1; (Default 1).

errors

0 – Silence errors

concatParams

Combine any number of elements into a list, like table.concat() in Lua.

From a template:

1

First element; missing and empty elements are ignored.

2 3 4 5 6 …

Further list elements

From Lua

args

table (sequence) of the elements

apply

Separator between elements; defaults to |

adapt

optional formatting, which will be applied to each element; must contain %s.

containsCJK

Returns whether the input string contains any CJK characters

• Returns nothing if there are no CJK characters

getPlain

Remove wikimarkup (except templates): comments, tags, bold, italic, nbsp

isLatinRange

Returns some content, unless the string contains a character that would not normally be found in Latin text.

• Returns nothing if there is a non-Latin string.

isQuote

Returns some content if the parameter passed is a single character, and that character is a quote, such as '.

• Returns nothing for multiple characters, or if the character passed is not a quote.

listToText

Formatiere Listenelemente analog zu mw.text.listToText()

Zwischen den Elementen wird ein Komma mit Leerzeichen gesetzt; zwischen dem vorletzten und letzten das Wort „und“.

Als Listenelemente werden die Werte unbenannter Parameter verwendet.

Optionale Parameter von #invoke:

• format – Jedes Listenelement soll zunächst mit diesem Pattern formatiert werden, das mindestens ein %s enthalten muss.
• template=1 – Die Listenelemente werden der umgebenden Vorlageneinbindung entnommen.

Das Ergebnis ist die Zeichenkette.

quote

Schließe die Zeichenkette in sprachabhängige Anführungszeichen ein.

1

Eingabetext (wird getrimmt) – auch leerer Text führt zum Ergebnis

2

(optional) einzelner Sprachcode gemäß ISO 639

Liste aktuell unterstützter Sprachen

3

(optional) 2 für Anführungszeichen zweiter Ebene

quoteUnquoted

Schließe die Zeichenkette in sprachabhängige Anführungszeichen ein, falls nicht leer oder schon zu Beginn oder am Ende ein Anführungszeichen steht.

1

Eingabetext (wird getrimmt)

2

(optional) einzelner Sprachcode gemäß ISO 639

Liste aktuell unterstützter Sprachen

3

(optional) 2 für Anführungszeichen zweiter Ebene

removeDiacritics

Entfernt alle diacritical marks aus der Eingabe.

1

Eingabetext

sentenceTerminated

Ist die Zeichenkette mit einem Satzendezeichen beendet, auch CJK, auch wenn noch Anführungszeichen oder schließende eckige Klammern folgen?

• nichts – wenn nicht erkannt

ucfirstAll

Den ersten Buchstaben jedes erkennbaren Wortes groß schreiben.

Die Parserfunktion {{ucfirst:}} verändert hingegen nur das erste nichtleere Zeichen des Parameters.

Benannte HTML-Entities, deren Notation wegen Unsichtbarkeit oder Syntaxkonflikt üblich ist, werden nicht beeinträchtigt.

uprightNonlatin

Gib eine Zeichenkette zurück, bei der nichtlateinische Zeichen nicht kursiv dargestellt werden, abgesehen von einem einzelnen griechischen Buchstaben.

zip

Fügt mehrere Listen/Tupel in Textform elementweise im Reißverschlussprinzip zusammen (convolution), d.h. sei liste1 = "a b c" und liste2 = "1 2 3" dann ist zip(liste1, liste2, sep = " ", isep = "-", osep = "/") = "a-1/b-2/c-3" (Hinweis: Bei Aufruf der Funktion aus dem Wikitext mittels #invoke entfallen die Anführungsstriche.)

• 1, 2, 3, … – Listen/Tupel
• sep – Trennzeichen (Lua-Regex) mit dem die Einzelwerte der Liste voneinander getrennt sind. Wenn leer, wird die Liste in ihre Einzelzeichen zerlegt.
• sep1, sep2, sep3, … – falls einzelne Listen ein anderes Trennzeichen verwenden
• isep – Ausgabetrennzeichen mit dem die Einträge die in ihren Listen an gleichen Positionen stehen verbunden werden
• osep – Ausgabetrennzeichen mit dem ein Positionswechsel markiert wird

Beispiele (Testseite)

Eine Testseite illustriert praktische Beispiele.

Funktionen für Lua-Module

Alle oben dokumentierten Funktionen können auch über require() in andere Module eingebunden werden:

local lucky, Text = pcall( require, "Module:Text" )
if type( Text ) == "table" then
    Text = Text.Text()
else
    -- Fehlerfall; Text enthält Fehlermeldung
    return "<span class=\"error\">" .. Text .. "</span>"
end

Danach stehen zur Verfügung:

• Text.char( apply, again, accept )
• Text.concatParams( args, separator, format )
• Text.containsCJK( s )
• Text.getPlain( s )
• Text.isLatinRange( s )
• Text.isQuote( c )
• Text.listToText( table, format )
• Text.quote( s, lang, mode )
• Text.quoteUnquoted( s, lang, mode )
• Text.removeDiacritics( s )
• Text.sentenceTerminated( s )
• Text.ucfirstAll( s )
• Text.uprightNonlatin( s )
• Text.zip(…)
• Text.test( s )

  Modultest

Verwendung

Allgemeine Bibliothek; nicht eingegrenzt.

Abhängigkeiten

Keine.