Changeset 1053

Show
Ignore:
Timestamp:
07/04/06 04:22:07
Author:
miyagawa
Message:

add more comments to examples

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/plagger/examples/atode.yaml

    r579 r1053  
     1# Bookmark web pages "to read later" on del.icio.us 
     2# Send HTML emails out of those bookmarks to your inbox 
     3 
    14global: 
     5  # Set timezone to Tokyo 
    26  timezone: Asia/Tokyo 
    37 
    48plugins: 
     9  # Add del.icio.us bookmarks tagged "toread"   
    510  - module: Subscription::Config 
    611    config: 
     
    813        - http://del.icio.us/rss/miyagawa/toread 
    914 
     15  # Resolve relative links in the entry body 
    1016  - module: Filter::ResolveRelativeLink 
    1117 
     18  # Upgrade entry body to fulltext. Even if upgrade fails, store the whole HTML 
    1219  - module: Filter::EntryFullText 
    1320    config: 
    1421      store_html_on_failure: 1 
    1522 
     23  # Deduplicate entries using URL + datetime as a key 
    1624  - module: Filter::Rule 
    1725    rule: 
    18       module: Fresh 
    19       mtime: 
    20         path: /home/miyagawa/tmp/atode.mtime 
    21         autoupdate: 1 
     26      module: Deduped 
    2227 
     28  # Break each entry as a feed so Gmail will send you emails per entry 
    2329  - module: Filter::BreakEntriesToFeeds 
    2430 
     31  # Finally send emails to your Gmail account using localhost SMTP server 
    2532  - module: Publish::Gmail 
    2633    config: 
     
    3037        via: smtp 
    3138        host: localhost:25 
    32  
  • trunk/plagger/examples/bloglines2gmail.yaml

    r713 r1053  
     1# Fetch Bloglines unread items using Bloglines Web Services API 
     2# and send HTML emails for each feed (not entry) 
     3 
    14global: 
    2   plugin_path: 
    3     - /home/miyagawa/plagger/plugins 
    4   assets_path: /home/miyagawa/plagger/assets 
     5  # Set timezone to your local one 
    56  timezone: Asia/Tokyo 
     7  # this make logger logs important information 
    68  log: 
    79    level: info 
    810 
    911plugins: 
     12  # Fetch your Bloglines updated entries using Bloglines API 
     13  # Mark them read if the retrieval succceeds. 
     14  # Fetch optional metadata by using listsubs API 
    1015  - module: Subscription::Bloglines 
    1116    config: 
     
    1520      fetch_meta: 1 
    1621 
     22  # Add "Add to del.icio.us" Widget in the Email body 
    1723  - module: Widget::Delicious 
    1824    config: 
    1925      username: miyagawa 
    2026 
     27  # Add "Manage Bloglines Subscription of this feed" Widget 
    2128  - module: Widget::BloglinesSubscription 
    2229 
     30  # Send HTML email to your Gmail account using external SMTP server 
    2331  - module: Publish::Gmail 
    2432    config: 
  • trunk/plagger/examples/iefav2opml.yaml

    r993 r1053  
     1# Convert websites included in Win32 IE favorites to OPML file 
     2# by doing RSS/Atom auto-discovery 
     3 
    14global: 
     5  # set timezone to your local 
    26  timezone: Asia/Tokyo 
    37 
    48plugins: 
     9  # Read your bookmarks by scanning IE favorites 
    510  - module: Subscription::Bookmarks 
    611    config: 
    712      browser: InternetExplorer 
     13 
     14  # Output OPML file as plagger.opml in the current directory 
    815  - module: Publish::OPML 
    916    config: 
  • trunk/plagger/examples/livedoorreader2gmail.yaml

    r713 r1053  
     1# Fetch Livedoor Reader's unread items using JSON API 
     2# and send them as HTML email to your Gmail account 
     3 
    14global: 
    2   plugin_path: 
    3     - /home/miyagawa/plagger/plugins 
    4   assets_path: /home/miyagawa/plagger/assets 
     5  # Set timezone to your local 
    56  timezone: Asia/Tokyo 
     7  # This makes Plagger log important things 
    68  log: 
    79    level: info 
    810 
    911plugins: 
     12  # Fetch Livedoor Reader unread items using their authentication scheme 
     13  # Mark retrieved items as "read" if the request succeeds 
    1014  - module: Subscription::LivedoorReader 
    1115    config: 
     
    1418      mark_read: 1 
    1519 
     20  # Add "Add to del.icio.us" Widget 
    1621  - module: Widget::Delicious 
    1722    config: 
    1823      username: miyagawa 
    1924 
     25  # Send HTML emails to Gmail account using external SMTP 
    2026  - module: Publish::Gmail 
    2127    config: 
  • trunk/plagger/examples/planet.yaml

    r988 r1053  
    11global: 
     2  # Make plagger more verbose than default 
    23  log: 
    34    level: debug 
    45 
    56plugins: 
     7  # Subscribe to a couple of "My Feeds" on the web 
     8  # They could be either Feeds URL or Blog URL (with AUto-Discovery support) 
    69  - module: Subscription::Config 
    710    config: 
     
    1316        - http://d.hatena.ne.jp/miyagawa/ 
    1417 
    15   - module: Aggregator::Simple 
    16    
     18  # Create "Smart Feed" with all entries across the feeds, fresher than 7 days old 
     19  # Add the title "Planet Plagger" to the smartfeed 
    1720  - module: SmartFeed::All 
    1821    rule: 
     
    2225      title: Planet Plagger 
    2326 
     27  # Generate Planet XHTML output out of the smartfeed 
     28  # to the directory /tmp/planet with sixapart-std "skin" 
    2429  - module: Publish::Planet 
    2530    rule: 
     
    2833      dir: /tmp/planet 
    2934      skin: sixapart-std 
    30       template: 
    31         members_list: 1 
    32         style_url: http://bulknews.typepad.com/blog/styles.css 
     35      style_url: http://bulknews.typepad.com/blog/styles.css 
    3336 
     37  # Output Atom feed for the smartfeed 
    3438  - module: Publish::Feed 
    3539    rule: 
     
    3842      dir: /tmp/planet 
    3943 
     44  # Output RSS feed for the smartfeed 
    4045  - module: Publish::Feed 
    4146    rule: 
  • trunk/plagger/examples/podcast.yaml

    r733 r1053  
    11# synchronize Podcasts from Odeo subscription, download all the 
    22# episodes, rewrite enclosure URL and republish as RSS 2.0 podcast 
    3 # locally 
     3 
    44plugins: 
     5  # Subscribe to Odeo RSS feed of the user TatsuhikoMiyagawa 
    56  - module: Subscription::Odeo 
    67    config: 
    78      account: TatsuhikoMiyagawa 
    89 
     10  # Fix permalinks to the enclosures file (by resolving redirector cruft etc.) 
    911  - module: Filter::TruePermalink 
    1012 
     13  # Download enclosures to the local directory 
    1114  - module: Filter::FetchEnclosure 
    1215    config: 
    1316      dir: /home/miyagawa/public_html/podcasts 
    1417 
     18  # Rewrite downloaded enclosure's URL (file path) by replacing 
     19  # ".../public_html/" with ".../~miyagawa/" 
     20  # This way enclosure URL links to your local web server 
    1521  - module: Filter::RewriteEnclosureURL 
    1622    config: 
     
    1925          url:   http://rock/~miyagawa/ 
    2026 
     27  # Create SmartFeed for the all entries across the feeds 
    2128  - module: SmartFeed::All 
    2229 
     30  # Create a single unified odeo.xml as RSS 2.0 format 
    2331  - module: Publish::Feed 
    2432    rule: 
  • trunk/plagger/examples/search.yaml

    r676 r1053  
     1# Create your own search engine by aggregating data from variouis search engines 
     2# and store the updated entry data to the localhost HyperEstraier 
     3 
    14plugins: 
    2   - module: Subscription::Config 
    3     config: 
    4       feed: 
    5         - http://b.hatena.ne.jp/t/plagger?mode=rss&sort=eid 
    6         - http://del.icio.us/rss/tag/plagger 
    7         - http://bloglines.com/citations?url=http%3A%2F%2Fplagger.org%2F 
    8         - http://www.technorati.com/watchlists/rss.html?wid=349774 
    9         - http://groups.google.com/group/plagger-dev/feed/rss_v2_0_msgs.xml 
    10  
     5  # Subscribe to search engines using "Plagger" as a keyword 
     6  # and "http://plagger.org/" as a linking URL 
    117  - module: Subscription::Planet 
    128    config: 
    139      keyword: Plagger 
     10      url: http://plagger.org/ 
    1411 
    15   - module: CustomFeed::BloglinesCitations 
     12  # Aggregate those feeds using Xango the asynchronous crawler 
    1613  - module: Aggregator::Xango 
     14 
     15  # Fixup permalink by resolving redirector cruft to the canonicalized URL 
    1716  - module: Filter::TruePermalink 
     17 
     18  # Upgrade entry body to fulltext if possible 
    1819  - module: Filter::EntryFullText 
    1920 
     21  # Create SmartFeed by merging search results into a single new feed 
    2022  - module: SmartFeed::All 
    2123 
     24  # Store merged feed entries to localhost Estraier instance 
     25  # by using its node HTTP API 
    2226  - module: Search::Estraier 
    2327    config: 
  • trunk/plagger/examples/xoxo-planet.yaml

    r684 r1053  
     1# Create Planet web page using XOXO microformats as a subscription 
     2 
    13plugins: 
     4  # Create a subscription out of XOXO-compatible XHTML web page 
    25  - module: Subscription::XOXO 
    36    config: 
    47      url: http://d.hatena.ne.jp/antipop/20050628/1119966355 
    58 
    6 #  - module: Aggregator::Xango 
     9  # Create SmartFeed with entries Fresher than 7 days old 
    710  - module: SmartFeed::All 
    811    rule: 
     
    1215      title: Planet Perl JP 
    1316 
     17  # Output XHTML to public_html/perl using the default skin 
    1418  - module: Publish::Planet 
    1519    rule: 
     
    1822      dir: /home/miyagawa/public_html/perl 
    1923      skin: default 
    20       template: 
    21         members_list: 1 
  • trunk/plagger/examples/xoxo2opml.yaml

    r685 r1053  
     1# Convert XOXO XHTML subscription to OPML 
     2 
    13plugins: 
     4  # Create subcriptions from XOXO XHTML web page 
    25  - module: Subscription::XOXO 
    36    config: 
    47      url: http://d.hatena.ne.jp/antipop/20050628/1119966355 
    58 
     9  # Convert the subscriptions to OPML format 
    610  - module: Publish::OPML 
    711    config: 
  • trunk/plagger/examples/yapcvideo.yaml

    r755 r1053  
     1# Generate videocast feed (RSS 2.0) from archive.org search result page 
     2 
    13plugins: 
     4  # Subscribe to the archive.org tag search page 
    25  - module: Subscription::Config 
    36    config: 
    47      feed: 
    58         - url: http://www.archive.org/search.php?query=subject:%22yapc%22 
    6   - module: Aggregator::Simple 
     9 
     10  # Upgrade entry body to fulltext 
    711  - module: Filter::EntryFullText 
     12 
     13  # Find Enclosures from entry body by looking for links to mov/mp4 files 
    814  - module: Filter::FindEnclosures 
     15 
     16  # Issue HEAD requests to found enclosures to know HTTP Content-Length 
    917  - module: Filter::HEADEnclosureMetadata 
     18 
     19  # Create RSS 2.0 feed out of those enclosures 
    1020  - module: Publish::Feed 
    1121    config: