Version 2 vs 3
Version 2 vs 3
Edits
Edits
- Edit by stwalkerster, Version 3
- Mar 17 2018 1:19 PM
- Edit by stwalkerster, Version 2
- Mar 17 2018 1:12 AM
- ·upd for 2.0
« Previous Change | Next Change » |
Edit Older Version 2... | Edit Older Version 3... |
Content Changes
Content Changes
== Commands ==
### Quit ###
Requires: ?
```
=quit
```
Stops the bot.
### Command Access ###
Requires: ?
```
=commandaccess ???
```
### My Flags ###
Requires: ?
```
=myflags ???
```
### Quick ###
Requires: ?
```
=quick ???
```
### Stalk ###
Requires: ?
```
=stalk <addcmd>|<delcmd>|<setcmd>|list|<mailcmd>|<descriptioncmd>|<expirycmd>|<enabledcmd>
```
```
<addcmd> := add <flag>
<delcmd> := del <flag>
<setcmd> := set <flag> <simplevalue>|<complexvalue>
<mailcmd> := mail <flag> [immediate] true|false
<descriptioncmd> := description <flag> <description>
<expirycmd> := expiry <flag> <expiry date>
<enabledcmd> := enabled <flag> true|false
<simplevalue> := page|user|summary <regex>
<complexvalue> := xml <xml fragment>
```
Modifies stalk commands
Use "add <flag> simple" to add a new simple stalk flag, then "set <flag> user|page|summary <regex>" to set up the monitoring for that stalk.
Use "add <flag> complex" to add a new complex stalk, then "set xml <xmlfragment>" to set the search tree for the complex stalk.
A complex stalk XML search tree is an XML root element from the list: and, or, not, true, false, user, page, summary. and and or MUST have two child nodes, not MUST have one child node, and the rest MUST have zero child nodes. user, page, and summary MUST have an attribute called value containing a regular expression to match.
For example:
```
<and>
<or>
<page value="Wikipedia:New contributors' help page"/>
<page value="Wikipedia:Help Desk"/>
</or>
<and>
<not>
<user value="Stwalkerster"/>
</not>
<summary value="/\* New Section \*/"/>
</and>
</and>
```
Use the mail option to enable or disable logging of stalk triggers via email. By default, every stalk has it enabled.
### ACC ###
Requires: ?
```
=acc <id> <username>
```
Adds a stalk with key `acc<id>` (eg `acc12345`) for any match on the specified username
### Version ###
Requires: ?
```
=version
```
Shows the current bot version.
## Future commands ##
(none planned)
## Edit Flags ##
For the flag-based stalks, this is a description of some of the flags:
```
! - unreviewed
M - minor
N - new
B - bot
move - move
```
== Commands ==
### Die ###
Requires: Owner
```
=die
```
Shuts down the bot.
Location: `Stwalkerster.Bot.CommandLib.Commands.BotManagement`
### Command Access ###
Requires: Standard
```
=commandaccess <command>
```
Retrieves the flag required to use the specified command.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### My Flags ###
Requires: Standard
```
=myflags
=myaccess
=whoami
```
Retrieves the flags available to the current user.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### Quick ###
Requires: Protected
```
=quick <Flag> <Type> <Match>
```
Sets up a new basic stalk with the specified match and type, and default options specified.
Specifically, `=quick foo page bar` would create a new stalk `foo` monitoring the page `bar`.
Location: `EyeInTheSky.Commands`
### Stalk ###
Requires: Protected
```
=stalk list
```
Lists all configured stalks
```
=stalk add <Flag>
```
Adds a new unconfigured stalk
```
=stalk del <Flag>
```
Deletes a stalk
```
=stalk enabled <Flag> <true|false>
```
Marks a stalk as enabled or disabled
```
=stalk mail <Flag> <true|false>
```
Enables or disables email notifications for each trigger of the specified stalk
```
=stalk description <Flag> <Description...>
```
Sets the description of the specified stalk
```
=stalk expiry <Flag> <Description...>
```
Sets the description of the specified stalk
```
=stalk set <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to specified user, page, or edit summary regex. Alternatively, manually specify an XML tree (advanced).
```
=stalk and <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical AND of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
```
=stalk or <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical OR of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
An XML search tree is an XML root element from the list: `and`, `or`, `not`, `true`, `false`, `user`, `page`, `summary`, `flag`. `and` and `or` MUST have two child nodes, `not` MUST have one child node, and the rest MUST have zero child nodes. `user`, `page`, `flag` and `summary` MUST have an attribute called value containing a regular expression to match.
For example:
```
<and>
<or>
<page value="Wikipedia:New contributors' help page"/>
<page value="Wikipedia:Help Desk"/>
</or>
<and>
<not>
<user value="Stwalkerster"/>
</not>
<summary value="/\* New Section \*/"/>
</and>
</and>
```
Use the mail option to enable or disable logging of stalk triggers via email. By default, every stalk has it enabled.
### ACC ###
Requires: Protected
```
=acc <id> <username>
```
Adds a new temporary stalk with key `acc<id>` (eg `acc12345`) for any match on the specified username
Location: `EyeInTheSky.Commands`
### Version ###
Requires: Standard
```
=version
```
Shows the current bot version.
Location: `EyeInTheSky.Commands`
## Edit Flags ##
For the flag-based stalks, this is a description of //some// of the flags:
```
! - unreviewed
M - minor
N - new
B - bot
move - move
```
== Commands ==
### QuitDie ###
Requires: ?Owner
```
=quit=die
```
StopsShuts down the bot.
Location: `Stwalkerster.Bot.CommandLib.Commands.BotManagement`
### Command Access ###
Requires: ?Standard
```
=commandaccess ???<command>
```
Retrieves the flag required to use the specified command.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### My Flags ###
Requires: ?Standard
```
=myflags ???
=myaccess
=whoami
```
Retrieves the flags available to the current user.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### Quick ###
Requires: ?Protected
```
=quick ???<Flag> <Type> <Match>
```
Sets up a new basic stalk with the specified match and type, and default options specified.
Specifically, `=quick foo page bar` would create a new stalk `foo` monitoring the page `bar`.
Location: `EyeInTheSky.Commands`
### Stalk ###
Requires: ?Protected
```
=stalk list
```
Lists all configured stalks
```
=stalk <addcmd>|<delcmd>|<setcmd>|list|<mailcmd>|<descriptioncmd>|<expirycmd>|<enabledcmdadd <Flag>
```
Adds a new unconfigured stalk
```
<addcmd> := add <flag=stalk del <Flag>
<delcmd> := del <flag>```
Deletes a stalk
```
<setcmd> := set <f=stalk enabled <Flag> <simplevalue>|<complexvaluetrue|false>
<mailcmd> := mail <flag> [immediate] true|false```
<descriptioncmd> := description <flag> <description>Marks a stalk as enabled or disabled
<expirycmd> := expiry <flag> <expiry date>```
<enabledcmd> := enabled <f=stalk mail <Flag> <true|false>
<simplevalue> := page|user|summary <regex>```
<complexvalue> := xml <xml fragment>Enables or disables email notifications for each trigger of the specified stalk
```
Modifies stalk commands
Use "add <flag> simple" to add a new simple stalk flag, then "set <flag> user|page|summary <regex>" to set up the monitoring for that stalk.=stalk description <Flag> <Description...>
Use "add <flag> complex" to add a new complex stalk```
Sets the description of the specified stalk
```
=stalk expiry <Flag> <Description...>
```
Sets the description of the specified stalk
```
=stalk set <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to specified user, page, or edit summary regex. Alternatively, then "set xml <xmlfragment>" to set the search tree for the complex stalk.
A complex stalk XML search tree is an XML root element from the list: andmanually specify an XML tree (advanced).
```
=stalk and <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical AND of the current configuration, orand a specified user, notpage, true,or edit summary regex; falseor XML tree (advanced).
```
=stalk or <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical OR of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
An XML search tree is an XML root element from the list: `and`, `or`, `not`, `true`, `false`, `user`, `page`, `summary`, summary`flag`. and`and` and or`or` MUST have two child nodes, not`not` MUST have one child node, and the rest MUST have zero child nodes. `user`, `page`, `flag` and `summary` MUST have an attribute called value containing a regular expression to match.
For example:
```
<and>
<or>
<page value="Wikipedia:New contributors' help page"/>
<page value="Wikipedia:Help Desk"/>
</or>
<and>
<not>
<user value="Stwalkerster"/>
</not>
<summary value="/\* New Section \*/"/>
</and>
</and>
```
Use the mail option to enable or disable logging of stalk triggers via email. By default, every stalk has it enabled.
### ACC ###
Requires: ?Protected
```
=acc <id> <username>
```
Adds a new temporary stalk with key `acc<id>` (eg `acc12345`) for any match on the specified username
Location: `EyeInTheSky.Commands`
### Version ###
Requires: ?Standard
```
=version
```
Shows the current bot version.
## Future commands ##
(none planned)
Location: `EyeInTheSky.Commands`
## Edit Flags ##
For the flag-based stalks, this is a description of //some// of the flags:
```
! - unreviewed
M - minor
N - new
B - bot
move - move
```