README

   1 About the fork
   2 --------------
   3
   4 This project is a fork of apparently dead "django-pagination" project
   5 originally written by 'Eric Florenzano'. It is maintained by the Linaro
   6 Validation/Infrastructure team. Latest releases can be found on launchpad and
   7 pypi.
   8
   9 We are in the process of deciding how to properly host and manage the project.
  10 Feel free to hop to #linaro on irc.freenode.net and ask either 'zyga' or
  11 'mwhudson' about this.
  12
  13
  14 Contributors
  15 ------------
  16
  17 We would like to welcome any and all contributors. Please use the pull request
  18 feature on github.
  19
  20
  21 How to use linaro-django-pagination
  22 -----------------------------------
  23
  24 ``linaro-django-pagination`` allows for easy Digg-style pagination without
  25 modifying your views.
  26
  27 There are really 5 steps to setting it up with your projects (not including
  28 installation, which is covered in INSTALL.txt in this same directory.)
  29
  30 1. List this application in the ``INSTALLED_APPS`` portion of your settings
  31    file.  Your settings file might look something like::
  32
  33        INSTALLED_APPS = (
  34            # ...
  35            'linaro_django_pagination',
  36        )
  37
  38
  39 2. Install the pagination middleware.  Your settings file might look something
  40    like::
  41
  42        MIDDLEWARE_CLASSES = (
  43            # ...
  44            'linaro_django_pagination.middleware.PaginationMiddleware',
  45        )
  46
  47 3. If it's not already added in your setup, add the request context processor.
  48    Note that context processors are set by default implicitly, so to set them
  49    explicitly, you need to copy and paste this code into your under
  50    the value TEMPLATE_CONTEXT_PROCESSORS::
  51
  52         ("django.core.context_processors.auth",
  53         "django.core.context_processors.debug",
  54         "django.core.context_processors.i18n",
  55         "django.core.context_processors.media",
  56         "django.core.context_processors.request")
  57
  58 4. Add this line at the top of your template to load the pagination tags:
  59
  60        {% load pagination_tags %}
  61
  62
  63 5. Decide on a variable that you would like to paginate, and use the
  64    autopaginate tag on that variable before iterating over it.  This could
  65    take one of two forms (using the canonical ``object_list`` as an example
  66    variable):
  67
  68        {% autopaginate object_list %}
  69
  70    This assumes that you would like to have the default 20 results per page.
  71    If you would like to specify your own amount of results per page, you can
  72    specify that like so:
  73
  74        {% autopaginate object_list 10 %}
  75
  76    Note that this replaces ``object_list`` with the list for the current page, so
  77    you can iterate over the ``object_list`` like you normally would.
  78
  79
  80 6. Now you want to display the current page and the available pages, so
  81    somewhere after having used autopaginate, use the paginate inclusion tag:
  82
  83        {% paginate %}
  84
  85    This does not take any arguments, but does assume that you have already
  86    called autopaginate, so make sure to do so first.
  87
  88
  89 That's it!  You have now paginated ``object_list`` and given users of the site
  90 a way to navigate between the different pages--all without touching your views.
  91
  92
  93 Optional Settings
  94 -----------------
  95
  96 In linaro-django-pagination, there are no required settings.  There are,
  97 however, a small set of optional settings useful for changing the default
  98 behavior of the pagination tags.  Here's an overview:
  99
 100 ``PAGINATION_DEFAULT_PAGINATION``
 101     The default amount of items to show on a page if no number is specified.
 102
 103 ``PAGINATION_DEFAULT_WINDOW``
 104     The number of items to the left and to the right of the current page to
 105     display (accounting for ellipses).
 106
 107 ``PAGINATION_DEFAULT_ORPHANS``
 108     The number of orphans allowed.  According to the Django documentation,
 109     orphans are defined as::
 110
 111         The minimum number of items allowed on the last page, defaults to zero.
 112
 113 ``PAGINATION_INVALID_PAGE_RAISES_404``
 114     Determines whether an invalid page raises an ``Http404`` or just sets the
 115     ``invalid_page`` context variable.  ``True`` does the former and ``False``
 116     does the latter.