模块:String/doc

由Harry00025汉化于MediaWiki Module:String/doc，删去了前言和配置手册，有更改。
若想查阅原文，请使用科学上网手段并访问 https://zh.wikipedia.org/wiki/Module:String 。

本模块添加了简单的字符串函数。

len

此函数返回字符串的长度。

范例：{{#invoke:String|len|目标字符串}}

sub

本函数返回目标函数的指定段落。请注意，首个字符的编号为1而非0。

范例：{{#invoke:String|sub|目标字符串|起始位置|结束位置}}

• 起始位置和结束位置为数字。填入负数代表反向索引，例如-1代表字符串的最后一个字符。

match

本函数可以用于检查A字符串里是否含有B字符串。

范例：{{#invoke:String|match|被索引字符串|索引字符串|起始位置|需要匹配次数|字符串类型|错误输出}}

不知道为什么没有提供“结束位置”的选项设置

• 如果被索引字符串里含有索引字符串，则返回索引字符串；若不含，则返回错误输出，若没有错误输出，则报错。
• 需要匹配次数：如果被索引字符串里需要含有指定次数次索引字符串，则返回索引字符串，若没有达到次数则返回错误输出，若没有错误输出，则报错。本项默认为1。
• 字符串类型：Boolean flag indicating that pattern should be understood as plain text and not as a Lua-style regular expression. Defaults to false.
• 错误输出：当函数报错时的输出，省去了使用{{#iferror}}的步骤。

pos

本函数返回指定字符串里的指定位置的数据。

范例：{{#invoke:String|pos|目标字符串|位置}}

• 位置为数字。填入负数代表反向索引，例如-1代表字符串的最后一个字符。

find

本函数返回A字符串里包含的B字符串的位置。

范例：{{#invoke:String|find|被查找字符串|查找字符串|起始位置|字符串类型}}

不知道为什么没有提供“结束位置”的选项设置

• 如果被查找字符串里含有查找字符串，则返回被查找字符串里第一次查找到查找字符串的第一个字符的位置。如果没有，返回0。
• 起始位置：为数字，填入负数代表反向索引，例如-1代表字符串的最后一个字符。只能查找被查找字符串的指定起始位置(含)之后的位置，默认为1。
• 字符串类型：Boolean flag indicating that target should be understood as plain text and not as a Lua-style regular expression, defaults to true.

replace

本函数可以将A字符串内的B字符串替换为C字符串。

范例：{{#invoke:String|replace|A字符串|B字符串|C字符串|替换数量|字符串类型}}

• A字符串：被替换的字符串。
• B字符串：A字符串内被替换的文本。
• C字符串：替换A字符串内的B字符串的文本。
• 替换数量：从字符串头开始，替换指定次数，默认为all。
• 字符串类型：Boolean flag indicating that pattern should be understood as plain text and not as a Scribunto ustring pattern (a unicode-friendly Lua-style regular expression); defaults to true.

rep

本函数可以将指定字符串重复指定次数。

范例：{{#invoke:String|rep|指定字符串|重复次数}}