Changed back from .rst to .txt to match Django's convention

[django-pagination.git] / README.txt

diff --git a/README.txt b/README.txt
index 0834d6c..1a86b09 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -8,7 +8,7 @@ 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:
+   file.  Your settings file might look something like::
    
        INSTALLED_APPS = (
            # ...
@@ -17,20 +17,30 @@ installation, which is covered in INSTALL.txt in this same directory.)
 
 
 2. Install the pagination middleware.  Your settings file might look something
-   like:
+   like::
    
        MIDDLEWARE_CLASSES = (
            # ...
            'pagination.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::
+   
+        ("django.core.context_processors.auth",
+        "django.core.context_processors.debug",
+        "django.core.context_processors.i18n",
+        "django.core.context_processors.media",
+        "django.core.context_processors.request")
 
-3. Add this line at the top of your template to load the pagination tags:
+4. Add this line at the top of your template to load the pagination tags:
 
        {% load pagination_tags %}
 
 
-4. Decide on a variable that you would like to paginate, and use the
+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):
@@ -47,7 +57,7 @@ installation, which is covered in INSTALL.txt in this same directory.)
    you can iterate over the ``object_list`` like you normally would.
    
 
-5. Now you want to display the current page and the available pages, so
+6. Now you want to display the current page and the available pages, so
    somewhere after having used autopaginate, use the paginate inclusion tag:
    
        {% paginate %}
@@ -57,4 +67,4 @@ installation, which is covered in INSTALL.txt in this same directory.)
 
 
 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
+a way to navigate between the different pages--all without touching your views.