Help:Lua/mw.message

来自滚动的天空Wiki

mw.message库是MediaWiki本地化消息和MediaWiki:命名空间中的页面的接口。

静态方法[编辑源代码]

new[编辑源代码]

mw.message.new(key, ...)

创建一个指定了消息键(key)的新消息对象,剩下的参数传递到新的对象的params()的方法。

消息对象没有属性,但是有下面列出的几个方法。

newFallbackSequence[编辑源代码]

mw.message.newFallbackSequence(...)

创建给定的消息的新的消息对象,其中会使用第一个存在的键。

消息对象没有属性,但有下面列出的几种方法。

newRawMessage[编辑源代码]

mw.message.newRawMessage(msg, ...)

创建新的消息对象,直接使用给定的文本,而不是查找国际化的消息。剩下的参数会传递到新对象的params()方法中。

消息对象没有属性,但是有下面列出的几个方法。

rawParam[编辑源代码]

mw.message.rawParam(value)

将该值包装起来,使之不会被msg:parse()解析为维基文本。

numParam[编辑源代码]

mw.message.numParam(value

将该值包装起来,使之自动被格式化为lang:formatNum()。注意这不依赖事实上有效的语言库

getDefaultLanguage[编辑源代码]

mw.message.getDefaultLanguage()

返回默认语言的语言对象。

实例方法[编辑源代码]

下面的各个实例中,msg表示一个通过上面的方法创建的消息对象。

params[编辑源代码]

msg:params(...)msg:params(params)

给消息添加参数,传入的参数可以为独立的参数或者一个数组。参数必须是数字、字符串或由mw.message.numParam()mw.message.rawParam()返回的特殊的值。如果使用数组,参数必须是直接出现在表中,忽略__index元方法。

返回msg对象,以允许链式调用。

rawParams[编辑源代码]

msg:rawParams(...)msg:rawParams(params)

类似于:params(),但是会先通过mw.message.rawParam()传递所有的参数。

返回msg对象,以允许链式调用。

numParams[编辑源代码]

msg:numParams(...)msg:numParams(params)

类似于:params(),但是会先通过mw.message.numParam()传递所有的参数。

返回msg对象,以允许链式调用。

inLanguage[编辑源代码]

msg:inLanguage(lang)

指定一个语言,以在加工消息时使用。lang可以是字符串,或者带有getCode()元表的表(比如语言对象)。

默认的语言是由mw.message.getDefaultLanguage()返回的。

返回msg对象,以允许链式调用。

useDatabase[编辑源代码]

msg:useDatabase(bool)

指定是否在MediaWiki:命名空间查找消息(比如在数据库中查找),或者只是使用MediaWiki分配的默认消息。

默认为true。

返回msg对象,以允许链式调用。

plain[编辑源代码]

msg:plain()

替换参数按原样返回消息维基文本。模板调用和解析器函数都是完整的。

exists[编辑源代码]

msg:exists()

返回表示消息键是否存在的布尔值。

isBlank[编辑源代码]

msg:isBlank()

返回表示消息键是否有内容的布尔值。当消息键不存在或者消息是空字符串时返回true。

isDisabled[编辑源代码]

msg:isDisabled()

返回表示消息键是否被禁用的布尔值。如果消息键不存在,或者消息是空字符串,或者是字符串“-”,则返回true。