Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed #13740 -- Added documentation for the can_delete InlineModelAdm…

…in option. Thanks to Alex Gaynor for the patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@13458 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 88f2f0b39d051009568ba194725d4cd5cc553c6e 1 parent c4e766c
@freakboy3742 freakboy3742 authored
Showing with 54 additions and 56 deletions.
  1. +54 −56 docs/ref/contrib/admin/index.txt
View
110 docs/ref/contrib/admin/index.txt
@@ -1027,90 +1027,88 @@ The difference between these two is merely the template used to render them.
The ``InlineModelAdmin`` class is a subclass of ``ModelAdmin`` so it inherits
all the same functionality as well as some of its own:
-``model``
-~~~~~~~~~
+.. attribute:: InlineModelAdmin.model
-The model in which the inline is using. This is required.
+ The model in which the inline is using. This is required.
-``fk_name``
-~~~~~~~~~~~
+.. attribute:: InlineModelAdmin.fk_name
-The name of the foreign key on the model. In most cases this will be dealt
-with automatically, but ``fk_name`` must be specified explicitly if there are
-more than one foreign key to the same parent model.
+ The name of the foreign key on the model. In most cases this will be dealt
+ with automatically, but ``fk_name`` must be specified explicitly if there
+ are more than one foreign key to the same parent model.
-``formset``
-~~~~~~~~~~~
+.. attribute:: InlineModelAdmin.formset
-This defaults to ``BaseInlineFormSet``. Using your own formset can give you
-many possibilities of customization. Inlines are built around
-:ref:`model formsets <model-formsets>`.
+ This defaults to ``BaseInlineFormSet``. Using your own formset can give you
+ many possibilities of customization. Inlines are built around
+ :ref:`model formsets <model-formsets>`.
-``form``
-~~~~~~~~
+.. attribute:: InlineModelAdmin.form
-The value for ``form`` defaults to ``ModelForm``. This is what is
-passed through to ``inlineformset_factory`` when creating the formset for this
-inline.
+ The value for ``form`` defaults to ``ModelForm``. This is what is passed
+ through to ``inlineformset_factory`` when creating the formset for this
+ inline.
.. _ref-contrib-admin-inline-extra:
-``extra``
-~~~~~~~~~
+.. attribute:: InlineModelAdmin.extra
-This controls the number of extra forms the formset will display in addition
-to the initial forms. See the
-:ref:`formsets documentation <topics-forms-formsets>` for more information.
-.. versionadded:: 1.2
+ This controls the number of extra forms the formset will display in addition
+ to the initial forms. See the
+ :ref:`formsets documentation <topics-forms-formsets>` for more information.
+
+ .. versionadded:: 1.2
-For users with JavaScript-enabled browsers, an "Add another" link is
-provided to enable any number of additional inlines to be added in
-addition to those provided as a result of the ``extra`` argument.
+ For users with JavaScript-enabled browsers, an "Add another" link is
+ provided to enable any number of additional inlines to be added in addition
+ to those provided as a result of the ``extra`` argument.
-The dynamic link will not appear if the number of currently displayed
-forms exceeds ``max_num``, or if the user does not have JavaScript
-enabled.
+ The dynamic link will not appear if the number of currently displayed forms
+ exceeds ``max_num``, or if the user does not have JavaScript enabled.
.. _ref-contrib-admin-inline-max-num:
-``max_num``
-~~~~~~~~~~~
+.. attribute:: InlineModelAdmin.max_num
-This controls the maximum number of forms to show in the inline. This doesn't
-directly correlate to the number of objects, but can if the value is small
-enough. See :ref:`model-formsets-max-num` for more information.
+ This controls the maximum number of forms to show in the inline. This
+ doesn't directly correlate to the number of objects, but can if the value
+ is small enough. See :ref:`model-formsets-max-num` for more information.
-``raw_id_fields``
-~~~~~~~~~~~~~~~~~
+.. attribute:: InlineModelAdmin.raw_id_fields
-By default, Django's admin uses a select-box interface (<select>) for
-fields that are ``ForeignKey``. Sometimes you don't want to incur the
-overhead of having to select all the related instances to display in the
-drop-down.
+ By default, Django's admin uses a select-box interface (<select>) for
+ fields that are ``ForeignKey``. Sometimes you don't want to incur the
+ overhead of having to select all the related instances to display in the
+ drop-down.
-``raw_id_fields`` is a list of fields you would like to change
-into a ``Input`` widget for either a ``ForeignKey`` or ``ManyToManyField``::
+ ``raw_id_fields`` is a list of fields you would like to change into a
+ ``Input`` widget for either a ``ForeignKey`` or ``ManyToManyField``::
- class BookInline(admin.TabularInline):
- model = Book
- raw_id_fields = ("pages",)
+ class BookInline(admin.TabularInline):
+ model = Book
+ raw_id_fields = ("pages",)
-``template``
-~~~~~~~~~~~~
-The template used to render the inline on the page.
+.. attribute:: InlineModelAdmin.template
-``verbose_name``
-~~~~~~~~~~~~~~~~
+ The template used to render the inline on the page.
-An override to the ``verbose_name`` found in the model's inner ``Meta`` class.
+.. attribute:: InlineModelAdmin.verbose_name
-``verbose_name_plural``
-~~~~~~~~~~~~~~~~~~~~~~~
+ An override to the ``verbose_name`` found in the model's inner ``Meta``
+ class.
+
+.. attribute:: InlineModelAdmin.verbose_name_plural
+
+ An override to the ``verbose_name_plural`` found in the model's inner
+ ``Meta`` class.
+
+.. attribute:: InlineModelAdmin.can_delete
+
+ Specifies whether or not inline objects can be deleted in the inline.
+ Defaults to ``True``.
-An override to the ``verbose_name_plural`` found in the model's inner ``Meta``
-class.
Working with a model with two or more foreign keys to the same parent model
---------------------------------------------------------------------------
Please sign in to comment.
Something went wrong with that request. Please try again.