Commit 742ff080 authored by Malcolm Tredinnick's avatar Malcolm Tredinnick
Browse files

[1.0.X] Fixed #9215 -- Added a view/template example of using pagination. 

Based on a patch from shacker and Matt Dennenbaum.

Backport of r9193 from trunk.


git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.0.X@9196 bcc190cf-cafb-0310-a4f2-bffc1f526a37
parent 4991aac2

AUTHORS

+1 −0
Original line number Diff line number Diff line
@@ -106,6 +106,7 @@ answer newbie questions, and generally made Django that much better: 
    Jason Davies (Esaj) <http://www.jasondavies.com/>

    Richard Davies <richard.davies@elastichosts.com>

    Alex Dedul

    Matt Dennenbaum

    deric@monowerks.com

    Max Derkachev <mderk@yandex.ru>

    Rajesh Dhawan <rajesh.dhawan@gmail.com>

docs/topics/pagination.txt

+83 −26
Original line number Diff line number Diff line
@@ -75,6 +75,63 @@ page:: 
    objects such as Django's ``QuerySet`` to use a more efficient ``count()``

    method when available.





Using ``Paginator`` in a view

==============================



Here's a slightly more complex example using :class:`Paginator` in a view to

paginate a queryset. We give both the view and the accompanying template to

show how you can display the results. This example assumes you have a

``Contacts`` model that has already been imported.



The view function looks like this::



    from django.core.paginator import Paginator, InvalidPage, EmptyPage



    def listing(request):

        contact_list = Contacts.objects.all()

        paginator = Paginator(contact_list, 25) # Show 25 contacts per page



        # Make sure page request is an int. If not, deliver first page.

        try:

            page = int(request.GET.get('page', '1'))

        except ValueError:

            page = 1



        # If page request (9999) is out of range, deliver last page of results.

        try:

            contacts = paginator.page(page)

        except (EmptyPage, InvalidPage):

            contacts = paginator.page(paginator.num_pages)



        return render_to_response('list.html', {"contacts": contacts})



In the template :file:`list.html`, you'll want to include navigation between

pages along with any interesting information from the objects themselves::



    {% for contact in contacts.object_list %}

        {# Each "contact" is a Contact model object. #}

        {{ contact.full_name|upper }}<br />

        ...

    {% endfor %}



    <div class="pagination">

        <span class="step-links">

            {% if contacts.has_previous %}

                <a href="?page={{ contacts.previous_page_number }}">previous</a>

            {% endif %}



            <span class="current">

                Page {{ contacts.number }} of {{ contacts.paginator.num_pages }}.

            </span>



            {% if contacts.has_next %}

                <a href="?page={{ contacts.next_page_number }}">next</a>

            {% endif %}

        </span>

    </div>





``Paginator`` objects

=====================