mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 02:29:22 +01:00

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

2.8 KiB

Raw Blame History

Documentation for the ShrinkUrl plugin for Supybot

Purpose

Shrinks URLs using various URL shortening services, like tinyurl.

Usage

This plugin features commands to shorten URLs through different services, like tinyurl.

Commands

tiny <url>: Returns a TinyURL.com version of <url>
ur1 <url>: Returns an ur1 version of <url>.
x0 <url>: Returns an x0.no version of <url>.

Configuration

supybot.plugins.ShrinkUrl.bold

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

Determines whether this plugin will bold certain portions of its replies.

supybot.plugins.ShrinkUrl.default

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

Determines what website the bot will use when shrinking a URL. Valid strings: tiny, ur1, and x0.

supybot.plugins.ShrinkUrl.minimumLength

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

The minimum length a URL must be before the bot will shrink it.

supybot.plugins.ShrinkUrl.nonSnarfingRegexp

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

Determines what URLs are to be snarfed; URLs matching the regexp given will not be snarfed. Give the empty string if you have no URLs that you'd like to exclude from being snarfed.

supybot.plugins.ShrinkUrl.outFilter

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

Determines whether the bot will shrink the URLs of outgoing messages if those URLs are longer than supybot.plugins.ShrinkUrl.minimumLength.

supybot.plugins.ShrinkUrl.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.ShrinkUrl.serviceRotation

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

If set to a non-empty value, specifies the list of services to rotate through for the shrinkSnarfer and outFilter.

supybot.plugins.ShrinkUrl.shrinkSnarfer

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

Determines whether the shrink snarfer is enabled. This snarfer will watch for URLs in the channel, and if they're sufficiently long (as determined by supybot.plugins.ShrinkUrl.minimumLength) it will post a smaller URL from the service as denoted in supybot.plugins.ShrinkUrl.default.

supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain

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

Determines whether the snarfer will show the domain of the URL being snarfed along with the shrunken URL.

2.8 KiB Raw Blame History