From: Alan Hogan <contact@alanhogan.com>
Date: Thu, 12 May 2011 17:50:00 +0000 (-0700)
Subject: Describe redirections and the permanent argument
X-Git-Tag: v2.0.0~66^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=699318c837ea7727dbb8b03d81432b8b679a646d;p=thirdparty%2Ftornado.git

Describe redirections and the permanent argument
---

diff --git a/website/templates/documentation.txt b/website/templates/documentation.txt
index 31b313432..81f93c182 100644
--- a/website/templates/documentation.txt
+++ b/website/templates/documentation.txt
@@ -205,6 +205,23 @@ Other methods designed for overriding include:
  * `get_template_path(self)` - returns location of template files (default is
    in `Application` settings)
 
+### Redirection
+
+You can use `self.redirect` within a
+`RequestHandler` to redirect users elsewhere. 
+There is also an optional 
+parameter `permanent` which you can use to indicate
+that the redirection is considered permanent.  
+
+This triggers a `301 Moved Permanently` 
+HTTP status, which is useful for e.g.
+redirecting to a canonical URL for a page in an SEO-friendly manner.
+
+The default value of `permanent` is `False`, which is apt for things like redirecting
+users on successful POST requests.
+
+	self.redirect('/some-canonical-page', permanent=True)
+
 ### Templates
 
 You can use any template language supported by Python, but Tornado ships