{ "info": { "author": "Caktus Consulting Group", "author_email": "solutions@caktusgroup.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "django-crumbs\n=============\n\ndjango-crumbs is a pluggable Django app for adding breadcrumbs to your project.\n\nInstallation\n============\n\n1) Install django-crumbs with pip::\n\n pip install django-crumbs\n\n2) Add to your INSTALLED_APPS and run syncdb::\n\n INSTALLED_APPS = (\n ...,\n 'crumbs',\n )\n\nHow It Works\n============\n1) In each template, you'll need to use the add_crumb template tag to append items to the trail::\n\n # basic crumb without a link\n {% add_crumb 'People' %}\n # crumb with link\n {% add_crumb 'People' 'list_people' %}\n # crumb with link and args\n {% add_crumb person.name 'view_person' person.pk %}\n\n*Note:* no bread crumbs will be printed if only one call to add_crumb has been made.\n\nSetup\n=====\n\n1) In your base.html template, add something along the lines of the following code::\n \n
\n\n2) Now in each extended child template, simply add a new crumb to the trail in the breadcrumb block::\n \n {% block breadcrumb %}\n {{ block.super }}\n {% load breadcrumb_tags %}\n {% add_crumb 'People' 'list_people' %}\n {% endblock %}\n\nExample\n=======\n\n1) base.html::\n \n \n\n2) person/list.html::\n \n {% extends \"base.html\" %}\n {% block breadcrumb %}\n {{ block.super }}\n {% load breadcrumb_tags %}\n {% add_crumb 'People' 'list_people' %}\n {% endblock %}\n\n3) person/view.html::\n \n {% extends \"person/list.html\" %}\n {% block breadcrumb %}\n {{ block.super }}\n {% load breadcrumb_tags %}\n {% add_crumb person.name 'view_person' person.pk %}\n {% endblock %}\n \n\nDevelopment sponsored by `Caktus Consulting Group, LLC\n