From 73a6eb8ed08da2342baa7f4b4ed9b6743b5fb241 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Fri, 13 Oct 2006 14:26:08 +0000 Subject: [PATCH] Fixes #2384,#2566 -- Clarify the role that TEMPLATE_STRING_IF_INVALID plays in the template system, and the problems that can occur if it is used on a production site. git-svn-id: http://code.djangoproject.com/svn/django/trunk@3901 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/templates_python.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/templates_python.txt b/docs/templates_python.txt index 8129b209c7..a1d15811f8 100644 --- a/docs/templates_python.txt +++ b/docs/templates_python.txt @@ -212,6 +212,21 @@ template tags. If an invalid variable is provided to one of these template tags, the variable will be interpreted as ``None``. Filters are always applied to invalid variables within these template tags. +.. admonition:: For debug purposes only! + + While ``TEMPLATE_STRING_IF_INVALID`` can be a useful debugging tool, + it is a bad idea to turn it on as a 'development default'. + + Many templates, including those in the Admin site, rely upon the + silence of the template system when a non-existent variable is + encountered. If you assign a value other than ``''`` to + ``TEMPLATE_STRING_IF_INVALID``, you will experience rendering + problems with these templates and sites. + + Generally, ``TEMPLATE_STRING_IF_INVALID`` should only be enabled + in order to debug a specific template problem, then cleared + once debugging is complete. + Playing with Context objects ----------------------------