Date field - Revision history

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-25T07:15:06Z

Additional Properties

← Older revision		Revision as of 07:15, 25 April 2023
Line 18:		Line 18:
	\|-		\|-
	\| '''input_style''' \|\| <tt>long</tt> \|\| NO \|\| Whether to render the date inpit fields using longer or shorter month labels. \|\| Can be <tt>short</tt> or <tt>long</tt>. The former is useful if you have limited width in your input form, especially if you are using a date field in a [[Compound field]].		\| '''input_style''' \|\| <tt>long</tt> \|\| NO \|\| Whether to render the date inpit fields using longer or shorter month labels. \|\| Can be <tt>short</tt> or <tt>long</tt>. The former is useful if you have limited width in your input form, especially if you are using a date field in a [[Compound field]].
	\|}		\|-
	\| '''min_resolution''' \|\| <tt>day</tt> \|\| NO \|\| The minimum resoltion of date that must be entered. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.		\| '''min_resolution''' \|\| <tt>day</tt> \|\| NO \|\| The minimum resoltion of date that must be entered. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.
	\|-		\|-

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-25T07:14:52Z

Additional Properties

← Older revision		Revision as of 07:14, 25 April 2023
Line 17:		Line 17:
	! Name !! Default Value !! Required !! Description !! Notes		! Name !! Default Value !! Required !! Description !! Notes
	\|-		\|-
			\| '''input_style''' \|\| <tt>long</tt> \|\| NO \|\| Whether to render the date inpit fields using longer or shorter month labels. \|\| Can be <tt>short</tt> or <tt>long</tt>. The former is useful if you have limited width in your input form, especially if you are using a date field in a [[Compound field]].
			\|}
	\| '''min_resolution''' \|\| <tt>day</tt> \|\| NO \|\| The minimum resoltion of date that must be entered. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.		\| '''min_resolution''' \|\| <tt>day</tt> \|\| NO \|\| The minimum resoltion of date that must be entered. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.
	\|-		\|-

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-11T21:03:55Z

Additional Properties

← Older revision		Revision as of 21:03, 11 April 2023
Line 15:		Line 15:
	== Additional Properties ==		== Additional Properties ==
	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	! Name !! Default !! Required !! Description !! Notes		! Name !! Default Value !! Required !! Description !! Notes
	\|-		\|-
	\| '''min_resolution''' \|\| <tt>day</tt> \|\| NO \|\| The minimum resoltion of date that must be entered. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.		\| '''min_resolution''' \|\| <tt>day</tt> \|\| NO \|\| The minimum resoltion of date that must be entered. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-11T20:58:10Z

Additional Properties

← Older revision		Revision as of 20:58, 11 April 2023
Line 15:		Line 15:
	== Additional Properties ==		== Additional Properties ==
	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	~~\| name \|\| default \|\| description~~		! Name !! Default !! Required !! Description !! Notes
	\|-		\|-
	\| '''min_resolution''' \|\| day \|\| ~~One~~ of day\|month\|year. If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.		\| '''min_resolution''' \|\| <tt>day</tt> \|\| NO \|\| The minimum resoltion of date that must be entered. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.
	\|-		\|-
	\| '''render_res''' \|\| day \|\| ~~One of~~ <tt>day\|month\|year</tt>. If set to <tt>year</tt> then the dates <tt>1998-10-01</tt>, <tt>1998-10</tt> and <tt>1998</tt> would all be rendered as <tt>1998</tt>. This is not too useful in configuring the field, but can be set as a print option inside citation files.		\| '''render_res''' \|\| <tt>day</tt> \|\| NO \|\| The resolution to render the date stored by this field. Can be <tt>day</tt>, <tt>month</tt> or <tt>year</tt>. \|\| If set to <tt>year</tt> then the dates <tt>1998-10-01</tt>, <tt>1998-10</tt> and <tt>1998</tt> would all be rendered as <tt>1998</tt>. This is not too useful in configuring the field, but can be set as a print option inside citation files.
	\|-		\|-
	\| '''render_style''' \|\| long \|\| ~~One of~~ <tt>short\|long\|dow</tt>. If <tt>long</tt> then you'll see <tt>8 September 1998</tt>. If <tt>short</tt> then <tt>08 Sep 1998</tt>. <tt>dow</tt> would render <tt>Tuesday 8 September 1998</tt>.		\| '''render_style''' \|\| <tt>long</tt> \|\| NO \|\| The resolution to render the date stored by this field. Can be <tt>short</tt>, <tt>long</tt> or<tt>dow</tt>. \|\| If <tt>long</tt> then you'll see <tt>8 September 1998</tt>. If <tt>short</tt> then <tt>08 Sep 1998</tt>. <tt>dow</tt> would render <tt>Tuesday 8 September 1998</tt>.
	\|}		\|}

Drn@ecs.soton.ac.uk at 22:18, 9 April 2023

2023-04-09T22:18:17Z

← Older revision		Revision as of 22:18, 9 April 2023
Line 13:		Line 13:
	** [[Date field]]		** [[Date field]]

	== Properties ==		== Additional Properties ==
	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	\| name \|\| default \|\| description		\| name \|\| default \|\| description
Line 30:		Line 30:
	Date fields are stored in the database as:		Date fields are stored in the database as:

	fieldname_year SMALLINT, fieldname_month SMALLINT, fieldname_day SMALLINT		fieldname_year SMALLINT(6)
			fieldname_month SMALLINT(6)
			fieldname_day SMALLINT(6)

	If a date only has a year value then it would be stored as 1998,NULL,NULL		If a date only has a year value then it would be stored as 1998,NULL,NULL

Drn@ecs.soton.ac.uk: /* Required Phrases */

2023-04-09T09:39:41Z

Required Phrases

← Older revision		Revision as of 09:39, 9 April 2023
Line 25:		Line 25:

	== Required Phrases ==		== Required Phrases ==
	No additional phrases beyond the ~~standard~~ [[Metadata#Required_Phrases\|~~Metadata~~ field phrases]].		No additional phrases beyond the [[Metadata#Required_Phrases\|standard metadata field phrases]].

	== Database ==		== Database ==

Drn@ecs.soton.ac.uk: /* Required Phrases */

2023-04-09T09:01:02Z

Required Phrases

← Older revision		Revision as of 09:01, 9 April 2023
Line 25:		Line 25:

	== Required Phrases ==		== Required Phrases ==
	No additional phrases.		No additional phrases beyond the standard [[Metadata#Required_Phrases\|Metadata field phrases]].

	== Database ==		== Database ==

Drn@ecs.soton.ac.uk: Moved description to top. Added link to API page.

2023-03-21T08:22:09Z

Moved description to top. Added link to API page.

← Older revision		Revision as of 08:22, 21 March 2023
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}


	~~== Inheritance ==~~
	* [[Metadata]]
	** [[Date field]]

	== Description ==		== Description ==
Line 12:		Line 8:

	In the database EPrints actually uses 3 integer fields to store the date, rather than a built in date field. This is because of the need to allow <tt>NULL</tt> in month and day if the date is just <tt>1998</tt>.		In the database EPrints actually uses 3 integer fields to store the date, rather than a built in date field. This is because of the need to allow <tt>NULL</tt> in month and day if the date is just <tt>1998</tt>.

			== Inheritance ==
			* [[Metadata]]
			** [[Date field]]

	== Properties ==		== Properties ==

Drn@ecs.soton.ac.uk: /* Searching */ Added formatting

2023-03-20T16:05:27Z

Searching: Added formatting

← Older revision		Revision as of 16:05, 20 March 2023
Line 44:		Line 44:

	=== Searching ===		=== Searching ===
	Date fields can be searched as either single values or ranges. Searching for "2006" will also match 2006-12-25. You can search for "2000-" to search dates in or after 2000. Or "2000-12-2003-01" for December 2000 through January 2003.		Date fields can be searched as either single values or ranges. Searching for <tt>2006><tt> will also match <tt>2006-12-25</tt>. You can search for <tt>2000-</tt> to search dates in or after 2000. Or <tt>2000-12-2003-01</tt> for December 2000 through January 2003.

	== Examples ==		== Examples ==

Drn@ecs.soton.ac.uk: Added examples. Improved other sections unhide ToC.

2023-03-20T16:04:13Z

Added examples. Improved other sections unhide ToC.

← Older revision		Revision as of 16:04, 20 March 2023
Line 1:		Line 1:
	~~#REDIRECT [[API:EPrints/MetaField/Date]]~~		{{fieldtypes}}

	~~{{fieldtypes}}~~
	~~__NOTOC__~~

	== Inheritance ==		== Inheritance ==

	* [[Metadata]]		* [[Metadata]]
	** [[Date field]]		** [[Date field]]

	== Description ==		== Description ==
			This field is used to store a single date. Internally EPrints always uses ISO standard notation for dates, it avoids confusion. This is <tt>YYYY-MM-DD</tt>.

	~~This field is used~~ to store ~~a single~~ date. ~~Internally EPrints always uses ISO standard notation for dates, it avoids confusion. This is~~ YYYY-MM~~-DD~~.		In bibliographies sometimes exact dates of publication (or other events) are not known. EPrints allows you to store month and year values in date fields. <tt>YYYY</tt> or <tt>YYYY-MM</tt>.

	~~In bibliographies sometimes exact dates of publication (or other events) are not known. EPrints allows you to store month and year values in date fields. YYYY or YYYY-MM.~~		In the database EPrints actually uses 3 integer fields to store the date, rather than a built in date field. This is because of the need to allow <tt>NULL</tt> in month and day if the date is just <tt>1998</tt>.

	In the database EPrints actually uses 3 integer fields to store the date, rather than a built in date field. This is because of the need to allow "NULL" in month and day if the date is just "1998".

	== Properties ==		== Properties ==

	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	\| name \|\| default \|\| description		\| name \|\| default \|\| description
	\|-		\|-
	\| '''min_resolution''' \|\| day \|\| One of day\|month\|year. If set to "day" then values of YYYY or YYYY-MM will cause a validation error. If set to "month" then values of YYYY will cause a validation error. If set to "year" then day, month or year resolutions are allowed.		\| '''min_resolution''' \|\| day \|\| One of day\|month\|year. If set to <tt>day</tt> then values of <tt>YYYY</tt> or <tt>YYYY-MM</tt> will cause a validation error. If set to <tt>month</tt> then values of <tt>YYYY</tt> will cause a validation error. If set to <tt>year</tt> then day, month or year resolutions are allowed.
	\|-		\|-
	\| '''render_res''' \|\| day \|\| One of day\|month\|year. If set to "year" then the dates 1998-10-01, 1998-10 and 1998 would all be rendered as "1998". This is not too useful in configuring the field, but can be set as a print option inside citation files.		\| '''render_res''' \|\| day \|\| One of <tt>day\|month\|year</tt>. If set to <tt>year</tt> then the dates <tt>1998-10-01</tt>, <tt>1998-10</tt> and <tt>1998</tt> would all be rendered as <tt>1998</tt>. This is not too useful in configuring the field, but can be set as a print option inside citation files.
	\|-		\|-
	\| '''render_style''' \|\| long \|\| One of short\|long. If "long" then you'll see "8 September 1998". If "short" then "08 Sep 1998".		\| '''render_style''' \|\| long \|\| One of <tt>short\|long\|dow</tt>. If <tt>long</tt> then you'll see <tt>8 September 1998</tt>. If <tt>short</tt> then <tt>08 Sep 1998</tt>. <tt>dow</tt> would render <tt>Tuesday 8 September 1998</tt>.
	\|}		\|}


	== Required Phrases ==		== Required Phrases ==
			No additional phrases.
	~~None~~.

	== Database ==		== Database ==

	Date fields are stored in the database as:		Date fields are stored in the database as:

Line 43:		Line 35:

	== API ==		== API ==
			See [[API:EPrints/MetaField/Date\|API page]].

	Date values are represented in the API as scalars containing ISO encoded dates. eg.		Date values are represented in the API as scalars containing ISO encoded dates. eg.
Line 50:		Line 43:
	"1976-02-02"		"1976-02-02"

	== Searching ==		=== Searching ===
			Date fields can be searched as either single values or ranges. Searching for "2006" will also match 2006-12-25. You can search for "2000-" to search dates in or after 2000. Or "2000-12-2003-01" for December 2000 through January 2003.

	~~Date fields can~~ be ~~searched as either single values or ranges~~. ~~Searching for "2006" will also match 2006-12-25~~. ~~You can search for "2000-" to search dates in or after 2000~~. ~~Or "2000-12-2003-01" for December 2000 through January 2003~~.		== Examples ==
			Most basic example.
			{
			name => 'acceptance_date',
			type => 'date',
			}
			Set minimum resolution to which the date must be specified is at least a <tt>month</tt>.
			{
			name => 'moratorium_date',
			type => 'date',
			min_resolution => 'month',
			}
			Set resolution to render to the <tt>month</tt>, set rendering style to <tt>short</tt> (e.g. Feb 2023).
			{
			name => 'publication_date',
			type => 'date',
			render_res => 'month',
			render_style => short',
			}