From 179dd8aed7b1aad1a468d0931320b2510bc9b865 Mon Sep 17 00:00:00 2001 From: staticdev Date: Wed, 13 May 2020 15:03:41 -0300 Subject: [PATCH] Fixed RST --- README.rst | 110 ++++++++++++++++++++++++++++++++--------------------- 1 file changed, 66 insertions(+), 44 deletions(-) diff --git a/README.rst b/README.rst index c6e4ad9..79d42bc 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,9 @@ +=========================== +django-pagination-bootstrap +=========================== + +.. badges-begin + |Travis| |Python Version| |PyPi| |Black| .. |Travis| image:: https://api.travis-ci.org/staticdev/django-pagination-bootstrap.svg?branch=master @@ -14,90 +20,106 @@ :target: https://github.com/psf/black :alt: Black -django-pagination-bootstrap -=========================== - Django-pagination-bootstrap is an app to easy add pagination in Django_, using `Bootstrap`_'s layout. Note: This library currently works with Python 3.6+, Django 2.0+ and Bootstrap 3+. For older versions, please use version 1.3.0. Installation ------------- +============ + +To install ``django-pagination-bootstrap`` simply run: -To install ``django-pagination-bootstrap`` simply run:: +.. code:: console - pip install django-pagination-bootstrap + pip install django-pagination-bootstrap Configuration -------------- +============= We need to hook ``django-pagination-bootstrap`` into our project. -1. Put ``django-pagination-bootstrap`` into your ``INSTALLED_APPS`` at settings module:: +1. Put ``django-pagination-bootstrap`` into your ``INSTALLED_APPS`` at settings module: - INSTALLED_APPS = ( - ... - 'django-pagination_bootstrap', - ) +.. code-block:: python -2. Install the pagination middleware. Your settings file might look something like:: + INSTALLED_APPS = ( + # other apps + "django-pagination_bootstrap", + ) - MIDDLEWARE_CLASSES = ( - ... - 'django_pagination_bootstrap.middleware.PaginationMiddleware', - ) +2. Install the pagination middleware. Your settings file might look something like: + +.. code-block:: python + + MIDDLEWARE_CLASSES = ( + # other middleware + "django_pagination_bootstrap.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. - TEMPLATES = [ - { - "BACKEND": "django.template.backends.django.DjangoTemplates", - "DIRS": [], - "APP_DIRS": True, - "OPTIONS": { - "context_processors": [ - "django.template.context_processors.debug", - "django.template.context_processors.request", - "django.contrib.auth.context_processors.auth", - "django.template.context_processors.i18n", - "django.template.context_processors.media", - ], - }, - }, - ] +.. code-block:: python + + TEMPLATES = [ + { + "BACKEND": "django.template.backends.django.DjangoTemplates", + "DIRS": [], + "APP_DIRS": True, + "OPTIONS": { + "context_processors": [ + "django.template.context_processors.debug", + "django.template.context_processors.request", + "django.contrib.auth.context_processors.auth", + "django.template.context_processors.i18n", + "django.template.context_processors.media", + ], + }, + }, + ] + +4. Add this line at the top of your template to load the pagination tags: + +.. code-block:: python -4. Add this line at the top of your template to load the pagination tags:: + {% load 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): -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):: +.. code-block:: python - {% autopaginate object_list %} + {% 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:: +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 %} +.. code-block:: python + + {% 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. If you are using Bootstrap 3, use the paginate inclusion tag:: +6. Now you want to display the current page and the available pages, so somewhere after having used autopaginate. If you are using Bootstrap 3, use the paginate inclusion tag: + +.. code-block:: python - {% paginate %} + {% 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. Side effects ------------- +============ + A django-paginator_ instance will be injected in the template context as ``paginator``. You can access it as usual:: +.. code-block:: python + page {{ page }} of {{ paginator.num_pages }} 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: @@ -120,7 +142,7 @@ 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. Credits ------------- +======= This is based on Eric Florenzano's django-pagination 1.0.7 and is an updated version of https://github.com/tgdn/django-bootstrap-pagination for Django 1.7 or higher.