From ba412401bcd900ab40a1ec0c2a390ddac330d533 Mon Sep 17 00:00:00 2001
From: melinath <stephen.r.burrows@gmail.com>
Date: Wed, 9 Jun 2010 13:35:23 -0400
Subject: [PATCH] Added documentation and help text to models.py and
 containers.py to hopefully improve usability.

---
 .gitignore                 |  3 +++
 models.py                  | 13 ++++++++++---
 templatetags/containers.py |  2 +-
 3 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/.gitignore b/.gitignore
index 0d20b64..5cde84d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,4 @@
 *.pyc
+*~
+*#
+TODO
diff --git a/models.py b/models.py
index cea36c2..b1da9d0 100644
--- a/models.py
+++ b/models.py
@@ -21,6 +21,7 @@ from django.template.loader_tags import ExtendsNode, ConstantIncludeNode, Includ
 from django.template.loader import get_template
 from django.http import Http404, HttpResponse, HttpResponseServerError, HttpResponseRedirect
 from django.core.servers.basehttp import FileWrapper
+from django.conf import settings
 
 
 def register_value_model(model):
@@ -261,7 +262,7 @@ class Redirect(Node):
 		(302, 'Temporary'),
 		(301, 'Permanent'),
 	)
-	target = models.URLField()
+	target = models.URLField(help_text='Must be a valid, absolute URL (i.e. http://)')
 	status_code = models.IntegerField(choices=STATUS_CODES, default=302, verbose_name='redirect type')
 	
 	def render_to_response(self, request, path=None, subpath=None):
@@ -285,8 +286,9 @@ class File(Node):
 class Template(TreeModel):
 	name = models.CharField(max_length=255)
 	documentation = models.TextField(null=True, blank=True)
-	mimetype = models.CharField(max_length=255, null=True, blank=True)
-	code = models.TextField()
+	mimetype = models.CharField(max_length=255, null=True, blank=True,
+	    help_text='Default: %s' % settings.DEFAULT_CONTENT_TYPE)
+	code = models.TextField(verbose_name='django template code')
 	
 	@property
 	def origin(self):
@@ -354,6 +356,11 @@ class Template(TreeModel):
 
 
 class Page(Node):
+	"""
+	Represents an HTML page. The page will have a number of related Contentlets
+	depending on the template selected - but these will appear only after the
+	page has been saved with that template.
+	"""
 	template = models.ForeignKey(Template, related_name='pages')
 	title = models.CharField(max_length=255)
 	
diff --git a/templatetags/containers.py b/templatetags/containers.py
index cc6b313..ad9bb1d 100644
--- a/templatetags/containers.py
+++ b/templatetags/containers.py
@@ -44,7 +44,7 @@ class ContainerNode(template.Node):
 
 def do_container(parser, token):
 	"""
-	{% container <name> [[references <type>] as <variable>] %}
+	{% container <name> [[references <type>] as <variable>] %} 
 	"""
 	params = token.split_contents()
 	if len(params) >= 2:
-- 
2.20.1