Browse Source

Added a pagination example to ListView docs.

AK 7 years ago
parent
commit
3990d74018
2 changed files with 9 additions and 1 deletions
  1. 5 0
      docs/ref/class-based-views/generic-display.txt
  2. 4 1
      docs/topics/pagination.txt

+ 5 - 0
docs/ref/class-based-views/generic-display.txt

@@ -115,6 +115,7 @@ many projects they are typically the most commonly used views.
         class ArticleListView(ListView):
 
             model = Article
+            paginate_by = 100  # if pagination is desired
 
             def get_context_data(self, **kwargs):
                 context = super().get_context_data(**kwargs)
@@ -144,6 +145,10 @@ many projects they are typically the most commonly used views.
         {% endfor %}
         </ul>
 
+    If you're using pagination, you can adapt the :ref:`example template from
+    the pagination docs <using-paginator-in-view>`. Change instances of
+    ``contacts`` in that example template to ``page_obj``.
+
 .. class:: django.views.generic.list.BaseListView
 
     A base view for displaying a list of objects. It is not intended to be used

+ 4 - 1
docs/topics/pagination.txt

@@ -74,6 +74,7 @@ page::
     objects such as Django's ``QuerySet`` to use a more efficient ``count()``
     method when available.
 
+.. _using-paginator-in-view:
 
 Using ``Paginator`` in a view
 ==============================
@@ -97,7 +98,9 @@ The view function looks like this::
         return render(request, '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::
+pages along with any interesting information from the objects themselves:
+
+.. code-block:: html+django
 
     {% for contact in contacts %}
         {# Each "contact" is a Contact model object. #}