Changeset 189

Show
Ignore:
Timestamp:
02/27/06 08:23:14
Author:
miyagawa
Message:

Added docs to some plugins

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/plagger/lib/Plagger/Plugin/Aggregator/Simple.pm

    r177 r189  
    9191 
    92921; 
     93 
     94__END__ 
     95 
     96=head1 NAME 
     97 
     98Plagger::Plugin::Aggregator::Simple - Dumb simple aggregator 
     99 
     100=head1 SYNOPSIS 
     101 
     102  - module: Aggregator::Simple 
     103 
     104=head1 DESCRIPTION 
     105 
     106This plugin implements a Plagger dumb aggregator. It crawls 
     107subscription sequentially and parses XML feeds using L<XML::Feed> 
     108module. 
     109 
     110It can be also used as a base class for custom aggregators. See 
     111L<Plagger::Plugin::Aggregator::Xango> for example. 
     112 
     113=head1 AUTHOR 
     114 
     115Tatsuhiko Miyagawa 
     116 
     117=head1 SEE ALSO 
     118 
     119L<Plagger>, L<XML::Feed>, L<XML::RSS::LibXML> 
     120 
     121=cut 
  • trunk/plagger/lib/Plagger/Plugin/CustomFeed/Frepa.pm

    r143 r189  
    238238 
    2392391; 
     240 
    240241__END__ 
    241 config example. 
     242 
     243=head1 NAME 
     244 
     245Plagger::Plugin::CustomFeed::Frepa - Custom feed for livedoor Frepa 
     246 
     247=head1 SYNOPSIS 
    242248 
    243249  - module: CustomFeed::Frepa 
    244250    config: 
    245       livedoor_id: id 
    246       password: pass 
     251      livedoor_id: your-id 
     252      password: password 
    247253      fetch_body: 1 
     254      show_icon: 1 
     255 
     256=head1 DESCRIPTION 
     257 
     258This plugin fetches your friend blog updates from livedoor Frepa 
     259(L<http://frepa.livedoor.com/>) and creates a custom feed. 
     260 
     261=head1 CONFIGURATION 
     262 
     263See L<Plagger::Plugin::CustomFeed::Mixi> for C<fetch_body>, 
     264C<fetch_body_interval> and C<show_icon>. 
     265 
     266=head1 AUTHOR 
     267 
     268Kazuhiro Osawa 
     269 
     270=head1 SEE ALSO 
     271 
     272L<Plagger>, L<Plagger::Plugin::CustomFeed::Mixi>, L<WWW::Mechanize>, 
     273L<http://frepa.livedoor.com/> 
     274 
     275=cut 
  • trunk/plagger/lib/Plagger/Plugin/CustomFeed/Mailman.pm

    r124 r189  
    1011011; 
    102102 
     103__END__ 
     104 
     105=head1 NAME 
     106 
     107Plagger::Plugin::CustomFeed::Mailman - Custom feed for Mailman pipermail 
     108 
     109=head1 SYNOPSIS 
     110 
     111  - module: CustomFeed::Mailman 
     112    config: 
     113      url: http://lists.rawmode.org/pipermail/catalyst/ 
     114 
     115=head1 DESCRIPTION 
     116 
     117B<Note: Plagger has a bug that you'll have duplicated entries when you 
     118have multiple installations of identical CustomFeed. It will be fixed 
     119and this plugin's config interface may be changed altogether> 
     120 
     121This plugin creates a custom feed off of Mailman's pipermail URL. 
     122 
     123=head1 AUTHOR 
     124 
     125Tatsuhiko Miyagawa 
     126 
     127=head1 SEE ALSO 
     128 
     129L<Plagger> 
     130 
     131=cut 
  • trunk/plagger/lib/Plagger/Plugin/CustomFeed/Mixi.pm

    r132 r189  
    1041041; 
    105105 
     106__END__ 
     107 
     108=head1 NAME 
     109 
     110Plagger::Plugin::CustomFeed::Mixi -  Custom feed for mixi.jp 
     111 
     112=head1 SYNOPSIS 
     113 
     114    - module: CustomFeed::Mixi 
     115      config: 
     116        email: email@example.com 
     117        password: password 
     118        fetch_body: 1 
     119        show_icon: 1 
     120 
     121=head1 DESCRIPTION 
     122 
     123This plugin fetches your friends diary updates from mixi 
     124(L<http://mixi.jp/>) and creates a custom feed. 
     125 
     126=head CONFIGURATION 
     127 
     128=over 4 
     129 
     130=item email, password 
     131 
     132Credential you need to login to mixi.jp. 
     133 
     134=item fetch_body 
     135 
     136With this option set, this plugin fetches entry body HTML, not just a 
     137link to the entry. Defaults to 0. 
     138 
     139=item fetch_body_interval 
     140 
     141With C<fetch_body> option set, your Plagger script is recommended to 
     142wait for a little, to avoid mixi.jp throttling. Defaults to 1.5. 
     143 
     144=item show_icon: 1 
     145 
     146With this option set, this plugin fetches users buddy icon from 
     147mixi.jp site, which makes the output HTML very user-friendly. 
     148 
     149=back 
     150 
     151=head1 SCREENSHOT 
     152 
     153L<http://blog.bulknews.net/mt/archives/plagger-mixi-icon.gif> 
     154 
     155=head1 AUTHOR 
     156 
     157Tatsuhiko Miyagawa 
     158 
     159=head1 SEE ALSO 
     160 
     161L<Plagger>, L<WWW::Mixi> 
     162 
     163=cut 
  • trunk/plagger/lib/Plagger/Plugin/Filter/Delicious.pm

    r97 r189  
    22use strict; 
    33use base qw( Plagger::Plugin ); 
    4  
    5 # NOTE this module is untested and written just for a proof of 
    6 # concept. If you run this on your box with real feeds, del.icio.us 
    7 # wlil be likely to ban your IP. See http://del.icio.us/help/ for 
    8 # details. 
    94 
    105use Digest::MD5 qw(md5_hex); 
     
    4641 
    47421; 
     43 
     44__END__ 
     45 
     46=head1 NAME 
     47 
     48Plagger::Plugin::Filter::Delicious - Fetch tags and users count from del.icio.us 
     49 
     50=head1 SYNOPSIS 
     51 
     52  - module: Filter::Delicious 
     53 
     54=head1 DESCRIPTION 
     55 
     56B<Note: this module is mostly untested and written just for a proof of 
     57concept. If you run this on your box with real feeds, del.icio.us wlil 
     58be likely to ban your IP. See http://del.icio.us/help/ for details.> 
     59 
     60This plugin queries del.icio.us using its RSS feeds API to get the 
     61tags people added to the entries, and how many people bookmarked them. 
     62 
     63Users count is stored in C<delicious_users> metadata of 
     64Plagger::Entry, so that other plugins and smartfeeds can make use of. 
     65 
     66=head1 AUTHOR 
     67 
     68Tatsuhiko Miyagawa 
     69 
     70=head1 SEE ALSO 
     71 
     72L<Plagger>, L<http://del.icio.us/help/> 
     73 
     74=cut 
  • trunk/plagger/lib/Plagger/Plugin/Filter/HatenaBookmarkTag.pm

    r81 r189  
    3030    for my $entry ($feed->entries) { 
    3131        my $tag = $entry->category or next; 
    32         $tag = [ $tag ] unless ref($tag); 
     32           $tag = [ $tag ] unless ref($tag); 
    3333 
    3434        for my $t (@{$tag}) { 
     
    3939 
    40401; 
     41 
     42__END__ 
     43 
     44=head1 NAME 
     45 
     46Plagger::Plugin::Filter::HatenaBookmarkTag - Fetch tags from Hatena Bookmark 
     47 
     48=head1 SYNOPSIS 
     49 
     50  - module: Filter::HatenaBookmarkTag 
     51 
     52=head1 DESCRIPTION 
     53 
     54B<Note: this module is mostly untested and written just for a proof of 
     55concept. If you run this on your box with real feeds, Hatena might 
     56throttle your IP. See http://b.hatena.ne.jp/ for details.> 
     57 
     58This plugin queries Hatena Bookmark (L<http://b.hatena.ne.jp/>) using 
     59its RSS feeds API to get the tags people added to the entries. 
     60 
     61=head1 AUTHOR 
     62 
     63Tatsuhiko Miyagawa 
     64 
     65=head1 SEE ALSO 
     66 
     67L<Plagger>, L<Plagger::Plugin::Filter::HatenaBookmarkUsersCount>, 
     68L<http://b.hatena.ne.jp/> 
     69 
     70=cut 
  • trunk/plagger/lib/Plagger/Plugin/Filter/HatenaBookmarkUsersCount.pm

    r96 r189  
    4040 
    41411; 
     42 
     43__END__ 
     44 
     45=head1 NAME 
     46 
     47Plagger::Plugin::Filter::HatenaBookmarkUsersCount - Queries Hatena Bookmark users count 
     48 
     49=head1 SYNOPSIS 
     50 
     51  - module: Filter::HatenaBookmarkUsersCount 
     52 
     53=head1 DESCRIPTION 
     54 
     55This plugin queries Hatena Bookmark (L<http://b.hatena.ne.jp/>) how 
     56many people bookmarked each of feed entries, using its XMLRPC API 
     57C<bookmark.getCount>. 
     58 
     59Users count is stored in C<hatenabookmark_users> metadata of 
     60Plagger::Entry so that other plugins or smartfeeds can make use of. 
     61 
     62=head1 AUTHOR 
     63 
     64Kazuhiro Osawa, Tatsuhiko Miyagawa 
     65 
     66=head1 SEE ALSO 
     67 
     68L<Plagger>, L<http://d.hatena.ne.jp/keyword/%A4%CF%A4%C6%A4%CA%A5%D6%A5%C3%A5%AF%A5%DE%A1%BC%A5%AF%B7%EF%BF%F4%BC%E8%C6%C0API> 
     69 
     70=cut 
  • trunk/plagger/lib/Plagger/Plugin/Subscription/Bloglines.pm

    r177 r189  
    1151151; 
    116116 
     117__END__ 
     118 
     119=head1 NAME 
     120 
     121Plagger::Plugin::Subscription::Bloglines - Bloglines Subscription 
     122 
     123=head1 SYNOPSIS 
     124 
     125  - module: Subscription::Bloglines 
     126    config: 
     127      username: your-email@account 
     128      password: your-password 
     129      mark_read: 1 
     130 
     131=head1 DESCRIPTION 
     132 
     133This plugin allows you to synchronize your subscription using 
     134Bloglines Web Services sync API. 
     135 
     136=head1 CONFIGURATION 
     137 
     138=over 4 
     139 
     140=item username, password 
     141 
     142Your username & password to use with Bloglines API. 
     143 
     144=item mark_read 
     145 
     146C<mark_read> specifies whether this plugin "marks as read" the items 
     147you synchronize. Without this option, you will get the duplicated 
     148updates everytime you run Plagger, until you mark them unread using 
     149Bloglines browser interface. Defaults to 1. 
     150 
     151Setting this to 0 is recommended only for testing, or users who don't 
     152use Publish::Gmail plugin. 
     153 
     154=back 
     155 
     156=head1 AUTHOR 
     157 
     158Tatsuhiko Miyagawa 
     159 
     160=head1 SEE ALSO 
     161 
     162L<Plagger>, L<WebService::Bloglines>, L<http://www.bloglines.com/> 
     163 
     164=cut 
     165 
  • trunk/plagger/lib/Plagger/Plugin/Subscription/Config.pm

    r87 r189  
    3838 
    39391; 
     40 
     41__END__ 
     42 
     43=head1 NAME 
     44 
     45Plagger::Plugin::Subscription::Config - Subscription in config.yaml 
     46 
     47=head1 SYNOPSIS 
     48 
     49    - module: Subscription::Config 
     50      config: 
     51        feed: 
     52          - url: http://bulknews.typepad.com/blog/atom.xml 
     53          - url: http://blog.bulknews.net/mt/index.rdf 
     54 
     55=head1 DESCRIPTION 
     56 
     57This plugin allows you to configure your subscription I<hardwired> in 
     58C<config.yaml>. 
     59 
     60=head1 AUTHOR 
     61 
     62Tatsuhiko Miyagawa 
     63 
     64=head1 SEE ALSO 
     65 
     66L<Plagger> 
     67 
     68=cut