Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added admin settings documentation

  • Loading branch information...
commit 073b09a7b338fa19048509cdcdf6e4792cc18a92 1 parent 89c7333
@coordt coordt authored
Showing with 49 additions and 0 deletions.
  1. +49 −0 doc_src/admin_settings.rst
View
49 doc_src/admin_settings.rst
@@ -0,0 +1,49 @@
+.. _admin_settings:
+
+==============================
+Adding the fields to the Admin
+==============================
+
+By default, Django Categories adds the fields you configure to the model's Admin class. If your ModelAdmin class does not use the ``fieldsets`` attribute, the configured category fields are simply appended to the bottom the fields. If your ModelAdmin uses the ``fieldsets`` attribute, a new fieldset named ``Categories``, containing all the configured fields is appended to the fieldsets. You can override or alter this behavior with the :ref:`ADMIN_FIELDSETS` setting.
+
+ADMIN_FIELDSETS allows you to:
+
+* Prevent Django Categories from adding the fields or fieldsets to a model's ModelAdmin class.
+* Change the name of the fieldset (from the default: "Categories")
+* Change the placement of the fieldset (from the default: bottom)
+
+Preventing fields in the admin class
+====================================
+
+If you don't want Django Categories to add any fields to the admin class, simply use the following format::
+
+ CATEGORIES_SETTINGS = {
+ 'ADMIN_FIELDSETS': [
+ 'app.model': None,
+ ]
+ }
+
+Changing the name of the field set
+==================================
+
+To rename the field set, use the following format::
+
+ CATEGORIES_SETTINGS = {
+ 'ADMIN_FIELDSETS': [
+ 'app.model': 'Taxonomy',
+ ]
+ }
+
+Putting the field set exactly where you want it
+===============================================
+
+For complete control over the field set, use the following format::
+
+ CATEGORIES_SETTINGS = {
+ 'ADMIN_FIELDSETS': [
+ 'app.model': {
+ 'name': 'Categories',
+ 'index': 0
+ },
+ ]
+ }
Please sign in to comment.
Something went wrong with that request. Please try again.