diff --git a/develop/capabilities.rst b/develop/capabilities.rst new file mode 100644 index 0000000..755a343 --- /dev/null +++ b/develop/capabilities.rst @@ -0,0 +1,55 @@ +************ +Capabilities +************ + +.. note:: + I wrote this section with the little knowledge I have of the capabilities + system; I work mainly by testing different possibilities until I get what + I want. + As for all the documentation, feel free to contact me to + correct/enhance it. + +First, you should know how capabilities work +:ref:`on the user side `. + +Checking for a capability given its name +======================================== + +You only have to use ``ircdb.checkCapability(prefix, 'capability')``. + +You can also override some behavior of the capability system. Here is the +complete documentation of ``ircdb.checkCapabiltiy``: + +.. autofunction:: supybot.ircdb.checkCapability + :noindex: + +Manipulating capability names +============================= + +Althrough you can manipulate capability names with string operations, +Supybot provides a few methods to do that “in the abstract” (could be +useful if we change the capability syntax one day…): + +.. autofunction:: supybot.ircdb.isCapability + :noindex: + +.. autofunction:: supybot.ircdb.makeChannelCapability + :noindex: + +.. autofunction:: supybot.ircdb.isChannelCapability + :noindex: + +.. autofunction:: supybot.ircdb.makeAntiCapability + :noindex: + +.. autofunction:: supybot.ircdb.unAntiCapability + :noindex: + +.. autofunction:: supybot.ircdb.invertCapability + :noindex: + +.. autofunction:: supybot.ircdb.isAntiCapability + :noindex: + +.. autofunction:: supybot.ircdb.canonicalCapability + :noindex: diff --git a/develop/index.rst b/develop/index.rst index 99fc430..02f2788 100644 --- a/develop/index.rst +++ b/develop/index.rst @@ -23,6 +23,7 @@ Specific documentation :maxdepth: 2 using_utils.rst + capabilities.rst events.rst httpserver.rst @@ -36,3 +37,4 @@ Library reference irclib.rst commands.rst ircmsgs.rst + ircdb.rst diff --git a/use/capabilities.rst b/use/capabilities.rst index aa19e7d..a720c37 100644 --- a/use/capabilities.rst +++ b/use/capabilities.rst @@ -1,3 +1,5 @@ +.. _capabilities: + ************ Capabilities ************