Twinkle是維基人用於快速執行常見維護工作(如提交刪除候選及清理破壞)的JavaScript庫和應用程式。
它構建於已被許多維基百科腳本和編輯工具使用的morebits.js
庫之上。
查看中文維基百科上的Wikipedia:Twinkle以獲取更多信息。
AzaToth是本工具和morebits.js
庫的的最初作者和維護者。
要生成被貓過的Twinkle腳本,請使用以下bash
命令:
awk 'FNR==1{print ""}{print}' twinkle.header.js modules/*.js twinkle.footer.js > alltwinkle.js
然後就可以把alltwinkle.js
上傳到MediaWiki:Gadget-Twinkle.js。這並未包含morebits.js
和morebits.css
,它們需要被分開上傳。
如果morebits.js
和/或morebits.css
需要更新,它們應當被同步到這些地方:
- morebits.js 至MediaWiki:Gadget-morebits.js
- morebits.css 至MediaWiki:Gadget-morebits.css
MediaWiki:Gadgets-definition應當包含這一行:
* Twinkle[ResourceLoader|dependencies=jquery.ui.dialog,jquery.tipsy]|morebits.js|morebits.css|Twinkle.js
存在一個名為sync.pl
的同步腳本,可用於向維基百科上拉取和推送文件。
這個程序依賴於Perl 5.10和模塊Git::Repository
與MediaWiki::Bot
,可輕易用App::cpanminus
安裝:
cpanm --sudo install Git::Repository MediaWiki::Bot
在運行這個程序時,您可以在命令行中使用--username
和--password
參數提供您的憑據,但更推薦將它們保存到~/.mwbotrc
的文件中,採用以下格式:
username => "Username",
password => "password",
base => "User::Username"
其中base
是pull
和push
文件時的wiki路徑前綴。
留意您的工作目錄不需要是乾淨的;亦可以stash
或commit
您的修改。
要pull
用戶Foobar的修改,做:
./sync.pl --base User:Foobar --pull morebits.js
要push
您的修改到Foobar的wiki頁,做:
./sync.pl --base User:Foobar --push morebits.js
也有一deploy
命令來部署新的文件。
./sync.pl --deploy twinkle.js
make deploy
編輯摘要會包含分支和上次提交的SHA。
雖然舊的代碼有許多不同且不一致的格式,但我們已經決定要在代碼中使用更為一致的格式。
jQuery Core Style Guideline是我們在此之後使用的格式指引。