X-Git-Url: https://git.mdrn.pl/django-pagination.git/blobdiff_plain/0e2359471fefbd58afb7914302b5d3586d262b7b..3d85d2e674e7019ed585d31adddec6346afa7ec7:/docs/index.html diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index d838d18..0000000 --- a/docs/index.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - -How to use django-pagination - - - -
-

How to use django-pagination

-

django-pagination allows for easy Digg-style pagination without modifying -your views.

-

There are really 5 steps to setting it up with your projects (not including -installation, which is covered in INSTALL.txt in this same directory.)

-
    -
  1. List this application in the INSTALLED_APPS portion of your settings -file. Your settings file might look something like:

    -
    -INSTALLED_APPS = (
    -    # ...
    -    'pagination',
    -)
    -
    -
  2. -
  3. Install the pagination middleware. Your settings file might look something -like:

    -
    -MIDDLEWARE_CLASSES = (
    -    # ...
    -    'pagination.middleware.PaginationMiddleware',
    -)
    -
    -
  4. -
  5. Add this line at the top of your template to load the pagination tags:

    -
    -

    {% load pagination_tags %}

    -
    -
  6. -
  7. 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):

    -
    -

    {% 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:

    -
    -

    {% 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.

    -
  8. -
  9. Now you want to display the current page and the available pages, so -somewhere after having used autopaginate, use the paginate inclusion tag:

    -
    -

    {% paginate %}

    -
    -

    This does not take any arguments, but does assume that you have already -called autopaginate, so make sure to do so first.

    -
  10. -
-

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.

-
- - \ No newline at end of file