public
Description: Fieldset Rendering For Non-Admin Forms
Homepage:
Clone URL: git://github.com/muhuk/django-formfieldset.git
name age message
file LICENSE.txt Thu Mar 12 13:15:46 -0700 2009 Fix license [muhuk]
file README.rst Sun Nov 22 06:06:12 -0800 2009 fix #6: updated link for django-form-utils [muhuk]
directory example/ Sat May 30 04:24:32 -0700 2009 Improve example project [muhuk]
directory formfieldset/ Sat Nov 21 12:14:48 -0800 2009 fieldsets can be rendered individually [muhuk]
file setup.py Thu Aug 06 00:36:40 -0700 2009 More PYPI compatibility [muhuk]
README.rst

django-formfieldset is a simple Django app that provides a mix-in class for admin-like fieldset rendering.

Features

  • Fieldset functionality similar to ModelAdmin
  • Shorthand rendering functions with fieldsets both for whole forms and for individual fieldsets
    • render as P
    • render as TABLE
    • render as UL
  • Templates are class variables
  • Overrides nothing in django.forms.Form

Installation

  1. Add "django-formfieldset" directory to your Python path.
  2. Add "formfieldset" to your INSTALLED_APPS tuple found in your settings file. (optional - to be able to run tests)

Testing & Example

There is an example project in the example/ folder. To run automated tests for django-formfieldset run the following command in example/ directory:

python manage.py test formfieldset

To run the example project:

python manage.py runserver

Then you can visit http://localhost:8000/ to view the example.

Usage

  1. Create your form with FieldsetMixin.
  2. Add a fieldsets attribute to your form. See admin docs for detailed explanation.
  3. Render your form with fieldset enabled methods:
    • You can use iter_fieldsets() for custom form rendering. It will yield Fieldset objects. Fieldsets act as iterators for widgets in them.
    • You can use as_fieldset_table(), as_fieldset_ul() and as_fieldset_p() methods that act like built-in as_* method except fieldset support.