Ticket #7166: 7166.patch

docs/generic_views.txt

@@ -816 +816 @@
 These values and lists are 1-based, not 0-based, so the first page would be
 represented as page ``1``. 
 
+When pagination is enabled, the following variables will be available within the template.
+
+**Pagination variables:**
+
+    * ``is_paginated``: A boolean specifying whether the results are paginated.
+
+    * ``results_per_page``: The number of objects per page (if paginated).
+
+    * ``has_next``: A boolean specifying whether there is a next page.
+
+    * ``has_previous``: A boolean specifying whether there is a previous page.
+
+    * ``page``: The current page number.
+
+    * ``next``: The next page number.
+
+    * ``previous``: The previous page name.
+
+    * ``pages``: The total number of pages.
+
+    * ``hits``: The total number of objects.
+
+    * ``last_on_page``: The result number of the last of object in the object_list (1-indexed).
+
+    * ``first_on_page``: The result number of the first object in the object_list (1-indexed).
+
+    * ``page_range``: A list of all page numbers (1-indexed).
+
 An example of the use of pagination can be found in the `object pagination`_
 example model.