Tweaked forms/oldforms docs to better represent the current state of things.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8024 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Jacob Kaplan-Moss 2008-07-21 17:00:59 +00:00
parent 8b1684e676
commit f2c31535a0
2 changed files with 7 additions and 50 deletions

View File

@ -2,60 +2,20 @@
The forms library The forms library
================= =================
``django.forms`` is Django's fantastic new form-handling library. It's a ``django.forms`` is Django's form-handling library.
replacement for the old form/manipulator/validation framework, which has been
moved to ``django.oldforms``. This document explains how to use this new
library.
Migration plan .. adminition:: Looking for oldforms?
==============
``django.newforms`` is new in Django's 0.96 release, but, as it won't be new ``django.forms`` was once called ``newforms`` since it replaced Django's
forever, we plan to rename it to ``django.forms`` in the future. The current original form/manipulator/validation framework. The old form handling
``django.forms`` package will be available as ``django.oldforms`` until Django library is still available as `django.oldforms`_, but will be removed
1.0, when we plan to remove it for good. in a future version of Django.
That has direct repercussions on the forward compatibility of your code. Please .. _django.oldforms: ../oldforms/
read the following migration plan and code accordingly:
* The old forms framework (the current ``django.forms``) has been copied to
``django.oldforms``. Thus, you can start upgrading your code *now*,
rather than waiting for the future backwards-incompatible change, by
changing your import statements like this::
from django import forms # old
from django import oldforms as forms # new
* In the next Django release (0.97), we will move the current
``django.newforms`` to ``django.forms``. This will be a
backwards-incompatible change, and anybody who is still using the old
version of ``django.forms`` at that time will need to change their import
statements, as described in the previous bullet.
* We will remove ``django.oldforms`` in the release *after* the next Django
release -- either 0.98 or 1.0, whichever comes first.
With this in mind, we recommend you use the following import statement when
using ``django.newforms``::
from django import newforms as forms
This way, your code can refer to the ``forms`` module, and when
``django.newforms`` is renamed to ``django.forms``, you'll only have to change
your ``import`` statements.
If you prefer "``import *``" syntax, you can do the following::
from django.newforms import *
This will import all fields, widgets, form classes and other various utilities
into your local namespace. Some people find this convenient; others find it
too messy. The choice is yours.
Overview Overview
======== ========
As with the ``django.oldforms`` ("manipulators") system before it,
``django.forms`` is intended to handle HTML form display, data processing ``django.forms`` is intended to handle HTML form display, data processing
(validation) and redisplay. It's what you use if you want to perform (validation) and redisplay. It's what you use if you want to perform
server-side validation for an HTML form. server-side validation for an HTML form.

View File

@ -11,9 +11,6 @@ strongly encourage you not to waste your time learning this. Instead, learn and
use the django.forms system, which we have begun to document in the use the django.forms system, which we have begun to document in the
`forms documentation`_. `forms documentation`_.
If you have legacy form/manipulator code, read the "Migration plan" section in
that document to understand how we're making the switch.
.. _forms documentation: ../forms/ .. _forms documentation: ../forms/
Introduction Introduction