Dan Collins > MediaWiki-Bot-Plugin-CUP > MediaWiki::Bot::Plugin::CUP

Download:
MediaWiki-Bot-Plugin-CUP-0.3.2.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.3.2   Source  

NAME ^

MediaWiki::Bot::Plugin::CUP - a plugin for MediaWiki::Bot which contains data retrieval tools for the 2009 WikiCup hosted on the English Wikipedia

SYNOPSIS ^

use MediaWiki::Bot;

my $editor = MediaWiki::Bot->new('Account'); $editor->login('Account', 'password'); $editor->cup_get_all('User:Contestant');

DESCRIPTION ^

MediaWiki::Bot is a framework that can be used to write Wikipedia bots. MediaWiki::Bot::Plugin::CUP can be used for data retrieval and reporting bots related to the 2009 WikiCup

AUTHOR ^

Dan Collins (ST47) and others

METHODS ^

import()

Calling import from any module will, quite simply, transfer these subroutines into that module's namespace. This is possible from any module which is compatible with MediaWiki/Bot.pm.

cup_get_all($contestant[, $text])

Will retrieve the contestant's total score. $text is optional but recommended if you will be calling these functions multiple times for the same user or if you will be using the submisssions pages, for performance reasons. Also, if you need to get several users' stats, please use MediaWiki::Bot's get_pages sub to retrieve all the submissions pages in one go. Also, if you want any control at all over where we get the data, say if there's a capitalization mismatch or the submissions pages are not located where I think they are, then if you pass the text of the submission page to me, I will use your submissions page. Finally, note that for purposes of getting edit counts, we use $contestant as the username, so please don't do anything to mangle that just so that I get the right submissions page. File a bug first.

Data is returned as edits, gas, fas, fls, fss, fpis, fpos, dyks, itns, fts, gts, and total score. All are in number of points claimed, not number of articles submitted.

cup_get_item($contestant, $item[, $text])

Will retrieve the contestant's subscore for a particular item. $item must match the title in config exactly. $text is optional but recommended.

Data is returned as number, not score. For scores or for general use, use cup_get_all.

syntax highlighting: