Changeset 6057

Timestamp:

12 May 2011, 01:46:03 (13 years ago)

Author:

uli

Message:

Add more docs.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/widgets/datewidget.py (modified) (2 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/widgets/datewidget.py

@@ -72 +72 @@
 
 #: A dictionary of supported date formats.
+#:
+#: The following formats are supported:
+#:
+#: ``iso``
+#:    ISO format ``YYYY-MM-DD``
+#: ``le``
+#:    little endian with slashes: ``DD/MM/YYYY``
+#: ``de``
+#:    german date format: ``DD.MM.YYYY``
+#: ``us``
+#:    middle endian format common in the U.S.: ``MM/DD/YYYY``
+#:
+#: Furthermore we support for input widgets an additional year
+#: marker. Input date widgets with this marker provide also a year
+#: selector, handy for dates of birth etc.
+#:
+#: The year-supporting formats are similar to the basic versions above:
+#:
+#: ``iso-year``
+#:    ISO format ``YYYY-MM-DD``
+#: ``le-year``
+#:    little endian with slashes: ``DD/MM/YYYY``
+#: ``de-year``
+#:    german date format: ``DD.MM.YYYY``
+#: ``us-year``
+#:    middle endian format common in the U.S.: ``MM/DD/YYYY``
+#:    
+#: For date display widgets there is naturally no difference between a
+#: year and non-year setting (you can for instance use 'le' or 'le-year'
+#: with the same output).
 DATE_FORMATS = {
-    'iso': ('datepicker', '%Y-%m-%d'),
-    'le':  ('datepicker-le', '%d/%m/%Y'),
-    'de':  ('datepicker-de', '%d.%m.%Y'),
-    'us':  ('datepicker-us', '%m/%d/%Y'),
-    'iso-year': ('datepicker-year', '%Y-%m-%d'),
-    'le-year':  ('datepicker-le-year', '%d/%m/%Y'),
-    'de-year':  ('datepicker-de-year', '%d.%m.%Y'),
-    'us-year':  ('datepicker-us-year', '%m/%d/%Y'),
+    'iso': ('datepicker', '%y-%m-%d'),
+    'le':  ('datepicker-le', '%d/%m/%y'),
+    'de':  ('datepicker-de', '%d.%m.%y'),
+    'us':  ('datepicker-us', '%m/%d/%y'),
+    'iso-year': ('datepicker-year', '%y-%m-%d'),
+    'le-year':  ('datepicker-le-year', '%d/%m/%y'),
+    'de-year':  ('datepicker-de-year', '%d.%m.%y'),
+    'us-year':  ('datepicker-us-year', '%m/%d/%y'),
     }
 def FriendlyDateWidget(format):
     """Get a friendly date input widget for `format`.
+
+    This widget is suitable for edit and add forms.
+    
+    Valid `format` values are the keys of :var:`DATE_FORMATS`
+    dict. Default is ``le`` (little endian; DD/MM/YYYY).
+
+    Friendly date widgets are rendered with a specialized CSS tag for
+    enabling JavaScript datepickers.
     """
     css_class, date_format = DATE_FORMATS.get(format, DATE_FORMATS['le'])
@@ -93 +131 @@
 def FriendlyDateDisplayWidget(format):
     """Get a friendly date display widget for `format`.
+
+    This widget is suitable for display forms.
+    
+    Valid `format` values are the keys of :var:`DATE_FORMATS`
+    dict. Default is ``le`` (little endian; DD/MM/YYYY).
+
+    Friendly date widgets are rendered with a specialized CSS tag for
+    enabling JavaScript datepickers.
     """
     css_class, date_format = DATE_FORMATS.get(format, DATE_FORMATS['le'])