X-Git-Url: https://git.mdrn.pl/django-pagination.git/blobdiff_plain/3d85d2e674e7019ed585d31adddec6346afa7ec7..ed2e18624eb398e5bd9dcaa81105241c401c3203:/docs/usage.txt?ds=inline diff --git a/docs/usage.txt b/docs/usage.txt index 1a86b09..b520169 100644 --- a/docs/usage.txt +++ b/docs/usage.txt @@ -68,3 +68,39 @@ 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. + + +A Note About Uploads +-------------------- + +It is important, when using django-pagination in conjunction with file uploads, +to be aware of when ``request.page`` is accessed. As soon as ``request.page`` +is accessed, ``request.upload_handlers`` is frozen and cannot be altered in any +way. It's a good idea to access the ``page`` attribute on the request object +as late as possible in your views. + + +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: + +``PAGINATION_DEFAULT_PAGINATION`` + The default amount of items to show on a page if no number is specified. + +``PAGINATION_DEFAULT_WINDOW`` + The number of items to the left and to the right of the current page to + display (accounting for ellipses). + +``PAGINATION_DEFAULT_ORPHANS`` + The number of orphans allowed. According to the Django documentation, + orphans are defined as:: + + The minimum number of items allowed on the last page, defaults to zero. + +``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. \ No newline at end of file