mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-25 12:12:54 +01:00

History

Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason.		2021-04-05 17:42:31 +02:00
..
locales	Fix msgfmt warnings.	2020-03-26 22:10:28 +01:00
__init__.py	all plugins: auto-generate READMEs	2021-04-05 17:42:31 +02:00
config.py	Fix neutral pronouns.	2014-04-11 21:56:42 +00:00
messages.pot	Squashed commit of the following:	2014-12-20 14:37:27 +01:00
plugin.py	Seen: Don't internalize IrcString.	2020-05-22 08:38:42 +02:00
README.rst	all plugins: auto-generate READMEs	2021-04-05 17:42:31 +02:00
test.py	Replace failUnless/failIf with assertTrue/assertFalse.	2020-01-26 11:14:18 +01:00

README.rst

Documentation for the Seen plugin for Supybot

Purpose

Keeps track of the last time a user was seen on a channel and what they last said. It also allows you to see what you missed since you parted the channel.

Usage

This plugin allows you to see when and what someone last said and what you missed since you left a channel.

Commands

any [<channel>] [--user <name>] [<nick>]: Returns the last time <nick> was seen and what <nick> was last seen doing. This includes any form of activity, instead of just PRIVMSGs. If <nick> isn't specified, returns the last activity seen in <channel>. If --user is specified, looks up name in the user database and returns the last time user was active in <channel>. <channel> is only necessary if the message isn't sent on the channel itself.
last [<channel>]: Returns the last thing said in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
seen [<channel>] <nick>: Returns the last time <nick> was seen and what <nick> was last seen saying. <channel> is only necessary if the message isn't sent on the channel itself. <nick> may contain * as a wildcard.
since [<channel>] [<nick>]: Returns the messages since <nick> last left the channel. If <nick> is not given, it defaults to the nickname of the person calling the command.
user [<channel>] <name>: Returns the last time <name> was seen and what <name> was last seen saying. This looks up <name> in the user seen database, which means that it could be any nick recognized as user <name> that was seen. <channel> is only necessary if the message isn't sent in the channel itself.

Configuration

supybot.plugins.Seen.minimumNonWildcard

This config variable defaults to "2", is network-specific, and is channel-specific.

The minimum non-wildcard characters required to perform a 'seen' request. Of course, it only applies if there is a wildcard in the request.

supybot.plugins.Seen.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.

supybot.plugins.Seen.showLastMessage

This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the last message will be displayed with @seen. Useful for keeping messages from a channel private.