X-Git-Url: https://git.mdrn.pl/django-pagination.git/blobdiff_plain/946035aa30833df81bf6cb2ca307278c4a3f1962..2918ede7ab519905630f6a78389d5a613b0a814f:/doc/usage.rst diff --git a/doc/usage.rst b/doc/usage.rst index 804337f..a57cf46 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -60,6 +60,14 @@ installation, which is covered in :ref:`installation`.) 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. + + If you are using template ``{% block %}`` tags, the autopaginate tag must + exist in the same ``{% block %}`` where you access the paginated + ``object_list``. + + In general the full syntax is:: + + autopaginate QUERYSET [PAGINATE_BY] [ORPHANS] [as NAME] 6. Now you want to display the current page and the available pages, so @@ -67,7 +75,7 @@ installation, which is covered in :ref:`installation`.) {% paginate %} - This does not take any arguments, but does assume that you have already + This does not require any arguments, but does assume that you have already called autopaginate, so make sure to do so first. @@ -77,14 +85,33 @@ a way to navigate between the different pages--all without touching your views. Custom pagination templates =========================== -In order to override the default pagination template use the extended form of -the ``paginate`` tag:: +By default the objects will be paginated using a helper template +"pagination/pagination.html". You can change this with an argument to +``paginate``. + +In general the full syntax is:: + + paginate [using "TEMPLATE"] + +For example, to paginate posts on a hypothetical blog page you could use +something like this:: {% autopaginate posts pagesize %} {% paginate using "pagination/blog/post.html" %} The default pagination template is contained in the -``pagination/pagination.html`` file inside the distribution. +``pagination/pagination.html`` file inside the distribution. You could extend +it and only customize the parts you care about. Please inspect the template to +see the blocks it defines that you could customize. + + +Multiple paginations per page +============================= + +You can use autopaginate/paginate multiple times in the same template. The only +requirement is to call autopaginate before calling paginate. That is, paginate +acts on the most recent call to autopaginate. + A Note About Uploads ====================