API 文档

施工中

本页面的内容正在施工中,请以最终版为准!

这里介绍的是由 InPageEdit 提供的函数或变量。

当介绍函数时,<param>代表必选,[param]代表可选,|代表或者。

window.InPageEdit

window.InPageEdit = InPageEdit;
1

InPageEdit.about()

……

InPageEdit.api

锁定

保留了有关 InPageEdit 的一些接口,例如

  • Type: {Object}
  • Return:
    • aboutUrl 关于&帮助的 URL
    • analysis 统计信息的数据上报接口
    • analysisUrl 统计信息展示页面的 URL
    • updatelogsUrl 更新日志的 URL

……

InPageEdit.preference

InPageEdit.preference.default

保存预设的参数设置

  • Type: [Array]
  • Return:
{
  "doNotCollectMyInfo": false,
  "doNotShowLocalWarn": false,
  "editMinor": false,
  "editSummary": _msg("preference-summary-default"),
  "lockToolBox": false,
  "redLinkQuickEdit": true,
  "outSideClose": true,
  "watchList": Boolean(mw.user.options.get("watchdefault"))
}
1
2
3
4
5
6
7
8
9
10

InPageEdit.preference.get([setting])

获取参数设置的值

  • setting{String}
    • 需要获取的参数设置的键,不指定则以 Object 返回全部设定

InPageEdit.preference.set(<settingKey>[, settingValue])

不推荐使用此函数保存个人设置

保存参数设置的值

  • settingKey {Object|String}
    • 要保存的参数设置键值对或键
  • settingValue {Any}
    • 要保存的参数的值
    • settingKey为 String 时必填

InPageEdit.progress(<text>)

……

InPageEdit.quickDelete([page])

打开快速删除的对话框

  • page {String}
    • Default: mw.config.get('wgPageName')
    • 要删除的页面名

InPageEdit.quickDiff(<param>)

通过参数展示快速差异模态框

  • param {Object}
    • MediaWiki diff API 标准参数

InPageEdit.quickEdit([options])

按照设定参数打开快速编辑的模态框

  • options {Object|String}

    • 不配置或者传入空值,以当前浏览的页面为目标页面
    • 传入字符串时,将字符串视为目标页面名
    • 传入 JSON 对象时,将会尝试与默认配置项进行合并后执行后续操作
  • 可供配置的 JSON 参数:

    • options.page {String} 页面名称,不能与pageId同时使用(预设为当前页面名)
    • options.pageId {Number} 页面 ID,不能与page同时使用
    • options.revision {Number} 若配置,将以提供的 revision 编号查找页面信息,可能忽略页面配置(预设为当前页面的版本 ID)
    • options.section {Number|"new"} 若配置,编辑段落,段落为大于 0 且小于页面段落数的数字或者"new"(预设为 null,编辑全文)
    • options.editMinor {Boolean} 若配置,取代小编辑的勾选状态
    • options.editSummary 若配置,取代编辑摘要的内容
    • options.reload {Boolean} 若配置,取代保存后刷新页面的勾选状态
    • 其余参数均不建议修改,否则可能导致故障

InPageEdit.quickPreview()

……

InPageEdit.quickRedirect()

……

InPageEdit.quickRename()

……

InPageEdit.specialNotice()

……

InPageEdit.version

锁定
  • Type: "String"
  • Return: 当前使用的 InPageEdit 版本号

InPageEdit.versionInfo()

……

_msg(<msgKey>[, ...args])

内部

通过键获取 i18n 字符串

  • msgKey {String}
  • args {String}
    • 替换字符串中的占位符(例如$1