source: trunk/www.guidonia.net/wp/wp-content/plugins/feeder-v0.3/README.txt@ 44

Feeder 0.3  Documentation
-=-=-=-=-=-=-=-=-=-=-=-=-

Just Copy the feeder.php to /wp-root-path/wp-content/plugins/
where /wp-root-path/ contains your Wordpress Installation and Follow the Instructions.


Make Sure the ./wp-content/uploads/ Folder Exists and is set to CHMOD 777
if you want to use the Feed-Cache Features. (and your disk/host has atleast 50KB of free Space)



I. Instructions
---------------

1) Edit the "sidebar.php" File of your Default Template using Wordpress ACP or FTP and
add the Following Lines in a Place Suitable for your Purpose.

<!---- QUICK ---->
      <?php if ( class_exists('feeder') ) : ?>
         <h2><?php _e('Feeder'); ?></h2>
         <ul>
            <?php new feeder("http://feed-link"); ?>
         </ul>
      <?php endif; ?>
<------ END ----->


<!------- ADVANCED ------->
      <?php if ( class_exists('feeder') ) : ?>
         <h2><?php _e('Feeder'); ?></h2>
         <ul>
            <?php new feeder("http://feed-link", num-links, "<li>", "</li>", "feeder-link", "target", num-chars, 1, cache-time); ?>
         </ul>
      <?php endif; ?>
<!--------- END ---------->      


   Where
   (i) 'http://feed-link' -> Feed URL you want to use
  {ii} 'num-links' -> Number of Links to Show
 (iii) '<li>' and '</li>' -> xHTML Tags to Bind the Links
  (iv) 'feeder-link' -> CSS Class of the Links Shown for Styling (Leave it as it is)
   (v) 'target' -> Link Target, "_blank" for New Window and "_self" for the Current Window.
   (v) 'num-chars' -> Number of Characters to Parse for the Title
  (vi) '1' -> Enable Feed Cache, Change to 0 if you dont want to use it/Anything Goes Wrong.
 (vii) 'cache-time' -> Update the Cache Every n Seconds.. 3600 = 1Hr
  
  Example: <?php new feeder("http//domain.com/feed/", 5, "<li>", "</li>", "feeder-link", "_self", 32, 1, 3600); ?>
  NOTE: Do NOT Quote the num-chars, num-links, cache and cache-time!

2) Activate the Plugin from the Wordpress ACP Plugins Page.



II. Regarding Feed-Cache
------------------------

If you directly source the Feed from another site, there seems to be a Lag in rendering Your Blog!
Mostly because the Source Site is a Little Slow or has a Huge amount of Traffic.

Feeder's Feed-Cache will keep a Scaled Down Copy of the RSS Feed in your own Server (Containing only Links and Titles)
It Automatically Updates the Cache according to the time set (Default: 3600secs)

Make sure the Uploads Folder of your blog is set to CHMOD 777 (Write-Write-Write) if you want to use the Feature.



III. Bugs, etc.
---------------

If you Find any Nasty Bugs in my Plugin, Email me (subbu.exe[at]gmail.com)
Thank You :)



IV. License
-----------

Meh! See GPLv2 in gnu.org

XML Parser Function is taken from PHP Manual. I Think PHP License, etc. applies for that..



V. Feature Requests & Contact
-----------------------------

Plugin Page: http://xubz.com/weblog/2007/03/feeder-wordpress-plugin
Author Blog: http://xubz.com/

Email me (subbu.exe[at]gmail.com) if you want to Request Features, etc.

I'm a Freelance Web Developer and Designer, Contact me about any Queries of those..

(And Forgive my English.. :-/)



EOF