Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-25 04:02:46 +01:00
Code Issues Projects Releases Wiki Activity

Fixed some stuff in the FAQ and updated the DocBook version

Browse Source
This commit is contained in:
Daniel DiPaolo 2004-09-05 05:31:33 +00:00
parent 1f6f86aea7
commit e271ea6a47
2 changed files with 180 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

223
docs/DocBook/faq.sgml
View File

@ -36,7 +36,7 @@
</question> </question>
<answer> <answer>
<para> <para>
Because you're not given it anything to recognize you Because you've not given it anything to recognize you
from! You'll need to identify with the bot from! You'll need to identify with the bot
(<botcommand>help identify</botcommand> to see how that (<botcommand>help identify</botcommand> to see how that
works) or add your hostmask to your user record works) or add your hostmask to your user record
@ -98,7 +98,7 @@
&lt;dunk1&gt; ;] &lt;dunk1&gt; ;]
&lt;jemfinch|lambda&gt; @load Enforcer &lt;jemfinch|lambda&gt; @load Enforcer
&lt;supybot&gt; jemfinch|lambda: The operation succeeded. &lt;supybot&gt; jemfinch|lambda: The operation succeeded.
&lt;jemfinch|lambda&gt; @config supybot.plugins.Enforcer.autoOp.#supybot On &lt;jemfinch|lambda&gt; @config channel supybot.plugins.Enforcer.autoOp On
&lt;supybot&gt; jemfinch|lambda: The operation succeeded. &lt;supybot&gt; jemfinch|lambda: The operation succeeded.
&lt;jemfinch|lambda&gt; ok, now cycle the channel (part and then rejoin) &lt;jemfinch|lambda&gt; ok, now cycle the channel (part and then rejoin)
&lt;&ndash; dunk1 (dunker@freebsd.nl) has left #supybot &lt;&ndash; dunk1 (dunker@freebsd.nl) has left #supybot
@ -130,29 +130,6 @@
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>
<qandaentry>
<question>
<para>
How do I make my Supybot connect to multiple servers?
</para>
</question>
<answer>
<para>
You'll need to use the <plugin>Relay</plugin> plugin. As
long as you don't call the <botcommand>relay
join</botcommand> command, it won't actually do any
relaying between channels (even if the bot is on the same
channel on different networks). In order to use the Relay
plugin, you'll want to first call the <botcommand>relay
start</botcommand> command, followed by the
<botcommand>relay connect</botcommand> command. These
commands are (unfortunately) not persistent at this time,
so you'll need to give them to the bot anytime you start
it up. We'll probably have this lack of persistence
rectified before the next release.
</para>
</answer>
</qandaentry>
<qandaentry> <qandaentry>
<question> <question>
<para> <para>
@ -161,7 +138,7 @@
</question> </question>
<answer> <answer>
<para> <para>
Supybot most certainly can! In fact, we offer two Supybot most certainly can! In fact, we offer three
full-fledged factoids-related plugins! full-fledged factoids-related plugins!
</para> </para>
<para> <para>
@ -169,33 +146,35 @@
<nick>jemfinch</nick>) is Supybot's original <nick>jemfinch</nick>) is Supybot's original
factoids-related plugin. It offers full integration with factoids-related plugin. It offers full integration with
Supybot's nested commands as well as a complete 1:n key to Supybot's nested commands as well as a complete 1:n key to
factoid ratio, with lookup by individual number. factoid ratio, with lookup by individual number. Factoids
<plugin>Factoids</plugin> also uses a channel-specific also uses a channel-specific database instead of a global
database instead of a global database, although in the database though that's configurable with the
future it will likely be a configuration option whether to <registrygroup>supybot.databases.plugins.channelSpecific</registrygroup>
use channel-specific or global databases for such plugins. configuration variable.
</para> </para>
<para> <para>
<plugin>MoobotFactoids</plugin> (written by <plugin>MoobotFactoids</plugin> (written by
<nick>Strike</nick>) is much more full-featured, offering <nick>Strike</nick>) is much more full-featured, offering
users the ability to define factoids in a slightly more users the ability to define factoids in a slightly more
user-friendly way, as well as parsing factoids to handle user-friendly way, as well as parsing factoids to handle
&lt;reply&gt;, &lt;action&gt;, "see", and alternations &lt;reply&gt;, &lt;action&gt;, and alternations (defining
(defining a factoid "test" as "&lt;reply&gt;(foo|bar|baz)" a factoid &ldquo;test&rdquo; as
will make the bot send "foo" or "bar" or "baz" to the &ldquo;&lt;reply&gt;(foo|bar|baz)&rdquo; will make the bot
channel (without the normal "test is " at the beginning)). send &ldquo;foo&rdquo; or &ldquo;bar&rdquo; or
If you're accustomed to Moobot's factoids or Blootbot's &ldquo;baz&rdquo; to the channel (without the normal
factoids, then this is the Factoids plugin for you. &ldquo;test is &rdquo; at the beginning)). If you're
Unfortunately, due to the more natural definition syntax accustomed to Moobot's factoids or Blootbot's factoids,
(required to be compatible with Moobot) you can't define then this is the Factoids plugin for you. Unfortunately,
Factoids with nested commands; you'll have to evaluate the due to the more natural definition syntax (required to be
command first and then copy the result into your factoid comaptible with Moobot) you can't define Factoids with
definition. <plugin>MoobotFactoids</plugin> uses a global nested commands; you'll have to evaluate the command first
database, so the factoids are the same for all channels. and then copy the result into your factoid definition.
</para> </para>
<para> <para>
In the future, we plan to have a compatibility plugin for <plugin>Infobot</plugin> (written by
Infobot, but as of present we've not yet written one. <nick>jamessan</nick>) is used for Infobot compatibility;
if you still want the basic functionality of Infobot, this
is the plugin to use.
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -210,14 +189,129 @@
<para> <para>
As of present, we have no automated way to do so. As of present, we have no automated way to do so.
<nick>Strike</nick> has written a few scripts for <nick>Strike</nick> has written a few scripts for
importing a Moobot database into importing a Moobot database into MoobotFactoids, however,
<plugin>MoobotFactoids</plugin>, however, so you'll want so you'll want to talk to him about helping you with that.
to talk to him about helping you with that. We're We're certainly happy to help you convert such databases;
certainly happy to help you convert such databases; if you if you can provide us with such a database exported to a
can provide us with such a database exported to a flat flat file, we can probably do the rest of the work to
file, we can probably do the rest of the work to write a write a script that imports it into a database for one of
script that imports it into a database for one of our our factoids-related plugins.
factoids-related plugins. </para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Do I really have to use separate databases for each
channel?
</para>
</question>
<answer>
<para>
Of course not! We default to separate databases for each
channel because, well, that's what <nick>jemfinch</nick>
always thought was reasonable. Anyway, if you change the
configuration variable
<registrygroup>supybot.databases.plugins.channelSpecific</registrygroup>
to <literal>False</literal> instead of
<literal>True</literal>, for <emphasis>most</emphasis>
databases, each channel will share the same database (the
exceptions are <plugin>ChannelStats</plugin>,
<plugin>Herald</plugin>, <plugin>Seen</plugin>, and
<plugin>WordStats</plugin>, which are inherently rather
channel-based).
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Karma doesn't seem to work for me.
</para>
</question>
<answer>
<para>
<plugin>Karma</plugin> by default doesn't acknowledge
karma updates. If you check the karma of whatever you
increased/decreased, you'll note that your increment or
decrement still took place. If you'd rather
<plugin>Karma</plugin> acknowledge karma updates, change
the
<registrygroup>supybot.plugins.Karma.response</registrygroup>
configuration variable to <literal>On</literal>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
I added an alias, but it doesn't work!
</para>
</question>
<answer>
<para>
Take a look at <botcommand>help &lt;alias you
added&gt;</botcommand>. If the alias the bot has listed
doesn't match what you're giving it, chances re you need
to quote your alias in order for the brackets not to be
evaluated. For instance, if you're adding an alias to
give you a link to your homepage, you need to say:
<para>
<ircsession>
alias add mylink "format concat http://myhost.com/
[urlquote $1]"
</ircsession>
<para>
and not:
</para>
<ircsession>
alias add mylink format concat http://myhost.com/
[urlquote $1]
</ircsession>
<para>
The first version works; the second version will always
return the same url.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Is there a command that can tell me what capability
another command requires?
</para>
</question>
<answer>
<para>
No, there isn't, and there probably never will be.
Commands have the flexibility to check any capabilities
they wish to check; while this flexibility is useful, it
also makes it hard to guess what capability a certain
command requires. We could make a solution that would
work in a large majority of cases, but it wouldn't (and
couldn't!) be absolutely correct in all circumstances, and
since we're anal and we hate doing things halfway, we
probably won't ever add this partial solution.
</para>
<para>
Besides, is the error message so bad? If we did have such
a command, many users would call the command, see that
they could perform it, and then run the command, thus
doubling the activity in the channel. Is that something
you want?
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
How do I make my Supybot connect to multiple servers?
</para>
</question>
<answer>
<para>
Just use the <botcommand>connect</botcommand> command in
the <plugin>Owner</plugin> plugin. Easy as pie!
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -254,27 +348,8 @@
log entry). We'd also like to see the commands that log entry). We'd also like to see the commands that
caused the bug, or happened around the time you saw the caused the bug, or happened around the time you saw the
bug. If the bug involved a database, we'd love to see the bug. If the bug involved a database, we'd love to see the
database. Remember, it's always worse to send us too much database. Remember, it's always worse to send us too
information in a bug report than too little. little information in a bug report than too much.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Karma doesn't seem to work for me.
</para>
</question>
<answer>
<para>
<plugin>Karma</plugin> by default doesn't acknowledge
karma updates. If you check the karma of whatever you
increased/decreased, you'll note that your increment or
decrement still took place. If you'd rather
<plugin>Karma</plugin> acknowledge karma updates, change
the
<registrygroup>supybot.plugins.Karma.response</registrygroup>
configuration variable to <literal>On</literal>.
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>

5
docs/FAQ
View File

@ -78,7 +78,7 @@ A: Supybot most certainly can! In fact, we offer three full-fledged
MoobotFactoids (written by Strike) is much more full-featured, MoobotFactoids (written by Strike) is much more full-featured,
offering users the ability to define factoids in a slightly more offering users the ability to define factoids in a slightly more
user-friendly way, as well as parsing factoids to handle <reply>, user-friendly way, as well as parsing factoids to handle <reply>,
<action>, "see", and altnerations (defining a factoid "test" as <action>, and alternations (defining a factoid "test" as
"<reply>(foo|bar|baz)" will make the bot send "foo" or "bar" or "<reply>(foo|bar|baz)" will make the bot send "foo" or "bar" or
"baz" to the channel (without the normal "test is " at the "baz" to the channel (without the normal "test is " at the
beginning)). If you're accustomed to Moobot's factoids or beginning)). If you're accustomed to Moobot's factoids or
@ -86,8 +86,7 @@ A: Supybot most certainly can! In fact, we offer three full-fledged
Unfortunately, due to the more natural definition syntax (required Unfortunately, due to the more natural definition syntax (required
to be compatible with Moobot) you can't define Factoids with nested to be compatible with Moobot) you can't define Factoids with nested
commands; you'll have to evaluate the command first and then copy commands; you'll have to evaluate the command first and then copy
the result into your factoid definition. MoobotFactoids uses a the result into your factoid definition.
global database, so the factoids are the same for all channels.
Infobot (written by jamessan) is used for Infobot compatibility; Infobot (written by jamessan) is used for Infobot compatibility;
if you still want the basic functionality of Infobot, this is the if you still want the basic functionality of Infobot, this is the