Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Display menus based on the HTML structure of the pages

Project Description
# djangocms-local-navigation

This package provides a DjangoCMS plugin that displays a menu based on the
structure of the current page. You can for example create a local menu that is
based on all the h2 elements on your page.

## Installation

`$ pip install djangocms-local-navigation`

Then add it to INSTALLED_APPS:

```python
INSTALLED_APPS = (
# ...
'djangocms_local_navigation',
)
```

Also add the plugin processor, which will add the `id` attributes to your
navigation elements, allowing you to actually linking to them:

```python
CMS_PLUGIN_PROCESSORS = (
# ...
'djangocms_local_navigation.cms_plugin_processors.patch_elements',
)
```

You should now be able to add the plugin "Local menu" to your pages.

## Configuration

### CMS_LOCAL_NAVIGATION_NAV_ELEMENTS

Default: `h2`

Defines which elements are used to create the local menu. This is a CSS
selector so if you want for example only elements with the class
`local-navigation-heading` to be included in the navigation you could use
`h2.local-navigation-heading`.

### CMS_LOCAL_NAVIGATION_XML_PARSER

Default: `None` (means automatic detection)

Defines which XML parser is used to add anchors to the elements and create the
menu. Refer to [the BeautifulSoup documentation](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#specifying-the-parser-to-use)
for more information. Be advised that [lxml has known issues with
mod_python](http://lxml.de/FAQ.html#my-program-crashes-when-run-with-mod-python-pyro-zope-plone)
and can cause your processes to hang.

## Development

To run the tests, use `./setup.py test`.
Release History

Release History

This version
History Node

1.4.1

History Node

1.4.0

History Node

1.3.2

History Node

1.3.1

History Node

1.3.0

History Node

1.2.1

History Node

1.2.0

History Node

1.0.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
djangocms_local_navigation-1.4.1-py2-none-any.whl (7.8 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Aug 28, 2017
djangocms-local-navigation-1.4.1.tar.gz (4.7 kB) Copy SHA256 Checksum SHA256 Source Aug 28, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting