README.rst

   1 How to use django-pagination
   2 ----------------------------
   3
   4 ``django-pagination`` allows for easy Digg-style pagination without modifying
   5 your views.
   6
   7 There are really 5 steps to setting it up with your projects (not including
   8 installation, which is covered in INSTALL.txt in this same directory.)
   9
  10 1. List this application in the ``INSTALLED_APPS`` portion of your settings
  11    file.  Your settings file might look something like::
  12
  13        INSTALLED_APPS = (
  14            # ...
  15            'pagination',
  16        )
  17
  18
  19 2. Install the pagination middleware.  Your settings file might look something
  20    like::
  21
  22        MIDDLEWARE_CLASSES = (
  23            # ...
  24            'pagination.middleware.PaginationMiddleware',
  25        )
  26
  27 3. If it's not already added in your setup, add the request context processor.
  28    Note that context processors are set by default implicitly, so to set them
  29    explicitly, you need to copy and paste this code into your settings::
  30
  31         ("django.core.context_processors.auth",
  32         "django.core.context_processors.debug",
  33         "django.core.context_processors.i18n",
  34         "django.core.context_processors.media",
  35         "django.core.context_processors.request")
  36
  37 4. Add this line at the top of your template to load the pagination tags:
  38
  39        {% load pagination_tags %}
  40
  41
  42 5. Decide on a variable that you would like to paginate, and use the
  43    autopaginate tag on that variable before iterating over it.  This could
  44    take one of two forms (using the canonical ``object_list`` as an example
  45    variable):
  46
  47        {% autopaginate object_list %}
  48
  49    This assumes that you would like to have the default 20 results per page.
  50    If you would like to specify your own amount of results per page, you can
  51    specify that like so:
  52
  53        {% autopaginate object_list 10 %}
  54
  55    Note that this replaces ``object_list`` with the list for the current page, so
  56    you can iterate over the ``object_list`` like you normally would.
  57
  58
  59 6. Now you want to display the current page and the available pages, so
  60    somewhere after having used autopaginate, use the paginate inclusion tag:
  61
  62        {% paginate %}
  63
  64    This does not take any arguments, but does assume that you have already
  65    called autopaginate, so make sure to do so first.
  66
  67
  68 That's it!  You have now paginated ``object_list`` and given users of the site
  69 a way to navigate between the different pages--all without touching your views.