帮助:维基用户脚本开发指南
维基百科,自由的 encyclopedia
这份指南介绍在维基百科上开发用户脚本的基本方法。维基用户脚本是用JavaScript(JS)编写的,但本文不会介绍JS的语法。
内置脚本
所有维基百科页面都有MediaWiki生成的JS代码。浏览网页时,你的用户脚本可以访问这些内置代码生成的方法和变量。具体哪些页面可用哪些方法和变量,请参见en:Wikipedia:Catalogue of CSS classes#Stylesheets and JavaScript。
用户脚本可以使用JQuery,这是MediaWiki自带的。JQuery的最重要的方法是JQuery()
或$()
,用法说明请参考官方文档 (英文)。
最感兴趣的是:
- mw.config变量
- 可用的资源加载模块
- MediaWiki:Common.js(由中文维基百科的管理员所管理)
- 用户的全局脚本:/common.js
- 用户的特定皮肤脚本:/vector.js(实际名称取决于用户首选项中的皮肤设置)
用户脚本的结构
个人“用户”模块(由/common.js, /common.css 和非必需的当前皮肤的特定文件构建)以及小工具会被加载到所有页面
大部分脚本都需要访问页面上的HTML元素,因此需要在页面加载完成后再运行。(实际加载模块时可能并非如此)
function myScript() {
// ...
};
// 在文档加载完成后执行myScript方法。
jQuery( myScript );
也可以内联myScript。
jQuery( function () {
//... code ...
} );