From 3d85d2e674e7019ed585d31adddec6346afa7ec7 Mon Sep 17 00:00:00 2001 From: floguy Date: Mon, 20 Oct 2008 04:15:46 +0000 Subject: [PATCH] Moved docs into the docs directory. Also, added an index.txt useful for sphinx documentation. git-svn-id: https://django-pagination.googlecode.com/svn/trunk@35 7f1efe38-554e-0410-b69d-834cb44da2d5 --- docs/index.html | 352 -------------------------------- INSTALL.txt => docs/install.txt | 0 README.txt => docs/usage.txt | 0 3 files changed, 352 deletions(-) delete mode 100644 docs/index.html rename INSTALL.txt => docs/install.txt (100%) rename README.txt => docs/usage.txt (100%) 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. -

  2. Install the pagination middleware. Your settings file might look something -like:

    -
    -MIDDLEWARE_CLASSES = (
-    # ...
-    'pagination.middleware.PaginationMiddleware',
-)
-
    -
    3. -

  3. Add this line at the top of your template to load the pagination tags:

    -
    -

    {% load pagination_tags %}

    -
    -
    4. -

  4. 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.

    -
    5. -

  5. 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.

    -
    6. -
-

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 diff --git a/INSTALL.txt b/docs/install.txt similarity index 100% rename from INSTALL.txt rename to docs/install.txt diff --git a/README.txt b/docs/usage.txt similarity index 100% rename from README.txt rename to docs/usage.txt -- 2.45.2