X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/cc6dbd55a2af538657c288a709662b9c84949854..5da36a259abcc9fb76b736fc360560f0ff931640:/philo/contrib/shipherd/templatetags/shipherd.py?ds=inline
diff --git a/philo/contrib/shipherd/templatetags/shipherd.py b/philo/contrib/shipherd/templatetags/shipherd.py
index 508eace..1031d73 100644
--- a/philo/contrib/shipherd/templatetags/shipherd.py
+++ b/philo/contrib/shipherd/templatetags/shipherd.py
@@ -131,7 +131,7 @@ def recursenavigation(parser, token):
{% recursenavigation node "main" %}
-
- {{ navloop.item.text }}
+ {{ item.text }}
{% if item.get_children %}
{{ children }}
@@ -140,6 +140,22 @@ def recursenavigation(parser, token):
{% endrecursenavigation %}
+
+ .. note:: {% recursenavigation %} requires that the current :class:`HttpRequest` be present in the context as ``request``. The simplest way to do this is with the `request context processor`_. If this is installed with just the default template context processors, the entry in your settings file will look like this::
+
+ TEMPLATE_CONTEXT_PROCESSORS = (
+ # Defaults
+ "django.contrib.auth.context_processors.auth",
+ "django.core.context_processors.debug",
+ "django.core.context_processors.i18n",
+ "django.core.context_processors.media",
+ "django.core.context_processors.static",
+ "django.contrib.messages.context_processors.messages"
+ ...
+ "django.core.context_processors.request"
+ )
+
+ .. _request context processor: https://docs.djangoproject.com/en/dev/ref/templates/api/#django-core-context-processors-request
"""
bits = token.contents.split()
if len(bits) != 3:
@@ -155,6 +171,7 @@ def recursenavigation(parser, token):
@register.filter
def has_navigation(node, key=None):
+ """Returns ``True`` if the node has a :class:`.Navigation` with the given key and ``False`` otherwise. If ``key`` is ``None``, returns whether the node has any :class:`.Navigation`\ s at all."""
try:
nav = node.navigation
if key is not None:
@@ -169,6 +186,7 @@ def has_navigation(node, key=None):
@register.filter
def navigation_host(node, key):
+ """Returns the :class:`.Node` which hosts the :class:`.Navigation` which ``node`` has inherited for ``key``. Returns ``node`` if any exceptions are encountered."""
try:
return Navigation.objects.filter(node__in=node.get_ancestors(include_self=True), key=key).order_by('-node__level')[0].node
except: