docs/usage.txt

   1 How to use linaro-django-pagination
   2 ----------------------------
   3
   4 ``linaro-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 under
  30    the value TEMPLATE_CONTEXT_PROCESSORS::
  31
  32         ("django.core.context_processors.auth",
  33         "django.core.context_processors.debug",
  34         "django.core.context_processors.i18n",
  35         "django.core.context_processors.media",
  36         "django.core.context_processors.request")
  37
  38 4. Add this line at the top of your template to load the pagination tags:
  39
  40        {% load pagination_tags %}
  41
  42
  43 5. Decide on a variable that you would like to paginate, and use the
  44    autopaginate tag on that variable before iterating over it.  This could
  45    take one of two forms (using the canonical ``object_list`` as an example
  46    variable):
  47
  48        {% autopaginate object_list %}
  49
  50    This assumes that you would like to have the default 20 results per page.
  51    If you would like to specify your own amount of results per page, you can
  52    specify that like so:
  53
  54        {% autopaginate object_list 10 %}
  55
  56    Note that this replaces ``object_list`` with the list for the current page, so
  57    you can iterate over the ``object_list`` like you normally would.
  58
  59
  60 6. Now you want to display the current page and the available pages, so
  61    somewhere after having used autopaginate, use the paginate inclusion tag:
  62
  63        {% paginate %}
  64
  65    This does not take any arguments, but does assume that you have already
  66    called autopaginate, so make sure to do so first.
  67
  68
  69 That's it!  You have now paginated ``object_list`` and given users of the site
  70 a way to navigate between the different pages--all without touching your views.
  71
  72 Custom pagination templates
  73 ---------------------------
  74
  75 In order to override the default pagination template, declare a context variable
  76 named ``pagination_template`` set to the template name::
  77
  78     {% with 'pagination/blog/post.html' as pagination_template %}
  79         {% autopaginate posts pagesize %}
  80         {% paginate %}
  81     {% endwith %}
  82
  83 The default pagination template is contained in the ``pagination/default.html``
  84 file inside the distribution.
  85
  86 A Note About Uploads
  87 --------------------
  88
  89 It is important, when using linaro-django-pagination in conjunction with file uploads,
  90 to be aware of when ``request.page`` is accessed.  As soon as ``request.page``
  91 is accessed, ``request.upload_handlers`` is frozen and cannot be altered in any
  92 way.  It's a good idea to access the ``page`` attribute on the request object
  93 as late as possible in your views.
  94
  95
  96 Optional Settings
  97 ------------------
  98
  99 In linaro-django-pagination, there are no required settings.  There are, however, a
 100 small set of optional settings useful for changing the default behavior of the
 101 pagination tags.  Here's an overview:
 102
 103 ``PAGINATION_DEFAULT_PAGINATION``
 104     The default amount of items to show on a page if no number is specified.
 105
 106 ``PAGINATION_DEFAULT_WINDOW``
 107     The number of items to the left and to the right of the current page to
 108     display (accounting for ellipses).
 109
 110 ``PAGINATION_DEFAULT_ORPHANS``
 111     The number of orphans allowed.  According to the Django documentation,
 112     orphans are defined as::
 113
 114         The minimum number of items allowed on the last page, defaults to zero.
 115
 116 ``PAGINATION_INVALID_PAGE_RAISES_404``
 117     Determines whether an invalid page raises an ``Http404`` or just sets the
 118     ``invalid_page`` context variable.  ``True`` does the former and ``False``
 119     does the latter.
 120
 121 ``DISPLAY_PAGE_LINKS``
 122     If set to ``False``, links for single pages will not be displayed.
 123
 124 ``PREVIOUS_LINK_DECORATOR``
 125     An HTML prefix for the previous page link; the default value is ``&lsaquo;&lsaquo; ``.
 126
 127 ``NEXT_LINK_DECORATOR``
 128     An HTML postfix for the next page link; the default value is `` &rsaquo;&rsaquo;``.
 129
 130 ``DISPLAY_DISABLED_PREVIOUS_LINK``
 131     If set to ``False``, the previous page link will not be displayed if there's
 132     no previous page.
 133
 134 ``DISPLAY_DISABLED_NEXT_LINK``
 135     If set to ``False``, the next page link will not be displayed if there's no
 136     next page.