User:AnomieBOT/source/d/Talk.pm/doc

NAME

d::Talk - AnomieBOT talkpage utility decorator

SYNOPSIS

 use AnomieBOT::API;
 
 $api = new AnomieBOT::API('conf.ini', 1);
 $api->decorators(qw/d::Talk/);

DESCRIPTION

d::Talk contains various talk page related utility functions for use by an AnomieBOT task. When "d::Talk" is used as a decorator on the API object, the following methods are available.

METHODS PROVIDED

$api->whine( $title, $msg )

$api->whine( $title, $msg, %options )

If a section with the specified title doesn't exist on the specified page, create one with the specified $msg. Additional options are:

Summary: Edit summary, instead of the default "Name needs human assistance"
Pagename: Page to post the message to, instead of the bot's talk page.
NoSmallPrint: If true, the small print at the end of the message will be omitted.
NoSig: If true, no signature will be appended. You should probably have included the sig in the message.

Additionally, any options accepted by $api->edittoken() are accepted.

This may return anything returnable by $api->edittoken() or $api->edit().

COPYRIGHT

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.