Time field - Revision history

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

2023-04-16T12:20:55Z

Additional Properties

← Older revision		Revision as of 12:20, 16 April 2023
Line 13:		Line 13:

	== Additional Properties ==		== Additional Properties ==
	~~As for~~ [[Date field#Additional_Properties\|Date fields]] except for:		Same as [[Date field#Additional_Properties\|Date fields]] except for

	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	~~\| name \|\| default \|\| description~~		! Name !! Default Value !! Required? !! Description !! Notes
	\|-		\|-
	\| '''min_resolution''' \|\| second \|\| ~~One of second/minute/hour/day/month/year.~~ Indicates the smallest unit of measure that must be entered to make a value valid. Eg. ~~if "~~day~~" so long as there's a~~ year+month+day ~~the hours~~,~~seconds~~ and ~~minutes~~ are optional.		\| '''min_resolution''' \|\| <tt>second</tt> \|\| NO \|\| Indicates the smallest unit of measure that must be entered to make a value valid. Can be <tt>second</tt>, <tt>minute</tt>, <tt>hour</tt>, <tt>day</tt> <tt>month</tt> or <tt>year</tt>. \|\| Different from [[Date field]] default (<tt>day</tt>). E.g. <tt>day</tt> indicates <tt>year</tt>, <tt>month</tt> and <tt>day</tt> are required and <tt>hour</tt>, <tt>minute</tt> and <tt>second</tt> are optional.
	\|-		\|-
	\| '''render_res''' \|\| ~~day~~ \|\| ~~One~~ of second/minute/hour/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. Although it can be handy to store the time right down to the second, you often will just want to render the hours and minutes for day to day use.		\| '''render_res''' \|\| <tt>second</tt> \|\| NO \|\| Indicates the smallest unit of time that should be rendered for the value. an be <tt>second</tt>, <tt>minute</tt>, <tt>hour</tt>, <tt>day</tt> <tt>month</tt> or <tt>year</tt>. \|\| Different from [[Date field]] default (<tt>day</tt>). This is not too useful in configuring the field, but can be set as a print option inside citation files. Although it can be handy to store the time right down to the second, you often will just want to render the hours and minutes for day to day use.
	\|-		\|-
	\| '''render_style''' \|\| long \|\| ~~One of~~ short/~~long~~.		\| '''render_style''' \|\| <tt>long</tt> \|\| NO \|\| Whether to render time in <tt>long</tt> or <tt>short</tt> format. \|\| Same default value as [[Date field]]. However, if <tt>long</tt> then renders like <tt>8 September 1998 23:12:11 +01:00</tt>. If <tt>short</tt> then renders like <tt>08 Sep 1998 23:12:11</tt>.

	~~If "~~long" then ~~you'll see "~~8 September 1998 23:12:11 +01:00".

	If "short" then ~~value is rendered as "~~08 Sep 1998 23:12:11".
	\|}		\|}

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

2023-04-09T23:07:35Z

Required Phrases

← Older revision		Revision as of 23:07, 9 April 2023
Line 30:		Line 30:

	== Required Phrases ==		== Required Phrases ==
	No additional phrases.		No additional phrases beyond those required for [[Date field#Required_Phrases\|Date fields]].

	== Database ==		== Database ==

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

2023-04-09T23:07:08Z

Properties

← Older revision		Revision as of 23:07, 9 April 2023
Line 12:		Line 12:
	*** [[Time field]]		*** [[Time field]]

	== Properties ==		== Additional Properties ==
	As for [[~~date~~ field]]~~s with the following differences...~~		As for [[Date field#Additional_Properties\|Date fields]] except for:

	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"

Drn@ecs.soton.ac.uk at 00:21, 9 April 2023

2023-04-09T00:21:51Z

← Older revision		Revision as of 00:21, 9 April 2023
Line 52:		Line 52:
	{		{
	name => 'datestamp',		name => 'datestamp',
	type=> 'time',		type => 'time',
	render_res => 'minute',		render_res => 'minute',
	}		}
Line 58:		Line 58:
	{		{
	name => 'timestamp',		name => 'timestamp',
	type=> 'time',		type => 'time',
	render_style => 'short',		render_style => 'short',
	}		}
Line 64:		Line 64:
	{		{
	name => 'datestamp',		name => 'datestamp',
	type=> 'time',		type => 'time',
	render_style => 'short',		render_style => 'short',
	}		}
Line 70:		Line 70:
	{		{
	name => 'timestamp',		name => 'timestamp',
	~~type~~=> 'time',		typ e=> 'time',
	min_resolution => 'hour',		min_resolution => 'hour',
	}		}

Drn@ecs.soton.ac.uk: Added ToC. Added API and Examples sections. Reorganised/completed other sections.

2023-04-09T00:21:15Z

Added ToC. Added API and Examples sections. Reorganised/completed other sections.

← Older revision		Revision as of 00:21, 9 April 2023
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}
	~~__NOTOC__~~
	~~== Inheritance ==~~

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

	== Description ==		== Description ==

	This field is very similar to [[date field]] but allows the inclusion of hours, mintues and seconds. It is used for the various timestamps associated with an eprint record.		This field is very similar to [[date field]] but allows the inclusion of hours, mintues and seconds. It is used for the various timestamps associated with an eprint record.

	Times are always stored in UTC and rendered in the local timezone.		Times are always stored in UTC and rendered in the local timezone.

	In version 3.0 times must be input and searched in UTC. This is undesirable, but must systems do not require searching down to the hour. This may be addressed in a later version. (developers note: if this is an issue for you, drop us a line).		== Inheritance ==
			* [[Metadata]]
			** [[Date field]]
			*** [[Time field]]

	== Properties ==		== Properties ==

	As for [[date field]]s with the following differences...		As for [[date field]]s with the following differences...

Line 34:		Line 30:

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

	== Database ==		== Database ==
			fieldname_year SMALLINT(6)
	fieldname_year SMALLINT, fieldname_month SMALLINT, fieldname_day SMALLINT,		fieldname_month SMALLINT(6)
	fieldname_hour SMALLINT, fieldname_minute SMALLINT, fieldname_second SMALLINT		fieldname_day SMALLINT(6)
			fieldname_hour SMALLINT(6)
			fieldname_minute SMALLINT(6)
			fieldname_second SMALLINT(6)

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

	~~Similar~~ to ~~[[date field]] but of~~ the ~~format "YYYY-MM-DD HH:MM:SS"~~. ~~Parts may be ommited~~, ~~eg. YYYY-MM-DD HH:MM"~~.		== Examples ==
			Most basic example.
	== ~~Search =~~=		{
			name => 'timestamp',
	~~Exactly the same as [[~~date ~~field]]s~~. ~~In 3.0 there is no way~~ to ~~make finer grained searches than by day~~.		type => 'time',
			}
			Only render valyes down to the nearest minute.
			{
			name => 'datestamp',
			type=> 'time',
			render_res => 'minute',
			}
			Render date and time in short form.
			{
			name => 'timestamp',
			type=> 'time',
			render_style => 'short',
			}
			Render date and time in short form.
			{
			name => 'datestamp',
			type=> 'time',
			render_style => 'short',
			}
			Require minimum resolution to be to the hour.
			{
			name => 'timestamp',
			type=> 'time',
			min_resolution => 'hour',
			}

Moj at 15:22, 11 January 2007

2007-01-11T15:22:48Z

← Older revision		Revision as of 15:22, 11 January 2007
Line 1:		Line 1:
	~~{{reference}}~~
	{{fieldtypes}}		{{fieldtypes}}
			__NOTOC__
	== Inheritance ==		== Inheritance ==

Moj at 13:16, 11 January 2007

2007-01-11T13:16:01Z

← Older revision		Revision as of 13:16, 11 January 2007
Line 2:		Line 2:
	{{fieldtypes}}		{{fieldtypes}}

	== ~~Inherritance~~ ==		== Inheritance ==

	* [[Metadata]]		* [[Metadata]]

WikiSysop at 13:06, 11 January 2007

2007-01-11T13:06:39Z

← Older revision		Revision as of 13:06, 11 January 2007
Line 37:		Line 37:

	None.		None.

			== Database ==

			fieldname_year SMALLINT, fieldname_month SMALLINT, fieldname_day SMALLINT,
			fieldname_hour SMALLINT, fieldname_minute SMALLINT, fieldname_second SMALLINT

			== API ==

			Similar to [[date field]] but of the format "YYYY-MM-DD HH:MM:SS". Parts may be ommited, eg. YYYY-MM-DD HH:MM".

			== Search ==

			Exactly the same as [[date field]]s. In 3.0 there is no way to make finer grained searches than by day.

WikiSysop at 16:37, 10 January 2007

2007-01-10T16:37:34Z

← Older revision		Revision as of 16:37, 10 January 2007
Line 1:		Line 1:
			{{reference}}
			{{fieldtypes}}

			== Inherritance ==

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

WikiSysop: /* Description */

2007-01-09T18:19:36Z

Description

← Older revision		Revision as of 18:19, 9 January 2007
Line 4:		Line 4:

	== Description ==		== Description ==

			This field is very similar to [[date field]] but allows the inclusion of hours, mintues and seconds. It is used for the various timestamps associated with an eprint record.

			Times are always stored in UTC and rendered in the local timezone.

			In version 3.0 times must be input and searched in UTC. This is undesirable, but must systems do not require searching down to the hour. This may be addressed in a later version. (developers note: if this is an issue for you, drop us a line).

	== Properties ==		== Properties ==