From 56e590cc0be4d8c8b6fe0967583a6e02d18ee03e Mon Sep 17 00:00:00 2001 From: jaywelborn Date: Wed, 1 Nov 2017 20:40:49 +0100 Subject: [PATCH] Fixed #28761 -- Documented how an inline formset's prefix works. --- AUTHORS | 1 + docs/topics/forms/formsets.txt | 31 +++++++++++++++++++++++++++++++ docs/topics/forms/modelforms.txt | 4 ++++ 3 files changed, 36 insertions(+) diff --git a/AUTHORS b/AUTHORS index 80119cc990..e106e231e4 100644 --- a/AUTHORS +++ b/AUTHORS @@ -364,6 +364,7 @@ answer newbie questions, and generally made Django that much better: Jason Yan Javier Mansilla Jay Parlar + Jay Welborn Jay Wineinger J. Clifford Dyer jcrasta@gmail.com diff --git a/docs/topics/forms/formsets.txt b/docs/topics/forms/formsets.txt index 08acde1d4f..08c0194e53 100644 --- a/docs/topics/forms/formsets.txt +++ b/docs/topics/forms/formsets.txt @@ -578,6 +578,32 @@ argument - the index of the form in the formset. The index is ``None`` for the ... kwargs['custom_kwarg'] = index ... return kwargs +.. _formset-prefix: + +Customizing a formset's prefix +============================== + +In the rendered HTML, formsets include a prefix on each field's name. By +default, the prefix is ``'form'``, but it can be customized using the formset's +``prefix`` argument. + +For example, in the default case, you might see: + +.. code-block:: html + + + + +But with ``ArticleFormset(prefix='article')`` that becomes: + +.. code-block:: html + + + + +This is useful if you want to :ref:`use more than one formset in a view +`. + Using a formset in views and templates ====================================== @@ -653,6 +679,8 @@ If you manually render fields in the template, you can render Similarly, if the formset has the ability to order (``can_order=True``), it is possible to render it with ``{{ form.ORDER }}``. +.. _multiple-formsets-in-view: + Using more than one formset in a view ------------------------------------- @@ -686,3 +714,6 @@ a look at how this might be accomplished:: You would then render the formsets as normal. It is important to point out that you need to pass ``prefix`` on both the POST and non-POST cases so that it is rendered and processed correctly. + +Each formset's :ref:`prefix ` replaces the default ``form`` +prefix that's added to each field's ``name`` and ``id`` HTML attributes. diff --git a/docs/topics/forms/modelforms.txt b/docs/topics/forms/modelforms.txt index c261fb75d7..3c49e3b8e3 100644 --- a/docs/topics/forms/modelforms.txt +++ b/docs/topics/forms/modelforms.txt @@ -1148,6 +1148,10 @@ a particular author, you could do this:: >>> author = Author.objects.get(name='Mike Royko') >>> formset = BookFormSet(instance=author) +``BookFormSet``'s :ref:`prefix ` is ``'book_set'`` +(``_set`` ). If ``Book``'s ``ForeignKey`` to ``Author`` has a +:attr:`~django.db.models.ForeignKey.related_name`, that's used instead. + .. note:: :func:`~django.forms.models.inlineformset_factory` uses