Fixed #8962 -- Consistently support format and input_format in the various (individual, combined, split) date and time form fields and widgets.

Many thanks to Tai Lee for doing all the work here.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@10115 bcc190cf-cafb-0310-a4f2-bffc1f526a37

1 files changed, 46 insertions, 2 deletions

diff --git a/docs/ref/forms/widgets.txt b/docs/ref/forms/widgets.txt
index 364e664fc1..232a2acf0b 100644
--- a/docs/ref/forms/widgets.txt
+++ b/docs/ref/forms/widgets.txt
@@ -36,12 +36,49 @@ commonly used groups of widgets:
 
     File upload input: ``<input type='file' ...>``
 
+.. class:: DateInput
+
+    .. versionadded:: 1.1
+
+    Date input as a simple text box: ``<input type='text' ...>``
+
+    Takes one optional argument:
+    
+    .. attribute:: DateInput.format
+
+        The format in which this field's initial value will be displayed.
+
+    If no ``format`` argument is provided, the default format is ``'%Y-%m-%d'``.
+
 .. class:: DateTimeInput
 
     .. versionadded:: 1.0
 
     Date/time input as a simple text box: ``<input type='text' ...>``
 
+    Takes one optional argument:
+    
+    .. attribute:: DateTimeInput.format
+    
+        The format in which this field's initial value will be displayed.
+    
+    If no ``format`` argument is provided, the default format is ``'%Y-%m-%d %H:%M:%S'``.
+
+.. class:: TimeInput
+
+    Time input as a simple text box: ``<input type='text' ...>``
+
+    Takes one optional argument:
+    
+    .. attribute:: TimeInput.format
+    
+        The format in which this field's initial value will be displayed.
+    
+    If no ``format`` argument is provided, the default format is ``'%H:%M:%S'``.
+
+    .. versionchanged:: 1.1
+       The ``format`` argument was not supported in Django 1.0.
+
 .. class:: Textarea
 
     Text area: ``<textarea>...</textarea>``
@@ -91,8 +128,15 @@ commonly used groups of widgets:
 
 .. class:: SplitDateTimeWidget
 
-    Wrapper around two ``TextInput`` widgets: one for the date, and one for the
-    time.
+    Wrapper around two widgets: ``DateInput`` for the date, and ``TimeInput``
+    for the time.
+
+    Takes two optional arguments, ``date_format`` and ``time_format``, which
+    work just like the ``format`` argument for ``DateInput`` and ``TimeInput``.
+    
+    .. versionchanged:: 1.1
+       The ``date_format`` and ``time_format`` arguments were not supported in Django 1.0.
+
 
 Specifying widgets
 ------------------