.. _plugin:ask:

===
ASK
===
| 

about
-----
| 

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

| 

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

 ask a user a question and relay back the response. 



| 

commands
--------
| 


    :commands in this plugin: ask-part .. ask .. ask-stop .. ask-experts .. ask-join .. ask-subjects .. ask-list

| 

1) *ask .. [handle_ask]*

    :description:  
        arguments: <subject> <question> - this command lets you ask a question that gets dispatched to jabber 
        users that have registered themselves for that particular subject. 

    

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.ask_ask_command`.

    :examples:

    ::

        <user> ;ask ask-bot what is the mercurial repository
        <output> can't find jabber bot in fleet


2) *ask-experts .. [handle_askexperts]*

    :description:  arguments: <subject> - show all the experts on a subject. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.ask_ask-experts_command`.

    :examples:

    ::

        <user> ;ask-experts ask-bot
        <output> we dont know any experts on this subject yet


3) *ask-join .. [handle_askjoin]*

    :description:  arguments: <subject> - join the expert list of a subject. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.ask_ask-join_command`.

    :examples:

    ::

        <user> ;ask-join ask-bot
        <output> this command only works in jabber


4) *ask-list .. [handle_asklist]*

    :description:  show all available subjects. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.ask_ask-list_command`.

    :examples:

    ::

        <user> ;ask-list
        <output> available subjects:


5) *ask-part .. [handle_askpart]*

    :description:  arguments: <subject> - leave the expert list of a subject. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.ask_ask-part_command`.

    :examples:

    ::

        <user> ;ask-part ask-bot
        <output> this command only works in jabber


6) *ask-stop .. [handle_askstop]*

    :description:  no arguments - remove any waiting data for the user giving the command. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.ask_ask-stop_command`.

    :examples:

    ::

        <user> ;ask-stop
        <output> no question running


7) *ask-subjects .. [handle_asksubjects]*

    :description:  arguments: <JID> - show all the subjects an expert handles. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.ask_ask-subjects_command`.

    :examples:

    ::

        <user> ;ask-subjects feedbackloop@gmail.com
        <output> feedbackloop@gmail.com doesnt handle any subjects