User:妹空酱/Wikiplus/设置说明

在1.5.0版本之后您将可以自定义wikiplus的某些设置，设置以json格式存储在localstorage中。

设置格式为

{
    "设置名" : "设置值",
    "设置名" : "设置值",
}

请注意，设置值中如果有半角单引号'出现，请以\'转义。

说在前面

设置值为字符串

您可以将设置值定义为静态字符串，按上一小节所示格式即可。

设置值为匿名函数

您还可以把设置值设置为匿名函数。

示例：

{
    "defaultSummary" : "function(){return '正在使用wikiplus编辑页面[[' + mw.config.get('wgPageName') + ']]'}"
}

注意的事项有以下几点

1. 匿名函数请放在双引号内。
2. 在匿名函数内的引号请使用单引号，或使用\"来转义。
3. Wikiplus将先尝试用new Function()来解析您的设置值，如果解析失败或认为是非函数类型将作为字符串返回。
4. 上述示例的效果是(以此页为例)：默认编辑摘要将会是："正在使用Wikiplus编辑页面[[User:妹空酱/Wikiplus/设置说明]]"
5. 匿名函数有无限的可能性，请自行探索~
6. 在匿名函数内可以调用mediawiki的一些常量(参考Manual:Interface/JavaScript)和wikiplus提供的一些私有变量，具体设置具体说明。
7. 函数必须有返回值，且返回值与undefined在非严格判断下不相等。如果您的函数没有返回，请使用return true。（此时编辑摘要将会为“//快速编辑 via Wikiplus”）

在匿名函数内调用私有变量

要求wikiplus版本>=1.5.2

需要当前设置项提供了私有变量支持

如果您需要在匿名函数内调用私有变量。请为您的匿名函数设置一个形参，名称不限。

示例：

function(w){
	return w.sectionName;
}

所有提供的私有变量将集成为一个对象传入，请以object[key]或object.key的方式调用具体值。

注意，此处的w接受wikiplus传入的一个参数，并非全局变量，并随着使用情况可变。

设置列表

defaultSummary

键名：defaultSummary

接受类型：String

可插入的内联变量：

1. sectionName 当前编辑的段落名，如编辑全页返回页面名。
2. sectionNumber 当前编辑的段落编号，如编辑全页返回0。

escToExitQuickEdit

键名：escToExitQuickEdit

接受类型：Boolean

说明：将本值设为true则可以使用esc来退出快速编辑页面

disableEditEveryWhere

键名：disableEditEveryWhere

接受类型：Boolean

说明：将本值设为true可以禁用外部链接的快速编辑功能。

language

键名：language

接受类型：String

说明：本值不为空时，会把语言版本强制指定为该值。