Module:Text/doc

icon This is a documentation subpage for Module:Text.
It may contain usage information, categories and other content that is not part of the original module page.

Warning This Lua module is used on approximately 1,790,000 pages, or roughly 3% of all pages .
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Module:Yesno (sandbox)

Text – Module containing methods for the manipulation of text, wikimarkup and some HTML.

Functions for templates

[edit ]

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

removeDelimited

Remove all text between delimiters, including the delimiters themselves.

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

Formats list elements analogously to mw.text.listToText().

The elements are separated by a comma and space ; the word "and" appears between the first and last.

Unnamed parameters become the list items.

Optional parameters for #invoke:

format – Every list element will first be formatted with this format string; see here for how to construct this string. The string must contain at least one %s sequence.
template=1 – List elements should be taken from the calling template.

Returns the resulting string.

quote

Wrap the string in quotes; quotes can be chosen for a specific language.

1: Input text (will be automatically trimmed); may be empty.
2: (optional) the ISO 639 language code for the quote marks; should be one of the supported languages (in German)
3: (optional) 2 for second level quotes. This means the single quote marks in a statement such as: Jack said, "Jill said ‘fish’ last Tuesday."

quoteUnquoted

Wrap the string in quotes; quotes can be chosen for a specific language. Will not quote an empty string, and will not quote if there is a quote at the start or end of the (trimmed) string.

1: Input text (will be automatically trimmed); may be empty.
2: (optional) the ISO 639 language code for the quote marks; should be one of the supported languages (in German)
3: (optional) 2 for second level quotes. This means the single quote marks in a statement such as: Jack said, "Jill said ‘fish’ last Tuesday."

removeDiacritics

Removes all diacritical marks from the input.

1

Input text

sentenceTerminated

Is this sentence terminated? Should work with CJK, and allows quotation marks to follow.

Returns nothing if the sentence is unterminated.

ucfirstAll

The first letter of every recognized word is converted to upper case. This contrasts with the parser function {{ucfirst:}} which changes only the first character of the whole string passed.

A few common HTML entities are protected; the implementation of this may mean that numerical entities passed (e.g. &) are converted to & form

uprightNonlatin

Takes a string. Italicized non-Latin characters are un-italicized, unless they are a single Greek letter.

zip

Combines a tuple of lists by convolution. This is easiest to explain by example: given two lists, list1 = "a,b,c" and list2 = "1,2,3", then
zip(list1, list2, sep = ",", isep = "-", osep = "/")
outputs
a-1/b-2/c-3

1, 2, 3, ... – Lists to be combined
sep – A separator (in Lua regex form) used to split the lists. If empty, the lists are split into individual characters.
sep1, sep2, sep3, ... – Allows a different separator to be used for each list.
isep – Output separator; placed between elements which were at the same index in their lists.
osep – Output separator; placed between elements which had different original indices; i.e. between the groups joined with isep

split

Splits a string into chunks at the specified delimiter, and returns the first (or user-specified) chunk. This is non-Unicode-aware implementation of mw.text.split which, for ASCII-only text, can be up to 60 times faster.

1 (or text) – the text to be split
2 (or pattern) – the pattern to use when splitting the text. By default, this can be a string library pattern.
3 (or plain) – if set to "true", pattern will be interpreted as plain text, not a pattern.
4 (or index) – The chunk to return. If omitted, the first chunk will be returned. Can be set to a negative number to count from the end (e.g. -1 will return the last chunk).

Examples and test page

[edit ]

There are tests available (in German) to illustrate this in practice.

Use in another Lua module

[edit ]

All of the above functions can be called from other Lua modules. Use require(); the below code checks for errors loading it:

locallucky,Text=pcall(require,"Module:Text")
iftype(Text)=="table"then
Text=Text.Text()
else
-- In the event of errors, Text is an error message.
return"<span class=\"error\">"..Text.."</span>"
end

You may then call:

Text.char( apply, again, accept )
Text.concatParams( args, separator, format )
Text.containsCJK( s )
Text.removeDelimited( 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.split( text, pattern, plain ) – non Unicode version of mw.text.split
Text.gsplit( text, pattern, plain ) – non Unicode version of mw.text.gsplit
Text.ucfirstAll( s )
Text.uprightNonlatin( s )

Usage

[edit ]

This is a general library; use it anywhere.

Dependencies

[edit ]

Module:Yesno
Module:Text/data --- Lua patterns and information about quotes

Substring (select chunk of string by its position)
{{str sub new }} Select a substring based on starting and ending index counted in either direction. {{str left }} Keep the first N characters of a string, or duplicate it to N characters. {{str crop }} Return all but the last N characters of a string. {{str index }} Return the N-th character of a string.		{{str right }} Return substring starting at N-th character to end of string. {{str rightc }} Return the last N characters of a string; or a given value if empty. {{str sub old }} Return substring of given length starting at N-th character.

Trimming (select/remove chunk of string by character type)
{{trim }} Trim any leading or trailing whitespace {{str letter/trim }} Trim down to the beginning letters. {{str number/trim }} Trim down to the beginning numbers. {{trim brackets }} Trim any leading or trailing square brackets. {{trim quotes }} Trim leading or trailing matching quotes. {{trim leading }} Trim up to six instances of specified <prefix>.		{{string split }} Extract a short string from a long string. {{first word }} Trim down to the first space. {{remove first word }} Remove anything before the first space. {{last word }} Trim down from the last space. {{remove last word }} Remove anything after the last space.

Select/remove specific item from string
{{delink }}, {{trim brackets }} Removes wikilink brackets (wikicode); all or outer only. {{Plain text }} Removes wikicode (formatting and brackets) {{PAGENAMEBASE }} Trim off any parenthesis text at the end of a string (disambiguation). {{title disambig text }} Returns text in parentheses at the end of a string (disambiguation).		{{title year }} Returns the 3-or-4-digit year from a pagename, if any. {{title decade }} Returns the 4-digit decade from a pagename (e.g. "1740" from "Foo 1740s bar"), if any. {{title number }} Returns any number from a pagename. {{WikiProjectbasename }} Removes "WikiProject" from a pagename.

Insertion, replacement, and length
{{loop }} Repeat character string a specified number of times. {{replace }} Returns the string, after replacing all occurrences of a specified string with another string. {{str rep }} Returns the string, after replacing the first occurrence of a specified string with another string. {{digits }} Returns the string, after removing all characters that are not digits 0–9 {{Nowiki }} Displays wikitext as plain text.		{{str len }} Returns a string's length. {{str ≥ len }} Check if a string is "longer or equally long" or "shorter" than a given length. {{str ≤ len }} Check if a string is "shorter or equally long" or "longer" than a given length. {{str ≠ len }} Check if a string is "not equal" or "equal" to a given length.

Functions for templates

Examples and test page

Use in another Lua module

Usage

Dependencies

See also