Documentation

We've seen far too many open-source projects have really poor documentation, if any at all. We don't want to be like that. Our goal is to provide you with everything you need to install, upgrade, get started with, and really push SimplePie to its limits.

Besides documenting each and every single public function, we've also put together guides for various things to help you along. We decided to move everything into a wiki so that people can add their own notes, clarifications, and other helpful hints to the docs. Feel free to add your own tutorials and such, but please follow existing uses of wiki links and the API documentation.

You can look up a specific class or method by going to http://simplepie.org/api/[class name] which is just like how you can look up PHP functions by going to http://php.net/[function name].

Ready to learn? You can begin by clicking on one of the documentation links below.

• Frequently Asked Questions
• Typical Multifeed Gotchas
• Known Problematic Feeds
• I'm getting memory leaks!
• How does SimplePie's caching system work?
• How do I change the file permissions for the cache directory to be server-writable?

• Requirements and Getting Started
• Create a sample SimplePie-enabled page
• Upgrading from Beta 2, 3, 3.1, or 3.2

• API Documentation for 1.3
• Other Documentation for 1.3
• API Documentation for 1.2
• Tips, Tricks, Tutorials, and Screencasts
• Sites that have integrated SimplePie

• SimplePie Plugins and Integration
• SimplePie Add-ons

• Coding Standards
• Release Notes
• SimplePie Credits
• SimplePie in the Media

• SimplePie Live!