mirror of
https://github.com/progval/Limnoria.git
synced 2025-04-26 04:51:06 -05:00
63eb6672ea
This commit reverts db7ef3f02517f9f2a3c56829a22b9fad3c36e374 (though it keeps the year updates) After discussion with several people, it seems better to mention copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright explains the issue of using VCSs to track copyright. As db7ef3f02517f9f2a3c56829a22b9fad3c36e374 only replaced mentions of my name with 'The Limnoria Contributors', this commit only needs to undo that + add one person who contributed to setup.py.
.. _plugin-DDG:
Documentation for the DDG plugin for Supybot
============================================
Purpose
-------
Searches for results on DuckDuckGo's web search.
Usage
-----
Searches for results on DuckDuckGo.
Example::
<+jlu5> %ddg search eiffel tower
<@Atlas> The Eiffel Tower is an iron lattice tower located on the Champ de Mars in Paris. It was named after the engineer Gustave Eiffel, whose company designed and built the tower. - <https://en.wikipedia.org/wiki/Eiffel_Tower>
.. _commands-DDG:
Commands
--------
.. _command-ddg-search:
search <text>
Searches for <text> on DuckDuckGo's web search.
.. _conf-DDG:
Configuration
-------------
.. _conf-supybot.plugins.DDG.maxResults:
supybot.plugins.DDG.maxResults
This config variable defaults to "4", is network-specific, and is channel-specific.
Determines the maximum number of results the bot will respond with.
.. _conf-supybot.plugins.DDG.public:
supybot.plugins.DDG.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
.. _conf-supybot.plugins.DDG.region:
supybot.plugins.DDG.region
This config variable defaults to "", is network-specific, and is channel-specific.
Set the DDG search region to return results for the language/country of your choice. E.g. 'us-en' for United States. https://duckduckgo.com/params
.. _conf-supybot.plugins.DDG.searchFilter:
supybot.plugins.DDG.searchFilter
This config variable defaults to "moderate", is network-specific, and is channel-specific.
Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering Valid strings: active, moderate, and off.
.. _conf-supybot.plugins.DDG.showSnippet:
supybot.plugins.DDG.showSnippet
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will show a snippet of each resulting link. If False, it will show the title of the link instead.