Ticket #16610: django-docs-topic-auth-templates-context.patch

docs/topics/auth.txt

@@ -954 +954 @@
 
         * ``title``: The string "Logged out", localized.
 
+        * ``site``: The current :class:`~django.contrib.sites.models.Site`,
+          according to the :setting:`SITE_ID` setting. If you don't have the
+          site framework installed, this will be set to an instance of
+          :class:`~django.contrib.sites.models.RequestSite`, which derives the
+          site name and domain from the current
+          :class:`~django.http.HttpRequest`.
+
+        * ``site_name``: An alias for ``site.name``. If you don't have the site
+          framework installed, this will be set to the value of
+          :attr:`request.META['SERVER_NAME'] <django.http.HttpRequest.META>`.
+          For more on sites, see :doc:`/ref/contrib/sites`.
+
 .. function:: logout_then_login(request[, login_url])
 
     Logs a user out, then redirects to the login page.
@@ -976 +988 @@
         * ``post_change_redirect``: The URL to redirect to after a successful
           password change.
 
-        * .. versionadded:: 1.2
+          .. versionadded:: 1.2
 
-          ``password_change_form``: A custom "change password" form which must
+        * ``password_change_form``: A custom "change password" form which must
           accept a ``user`` keyword argument. The form is responsible for
-          actually changing the user's password.
+          actually changing the user's password. Defaults to 
+          :class:`~django.contrib.auth.forms.PasswordChangeForm`.
 
-
     **Template context:**
 
-        * ``form``: The password change form.
+        * ``form``: The password change form (see ``password_change_form`` above).
 
 .. function:: password_change_done(request[, template_name])
 
@@ -1006 +1018 @@
     .. versionchanged:: 1.3
         The ``from_email`` argument was added.
 
+    .. versionchanged:: 1.4
+        Users flagged with an unusable password (see
+        :meth:`~django.contrib.auth.models.User.set_unusable_password()`
+        will not be able to request a password reset to prevent misuse
+        when using an external authentication source like LDAP.
+
     **Optional arguments:**
 
         * ``template_name``: The full name of a template to use for
@@ -1037 +1055 @@
 
     **Template context:**
 
-        * ``form``: The form for resetting the user's password.
+        * ``form``: The form (see ``password_reset_form`` above) for resetting the user's password.
 
-        .. versionchanged:: 1.4
-            Users flagged with an unusable password (see
-            :meth:`~django.contrib.auth.models.User.set_unusable_password()`
-            will not be able to request a password reset to prevent misuse
-            when using an external authentication source like LDAP.
+    **Email templates context:**
 
+        * ``email``: An alias for ``user.email``
+
+        * ``user``: The current :class:`~django.contrib.auth.models.User`,
+          according to the ``email`` form field. Only active users are selected
+          (``is_active == True``).
+
+        * ``site_name``: An alias for ``site.name``. If you don't have the site
+          framework installed, this will be set to the value of
+          :attr:`request.META['SERVER_NAME'] <django.http.HttpRequest.META>`.
+          For more on sites, see :doc:`/ref/contrib/sites`.
+
+        * ``domain``: An alias for ``site.domain``. If you don't have the site
+          framework installed, this will be set to the value of
+          ``request.get_host()``.
+
+        * ``protocol``: http or https 
+
+        * ``uid``: The user's id encoded in base 36. 
+        
+        * ``token``: Token to check that the password is valid.
+
+    Sample ``registration/password_reset_email.html`` (email body template):
+
+    .. code-block:: html+django
+
+        {% load url from future %}
+        Someone asked for password reset for email {{ email }}. Follow the link below:
+        {{ protocol}}://{{ site_name }}{% url 'auth_password_reset_confirm' uidb36=uid token=token %}
+
+    The same template context is used for subject template. Subject must be
+    single line plain text string.
+
+
 .. function:: password_reset_done(request[, template_name])
 
     The page shown after a user has been emailed a link to reset their
@@ -1065 +1112 @@
 
         * ``uidb36``: The user's id encoded in base 36. This will default to
           ``None``.
+
         * ``token``: Token to check that the password is valid. This will default to ``None``.
+
         * ``template_name``: The full name of a template to display the confirm
           password view. Default value is :file:`registration/password_reset_confirm.html`.
+
         * ``token_generator``: Instance of the class to check the password. This
           will default to ``default_token_generator``, it's an instance of
           ``django.contrib.auth.tokens.PasswordResetTokenGenerator``.
+
         * ``set_password_form``: Form that will be used to set the password.
-          This will default to ``SetPasswordForm``.
+          Defaults to :class:`~django.contrib.auth.forms.SetPasswordForm`
+
         * ``post_reset_redirect``: URL to redirect after the password reset
           done. This will default to ``None``.
 
+    **Template context:**
+
+        * ``form``: The form (see ``set_password_form`` above) for setting the new user's password.
+
+        * ``validlink``: Boolean, True if the link (combination of uidb36 and
+          token) is valid or unused yet.
+
 .. function:: password_reset_complete(request[,template_name])
 
    Presents a view which informs the user that the password has been