Added directives and autodocumenters for template tags and filters in a custom extens...

[philo.git] / philo / templatetags / containers.py

diff --git a/philo/templatetags/containers.py b/philo/templatetags/containers.py
index c5fd445..e280e60 100644 (file)
--- a/philo/templatetags/containers.py
+++ b/philo/templatetags/containers.py
@@ -1,8 +1,13 @@
+"""
+The container template tags are automatically included as builtins if :mod:`philo` is an installed app.
+
+"""
+
 from django import template
 from django.conf import settings
-from django.utils.safestring import SafeUnicode, mark_safe
-from django.core.exceptions import ObjectDoesNotExist
 from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ObjectDoesNotExist
+from django.utils.safestring import SafeUnicode, mark_safe
 
 
 register = template.Library()
@@ -59,9 +64,15 @@ class ContainerNode(template.Node):
                return content
 
 
-def do_container(parser, token):
+@register.tag
+def container(parser, token):
        """
-       {% container <name> [[references <type>] as <variable>] %}
+       If a template using this tag is used to render a :class:`.Page`, that :class:`.Page` will have associated content which can be set in the admin interface. If a content type is referenced, then a :class:`.ContentReference` object will be created; otherwise, a :class:`.Contentlet` object will be created.
+       
+       Usage::
+       
+               {% container <name> [[references <app_label>.<model_name>] as <variable>] %}
+       
        """
        params = token.split_contents()
        if len(params) >= 2:
@@ -94,6 +105,3 @@ def do_container(parser, token):
                
        else: # error
                raise template.TemplateSyntaxError('"%s" template tag provided without arguments (at least one required)' % tag)
-
-
-register.tag('container', do_container)