Package: simple_paginator
django-simplepaginator======================django-simplepaginator is a small wrapper around the standard Django paginator. The goal ofdjango-simplepaginator is _not_ to replace the Django paginator with yet another kind of paginationinterface. It just simplifies the creation of a pagination and provides templates for columntitles and page navigation. It supports sorting and orphans.Installation------------Copy the simple_paginator folder to your project or install it into your pythonpath:# python setup.py installIf you use pip, you can also install it directly using the -e parameter:# pip install -e git://github.com/dbrgn/django-simplepaginator.git#egg=simple_paginatorThen add simple_paginator to your `INSTALLED_APPS` setting.Usage-----The SimplePaginator object accepts the following keyword arguments:* `request` -- The request object* `prefix` -- The prefix for the controls' css-class and for the GET parameters* `data` -- Elements to paginate* `columns` -- A tuple of tuples containing column name and key (default None)* `per_page` -- How many elements to display per page (default 20)* `orphans` -- Whether to move orphans to the previous page (default 1)In the view, use the `paginate()`-shortcutfunction to return pagination items. Remember that eachpagination on a page must have a distinct prefix.Columns can be marked as non-sortable by setting the sort key to `None`.### Example:```pythonfrom django.shortcuts import render_to_responseimport simple_paginatortry:objects = models.Example.objects.filter(id__lte=100)except ObjectDoesNotExist:objects = Noneprefix = 'itemlist'columns = (('Column1', 'modelfield1'),('Column2', 'modelfield2'),('Column3', None),)items, order, baseurl = simple_paginator.paginate(request, prefix, functions, columns)context = {'items': items,'prefix': prefix,'columns': columns,'order': order,'baseurl': baseurl}return render_to_response('template.html', context)```And in the template:```html<h1>Pagination demo</h1><p>This pagination shows all Example objects with an id <= 100.</p><div class="simple_paginator"><table>{% include 'simple_paginator/paginator_header.html' %}{% for item in items.object_list %}<tr class="{% cycle 'odd' 'even' %}"><td>{{ item.modelfield1 }}</td><td>{{ item.modelfield2 }}</td><td>{{ item.modelfield3 }}</td></tr>{% endfor %}</table>{% include 'simple_paginator/paginator_control.html' %}</div>```If the column/sorting feature is not used, some parts can be omitted:```html<h1>Pagination demo</h1><p>This pagination lists some items.</p><div class="simple_paginator">{% for item in items.object_list %}<div class="item">{{ item }}</div>{% endfor %}{% include 'simple_paginator/paginator_control.html' %}</div>```Customization-------------You can customize the paginator header and control templates by copying them to your projectfolder and editing them, or by adding completely new templates. They should be put in adirectory called "simple_paginator" inside your template folder.Please keep in mind that most of the control logic is done inside those templates, so be carefulchanging them.Changelog---------v0.3.0 (2013-08-21)- [bug] Removed `<div>` from `paginator_header.html` template (#1)v0.2.2 (2011-09-07)- [add] Feature to mark columns as non-sortablev0.2.1 (2011-08-30)- [bug] Fixed compatibility with Python 2.5v0.2 (2011-08-26)- [add] Published django-simplepaginator on Github- [bug] Fixed critical bugs in view and templates- [bug] Fixed problems with setup.pyLicense-------Copyright 2011-2013 Danilo Bargen (http://dbrgn.ch/)This program is free software: you can redistribute it and/or modify it under the terms of the GNULesser General Public License as published by the Free Software Foundation, either version 3 of theLicense, or any later version.This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; withouteven the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU LesserGeneral Public License for more details.You should have received a copy of the GNU Lesser General Public License along with this program.If not, see http://www.gnu.org/licenses/lgpl.html.