Add a "namespace-subdivided" Django templates directory for the SoC
authorTodd Larsen <tlarsen@google.com>
Tue, 06 May 2008 19:25:37 +0000
changeset 3 962da9e1065d
parent 2 cc10e920ecea
child 4 1f3cf1c04d14
Add a "namespace-subdivided" Django templates directory for the SoC framework.
soc/templates/README.templates
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/soc/templates/README.templates	Tue May 06 19:25:37 2008 +0000
@@ -0,0 +1,18 @@
+Templates are placed in a "namespace" subdirectory in the templates directory,
+since the templates directory will be added to the Django templates search
+path.  This allows other packages to extend existing templates without "hiding"
+the original template.  For example, a template in another Melange application
+can extend a template in the SoC framework like this:
+
+  {% extends 'soc/some_existing_template.html %}
+
+without "hiding" the some_existing_template.html for other uses, even if the
+derived template is also named some_existing_template.html.
+
+So, please do not put any templates in this soc/templates directory, but only
+place them in the soc/templates/soc "namespace" subdirectory.
+
+Different Melange applications should also follow this pattern, to promote
+sharing of templates between applications as well.  For exmample, the GSoC
+Melange application should place its templates in gsoc/templates/gsoc.
+