From 23365af57d384d36cfcea9cbdb8918fc74be60c9 Mon Sep 17 00:00:00 2001 From: Kim Jin Su Date: Wed, 13 Jan 2016 08:06:33 +0900 Subject: [PATCH] Add docs for datetime type --- .../docs/api/db/types/datetime/contents.lr | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 content/docs/api/db/types/datetime/contents.lr diff --git a/content/docs/api/db/types/datetime/contents.lr b/content/docs/api/db/types/datetime/contents.lr new file mode 100644 index 00000000..a45a5168 --- /dev/null +++ b/content/docs/api/db/types/datetime/contents.lr @@ -0,0 +1,59 @@ +title: datetime +--- +type: type +--- +summary: A type that can store a date and time. +--- +body: + +The `datetime` type can store a date and time. +`datetime` value can also include time zone info. + +The canonical format for the type in text form is `YYYY-MM-DD HH:MM:SS[ Z]`. + +`Z` is optional information. +You can use `Z` field with below informations. + +* Time Zone Abbreviations such as `UTC`, `EST` +* Time Zone Name such as `America/Dominica` +* Timedelta such as `+0900`, `-0930` + +You can also use [datetimeformat +:ref](../../../../api/templates/filters/datetimeformat/) +filter with this type. + +## Valid Examples + +``` +pub_date: 2016-01-13 07:53:22 + +or + +pub_date: 2016-01-13 07:53:22 UTC + +or + +pub_date: 2016-01-13 07:53:22 EST + +or + +pub_date: 2016-01-13 07:53:22 America/Dominica + +or + +pub_date: 2016-01-13 07:53:22 +0900 +``` + +## Field Usage + +```ini +[fields.pub_date] +label = Publication date +type = datetime +``` + +## Template Usage + +```html+jinja +

Published: {{ this.pub_date.strftime('%Y-%m-%d %H:%M:%S') }} +```