.. Swingers documentation master file

django-swingers: Common utilities and templates for app development.
********************************************************************

Release v\ |version|. (:ref:`Installation <install>`)

django-swingers is an :ref:`Apache2 Licensed <apache2>` library of common
utilities, templates and django customizations used throughout
`Department of Parks and Wildlife <http://dpaw.wa.gov.au/>`_.

Swingers provides a number of convenience functions to assist developers in
managing permissions and authorisation across your application.


Feature Support
===============

django-swingers' feature list:

- Audit model implements revision control and tracks creation / modification
- An LDAP backend to support DPaW users
- Authentication middleware to handle user authorisation
- Widgets for various map views
- Admin integration for the Audit model
- Abstract models to handle GIS.
- Base settings for all projects.
- Utility methods to handle GeoJSON, breadcrumbs and more.
- A set of custom base templates.
- A custom :class:`~django.db.models.FileField` for restricting
  uploaded files to certain content types.
- A *post_syncdb* hook that adds *view_** permission for all *content_types*.


User Guide
==========

This part of the documentation focuses on getting the user up to speed with
what's available as part of django-swingers and how to get the most out of it.
The section is divided into submodules based on the swingers.* submodules.

.. toctree::
   :maxdepth: 2

   user/intro
   user/install
   user/quickstart

   user/admin
   user/auth
   user/base
   user/bin
   user/conf
   user/forms
   user/geo
   user/management
   user/middleware
   user/models
   user/templates
   user/templatetags
   user/utils
   user/views


Contributor Guide
=================

If you want to contribute to the project, this part of the documentation is for
you.

.. toctree::
   :maxdepth: 1

   dev/contribute
   dev/todo
   dev/changelog
   dev/authors
