Documentation Wiki

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 Tarzan to its limits.

Besides documenting each and every single function, we're also putting together guides for various things to help you along. We decided to add 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.

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

Tarzan requires the following PHP versions and extensions:

• PHP 5.1.4 (or newer)
• cURL 7.15 (or newer; for fetching remote data)
• SimpleXML (for handling XML responses; built into PHP 5.x)
• An understanding of of object-oriented PHP and iterating over SimpleXML nodes (or the ability to figure it out).

If you would like to use one of the optional caching layers, you might need support for (depending on your choice):

• Permissions to make files server-writable (for file-based caching)
• APC (a lightweight caching system)
• PDO (a normalized database access API; ships with PHP 5.1)
• SQLite 3.x (or newer) + PDO_SQLITE bindings (for SQLite caching)
• MySQL 4.1 (or newer) + PDO_MYSQL bindings (for MySQL caching)
• PostgreSQL 6.5 (or newer) + PDO_PGSQL bindings (for PostgreSQL caching)

• Frequently Asked Questions (FAQ)
• Getting Started and Technical Overview

• General Information
• Tips, Tricks, Tutorials, and Screencasts
• Technical Information