=====
 RSS 
=====
| 

about
-----
| 

:author:  Bart Thate <bthate@gmail.com>
:contact: IRCNET/#dunkbots
:website: http://plugins.gozerbot.org
:license: Public Domain
 
| 

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

manage rss feeds

| 

 the rss mantra is of the following:
 
 as OPER:
 
 . add a url with rss-add
 . start the watcher with rss-watch
 
 now the user can start the bot sending messages of the feed to him with
 rss-start. if an OPER gives a rss-start command in a channel data will be
 send to the channel.
  

| 

commands
--------
| 


1) rss-add

    rss-add <name> <url> to the rsswatcher

    ::

        <user> !rss-add gozerbot http://gozerbot.org/hg/gozerbot/?cmd=changelog;style=rss
        <output> rss item added

3) rss-watch

    rss-watch <name> [seconds to sleep] .. go watching <name>

    ::

        <user> !rss-watch gozerbot
        <output> watcher started

    ::

        <user> !rss-watch gozerbot 600
        <output> already watching gozerbot

3) rss-start

    rss-start <name> .. start a rss feed (per user/channel) 

    ::

        <user> !rss-start gozerbot
        <output> gozerbot started

3) rss-addchannel

    rss-addchannel <name> [<botname>] <channel> ..add <channel> or <botname> <channel> to watchchannels of <name>

    ::

        <user> !rss-addchannel gozerbot #dunkbots
        <output> #dunkbots added to gozerbot rss item

    ::

        <user> !rss-addchannel gozerbot main #dunkbots
        <output> #dunkbots added to gozerbot rss item

3) rss-additem

    add a token to the itemslist (per user/channel)

    ::

        <user> !rss-additem gozerbot link
        <output> link added to (gozerbot,#test) itemslist

3) rss-addmarkup

    add a markup option to the markuplist (per user/channel)

    ::

        <user> !rss-addmarkup gozerbot noseperator 1
        <output> noseperator added to (gozerbot,#test) markuplist

3) rss-all

    give titles of a feed

    ::

        <user> !rss-all gozerbot
        <output> branch merge .. plugin docs step 5 .. check for ignore
        <output>  in infoitem callback .. plugin docs step 4 .. plugin
        <output>  docs step 3 .. plugin docs step 2 .. plugin docs step
        <output>  1 .. cleanup basic plugins .. up version .. branch
        <output>  merge

7) rss-channels

    rss-channels <name> .. show channels

    ::

        <user> !rss-channels gozerbot
        <output> ('test', '#test') .. ('test', '#dunkbots') .. ('main',
        <output>  '#dunkbots')

4) rss-del

    rss-del <name> .. remove <name> from the rsswatcher

    ::

        <user> !rss-del mekker
        <output> there is no mekker rss item

3) rss-delchannel

    rss-delchannel <name> [<botname>] [<channel>] .. delete <channel> or <botname> <channel> from watchchannels of <name>

    ::

        <user> !rss-delchannel gozerbot #dunkbots
        <output> #dunkbots removed from gozerbot rss item

    ::

        <user> !rss-delchannel gozerbot main #dunkbots
        <output> #dunkbots removed from gozerbot rss item

3) rss-delitem

    remove a token from the itemslist (per user/channel)

    ::

        <user> !rss-delitem gozerbot link
        <output> link removed from (gozerbot,#test) itemslist

3) rss-delmarkup

    remove a markup option from the markuplist (per user/channel)

    ::

        <user> !rss-delmarkup gozerbot noseperator
        <output> noseperator removed from (gozerbot,#test) markuplist

3) rss-description

    give description of item which title matches search key

    ::

        <user> !rss-description gozerbot gozer
        <output> none

4) rss-feeds

    rss-feeds <name> .. show what feeds are running in a channel

    ::

        <user> !rss-feeds
        <output> gozerbot

    ::

        <user> !rss-feeds #dunkbots
        <output> #dunkbots has no feeds running

3) rss-get

    rss-get <name> .. get data from <name>

    ::

        <user> !rss-get gozerbot
        <output> results of gozerbot: branch merge || plugin docs step
        <output>  5 || check for ignore in infoitem callback || plugin
        <output>  docs step 4 || plugin docs step 3 || plugin docs step
        <output>  2 || plugin docs step 1 || cleanup basic plugins ||
        <output>  up version || branch merge

7) rss-itemslist

    rss-itemslist <name> .. get itemslist of <name> 

    ::

        <user> !rss-itemslist gozerbot
        <output> title

3) rss-link

    give link of item which title matches search key

    ::

        <user> !rss-link gozerbot gozer
        <output> none

4) rss-list

    get list of rss items

    ::

        <user> !rss-list
        <output> dev .. gozerbot

3) rss-markup

    show markup list for a feed (per user/channel)

    ::

        <user> !rss-markup gozerbot
        <output> {}

3) rss-running

    rss-running .. get running rsswatchers

    ::

        <user> !rss-running
        <output> gozerbot [('test', '#test')]

3) rss-scan

    rss-scan <name> .. get possible items of <name> 

    ::

        <user> !rss-scan gozerbot
        <output> summary_detail=10 .. updated_parsed=10 .. links=10
        <output>  .. author=10 .. title=10 .. updated=10 .. summary=10
        <output>  .. title_detail=10 .. link=10 .. author_detail=10

5) rss-search

    search titles of all current feeds

    ::

        <user> !rss-search goz
        <output> none

6) rss-setsleeptime

    rss-setsleeptime <name> <seconds> .. set sleeping time for <name> .. min 60 sec

    ::

        <user> !rss-setsleeptime gozerbot 600
        <output> sleeptime set

3) rss-sleeptime

    rss-sleeptime <name> .. get sleeping time for <name>

    ::

        <user> !rss-sleeptime gozerbot
        <output> sleeptime for gozerbot is 600 seconds

3) rss-stop

    rss-stop <name> .. stop a rss feed (per user/channel) 

    ::

        <user> !rss-stop gozerbot
        <output> gozerbot stopped

3) rss-stopwatch

    rss-stopwatch <name> .. stop polling <name>

    ::

        <user> !rss-stopwatch gozerbot
        <output> stopped gozerbot rss watch

3) rss-sync

    rss-sync <name> .. sync data of <name>

    ::

        <user> !rss-sync gozerbot
        <output> gozerbot synced

3) rss-url

    rss-url <name> .. get url from rssitem with <name>

    ::

        <user> !rss-url gozerbot
        <output> url of gozerbot: http://gozerbot.org/hg/gozerbot/?cmd=changelog;style=rss
