Use a template include for extra_nav

Author: Rebecca Lovewell

docs/settings.rst

@@ -4,47 +4,6 @@ Settings
 All django-timepiece settings are optional. Default values are given in
 ``timepiece.defaults`` and can be overriden in your project's settings.
 
-.. _TIMEPIECE_EXTRA_NAV:
-
-TIMEPIECE_EXTRA_NAV
--------------------
-
-:Default: ``{}``
-
-This is an optional setting that is used to add extra navigation items to the
-global navigation bar displayed at the top of each django-timepiece page. The
-setting uses `Twitter Bootstrap's <http://twitter.github.com/bootstrap/>`_
-dropdown navigation. The setting can be declared as follows:
-
-    .. code-block:: python
-
-        TIMEPIECE_EXTRA_NAV = {
-            'Dropdown Text': [
-                ('named_url_1', 'Dropdown Item #1',),
-                ('named_url_2', 'Dropdown Item #2',),
-            ], ...
-        }
-
-For example, the following would add a "Paste Bin" dropdown menu with the two
-links "Make a Paste" and "View my Pastes" as menu items in that dropdown.
-
-    .. code-block:: python
-
-        TIMEPIECE_EXTRA_NAV = {
-            'Paste Bin': [
-                ('create_paste_view', 'Make a Paste',),
-                ('user_paste_view', 'View my Pastes',),
-            ],
-        }
-
-You can add as many menu items as you wish and are only limited by the space
-available in the navigation bar. Any navigation item that you add will appear
-following the django-timepiece related navigation items.
-
-Note: To take advantage of this feature, you must have the context processor
-`timepiece.context_processors.extra_nav` listed in Django's
-`TEMPLATE_CONTEXT_PROCESSORS` setting.
-
 .. _TIMEPIECE_DEFAULT_LOCATION_SLUG:
 
 TIMEPIECE_DEFAULT_LOCATION_SLUG

example_project/settings/base.py

@@ -94,7 +94,6 @@
     'django.contrib.messages.context_processors.messages',
     'django.core.context_processors.request',
     'timepiece.context_processors.quick_search',
-    'timepiece.context_processors.extra_nav',
     'timepiece.context_processors.quick_clock_in',
 )
 
@@ -172,5 +171,4 @@
 
 # django-timepiece settings
 TIMEPIECE_DEFAULT_LOCATION_SLUG = None
-TIMEPIECE_PROJECTS = {}
-EXTRA_NAV = {}
+TIMEPIECE_PAID_LEAVE_PROJECTS = {}

timepiece/context_processors.py

@@ -50,9 +50,3 @@ def quick_clock_in(request):
         'leave_projects': leave_projects,
         'work_projects': work_projects,
     }
-
-
-def extra_nav(request):
-    return {
-        'timepiece_extra_nav': utils.get_setting('TIMEPIECE_EXTRA_NAV'),
-    }

timepiece/defaults.py

@@ -3,8 +3,6 @@
 
 class TimepieceDefaults(object):
 
-    TIMEPIECE_EXTRA_NAV = {}
-
     TIMEPIECE_DEFAULT_LOCATION_SLUG = None
 
     TIMEPIECE_PAID_LEAVE_PROJECTS = {}

timepiece/templates/timepiece/extra_nav.html

@@ -0,0 +1,23 @@
+{% comment %}
+You can override this template to include extra, custom items in the timepiece
+navigation bar.
+We use Bootstrap styling so you can use both plain navigation items and
+dropdown navigation items.
+
+For example:
+
+<!-- A dropdown menu item. -->
+<li class="dropdown">
+    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Paste Bin <b class="caret"></b></a>
+    <ul class="dropdown-menu">
+        <li><a href="{% url 'create_paste' %}">Create Paste</a></li>
+        <li><a href="{% url 'list_pastes' %}">View Pastes</a></li>
+    </ul>
+</li>
+
+<!-- A plain menu item. -->
+<li>
+    <a href="http://example.com/">Example</a>
+</li>
+
+{% endcomment %}

timepiece/templates/timepiece/navigation.html

@@ -81,16 +81,7 @@
                         </li>
                     {% endif %}
 
-                    {% for name, links in timepiece_extra_nav.items %}
-                        <li class="dropdown">
-                            <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ name }} <b class="caret"></b></a>
-                            <ul class="dropdown-menu">
-                                {% for url_name, link_text in links %}
-                                    <li><a href="{% url url_name %}">{{ link_text }}</a></li>
-                                {% endfor %}
-                            </ul>
-                        </li>
-                    {% endfor %}
+                    {% include "timepiece/extra_nav.html" %}
                 </ul>
             {% endblock %}