Jump to content
Wikipedia The Free Encyclopedia

Module:Ustring

From Wikipedia, the free encyclopedia
Module documentation[view] [edit] [history] [purge]
[画像:Warning] This Lua module is used in system messages, and on approximately 819,000 pages, or roughly 1% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
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. Please discuss changes on the talk page before implementing them.
This module can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.
This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.
Page protected This module is currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.

This module directly imports all functions from the mw.ustring library. Documentation for each function can be found there.

The module takes an indefinite number of arguments. Arguments given as |s1=, |s2=, etc, are read first, and are used as strings. All remaining numerical arguments are coerced to number type if possible, and remain strings if not. If you wish for a numerical (i.e. unnamed or "|1=", "|2=") to remain a string, you can simply escape it by inserting \ at the beginning of the string.

Note that MediaWiki will always trim whitespace from named arguments; to give arguments with surrounding whitespace you must use unnamed parameters starting with \.

How to pass inconvenient strings
To pass this... Write this Explanation
" 0123 " |\ 123 To get surrounding whitespace must use unnamed, but must precede with \ to indicate that it isn't a number.
"0123" |s1=0123 If you don't need to preserve whitespace use |s1= etc.
"0123" |1=0123円 If you don't need to preserve whitespace explicitly use |1= etc.
In another template, to pass its parameter {{{1}}}, preserving whitespace |\{{{1}}} Must provide the \ with unknown string input.
In another template, to pass its parameter {{{1}}}, stripping whitespace |s1={{{1}}}
In another template, to pass its parameter {{{1}}}, stripping whitespace |1=\{{#if:1|{{{1}}}}}

You can also wrap results in tags. All other unused arguments will be passed to frame:extensionTag

Usage

{{#invoke:Ustring|function_name|arg1|arg2|...}} is equivalent to mw.ustring.function_name(arg1,arg2,...)

Example using mw.ustring.sub

{{#invoke:Ustring|sub|s1=abcde|2|4}}

produces:

bcd

Example using mw.ustring.gsub

{{#invoke:Ustring|gsub|s1=1234|23|}}

produces:

14

Example using mw.ustring.char

&#{{#invoke:ustring|char|49|48|59}}

produces:




Example using mw.ustring.match

{{#invoke:Ustring|match|s1=abcde|s2=(c%w)}}

produces:

cd

Note: Only the first match is returned. Additional returns are omitted because mw.ustring.gsub's second return value is generally undesirable.

Example using tag arguments

{{#invoke:Ustring|match
|s1={{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send
|tag=syntaxhighlight|lang=lua}}

produces: 

ifnotfargs.tagthen
return(what(unpack(args)))-- Outside parens truncate to first result avoiding tail call
end
localtagargs={}
forx,yinpairs(fargs)do
ifnotfargsused[x]thentagargs[x]=yend
end

Note that: 

<syntaxhighlight lang="lua">{{#invoke:Ustring|match
|s1={{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight>

produces: 

{{#invoke:Ustring|match
|s1={{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send}}

Errors

Errors from accessing mw.ustring should be maintained, e.g.:

{{#invoke:Ustring|xyzzy}}

should produce:

Script error: The function "xyzzy" does not exist.

and

{{#invoke:Ustring|maxPatternLength}}

should produce:

Script error: "maxPatternLength" is not a function.

See also

String-handling templates (help page)
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.
Analysis and searching
{{str startswith }}
{{str endswith }} Check if a string starts or ends with a given string.
{{str find }}, {{strfind short }} Returns the numerical location of a given string in a string.
{{str count }} Count the number of occurrences of a pattern within a string.
{{Array }} Array item manipulation and retrieval.
{{a or an }} Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel.
{{in string }} Returns optional string when given string is not found
{{Isnumeric }} Returns number when true, blank when not numeric.
{{str letter }} Returns the number of letters that begin a string.
{{str number }} Returns the number of numbers that begin a string.
Modules and built-in functions
The above documentation is transcluded from Module:Ustring/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

 require('strict')
 returnsetmetatable({},{
 __index=function(t,k)
 localwhat=mw.ustring[k]
 iftype(what)~="function"then
 returnwhat
 end
 returnfunction(frame)
 localfargs=frame.args
 localfargsused={tag=true}
 localargs={}
 localstr_i=1
 whilefargs['s'..str_i]do
 fargsused['s'..str_i]=true
 args[str_i]=fargs['s'..str_i]
 str_i=str_i+1
 end
 fori,vinipairs(fargs)do
 fargsused[i]=true
 args[i+str_i-1]=tonumber(v)orv:gsub("^\\","",1)
 end
 ifnotfargs.tagthen
 return(what(unpack(args)))-- Outside parens truncate to first result avoiding tail call
 end
 localtagargs={}
 forx,yinpairs(fargs)do
 ifnotfargsused[x]thentagargs[x]=yend
 end
 returnframe:extensionTag{name=fargs.tag,content=what(unpack(args)),args=tagargs}
 end
 end
 })
Retrieved from "https://en.wikipedia.org/w/index.php?title=Module:Ustring&oldid=1208349011"

AltStyle によって変換されたページ (->オリジナル) /