diff --git a/docs/DocBook/faq.sgml b/docs/DocBook/faq.sgml index caa6247c5..9f22f3b39 100644 --- a/docs/DocBook/faq.sgml +++ b/docs/DocBook/faq.sgml @@ -36,7 +36,7 @@ - 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 (help identify to see how that works) or add your hostmask to your user record @@ -98,7 +98,7 @@ <dunk1> ;] <jemfinch|lambda> @load Enforcer <supybot> jemfinch|lambda: The operation succeeded. - <jemfinch|lambda> @config supybot.plugins.Enforcer.autoOp.#supybot On + <jemfinch|lambda> @config channel supybot.plugins.Enforcer.autoOp On <supybot> jemfinch|lambda: The operation succeeded. <jemfinch|lambda> ok, now cycle the channel (part and then rejoin) <– dunk1 (dunker@freebsd.nl) has left #supybot @@ -130,6 +130,178 @@ + + + + Can Supybot do factoids? + + + + + Supybot most certainly can! In fact, we offer three + full-fledged factoids-related plugins! + + + Factoids (written by + jemfinch) is Supybot's original + factoids-related plugin. It offers full integration with + Supybot's nested commands as well as a complete 1:n key to + factoid ratio, with lookup by individual number. Factoids + also uses a channel-specific database instead of a global + database though that's configurable with the + supybot.databases.plugins.channelSpecific + configuration variable. + + + MoobotFactoids (written by + Strike) is much more full-featured, offering + users the ability to define factoids in a slightly more + user-friendly way, as well as parsing factoids to handle + <reply>, <action>, and alternations (defining + a factoid “test” as + “<reply>(foo|bar|baz)” will make the bot + send “foo” or “bar” or + “baz” to the channel (without the normal + “test is ” at the beginning)). If you're + accustomed to Moobot's factoids or Blootbot's factoids, + then this is the Factoids plugin for you. Unfortunately, + due to the more natural definition syntax (required to be + comaptible with Moobot) you can't define Factoids with + nested commands; you'll have to evaluate the command first + and then copy the result into your factoid definition. + + + Infobot (written by + jamessan) is used for Infobot compatibility; + if you still want the basic functionality of Infobot, this + is the plugin to use. + + + + + + + Can I import my Infobot/Blootbot/Moobot factoids into + Supybot? + + + + + As of present, we have no automated way to do so. + Strike has written a few scripts for + importing a Moobot database into MoobotFactoids, however, + so you'll want to talk to him about helping you with that. + We're certainly happy to help you convert such databases; + if you can provide us with such a database exported to a + flat file, we can probably do the rest of the work to + write a script that imports it into a database for one of + our factoids-related plugins. + + + + + + + Do I really have to use separate databases for each + channel? + + + + + Of course not! We default to separate databases for each + channel because, well, that's what jemfinch + always thought was reasonable. Anyway, if you change the + configuration variable + supybot.databases.plugins.channelSpecific + to False instead of + True, for most + databases, each channel will share the same database (the + exceptions are ChannelStats, + Herald, Seen, and + WordStats, which are inherently rather + channel-based). + + + + + + + Karma doesn't seem to work for me. + + + + + Karma 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 + Karma acknowledge karma updates, change + the + supybot.plugins.Karma.response + configuration variable to On. + + + + + + + I added an alias, but it doesn't work! + + + + + Take a look at help <alias you + added>. 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: + + + alias add mylink "format concat http://myhost.com/ + [urlquote $1]" + + + and not: + + + alias add mylink format concat http://myhost.com/ + [urlquote $1] + + + The first version works; the second version will always + return the same url. + + + + + + + Is there a command that can tell me what capability + another command requires? + + + + + 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. + + + 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? + + + @@ -138,86 +310,8 @@ - You'll need to use the Relay plugin. As - long as you don't call the relay - join 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 relay - start command, followed by the - relay connect 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. - - - - - - - Can Supybot do factoids? - - - - - Supybot most certainly can! In fact, we offer two - full-fledged factoids-related plugins! - - - Factoids (written by - jemfinch) is Supybot's original - factoids-related plugin. It offers full integration with - Supybot's nested commands as well as a complete 1:n key to - factoid ratio, with lookup by individual number. - Factoids also uses a channel-specific - database instead of a global database, although in the - future it will likely be a configuration option whether to - use channel-specific or global databases for such plugins. - - - MoobotFactoids (written by - Strike) is much more full-featured, offering - users the ability to define factoids in a slightly more - user-friendly way, as well as parsing factoids to handle - <reply>, <action>, "see", and alternations - (defining a factoid "test" as "<reply>(foo|bar|baz)" - will make the bot send "foo" or "bar" or "baz" to the - channel (without the normal "test is " at the beginning)). - If you're accustomed to Moobot's factoids or Blootbot's - factoids, then this is the Factoids plugin for you. - Unfortunately, due to the more natural definition syntax - (required to be compatible with Moobot) you can't define - Factoids with nested commands; you'll have to evaluate the - command first and then copy the result into your factoid - definition. MoobotFactoids uses a global - database, so the factoids are the same for all channels. - - - In the future, we plan to have a compatibility plugin for - Infobot, but as of present we've not yet written one. - - - - - - - Can I import my Infobot/Blootbot/Moobot factoids into - Supybot? - - - - - As of present, we have no automated way to do so. - Strike has written a few scripts for - importing a Moobot database into - MoobotFactoids, however, so you'll want - to talk to him about helping you with that. We're - certainly happy to help you convert such databases; if you - can provide us with such a database exported to a flat - file, we can probably do the rest of the work to write a - script that imports it into a database for one of our - factoids-related plugins. + Just use the connect command in + the Owner plugin. Easy as pie! @@ -254,27 +348,8 @@ log entry). We'd also like to see the commands that caused the bug, or happened around the time you saw 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 - information in a bug report than too little. - - - - - - - Karma doesn't seem to work for me. - - - - - Karma 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 - Karma acknowledge karma updates, change - the - supybot.plugins.Karma.response - configuration variable to On. + database. Remember, it's always worse to send us too + little information in a bug report than too much. diff --git a/docs/FAQ b/docs/FAQ index 6641a1ebf..2a476f301 100644 --- a/docs/FAQ +++ b/docs/FAQ @@ -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, offering users the ability to define factoids in a slightly more user-friendly way, as well as parsing factoids to handle , - , "see", and altnerations (defining a factoid "test" as + , and alternations (defining a factoid "test" as "(foo|bar|baz)" will make the bot send "foo" or "bar" or "baz" to the channel (without the normal "test is " at the 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 to be compatible with Moobot) you can't define Factoids with nested commands; you'll have to evaluate the command first and then copy - the result into your factoid definition. MoobotFactoids uses a - global database, so the factoids are the same for all channels. + the result into your factoid definition. Infobot (written by jamessan) is used for Infobot compatibility; if you still want the basic functionality of Infobot, this is the