User Guide
Standalone User Guide
There is currently no standalone user guide for Propel 1.3. We would like to provide one eventually, but until that time documentation will be managed exclusively in this wiki.
Wiki Documentation
We will be rewriting some of the chapters from the HTML user guide and providing new documentation topics in wiki format
Please send a note to dev@… if you'd like to help write documentation. Any help is always appreciated. If you are helping, please see the wiki:Development/Guidelines/UserDocumentationGuidelines page for some style guidelines to keep things looking consistent.
The Basics
- Installation
How to configure a new installation of Propel.
- Upgrading
Upgrading from Propel 1.2 to 1.3
- Quickstart Guide
How to start using Propel for your application
- Basic CRUD
The basics of Propel CRUD (Create, Retrieve, Update, Delete) operations
General Topics
- Criteria
More examples of using Propel's Criteria object to simplify query writing.
- Relationships
How to access related rows in Propel.
- Validators
How to use Propel's validation framework.
- Configure Logging
How to configure Propel to log info, errors, etc.
Advanced Topics
- Copying Objects
Information about cloning objects and performing persisted object copying.
- Many-to-Many Relationships
How to work with many-to-many relationships in Propel.
- Tree support
Working with the NEW tree support in Propel 1.3.
- LOB support
Working with LOBs in Propel.
- Inheritance
Single-table inheritance in Propel.
- Replication
Use Propel in a Master-Slave Replication Environment.