doc/usage.rst

   1 .. _usage:
   2
   3 Usage
   4 *****
   5
   6 How to use linaro-django-pagination
   7 ===================================
   8
   9 ``linaro-django-pagination`` allows for easy Digg-style pagination without modifying
  10 your views.
  11
  12 There are really 5 steps to setting it up with your projects (not including
  13 installation, which is covered in INSTALL.txt in this same directory.)
  14
  15 1. List this application in the ``INSTALLED_APPS`` portion of your settings
  16    file.  Your settings file might look something like::
  17
  18        INSTALLED_APPS = (
  19            # ...
  20            'linaro_django_pagination',
  21        )
  22
  23
  24 2. Install the pagination middleware.  Your settings file might look something
  25    like::
  26
  27        MIDDLEWARE_CLASSES = (
  28            # ...
  29            'linaro_django_pagination.middleware.PaginationMiddleware',
  30        )
  31
  32 3. If it's not already added in your setup, add the request context processor.
  33    Note that context processors are set by default implicitly, so to set them
  34    explicitly, you need to copy and paste this code into your under
  35    the value TEMPLATE_CONTEXT_PROCESSORS::
  36
  37         ("django.core.context_processors.auth",
  38         "django.core.context_processors.debug",
  39         "django.core.context_processors.i18n",
  40         "django.core.context_processors.media",
  41         "django.core.context_processors.request")
  42
  43 4. Add this line at the top of your template to load the pagination tags:
  44
  45        {% load pagination_tags %}
  46
  47
  48 5. Decide on a variable that you would like to paginate, and use the
  49    autopaginate tag on that variable before iterating over it.  This could
  50    take one of two forms (using the canonical ``object_list`` as an example
  51    variable):
  52
  53        {% autopaginate object_list %}
  54
  55    This assumes that you would like to have the default 20 results per page.
  56    If you would like to specify your own amount of results per page, you can
  57    specify that like so:
  58
  59        {% autopaginate object_list 10 %}
  60
  61    Note that this replaces ``object_list`` with the list for the current page, so
  62    you can iterate over the ``object_list`` like you normally would.
  63
  64
  65 6. Now you want to display the current page and the available pages, so
  66    somewhere after having used autopaginate, use the paginate inclusion tag:
  67
  68        {% paginate %}
  69
  70    This does not take any arguments, but does assume that you have already
  71    called autopaginate, so make sure to do so first.
  72
  73
  74 That's it!  You have now paginated ``object_list`` and given users of the site
  75 a way to navigate between the different pages--all without touching your views.
  76
  77 Custom pagination templates
  78 ===========================
  79
  80 In order to override the default pagination template use the extended form of
  81 the ``paginate`` tag::
  82
  83     {% autopaginate posts pagesize %}
  84     {% paginate using "pagination/blog/post.html" %}
  85
  86 The default pagination template is contained in the
  87 ``pagination/pagination.html`` file inside the distribution.
  88
  89 A Note About Uploads
  90 ====================
  91
  92 It is important, when using linaro-django-pagination in conjunction with file
  93 uploads, to be aware of when ``request.page`` is accessed.  As soon as
  94 ``request.page`` is accessed, ``request.upload_handlers`` is frozen and cannot
  95 be altered in any way.  It's a good idea to access the ``page`` attribute on
  96 the request object as late as possible in your views.
  97
  98
  99 Optional Settings
 100 =================
 101
 102 In linaro-django-pagination, there are no required settings.  There are,
 103 however, a small set of optional settings useful for changing the default
 104 behavior of the pagination tags.  Here's an overview:
 105
 106 ``PAGINATION_DEFAULT_PAGINATION``
 107     The default amount of items to show on a page if no number is specified.
 108     Defaults to 20
 109
 110 ``PAGINATION_DEFAULT_WINDOW``
 111     The number of items to the left and to the right of the current page to
 112     display (accounting for ellipses). Defaults to 4.
 113
 114 ``PAGINATION_DEFAULT_MARGIN``
 115     FIXME: This needs to be documented.
 116
 117 ``PAGINATION_DEFAULT_ORPHANS``
 118     The number of orphans allowed.  According to the Django documentation,
 119     orphans are defined as::
 120
 121         The minimum number of items allowed on the last page, defaults to zero.
 122
 123 ``PAGINATION_INVALID_PAGE_RAISES_404``
 124     Determines whether an invalid page raises an ``Http404`` or just sets the
 125     ``invalid_page`` context variable.  ``True`` does the former and ``False``
 126     does the latter. Defaults to False
 127
 128 ``PAGINATION_DISPLAY_PAGE_LINKS``
 129     If set to ``False``, links for single pages will not be displayed. Defaults to True.
 130
 131 ``PAGINATION_PREVIOUS_LINK_DECORATOR``
 132     An HTML prefix for the previous page link; the default value is ``&lsaquo;&lsaquo;``.
 133
 134 ``PAGINATION_NEXT_LINK_DECORATOR``
 135     An HTML postfix for the next page link; the default value is ``&rsaquo;&rsaquo;``.
 136
 137 ``PAGINATION_DISPLAY_DISABLED_PREVIOUS_LINK``
 138     If set to ``False``, the previous page link will not be displayed if there's
 139     no previous page. Defaults to False.
 140
 141 ``PAGINATION_DISPLAY_DISABLED_NEXT_LINK``
 142     If set to ``False``, the next page link will not be displayed if there's no
 143     next page. Defaults to False.