Metadata - Revision history

Drn@ecs.soton.ac.uk: Using transclusion rather than redirection.

2017-09-08T13:11:31Z

Using transclusion rather than redirection.

Pm705 at 19:08, 13 March 2010

2010-03-13T19:08:03Z

← Older revision		Revision as of 19:08, 13 March 2010
Line 1:		Line 1:
	#REDIRECT [[:Category:EPrints Metadata Fields]]		#REDIRECT [[:Category:EPrints Metadata Fields]]
	{{fieldtypes}}		{{fieldtypes}}
	~~[[Category:EPrints Metadata Fields]]~~
	== Metadata Field Types ==		== Metadata Field Types ==

Pm705: Redirected page to Category:EPrints Metadata Fields

2010-03-13T19:07:02Z

Redirected page to Category:EPrints Metadata Fields

← Older revision		Revision as of 19:07, 13 March 2010
Line 1:		Line 1:
			#REDIRECT [[:Category:EPrints Metadata Fields]]
	{{fieldtypes}}		{{fieldtypes}}
	[[Category:EPrints Metadata Fields]]		[[Category:EPrints Metadata Fields]]

Pm705 at 18:21, 13 March 2010

2010-03-13T18:21:56Z

← Older revision		Revision as of 18:21, 13 March 2010
Line 1:		Line 1:

	{{fieldtypes}}		{{fieldtypes}}
			[[Category:EPrints Metadata Fields]]
	== Metadata Field Types ==		== Metadata Field Types ==

Pm705@zepler.net: /* Rendering Properties */

2009-12-30T15:17:09Z

Rendering Properties

← Older revision		Revision as of 15:17, 30 December 2009
Line 106:		Line 106:
	\| '''render_dont_link''' \|\| 0 \|\| Set this to true to stop this field hyperlinking itself when rendered. Currently only affects [[url field]]s and [[email field]]s.		\| '''render_dont_link''' \|\| 0 \|\| Set this to true to stop this field hyperlinking itself when rendered. Currently only affects [[url field]]s and [[email field]]s.
	\|-		\|-
	\| '''render_order''' \|\| "fg" \|\| <b>Only for fields ~~with~~ type=>name.</b> The order the name is rendered. For example 'gf'is given name first then family name.		\| '''render_order''' \|\| "fg" \|\| <b>Only for fields of type=>name.</b> The order the name is rendered. For example 'gf' is given name first then family name.
	\|-		\|-
	\| '''render_single_value''' \|\| undef \|\| The value of this property is the name of a subroutine to call to render values from this field. For a multiple field this is called once per value in the list of values. The function should take the following parameters: ( $session, $field, $value, $object). It should return an [[XHTML DOM]] object of the rendered value.		\| '''render_single_value''' \|\| undef \|\| The value of this property is the name of a subroutine to call to render values from this field. For a multiple field this is called once per value in the list of values. The function should take the following parameters: ( $session, $field, $value, $object). It should return an [[XHTML DOM]] object of the rendered value.

Pm705@zepler.net: /* Rendering Properties */

2009-12-30T15:14:53Z

Rendering Properties

← Older revision		Revision as of 15:14, 30 December 2009
Line 105:		Line 105:
	\|-		\|-
	\| '''render_dont_link''' \|\| 0 \|\| Set this to true to stop this field hyperlinking itself when rendered. Currently only affects [[url field]]s and [[email field]]s.		\| '''render_dont_link''' \|\| 0 \|\| Set this to true to stop this field hyperlinking itself when rendered. Currently only affects [[url field]]s and [[email field]]s.
			\|-
			\| '''render_order''' \|\| "fg" \|\| <b>Only for fields with type=>name.</b> The order the name is rendered. For example 'gf'is given name first then family name.
	\|-		\|-
	\| '''render_single_value''' \|\| undef \|\| The value of this property is the name of a subroutine to call to render values from this field. For a multiple field this is called once per value in the list of values. The function should take the following parameters: ( $session, $field, $value, $object). It should return an [[XHTML DOM]] object of the rendered value.		\| '''render_single_value''' \|\| undef \|\| The value of this property is the name of a subroutine to call to render values from this field. For a multiple field this is called once per value in the list of values. The function should take the following parameters: ( $session, $field, $value, $object). It should return an [[XHTML DOM]] object of the rendered value.
Line 110:		Line 112:
	\| '''render_value''' \|\| undef \|\| As with render single value, but this gets passed the entire list of values (an array reference) if it's a multiple field. Parameters passed are: ( $session, $self, $value, $all_langs, $no_link, $object ). $all_langs indicates that all language variants should be shown - only really useful for multilang fields. $no_link being true is a request to place no hyperlinks in the resulting HTML. It should return an [[XHTML DOM]] object of the rendered value.		\| '''render_value''' \|\| undef \|\| As with render single value, but this gets passed the entire list of values (an array reference) if it's a multiple field. Parameters passed are: ( $session, $self, $value, $all_langs, $no_link, $object ). $all_langs indicates that all language variants should be shown - only really useful for multilang fields. $no_link being true is a request to place no hyperlinks in the resulting HTML. It should return an [[XHTML DOM]] object of the rendered value.
	\|}		\|}


	=== Input and Validation Properties ===		=== Input and Validation Properties ===

Moj at 14:52, 11 January 2007

2007-01-11T14:52:02Z

← Older revision		Revision as of 14:52, 11 January 2007
Line 1:		Line 1:
	~~{{reference}}~~
	{{fieldtypes}}		{{fieldtypes}}

WikiSysop at 16:48, 10 January 2007

2007-01-10T16:48:06Z

← Older revision		Revision as of 16:48, 10 January 2007
Line 7:		Line 7:

	Some of these subclasses provide very rich features, others very simple. For example the [[url field]] works just like the text field except that it's only valid if it looks like a url and when rendered it is a hyper-link.		Some of these subclasses provide very rich features, others very simple. For example the [[url field]] works just like the text field except that it's only valid if it looks like a url and when rendered it is a hyper-link.

			A metadata field describes one field of data in one type of [[Data Object]]. For example the "title" field of an [[EPrint Object]] or the "email" field in a [[User Object]].

			Every [[Data Object]] has system fields (which are set by the system, and not alterable), but the [[User Object]] and [[EPrint Object]] have additional fields which are configured on a per-repository basis.

			These can be customised in the [[user_fields.pl]] and [[eprint_fields.pl]] files. Note that changing these files does not automatically modify the underlying database so should (generally) only be done before the database is created. Some metadata properties do not affect the database, and are marked as such.

			If you add or remove fields, or modify a property which affects the database then you'll need to alter the database to match. In 3.0 this must be done by hand, but we have plans to build a tool to do this for you.

			Default values marked *config indicate that the default value for the repository may be modified in the configuration file [[field_property_defaults.pl]]


	== Inherritance ==		== Inherritance ==

WikiSysop: /* Description */

2007-01-10T16:47:43Z

Description

← Older revision		Revision as of 16:47, 10 January 2007
Line 51:		Line 51:
	*** '''[[Secret field\|Secret]]''' - used to store passwords.		*** '''[[Secret field\|Secret]]''' - used to store passwords.

	~~== Description ==~~

	~~A metadata field describes one field of data in one type of [[Data Object]]. For example the "title" field of an [[EPrint Object]] or the "email" field in a [[User Object]].~~

	Every [[Data Object]] has system fields (which are set by the system, and not alterable), but the [[User Object]] and [[EPrint Object]] have additional fields which are configured on a per-repository basis.

	These can be customised in the [[user_fields.pl]] and [[eprint_fields.pl]] files. Note that changing these files does not automatically modify the underlying database so should (generally) only be done before the database is created. Some metadata properties do not affect the database, and are marked as such.

	If you add or remove fields, or modify a property which affects the database then you'll need to alter the database to match. In 3.0 this must be done by hand, but we have plans to build a tool to do this for you.

	~~Default values marked *config indicate that the default value for the repository may be modified in the configuration file [[field_property_defaults.pl]]~~

	== Properties ==		== Properties ==

WikiSysop at 16:47, 10 January 2007

2007-01-10T16:47:16Z

← Older revision		Revision as of 16:47, 10 January 2007
Line 14:		Line 14:
	Some field types inherrit the properties of another, and then modify them in some way. For example the [[namedset field]] works like a [[set field]] except that it gets its options from a namedsets file not from the options=>[] in the field properties.		Some field types inherrit the properties of another, and then modify them in some way. For example the [[namedset field]] works like a [[set field]] except that it gets its options from a namedsets file not from the options=>[] in the field properties.

	* Basic metadata field - this is abstract, fields must be one of the types listed below...		* '''Basic metadata field''' - this is abstract, fields must be one of the types listed below...
	** [[Boolean field\|Boolean]] - TRUE or FALSE (or can be unset, of course)		** '''[[Boolean field\|Boolean]]''' - TRUE or FALSE (or can be unset, of course)
	** [[Compound field\|Compound]] - virtual field, joins together several "multiple" fields. eg. author_name and author_email		** '''[[Compound field\|Compound]]''' - virtual field, joins together several "multiple" fields. eg. author_name and author_email
	*** [[Multilang field\|Multilang]] - allows language variants of a field. eg. titles in French, German and/or English.		*** '''[[Multilang field\|Multilang]]''' - allows language variants of a field. eg. titles in French, German and/or English.
	** [[Date field\|Date]] - stores a date.		** '''[[Date field\|Date]]''' - stores a date.
	*** [[Time field\|Time]] - stores a date and time.		*** '''[[Time field\|Time]]''' - stores a date and time.
	** [[Float field\|Float]] - stores a floating point value		** '''[[Float field\|Float]]''' - stores a floating point value
	** [[Int field\|Int]] - a positive integer value		** '''[[Int field\|Int]]''' - a positive integer value
	*** [[Itemref field\|Itemref]] - a reference to another [[Data Object]] (eg. a user or other eprint)		*** '''[[Itemref field\|Itemref]]''' - a reference to another [[Data Object]] (eg. a user or other eprint)
	*** [[Pagerange field\|Pagerange]] - a pagerange, eg 122-130		*** '''[[Pagerange field\|Pagerange]]''' - a pagerange, eg 122-130
	** [[Search field\|Search]] - a serialised search		** '''[[Search field\|Search]]''' - a serialised search
	** [[Set field\|Set]] - a limited set of options		** '''[[Set field\|Set]]''' - a limited set of options
	*** [[Namedset field\|Namedset]] - like a normal set, but takes its options from a [[namedset]] configuration file.		*** '''[[Namedset field\|Namedset]]''' - like a normal set, but takes its options from a [[namedset]] configuration file.
	*** [[Subject field\|Subject]] - possible values are taken from the [[Subject]] heirarchy.		*** '''[[Subject field\|Subject]]''' - possible values are taken from the [[Subject]] heirarchy.
	** [[Text field\|Text]] - the basic text field. Maximum 255 bytes. nb. uft-8 means some chars take more than one byte.		** '''[[Text field\|Text]]''' - the basic text field. Maximum 255 bytes. nb. uft-8 means some chars take more than one byte.
	*** [[Email field\|Email]] - an email address		*** '''[[Email field\|Email]]''' - an email address
	*** [[Longtext field\|Longtext]] - like text but allows much longer text (65,000 bytes)		*** '''[[Longtext field\|Longtext]]''' - like text but allows much longer text (65,000 bytes)
	*** [[Name field\|Name]] - Stores a persons name broken up into logical parts.		*** '''[[Name field\|Name]]''' - Stores a persons name broken up into logical parts.
	*** [[Url field\|Url]] - stores a URL		*** '''[[Url field\|Url]]''' - stores a URL

	=== Internal-use and Deprecated Field Types ===		=== Internal-use and Deprecated Field Types ===

	* Basic metadata field		* '''Basic metadata field'''
	** [[File field\|File]] - virtual field represtenting the files in a document		** '''[[File field\|File]]''' - virtual field represtenting the files in a document
	** [[Id field\|Id]] - deprecated (do not use)		** '''[[Id field\|Id]]''' - deprecated (do not use)
	** Int		** '''Int'''
	*** [[Year field\|Year]] - deprecated (do not use)		*** '''[[Year field\|Year]]''' - deprecated (do not use)
	** [[Search field\|Search]] - a serialised search		** '''[[Search field\|Search]]''' - a serialised search
	** Set		** '''Set'''
	*** [[Arclanguage field\|Arclanguage]] - as for set, but the options are the valid languages of this repository		*** '''[[Arclanguage field\|Arclanguage]]''' - as for set, but the options are the valid languages of this repository
	*** [[Fields field\|Fields]] - as for set, but the options are the fields in a dataset.		*** '''[[Fields field\|Fields]]''' - as for set, but the options are the fields in a dataset.
	*** [[Langid field\|Langid]] - used internally by [[multilang field]]s to store the language id.		*** '''[[Langid field\|Langid]]''' - used internally by [[multilang field]]s to store the language id.
	** [[Subobject field\|Subobject]] - a virtual field, similar to itemref, but representing an object or objects which are sub-parts of the current object (as oppose to just related in some way)		** '''[[Subobject field\|Subobject]]''' - a virtual field, similar to itemref, but representing an object or objects which are sub-parts of the current object (as oppose to just related in some way)
	** Text		** '''Text'''
	*** [[Fulltext field\|Fulltext]] - virtual field used to represent to the full text of an eprint		*** '''[[Fulltext field\|Fulltext]]''' - virtual field used to represent to the full text of an eprint
	*** [[Secret field\|Secret]] - used to store passwords.		*** '''[[Secret field\|Secret]]''' - used to store passwords.

	== Description ==		== Description ==

← Older revision		Revision as of 16:47, 10 January 2007
Line 14:		Line 14:
	Some field types inherrit the properties of another, and then modify them in some way. For example the [[namedset field]] works like a [[set field]] except that it gets its options from a namedsets file not from the options=>[] in the field properties.		Some field types inherrit the properties of another, and then modify them in some way. For example the [[namedset field]] works like a [[set field]] except that it gets its options from a namedsets file not from the options=>[] in the field properties.

	* Basic metadata field - this is abstract, fields must be one of the types listed below...		* '''Basic metadata field''' - this is abstract, fields must be one of the types listed below...
	** [[Boolean field\|Boolean]] - TRUE or FALSE (or can be unset, of course)		** '''[[Boolean field\|Boolean]]''' - TRUE or FALSE (or can be unset, of course)
	** [[Compound field\|Compound]] - virtual field, joins together several "multiple" fields. eg. author_name and author_email		** '''[[Compound field\|Compound]]''' - virtual field, joins together several "multiple" fields. eg. author_name and author_email
	*** [[Multilang field\|Multilang]] - allows language variants of a field. eg. titles in French, German and/or English.		*** '''[[Multilang field\|Multilang]]''' - allows language variants of a field. eg. titles in French, German and/or English.
	** [[Date field\|Date]] - stores a date.		** '''[[Date field\|Date]]''' - stores a date.
	*** [[Time field\|Time]] - stores a date and time.		*** '''[[Time field\|Time]]''' - stores a date and time.
	** [[Float field\|Float]] - stores a floating point value		** '''[[Float field\|Float]]''' - stores a floating point value
	** [[Int field\|Int]] - a positive integer value		** '''[[Int field\|Int]]''' - a positive integer value
	*** [[Itemref field\|Itemref]] - a reference to another [[Data Object]] (eg. a user or other eprint)		*** '''[[Itemref field\|Itemref]]''' - a reference to another [[Data Object]] (eg. a user or other eprint)
	*** [[Pagerange field\|Pagerange]] - a pagerange, eg 122-130		*** '''[[Pagerange field\|Pagerange]]''' - a pagerange, eg 122-130
	** [[Search field\|Search]] - a serialised search		** '''[[Search field\|Search]]''' - a serialised search
	** [[Set field\|Set]] - a limited set of options		** '''[[Set field\|Set]]''' - a limited set of options
	*** [[Namedset field\|Namedset]] - like a normal set, but takes its options from a [[namedset]] configuration file.		*** '''[[Namedset field\|Namedset]]''' - like a normal set, but takes its options from a [[namedset]] configuration file.
	*** [[Subject field\|Subject]] - possible values are taken from the [[Subject]] heirarchy.		*** '''[[Subject field\|Subject]]''' - possible values are taken from the [[Subject]] heirarchy.
	** [[Text field\|Text]] - the basic text field. Maximum 255 bytes. nb. uft-8 means some chars take more than one byte.		** '''[[Text field\|Text]]''' - the basic text field. Maximum 255 bytes. nb. uft-8 means some chars take more than one byte.
	*** [[Email field\|Email]] - an email address		*** '''[[Email field\|Email]]''' - an email address
	*** [[Longtext field\|Longtext]] - like text but allows much longer text (65,000 bytes)		*** '''[[Longtext field\|Longtext]]''' - like text but allows much longer text (65,000 bytes)
	*** [[Name field\|Name]] - Stores a persons name broken up into logical parts.		*** '''[[Name field\|Name]]''' - Stores a persons name broken up into logical parts.
	*** [[Url field\|Url]] - stores a URL		*** '''[[Url field\|Url]]''' - stores a URL

	=== Internal-use and Deprecated Field Types ===		=== Internal-use and Deprecated Field Types ===

	* Basic metadata field		* '''Basic metadata field'''
	** [[File field\|File]] - virtual field represtenting the files in a document		** '''[[File field\|File]]''' - virtual field represtenting the files in a document
	** [[Id field\|Id]] - deprecated (do not use)		** '''[[Id field\|Id]]''' - deprecated (do not use)
	** Int		** '''Int'''
	*** [[Year field\|Year]] - deprecated (do not use)		*** '''[[Year field\|Year]]''' - deprecated (do not use)
	** [[Search field\|Search]] - a serialised search		** '''[[Search field\|Search]]''' - a serialised search
	** Set		** '''Set'''
	*** [[Arclanguage field\|Arclanguage]] - as for set, but the options are the valid languages of this repository		*** '''[[Arclanguage field\|Arclanguage]]''' - as for set, but the options are the valid languages of this repository
	*** [[Fields field\|Fields]] - as for set, but the options are the fields in a dataset.		*** '''[[Fields field\|Fields]]''' - as for set, but the options are the fields in a dataset.
	*** [[Langid field\|Langid]] - used internally by [[multilang field]]s to store the language id.		*** '''[[Langid field\|Langid]]''' - used internally by [[multilang field]]s to store the language id.
	** [[Subobject field\|Subobject]] - a virtual field, similar to itemref, but representing an object or objects which are sub-parts of the current object (as oppose to just related in some way)		** '''[[Subobject field\|Subobject]]''' - a virtual field, similar to itemref, but representing an object or objects which are sub-parts of the current object (as oppose to just related in some way)
	** Text		** '''Text'''
	*** [[Fulltext field\|Fulltext]] - virtual field used to represent to the full text of an eprint		*** '''[[Fulltext field\|Fulltext]]''' - virtual field used to represent to the full text of an eprint
	*** [[Secret field\|Secret]] - used to store passwords.		*** '''[[Secret field\|Secret]]''' - used to store passwords.

	== Description ==		== Description ==