Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.68 KB

README.md

File metadata and controls

45 lines (34 loc) · 1.68 KB
Raw

defaultSortBot Build Status Coverage Status Greenkeeper badge

Add Japanese sort key to mediawiki pages automatically.

{{DEFAULTSORT: そおときい}}

Usage

git clone https://github.com/kn1cht/defaultSortBot.git
cd defaultSortBot
npm install
cp config/example.yaml config/default.yaml
vi config/default.yaml
node main.js

default.yaml

Set your config in default.yaml before run defaultSortBot.

  • server: your mediawiki server domain.
  • path: relative path for the directory contains api.php.
  • username: username for mediawiki bot account.
  • password: password for mediawiki bot account.
  • namespaces : namespace to process.
    • id: namespace id number(get list from api.php?action=query&meta=siteinfo&siprop=namespaces).
    • prefix: namespace prefix(e.g. "Category") to exclude from DEFAULTSORT

Warning: DO NOT set default sort key to the pages which are included in another page, such as Template pages.

Run as scheduled task

vi schedule.js
npm i -g forever
forever start schedule.js

Used merencia/node-cron to generate scheduled job. Please modify setting in schedule.js as you like.