.. _plugin:hubbub: ====== HUBBUB ====== | about ----- | :author: FeedBackLoop :contact: FREENODE/#fbf :distribution: core :license: | description ----------- | the hubbub mantra is of the following: use the hb-register command to register url and start a feed in in one pass. | commands -------- | :commands in this plugin: hb-delitem .. hb-delchannel .. hb-watch .. hb-list .. hb-markup .. hb-stopall .. hb-register .. hb-addchannel .. hb-start .. hb-feeds .. hb-running .. hb-stop .. hb-markuplist .. hb-stopwatch .. hb-url .. hb-channels .. hb-add .. hb-get .. hb-additem .. hb-itemslist .. hb-subscribe .. hb-delmarkup .. hb-scan .. hb-addmarkup .. hb-setitems | 1) *hb-add .. [handle_hubbubadd]* :description: arguments: - add a hubbub item (name/url combo). :permissions: USER :code: :ref:`fbf.plugs.extra.hubbub_hb-add_command`. :examples: :: ;hb-add fbf https://github.com/feedbackflow/fbfbot/commits/master.atom credentials.py is needed in docs/docrun/config dir. see docs/docrun/examples 2) *hb-addchannel .. [handle_hubbubaddchannel]* :description: arguments: [] [] - add a channel to hubbub feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.hubbub_hb-addchannel_command`. :examples: :: ;hb-addchannel gozerbot #dunkbots we don't have a gozerbot hubbub object :: ;hb-addchannel gozerbot main #dunkbots we don't have a gozerbot hubbub object 3) *hb-additem .. [handle_hubbubadditem]* :description: arguments: - add an item (token) to a feeds itemslist, this list is used to determine what to display. :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-additem_command`. :examples: :: ;hb-additem gozerbot link we don't have a gozerbot feed 4) *hb-addmarkup .. [handle_hubbubaddmarkup]* :description: arguments: - add a markup to a feeds markuplist, this list determines how we display things. :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-addmarkup_command`. :examples: :: ;hb-addmarkup gozerbot all-lines 1 we don't have a gozerbot feed 5) *hb-channels .. [handle_hubbubchannels]* :description: arguments: - show channels of hubbub feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.hubbub_hb-channels_command`. :examples: :: ;hb-channels gozerbot we don't have a gozerbot hubbub object 6) *hb-delchannel .. [handle_hubbubdelchannel]* :description: arguments: [] [] [] - delete channel from hubbub feed. 7) *hb-delitem .. [handle_hubbubdelitem]* :description: arguments: - delete item (token) from a feeds itemlist. :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-delitem_command`. :examples: :: ;hb-delitem gozerbot link we don't have a gozerbot feed 8) *hb-delmarkup .. [handle_hubbubdelmarkup]* :description: arguments: - delete markup item from a feed's markuplist. :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-delmarkup_command`. :examples: :: ;hb-delmarkup gozerbot all-lines we don't have a gozerbot feed 9) *hb-feeds .. [handle_hubbubfeeds]* :description: arguments: [] - show what feeds are running in a channel. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.extra.hubbub_hb-feeds_command`. :examples: :: ;hb-feeds no feeds running :: ;hb-feeds #dunkbots no feeds running 10) *hb-get .. [handle_hubbubget]* :description: arguments: - fetch feed data. :permissions: HUBBUB .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-get_command`. :examples: :: ;hb-get gozerbot we don't have a gozerbot item 11) *hb-itemslist .. [handle_hubbubitemslist]* :description: arguments: - show itemslist (tokens) of hubbub item. :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-itemslist_command`. :examples: :: ;hb-itemslist gozerbot we don't have a gozerbot feed 12) *hb-list .. [handle_hubbublist]* :description: no arguments - return list of available feeds. :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-list_command`. :examples: :: ;hb-list no hubbub items yet 13) *hb-markup .. [handle_hubbubmarkup]* :description: arguments: - show the markup of a feed (channel specific). :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-markup_command`. :examples: :: ;hb-markup gozerbot we don't have a gozerbot feed 14) *hb-markuplist .. [handle_hubbubmarkuplist]* :description: no arguments - show possible markups that can be used. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.extra.hubbub_hb-markuplist_command`. :examples: :: ;hb-markuplist possible markups ==> all-lines: set this to 1 if you don't want items to be aggregated, reverse-order: set this to 1 if you want the items displayed with oldest item first, separator: set this to desired item separator, skipmerge: set this to 1 if you want to skip merge commits, tinyurl: set this to 1 when you want to use tinyurls 15) *hb-register .. [handle_hubbubregister]* :description: arguments: - register a url and start the feed in one pass. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.extra.hubbub_hb-register_command`. 16) *hb-running .. [handle_hubbubrunning]* :description: no arguments - show which feeds are running. :permissions: HUBBUB .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-running_command`. :examples: :: ;hb-running nothing running yet 17) *hb-scan .. [handle_hubbubscan]* :description: arguments: - scan feed for available tokens. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.extra.hubbub_hb-scan_command`. :examples: :: ;hb-scan gozerbot no gozerbot feeds available 18) *hb-setitems .. [handle_hubbubsetitems]* :description: arguments: - set items (tokens) of a feed, see hb-scan for a list of possible tokens. :permissions: GUEST .. USER :code: :ref:`fbf.plugs.extra.hubbub_hb-setitems_command`. :examples: :: ;hb-setitems gozerbot author author link pubDate we don't have a gozerbot feed 19) *hb-start .. [handle_hubbubstart]* :description: arguments: - start sending feeds to an user or channel. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.extra.hubbub_hb-start_command`. :examples: :: ;hb-start gozerbot sorry can't start: gozerbot 20) *hb-stop .. [handle_hubbubstop]* :description: arguments: - stop a hubbub feed to a user or channel. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.extra.hubbub_hb-stop_command`. :examples: :: ;hb-stop gozerbot failed to stop ['gozerbot'] feed done - hb-stop 21) *hb-stopall .. [handle_hubbubstopall]* :description: no arguments - stop all hubbub feeds to a channel. :permissions: HUBBUB .. OPER :code: :ref:`fbf.plugs.extra.hubbub_hb-stopall_command`. :examples: :: ;hb-stopall no feeds running in #test 22) *hb-stopwatch .. [handle_hubbubstopwatch]* :description: arguments: - stop watching a feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.hubbub_hb-stopwatch_command`. :examples: :: ;hb-stopwatch gozerbot there is no gozerbot item 23) *hb-subscribe .. [handle_hubbubsubscribe]* :description: arguments: [] - subscribe to a hubbub feed, provide a url if the feed is not yet registered. :permissions: USER :code: :ref:`fbf.plugs.extra.hubbub_hb-subscribe_command`. :examples: :: ;hb-subscribe fbf https://github.com/feedbackflow/fbfbot/commits/master.atom fbf feed is not yet added .. see hb-add https://github.com/feedbackflow/fbfbot/commits/master.atom feed is not yet added .. see hb-add 24) *hb-url .. [handle_hubbuburl]* :description: arguments: - return url of feed. :permissions: OPER :code: :ref:`fbf.plugs.extra.hubbub_hb-url_command`. :examples: :: ;hb-url gozerbot you are not the owner of the gozerbot feed 25) *hb-watch .. [handle_hubbubwatch]* :description: arguments: - enable a feed for watching (per channel). :permissions: USER :code: :ref:`fbf.plugs.extra.hubbub_hb-watch_command`. :examples: :: ;hb-watch gozerbot we don't have a gozerbot hubbub item