模組:String2/doc

这是Module:String2的文档页面

此模块文档被引用於約196,000個頁面，佔全部頁面的2%。
為了避免造成大規模的影響，所有對此模块文档的編輯應先於沙盒或測試樣例上測試。
測試後無誤的版本可以一次性地加入此模块文档中，但是修改前請務必於討論頁發起討論。

模板引用數量會自動更新。

此模块文档已评为alpha版，可接受第三方输入，并可用于少量页面以检查是否存在问题，但需要受到检查。欢迎提供新功能或修改其输入输出机制的建议。

The module “String2” contains 4 available calls that convert strings to upper, lower, sentence or title case.

The sentence case function finds the first letter and capitalises that, so it works properly with text containing wiki-markup. Compare {{#invoke:String2|sentence|[[action game]]}} -> Action game with {{ucfirst:{{lc:[[action game]]}}}} -> action game. Piped wiki-links are handled as well: {{#invoke:String2|sentence|[[trimix (breathing gas)|trimix]]}} -> Trimix.

The title case function capitalises the first letter of each word in the text, apart from a number of short words recommended by The U.S. Government Printing Office Style Manual.

Further functions commonly used on strings would be useful additions.

用法

{#invoke:String2 | upper |…}}
{#invoke:String2 | lower |…}}
{#invoke:String2 | sentence |…}}
{#invoke:String2 | title |…}}

參數

Just one unnamed parameter is used, representing the text to be converted to the required case.

範例

Input	Output
{{#invoke:String2\| upper \| abcd }}	脚本错误：函数“upper”不存在。
{{#invoke:String2\| upper \| abCD }}	脚本错误：函数“upper”不存在。
{{#invoke:String2\| upper \| ABcd }}	脚本错误：函数“upper”不存在。
{{#invoke:String2\| upper \| ABCD }}	脚本错误：函数“upper”不存在。
{{#invoke:String2\| upper \| }}	脚本错误：函数“upper”不存在。

{{#invoke:String2\| lower \| abcd }}	脚本错误：函数“lower”不存在。
{{#invoke:String2\| lower \| abCD }}	脚本错误：函数“lower”不存在。
{{#invoke:String2\| lower \| ABcd }}	脚本错误：函数“lower”不存在。
{{#invoke:String2\| lower \| ABCD }}	脚本错误：函数“lower”不存在。
{{#invoke:String2\| lower \| }}	脚本错误：函数“lower”不存在。

{{#invoke:String2\| sentence \| abcd }}	Abcd
{{#invoke:String2\| sentence \| abCD }}	Abcd
{{#invoke:String2\| sentence \| ABcd }}	Abcd
{{#invoke:String2\| sentence \| ABCD }}	Abcd
{{#invoke:String2\| sentence \| [[action game]] }}	Action game
{{#invoke:String2\| sentence \| [[trimix (breathing gas)\|trimix]] }}	Trimix
{{#invoke:String2 \| sentence \| {{#invoke:WikidataIB \|getValue \|P136 \|name=genre \|fetchwikidata=ALL \|qid=Q1396889}} }}	影射小說、寓言
{{#invoke:String2\| sentence \| }}

{{#invoke:String2\| title \| abcd }}	Abcd
{{#invoke:String2\| title \| abCD }}	Abcd
{{#invoke:String2\| title \| ABcd }}	Abcd
{{#invoke:String2\| title \| ABCD }}	Abcd
{{#invoke:String2\| title \| }}
{{#invoke:String2\| title \| The Vitamins Are In My Fresh California Raisins}}	The Vitamins Are in My Fresh California Raisins

參見

Module:String for the following functions:

len
sub
sublength
match
pos
str_find
find
replace
rep