Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New features Django Paginator #30

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
How to use django-pagination
----------------------------

``django-pagination`` allows for easy Digg-style pagination without modifying
your views.

There are really 5 steps to setting it up with your projects (not including
installation, which is covered in INSTALL.txt in this same directory.)

1. List this application in the ``INSTALLED_APPS`` portion of your settings
file. Your settings file might look something like::

INSTALLED_APPS = (
# ...
'pagination',
)


2. Install the pagination middleware. Your settings file might look something
like::

MIDDLEWARE_CLASSES = (
# ...
'pagination.middleware.PaginationMiddleware',
)

3. If it's not already added in your setup, add the request context processor.
Note that context processors are set by default implicitly, so to set them
explicitly, you need to copy and paste this code into your under
the value TEMPLATE_CONTEXT_PROCESSORS::

("django.core.context_processors.auth",
"django.core.context_processors.debug",
"django.core.context_processors.i18n",
"django.core.context_processors.media",
"django.core.context_processors.request")

4. Add this line at the top of your template to load the pagination tags:

{% load pagination_tags %}


5. Decide on a variable that you would like to paginate, and use the
autopaginate tag on that variable before iterating over it. This could
take one of two forms (using the canonical ``object_list`` as an example
variable):

{% autopaginate object_list %}

This assumes that you would like to have the default 20 results per page.
If you would like to specify your own amount of results per page, you can
specify that like so:

{% autopaginate object_list 10 %}

Note that this replaces ``object_list`` with the list for the current page, so
you can iterate over the ``object_list`` like you normally would.


6. Now you want to display the current page and the available pages, so
somewhere after having used autopaginate, use the paginate inclusion tag:

{% paginate %}

This does not take any arguments, but does assume that you have already
called autopaginate, so make sure to do so first.


That's it! You have now paginated ``object_list`` and given users of the site
a way to navigate between the different pages--all without touching your views.


A Note About Uploads
--------------------

It is important, when using django-pagination in conjunction with file uploads,
to be aware of when ``request.page`` is accessed. As soon as ``request.page``
is accessed, ``request.upload_handlers`` is frozen and cannot be altered in any
way. It's a good idea to access the ``page`` attribute on the request object
as late as possible in your views.


Optional Settings
------------------

In django-pagination, there are no required settings. There are, however, a
small set of optional settings useful for changing the default behavior of the
pagination tags. Here's an overview:

``PAGINATION_DEFAULT_TOTAL``
The default amount of items to show on a page if no number is specified.

``PAGINATION_DEFAULT_WINDOW``
The number of items to the left and to the right of the current page to
display (accounting for ellipses).

``PAGINATION_DEFAULT_ORPHANS``
The number of orphans allowed. According to the Django documentation,
orphans are defined as::

The minimum number of items allowed on the last page, defaults to zero.

``PAGINATION_INVALID_PAGE_RAISES_404``
Determines whether an invalid page raises an ``Http404`` or just sets the
``invalid_page`` context variable. ``True`` does the former and ``False``
does the latter.
Binary file added pagination/locale/ca/LC_MESSAGES/django.mo
Binary file not shown.
27 changes: 27 additions & 0 deletions pagination/locale/ca/LC_MESSAGES/django.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2009-03-16 16:26+0100\n"
"PO-Revision-Date: 2011-12-22 11:25+0100\n"
"Last-Translator: Raimon Esteve <[email protected]>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: templates/pagination/pagination.html:5
#: templates/pagination/pagination.html:7
msgid "previous"
msgstr "Anterior"

#: templates/pagination/pagination.html:21
#: templates/pagination/pagination.html:23
msgid "next"
msgstr "Següent"

Binary file added pagination/locale/es/LC_MESSAGES/django.mo
Binary file not shown.
27 changes: 27 additions & 0 deletions pagination/locale/es/LC_MESSAGES/django.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2009-03-16 16:26+0100\n"
"PO-Revision-Date: 2011-12-22 11:26+0100\n"
"Last-Translator: Raimon Esteve <[email protected]>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: templates/pagination/pagination.html:5
#: templates/pagination/pagination.html:7
msgid "previous"
msgstr "Anterior"

#: templates/pagination/pagination.html:21
#: templates/pagination/pagination.html:23
msgid "next"
msgstr "Siguiente"

6 changes: 4 additions & 2 deletions pagination/templatetags/pagination_tags.py
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

register = template.Library()

DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_PAGINATION', 20)
DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_TOTAL', 9) # aka PAGINATION_DEFAULT_PAGINATION
DEFAULT_WINDOW = getattr(settings, 'PAGINATION_DEFAULT_WINDOW', 4)
DEFAULT_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0)
INVALID_PAGE_RAISES_404 = getattr(settings,
Expand Down Expand Up @@ -82,7 +82,9 @@ def __init__(self, queryset_var, paginate_by=DEFAULT_PAGINATION,
def render(self, context):
key = self.queryset_var.var
value = self.queryset_var.resolve(context)
if isinstance(self.paginate_by, int):
if "paginator_option" in context: # User has defined how many items wants to see per page
paginate_by = context["paginator_option"]
elif isinstance(self.paginate_by, int):
paginate_by = self.paginate_by
else:
paginate_by = self.paginate_by.resolve(context)
Expand Down