.. _plugin:confluence:

==========
CONFLUENCE
==========
| 

about
-----
| 

:author:  FeedBackLoop <feedbackloop@gmail.com>
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

description
-----------
| 


confluence.py - fbfbot module for performing lookups on a confluence server
Copyright 2011, Richard Bateman

Special thanks to Sean B. Palmer for his phenny module; many of the ideas for
this were adapted from that plugin

http://inamidst.com/phenny/

BHJTW: adapted for FBFBOT on 15-09-2012





| 

commands
--------
| 


    :commands in this plugin: confluence-delserver .. confluence-addserver .. confluence-wiki .. confluence-enableserver .. confluence-disable

| 

1) *confluence-addserver .. [handle_add_confluence_server]*

    :description:  configure a new confluence server; syntax: add_confluence_server [server name] [url] [username] [password] 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.confluence_confluence-addserver_command`.

    :examples:

    ::

        <user> ;confluence-addserver FireBreath http://confluence.firebreath.org myuser mypassword
        <output> Added confluence server FireBreath


2) *confluence-delserver .. [handle_del_confluence_server]*

    :description:  remove a confluence server; syntax: del_confluence_server 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.confluence_confluence-delserver_command`.

    :examples:

    ::

        <user> ;confluence-delserver FireBreath http://confluence.firebreath.org myuser mypassword
        <output> syntax: del_confluence_server [server name]


3) *confluence-disable .. [handle_confluence_disable]*

    :description:  disable lookups for confluence in the current channel; syntax: confluence_disable 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.confluence_confluence-disable_command`.

    :examples:

    ::

        <user> ;confluence-disable
        <output> Confluence search was not enabled on this channel


4) *confluence-enableserver .. [handle_confluence_enable_server]*

    :description:  choose the confluence server for lookups in the current channel; syntax: handle_confluence_enable_server [server] 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.confluence_confluence-enableserver_command`.

    :examples:

    ::

        <user> ;confluence-enableserver confluenceserver
        <output> Unknown server confluenceserver


5) *confluence-wiki .. [handle_confluence_search]*

    :description: []

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.confluence_confluence-wiki_command`.

    :examples:

    ::

        <user> ;confluence-wiki #5 some search text
        <output> Confluence wiki search not enabled for this channel