Merge branch '0.9.X' into develop
authorStephen Burrows <stephen.r.burrows@gmail.com>
Wed, 15 Jun 2011 21:55:14 +0000 (17:55 -0400)
committerStephen Burrows <stephen.r.burrows@gmail.com>
Wed, 15 Jun 2011 21:55:14 +0000 (17:55 -0400)
docs/tutorials/shipherd.rst
philo/contrib/shipherd/templatetags/shipherd.py
setup.py

index 3a62cb0..3454ef2 100644 (file)
@@ -3,7 +3,21 @@ Using Shipherd in the Admin
 
 The navigation mechanism is fairly complex; unfortunately, there's no real way around that - without a lot of equally complex code that you are quite welcome to write and contribute! ;-)
 
-For this guide, we'll assume that you have the setup described in :doc:`getting-started`. We'll be adding a main :class:`.Navigation` to the root :class:`.Node` and making it display as part of the :class:`.Template`. Before getting started, make sure that you've added :mod:`philo.contrib.shipherd` to your :setting:`INSTALLED_APPS`.
+For this guide, we'll assume that you have the setup described in :doc:`getting-started`. We'll be adding a main :class:`.Navigation` to the root :class:`.Node` and making it display as part of the :class:`.Template`.
+
+Before getting started, make sure that you've added :mod:`philo.contrib.shipherd` to your :setting:`INSTALLED_APPS`. :mod:`~philo.contrib.shipherd` template tags also require the request context processor, so make sure to set :setting:`TEMPLATE_CONTEXT_PROCESSORS` appropriately::
+
+       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"
+       )
 
 Creating the Navigation
 +++++++++++++++++++++++
@@ -19,7 +33,7 @@ Displaying the Navigation
 
 All you need to do now is show the navigation in the template! This is quite easy, using the :ttag:`~philo.contrib.shipherd.templatetags.shipherd.recursenavigation` templatetag. For now we'll keep it simple. Adjust the "Hello World Template" to look like this::
        
-       <html>
+       <html>{% load shipherd %}
            <head>
                <title>{% container page_title %}</title>
            </head>
@@ -29,7 +43,7 @@ All you need to do now is show the navigation in the template! This is quite eas
                        <li{% if navloop.active %} class="active"{% endif %}>
                            {{ item.text }}
                        </li>
-                   {% endnavigation %}
+                   {% endrecursenavigation %}
                </ul>
                {% container page_body as content %}
                {% if content %}
index 85a0bc5..1031d73 100644 (file)
@@ -140,6 +140,22 @@ def recursenavigation(parser, token):
                        </li>
                    {% endrecursenavigation %}
                </ul>
+       
+       .. 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:
index f33d211..8f13ea5 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -44,7 +44,7 @@ setup(
        version = '.'.join([str(v) for v in version]),
        url = "http://philocms.org/",
        description = "A foundation for developing web content management systems.",
-       long_description = open(os.path.join(root_dir, 'README.markdown')).read(),
+       long_description = open(os.path.join(root_dir, 'README')).read(),
        maintainer = "iThink Software",
        maintainer_email = "contact@ithinksw.com",
        packages = packages,