Skip to content

Commit 71a301c

Browse files
committed
"show time" setting for date field
also added examples of localized vs fixed time
1 parent c0d7a54 commit 71a301c

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/fieldtypes/date.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,25 @@ The Date field allows for quick entry of dates via the publish form. When the fi
1515

1616
## Field Settings
1717

18-
### Localized or Fixed?
18+
### Date Localization
1919

20-
On the publish form, along with a field to enter a date, you will also see an option to select whether you want the date localized or fixed:
20+
Choose how the field data should be localized. The options are
21+
- _Always localized_ (the date displayed on front-end will be converted into logged-in member's timezone. Example use case is start of online event, when attenders need to know their local time)
22+
- _Alway fixed_ (the date on front-end will be displayed in the site's configured timezone. Example use case is start of in-person event, when attenders need to know the time as it is in the event's timezone)
23+
- _Ask each time_
24+
25+
### Include time?
26+
When turned off, only date will be displayed, otherwise the editor can also enter time into same field.
27+
28+
## Publish form
29+
30+
On the publish form (when `Date Localization` setting is set to `Ask each time`), along with a field to enter a date, you will also see an option to select whether you want the date localized or fixed:
2131

2232
- **Localized:** A date that is localized will be translated into the logged-in member's current timezone. For instance, if you enter a date of _10/21/2015 4:29 PM_ and you're in Pacific Daylight Time, a member in Eastern Daylight Time will see the date as _10/21/2015 7:29 PM_. Or, for logged out members, the date will be localized on the front-end according to the site's configured timezone.
2333
- **Fixed:** A fixed date will NOT be localized to a member's timezone, or the site's configured timezone. The date will appear as it does in the control panel everywhere by all members.
2434

35+
NOTE: **Note:** These options are only available when using Date as field and not as Grid column.
36+
2537
At the bottom of the calendar popup you will also see a "Today" button that can be used to automatically set the date to the current date.
2638

2739
## Template Tag

0 commit comments

Comments
 (0)