6 How to use linaro-django-pagination
7 ===================================
9 ``linaro-django-pagination`` allows for easy Digg-style pagination without modifying
12 There are really 5 steps to setting it up with your projects (not including
13 installation, which is covered in :ref:`installation`.)
15 1. List this application in the ``INSTALLED_APPS`` portion of your settings
16 file. Your settings file might look something like::
20 'linaro_django_pagination',
24 2. Install the pagination middleware. Your settings file might look something
27 MIDDLEWARE_CLASSES = (
29 'linaro_django_pagination.middleware.PaginationMiddleware',
32 3. If it's not already added in your setup, add the request context processor.
33 Note that context processors are set by default implicitly, so to set them
34 explicitly, you need to copy and paste this code into your under
35 the value TEMPLATE_CONTEXT_PROCESSORS::
37 ("django.core.context_processors.auth",
38 "django.core.context_processors.debug",
39 "django.core.context_processors.i18n",
40 "django.core.context_processors.media",
41 "django.core.context_processors.request")
43 4. Add this line at the top of your template to load the pagination tags:
45 {% load pagination_tags %}
48 5. Decide on a variable that you would like to paginate, and use the
49 autopaginate tag on that variable before iterating over it. This could
50 take one of two forms (using the canonical ``object_list`` as an example
53 {% autopaginate object_list %}
55 This assumes that you would like to have the default 20 results per page.
56 If you would like to specify your own amount of results per page, you can
59 {% autopaginate object_list 10 %}
61 Note that this replaces ``object_list`` with the list for the current page, so
62 you can iterate over the ``object_list`` like you normally would.
64 If you are using template ``{% block %}`` tags, the autopaginate tag must
65 exist in the same ``{% block %}`` where you access the paginated
68 In general the full syntax is::
70 autopaginate QUERYSET [PAGINATE_BY] [ORPHANS] [as NAME]
73 6. Now you want to display the current page and the available pages, so
74 somewhere after having used autopaginate, use the paginate inclusion tag:
78 This does not require any arguments, but does assume that you have already
79 called autopaginate, so make sure to do so first.
82 That's it! You have now paginated ``object_list`` and given users of the site
83 a way to navigate between the different pages--all without touching your views.
85 Custom pagination templates
86 ===========================
88 By default the objects will be paginated using a helper template
89 "pagination/pagination.html". You can change this with an argument to
92 In general the full syntax is::
94 paginate [using "TEMPLATE"]
96 For example, to paginate posts on a hypothetical blog page you could use
99 {% autopaginate posts pagesize %}
100 {% paginate using "pagination/blog/post.html" %}
102 The default pagination template is contained in the
103 ``pagination/pagination.html`` file inside the distribution. You could extend
104 it and only customize the parts you care about. Please inspect the template to
105 see the blocks it defines that you could customize.
108 Multiple paginations per page
109 =============================
111 You can use autopaginate/paginate multiple times in the same template. The only
112 requirement is to call autopaginate before calling paginate. That is, paginate
113 acts on the most recent call to autopaginate.
119 It is important, when using linaro-django-pagination in conjunction with file
120 uploads, to be aware of when ``request.page`` is accessed. As soon as
121 ``request.page`` is accessed, ``request.upload_handlers`` is frozen and cannot
122 be altered in any way. It's a good idea to access the ``page`` attribute on
123 the request object as late as possible in your views.
129 In linaro-django-pagination, there are no required settings. There are,
130 however, a small set of optional settings useful for changing the default
131 behavior of the pagination tags. Here's an overview:
133 ``PAGINATION_DEFAULT_PAGINATION``
134 The default amount of items to show on a page if no number is specified.
137 ``PAGINATION_DEFAULT_WINDOW``
138 The number of items to the left and to the right of the current page to
139 display (accounting for ellipses). Defaults to 4.
141 ``PAGINATION_DEFAULT_MARGIN``
142 FIXME: This needs to be documented.
144 ``PAGINATION_DEFAULT_ORPHANS``
145 The number of orphans allowed. According to the Django documentation,
146 orphans are defined as::
148 The minimum number of items allowed on the last page, defaults to zero.
150 ``PAGINATION_INVALID_PAGE_RAISES_404``
151 Determines whether an invalid page raises an ``Http404`` or just sets the
152 ``invalid_page`` context variable. ``True`` does the former and ``False``
153 does the latter. Defaults to False
155 ``PAGINATION_DISPLAY_PAGE_LINKS``
156 If set to ``False``, links for single pages will not be displayed. Defaults to True.
158 ``PAGINATION_PREVIOUS_LINK_DECORATOR``
159 An HTML prefix for the previous page link; the default value is ``‹‹``.
161 ``PAGINATION_NEXT_LINK_DECORATOR``
162 An HTML postfix for the next page link; the default value is ``››``.
164 ``PAGINATION_DISPLAY_DISABLED_PREVIOUS_LINK``
165 If set to ``False``, the previous page link will not be displayed if there's
166 no previous page. Defaults to False.
168 ``PAGINATION_DISPLAY_DISABLED_NEXT_LINK``
169 If set to ``False``, the next page link will not be displayed if there's no
170 next page. Defaults to False.
172 ``PAGINATION_DISABLE_LINK_FOR_FIRST_PAGE``
173 if set to ``False``, the first page will have ``?page=1`` link suffix in pagination displayed, otherwise is omitted.