=========================
Pancake PHP documentation
=========================

`Pancake PHP <https://bitbucket.org/ethanpoole/pancake>`_, or just Pancake for
short, is a library that provides the tools necessary to create web forms,
including pre-defined form fields, validators, and processing hooks.

Pancake is based on the following philosophy about forms:

* A more precise means of input is better for the user.

* Forms should be consistent across a website.

* All instructions pertaining to a form field must be in the ``<label>`` tag.

* Repetitive tasks should be made hassle-free.

* Pancakes are tasty.

Pancake is open source and licensed under a :doc:`BSD license <license>`.

Requirements
============

* `PHP 5.3+ <http://www.php.net/>`_
* `jQuery 1.6+ <http://jquery.com/>`_

Table of contents
=================

.. toctree::
   :maxdepth: 2
   
   tutorial
   topics/index
   references/index
   license

Acknowledgements
================

Pancake is developed and maintained by `Ethan Poole <http://ethanpoole.com>`_.
The project was initially developed at `Student Unions & Activities
<http://sua.umn.edu>`_ at the University of Minnesota.