Changeset 189

Timestamp:

02/27/06 08:23:14

Author:

miyagawa

Message:

Added docs to some plugins

Files:

• trunk/plagger/lib/Plagger/Plugin/Aggregator/Simple.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Plugin/CustomFeed/Frepa.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Plugin/CustomFeed/Mailman.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Plugin/CustomFeed/Mixi.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Plugin/Filter/Delicious.pm (modified) (2 diffs)
• trunk/plagger/lib/Plagger/Plugin/Filter/HatenaBookmarkTag.pm (modified) (2 diffs)
• trunk/plagger/lib/Plagger/Plugin/Filter/HatenaBookmarkUsersCount.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Plugin/Subscription/Bloglines.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Plugin/Subscription/Config.pm (modified) (1 diff)

trunk/plagger/lib/Plagger/Plugin/Aggregator/Simple.pm

@@ -91 +91 @@
-
-1;
+
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::Aggregator::Simple - Dumb simple aggregator
+
+=head1 SYNOPSIS
+
+  - module: Aggregator::Simple
+
+=head1 DESCRIPTION
+
+This plugin implements a Plagger dumb aggregator. It crawls
+subscription sequentially and parses XML feeds using L<XML::Feed>
+module.
+
+It can be also used as a base class for custom aggregators. See
+L<Plagger::Plugin::Aggregator::Xango> for example.
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<Plagger>, L<XML::Feed>, L<XML::RSS::LibXML>
+
+=cut

trunk/plagger/lib/Plagger/Plugin/CustomFeed/Frepa.pm

@@ -238 +238 @@
-
-1;
+
-__END__
-
+
+
+
+
+
+
-
-  - module: CustomFeed::Frepa
-    config:
-
-
+your-
+word
-      fetch_body: 1
+      show_icon: 1
+
+=head1 DESCRIPTION
+
+This plugin fetches your friend blog updates from livedoor Frepa
+(L<http://frepa.livedoor.com/>) and creates a custom feed.
+
+=head1 CONFIGURATION
+
+See L<Plagger::Plugin::CustomFeed::Mixi> for C<fetch_body>,
+C<fetch_body_interval> and C<show_icon>.
+
+=head1 AUTHOR
+
+Kazuhiro Osawa
+
+=head1 SEE ALSO
+
+L<Plagger>, L<Plagger::Plugin::CustomFeed::Mixi>, L<WWW::Mechanize>,
+L<http://frepa.livedoor.com/>
+
+=cut

trunk/plagger/lib/Plagger/Plugin/CustomFeed/Mailman.pm

@@ -101 +101 @@
-1;
-
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::CustomFeed::Mailman - Custom feed for Mailman pipermail
+
+=head1 SYNOPSIS
+
+  - module: CustomFeed::Mailman
+    config:
+      url: http://lists.rawmode.org/pipermail/catalyst/
+
+=head1 DESCRIPTION
+
+B<Note: Plagger has a bug that you'll have duplicated entries when you
+have multiple installations of identical CustomFeed. It will be fixed
+and this plugin's config interface may be changed altogether>
+
+This plugin creates a custom feed off of Mailman's pipermail URL.
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<Plagger>
+
+=cut

trunk/plagger/lib/Plagger/Plugin/CustomFeed/Mixi.pm

@@ -104 +104 @@
-1;
-
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::CustomFeed::Mixi -  Custom feed for mixi.jp
+
+=head1 SYNOPSIS
+
+    - module: CustomFeed::Mixi
+      config:
+        email: email@example.com
+        password: password
+        fetch_body: 1
+        show_icon: 1
+
+=head1 DESCRIPTION
+
+This plugin fetches your friends diary updates from mixi
+(L<http://mixi.jp/>) and creates a custom feed.
+
+=head CONFIGURATION
+
+=over 4
+
+=item email, password
+
+Credential you need to login to mixi.jp.
+
+=item fetch_body
+
+With this option set, this plugin fetches entry body HTML, not just a
+link to the entry. Defaults to 0.
+
+=item fetch_body_interval
+
+With C<fetch_body> option set, your Plagger script is recommended to
+wait for a little, to avoid mixi.jp throttling. Defaults to 1.5.
+
+=item show_icon: 1
+
+With this option set, this plugin fetches users buddy icon from
+mixi.jp site, which makes the output HTML very user-friendly.
+
+=back
+
+=head1 SCREENSHOT
+
+L<http://blog.bulknews.net/mt/archives/plagger-mixi-icon.gif>
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<Plagger>, L<WWW::Mixi>
+
+=cut

trunk/plagger/lib/Plagger/Plugin/Filter/Delicious.pm

@@ -2 +2 @@
-use strict;
-use base qw( Plagger::Plugin );
-
-# NOTE this module is untested and written just for a proof of
-# concept. If you run this on your box with real feeds, del.icio.us
-# wlil be likely to ban your IP. See http://del.icio.us/help/ for
-# details.
-
-use Digest::MD5 qw(md5_hex);
@@ -46 +41 @@
-
-1;
+
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::Filter::Delicious - Fetch tags and users count from del.icio.us
+
+=head1 SYNOPSIS
+
+  - module: Filter::Delicious
+
+=head1 DESCRIPTION
+
+B<Note: this module is mostly untested and written just for a proof of
+concept. If you run this on your box with real feeds, del.icio.us wlil
+be likely to ban your IP. See http://del.icio.us/help/ for details.>
+
+This plugin queries del.icio.us using its RSS feeds API to get the
+tags people added to the entries, and how many people bookmarked them.
+
+Users count is stored in C<delicious_users> metadata of
+Plagger::Entry, so that other plugins and smartfeeds can make use of.
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<Plagger>, L<http://del.icio.us/help/>
+
+=cut

trunk/plagger/lib/Plagger/Plugin/Filter/HatenaBookmarkTag.pm

@@ -30 +30 @@
-    for my $entry ($feed->entries) {
-        my $tag = $entry->category or next;
-
+   
-
-        for my $t (@{$tag}) {
@@ -39 +39 @@
-
-1;
+
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::Filter::HatenaBookmarkTag - Fetch tags from Hatena Bookmark
+
+=head1 SYNOPSIS
+
+  - module: Filter::HatenaBookmarkTag
+
+=head1 DESCRIPTION
+
+B<Note: this module is mostly untested and written just for a proof of
+concept. If you run this on your box with real feeds, Hatena might
+throttle your IP. See http://b.hatena.ne.jp/ for details.>
+
+This plugin queries Hatena Bookmark (L<http://b.hatena.ne.jp/>) using
+its RSS feeds API to get the tags people added to the entries.
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<Plagger>, L<Plagger::Plugin::Filter::HatenaBookmarkUsersCount>,
+L<http://b.hatena.ne.jp/>
+
+=cut

trunk/plagger/lib/Plagger/Plugin/Filter/HatenaBookmarkUsersCount.pm

@@ -40 +40 @@
-
-1;
+
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::Filter::HatenaBookmarkUsersCount - Queries Hatena Bookmark users count
+
+=head1 SYNOPSIS
+
+  - module: Filter::HatenaBookmarkUsersCount
+
+=head1 DESCRIPTION
+
+This plugin queries Hatena Bookmark (L<http://b.hatena.ne.jp/>) how
+many people bookmarked each of feed entries, using its XMLRPC API
+C<bookmark.getCount>.
+
+Users count is stored in C<hatenabookmark_users> metadata of
+Plagger::Entry so that other plugins or smartfeeds can make use of.
+
+=head1 AUTHOR
+
+Kazuhiro Osawa, Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<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>
+
+=cut

trunk/plagger/lib/Plagger/Plugin/Subscription/Bloglines.pm

@@ -115 +115 @@
-1;
-
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::Subscription::Bloglines - Bloglines Subscription
+
+=head1 SYNOPSIS
+
+  - module: Subscription::Bloglines
+    config:
+      username: your-email@account
+      password: your-password
+      mark_read: 1
+
+=head1 DESCRIPTION
+
+This plugin allows you to synchronize your subscription using
+Bloglines Web Services sync API.
+
+=head1 CONFIGURATION
+
+=over 4
+
+=item username, password
+
+Your username & password to use with Bloglines API.
+
+=item mark_read
+
+C<mark_read> specifies whether this plugin "marks as read" the items
+you synchronize. Without this option, you will get the duplicated
+updates everytime you run Plagger, until you mark them unread using
+Bloglines browser interface. Defaults to 1.
+
+Setting this to 0 is recommended only for testing, or users who don't
+use Publish::Gmail plugin.
+
+=back
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<Plagger>, L<WebService::Bloglines>, L<http://www.bloglines.com/>
+
+=cut
+

trunk/plagger/lib/Plagger/Plugin/Subscription/Config.pm

@@ -38 +38 @@
-
-1;
+
+__END__
+
+=head1 NAME
+
+Plagger::Plugin::Subscription::Config - Subscription in config.yaml
+
+=head1 SYNOPSIS
+
+    - module: Subscription::Config
+      config:
+        feed:
+          - url: http://bulknews.typepad.com/blog/atom.xml
+          - url: http://blog.bulknews.net/mt/index.rdf
+
+=head1 DESCRIPTION
+
+This plugin allows you to configure your subscription I<hardwired> in
+C<config.yaml>.
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa
+
+=head1 SEE ALSO
+
+L<Plagger>
+
+=cut