Browse Source

[DOCS] Document all date formats (#21164)

Resolves #21046
Lee Hinman 9 years ago
parent
commit
6a8bad8a06
1 changed files with 15 additions and 12 deletions
  1. 15 12
      docs/reference/mapping/params/format.asciidoc

+ 15 - 12
docs/reference/mapping/params/format.asciidoc

@@ -147,17 +147,18 @@ The following tables lists all the defaults ISO formats supported:
 
 `date_hour` or `strict_date_hour`::
 
-    A formatter that combines a full date and two digit hour of day.
+    A formatter that combines a full date and two digit hour of day:
+    `yyyy-MM-dd'T'HH`.
 
 `date_hour_minute` or `strict_date_hour_minute`::
 
     A formatter that combines a full date, two digit hour of day, and two
-    digit minute of hour.
+    digit minute of hour: `yyyy-MM-dd'T'HH:mm`.
 
 `date_hour_minute_second` or `strict_date_hour_minute_second`::
 
     A formatter that combines a full date, two digit hour of day, two digit
-    minute of hour, and two digit second of minute.
+    minute of hour, and two digit second of minute: `yyyy-MM-dd'T'HH:mm:ss`.
 
 `date_hour_minute_second_fraction` or `strict_date_hour_minute_second_fraction`::
 
@@ -183,16 +184,17 @@ The following tables lists all the defaults ISO formats supported:
 
 `hour` or `strict_hour`::
 
-    A formatter for a two digit hour of day.
+    A formatter for a two digit hour of day: `HH`
 
 `hour_minute` or `strict_hour_minute`::
 
-    A formatter for a two digit hour of day and two digit minute of hour.
+    A formatter for a two digit hour of day and two digit minute of hour:
+    `HH:mm`.
 
 `hour_minute_second` or `strict_hour_minute_second`::
 
     A formatter for a two digit hour of day, two digit minute of hour, and two
-    digit second of minute.
+    digit second of minute: `HH:mm:ss`.
 
 `hour_minute_second_fraction` or `strict_hour_minute_second_fraction`::
 
@@ -258,27 +260,28 @@ The following tables lists all the defaults ISO formats supported:
 
 `weekyear` or `strict_weekyear`::
 
-    A formatter for a four digit weekyear.
+    A formatter for a four digit weekyear: `xxxx`.
 
 `weekyear_week` or `strict_weekyear_week`::
 
-    A formatter for a four digit weekyear and two digit week of weekyear.
+    A formatter for a four digit weekyear and two digit week of weekyear:
+    `xxxx-'W'ww`.
 
 `weekyear_week_day` or `strict_weekyear_week_day`::
 
     A formatter for a four digit weekyear, two digit week of weekyear, and one
-    digit day of week.
+    digit day of week: `xxxx-'W'ww-e`.
 
 `year` or `strict_year`::
 
-    A formatter for a four digit year.
+    A formatter for a four digit year: `yyyy`.
 
 `year_month` or `strict_year_month`::
 
-    A formatter for a four digit year and two digit month of year.
+    A formatter for a four digit year and two digit month of year: `yyyy-MM`.
 
 `year_month_day` or `strict_year_month_day`::
 
     A formatter for a four digit year, two digit month of year, and two digit
-    day of month.
+    day of month: `yyyy-MM-dd`.