File: README.markdown

package info (click to toggle)
python-django-formfieldset 0%2Bgit20090520-621cb58-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, squeeze, wheezy
  • size: 56 kB
  • ctags: 30
  • sloc: python: 215; makefile: 10
file content (38 lines) | stat: -rw-r--r-- 1,126 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
**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
   * as `P`
   * as `TABLE`
   * as `UL`
 * 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)
 3. Create your forms with `FieldsetMixin`


Usage
=====

 * Add a `fieldsets` attribute to your form. See [admin docs][ref1] for
   detailed explanation.
 * Render your form with fieldset enabled methods:
   * You can use `iter_fieldsets()` for custom form rendering. It will yield
     `Fieldset` objects. `Fieldset`s 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.


  [ref1]: http://docs.djangoproject.com/en/dev/ref/contrib/admin/#fieldsets