833af36b08
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.
2.4 KiB
Documentation for the SedRegex plugin for Supybot
Purpose
History replacer using sed-style expressions.
Usage
Enable SedRegex on the desired channels:
config channel #yourchannel plugins.sedregex.enable True
After enabling SedRegex, typing a regex in the form
s/text/replacement/ will make the bot announce
replacements.
20:24 <~GL> helli world
20:24 <~GL> s/i/o/
20:24 <@Lily> GL meant to say: hello worldYou can also do othernick: s/text/replacement/ to only
replace messages from a certain user. Supybot ignores are respected by
the plugin, and messages from ignored users will only be considered if
their nick is explicitly given.
Regex flags
The following regex flags (i.e. the g in
s/abc/def/g, etc.) are supported:
i: case insensitive replacementg: replace all occurences of the original texts: (custom flag specific to this plugin) replace only messages from the caller
Configuration
- supybot.plugins.SedRegex.boldReplacementText
-
This config variable defaults to "True", is network-specific, and is channel-specific.
Should the replacement text be bolded?
- supybot.plugins.SedRegex.displayErrors
-
This config variable defaults to "True", is network-specific, and is channel-specific.
Should errors be displayed?
- supybot.plugins.SedRegex.enable
-
This config variable defaults to "False", is network-specific, and is channel-specific.
Should Perl/sed-style regex replacing work in this channel?
- supybot.plugins.SedRegex.ignoreRegex
-
This config variable defaults to "True", is network-specific, and is channel-specific.
Should Perl/sed regex replacing ignore messages which look like valid regex?
- supybot.plugins.SedRegex.processTimeout
-
This config variable defaults to "0.5", is not network-specific, and is not channel-specific.
Sets the timeout when processing a single regexp. The default should be adequate unless you have a busy or low-powered system that cannot process regexps quickly enough. However, you will not want to set this value too high as that would make your bot vulnerable to ReDoS attacks.
- supybot.plugins.SedRegex.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.