https://github.com/marcuswhybrow/django-lineage

Lightweight template tags for neater hierarchical navigation
https://github.com/marcuswhybrow/django-lineage

Last synced: 27 days ago
JSON representation

Lightweight template tags for neater hierarchical navigation

• Host: GitHub
• URL: https://github.com/marcuswhybrow/django-lineage
• Owner: marcuswhybrow
• License: bsd-3-clause
• Created: 2013-04-11T12:43:48.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-08-13T09:49:00.000Z (over 9 years ago)
• Last Synced: 2024-11-11T23:54:36.196Z (about 1 month ago)
• Language: Python
• Homepage: https://pypi.python.org/pypi/django-lineage/
• Size: 300 KB
• Stars: 34
• Watchers: 6
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Django Lineage

==============

Which navigation element is "active" in a template? Lineage determines a navigation element's state by inspecting the page URL:

    {% load lineage %}

    


        
Home

        
Blog

        
About

    


If the argument of `ancestor` matches the start of the URL (e.g. this nav element is at least a parent of this page), it outputs "active". **It's that simple!**

Installation

------------

Install using pip:

    pip install django-lineage

Add `'lineage'` to `INSTALLED_APPS` in `settings.py`:

    INSTALLED_APPS = (

        'lineage',

    )

Usage

-----

The `ancestor` tag needs to, of course, be loaded into your template:

    {% load lineage %}

The first way to use Lineage is the aformentioned `ancestor` tag. Again if the argument matches the start of the page URL it outputs "active", this should handle most use cases:

    {% ancestor '/arbitrary/path/' %}

`ancestor` can also handle variables, filters and all that stuff:

    {% ancestor some_variable|somefilter %}

Most importantly it also accepts `url` tag type reverse resolution (Behind the scenes the `url` tag derives our expected argument - a URL path string.)

    {% ancestor 'core:model_detail' model.pk %}

### Output Defaults to "active"

By default `ancestor` outputs "active" on a match. You can alter this default by adding `LINEAGE_ANCESTOR_PHRASE = 'newphrase'` to `settings.py`

### Overring Output

Override output on demand using the `ifancestor/endifancestor` combo:

    {% ifancestor 'pattern_name' %}

        This text here is only renderd if the

        URL argument is an ancestor.

    {% endifancestor %}

Assumptions

-----------

Lineage depends on sensible URL hierarchies, because it compares paths using regex matching. `{% ancestor '/base/' %}` will fire if the current URL begins with `/base/`. For example `/base/` and `/base/section/page/` return true, but `/other/path/` and `/base` (missing trailing slash) will not.

`request` must be present in the request context, since it's used to determine the current URL. Django has [a context preprocessor][1] that can insert it for you.

[1]: https://docs.djangoproject.com/en/dev/ref/templates/api/#django-core-context-processors-request

Similar Alternatives

--------------------

* [Django Menus][django-menus]

[django-menus]: https://bitbucket.org/schinckel/django-menus/overview