Id field - Revision history

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

2023-04-16T11:59:48Z

‎Additional Properties

2023-04-11T23:19:43Z

‎Required Phrases

2023-04-11T23:18:23Z

‎Additional Properties

2023-04-11T21:49:01Z

‎Inheritance: not a sub-class of text

2023-04-09T09:50:51Z

2023-03-21T08:46:25Z

Added structure to page

2020-06-14T11:24:34Z

2020-06-14T11:15:39Z

Removed deprecation warning.

2016-12-19T14:45:01Z

updated description around deprecation

2010-03-13T19:13:38Z

@@ Line 13: / Line 13: @@
 ! Name !! Default Value !! Required? !! Description !! Notes
 |-
-| '''match''' || <tt>EX</tt> || NO || Searches should match values exactly. ||  Default from parent default (<tt>EQ</tt>). This should not be modified in field configuration, as the purpose of Id fields is to match exactly.
+| '''match''' || <tt>EX</tt> || NO || Searches should match string values exactly. ||  Default from parent default (<tt>EQ</tt>). This should not be modified in field configuration, as the purpose of Id fields is to match exactly.
 |}

@@ Line 17: / Line 17: @@
 == Required Phrases ==
-No additional phrases beyond those required for [[Text field#Required_Phrases|Text fields]].
+No additional phrases beyond [[Metadata#Required_Phrases|standard metadata field phrases]].
 == Database ==

@@ Line 10: / Line 10: @@
 == Additional Properties ==
-As for [[Text field#Additional_Properties|Text fields]].
+{| border="1" cellpadding="3" cellspacing="0"
 == Required Phrases ==

@@ Line 7: / Line 7: @@
 == Inheritance ==
 * [[Metadata]]
-** [[Text field]]
+** [[Id field]]
 == Additional Properties ==

@@ Line 10: / Line 10: @@
 *** [[Id field]]
-== Properties ==
+== Additional Properties ==
-Same as [[Text field]].
+As for [[Text field#Additional_Properties|Text fields]].
 == Required Phrases ==
-No additional phrases.
+No additional phrases beyond those required for [[Text field#Required_Phrases|Text fields]].
 == Database ==

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

−	[[Metadata]] field. ~~Useful~~ in ~~search~~ as a '~~match full value~~' ~~rather than partial match of e.g.~~ type '~~text~~'	+
		+	== Description ==
		+	This metadata field is very similar to a [[Text field]], the main difference is for search where the whole value is indexed rather than in individual parts. In particular this is useful for things like ISBN or ISSN numbers which contain hyphens (<tt>-</tt>). For a text field the parts either side of the hyphen would be indexed separately but for a Id field this will be indexed as a single value. Therefore, allowing search to find only those items that match exactly.
		+
		+	== Inheritance ==
		+	* [[Metadata]]
		+	** [[Text field]]
		+	*** [[Id field]]
		+
		+	== Properties ==
		+	Same as [[Text field]].
		+
		+	== Required Phrases ==
		+	No additional phrases.
		+
		+	== Database ==
		+	Id fields are stored in the database as
		+
		+	fieldname VARCHAR(255)
		+
		+	== API ==
		+	See [[API:EPrints/MetaField/Id\|API page]].
		+
		+	== Examples ==
		+	Most basic example.
		+	{
		+	name => 'isbn',
		+	type => 'id',
		+	},
		+	Use a bespoke value renderer to add links to DOIs where appropriate.
		+	{
		+	name => 'id_number',
		+	type => 'id',
		+	render_value => 'EPrints::Extras::render_possible_doi',
		+	},

← Older revision		Revision as of 11:24, 14 June 2020
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}

−	[[Metadata]] field.	+	[[Metadata]] field. Useful in search as a 'match full value' rather than partial match of e.g. type 'text'
−
−	Useful in search as a 'match full value' rather than partial match of e.g. type 'text'

← Older revision		Revision as of 11:15, 14 June 2020
Line 3:		Line 3:
	[[Metadata]] field.		[[Metadata]] field.

−	~~Was marked as 'Deprecated. This is a lingering part of EPrints 2 and should not be used' but has continued to be used through 3.3.x versions and as the basis of new Identifier types e.g. ORCID.~~
	Useful in search as a 'match full value' rather than partial match of e.g. type 'text'		Useful in search as a 'match full value' rather than partial match of e.g. type 'text'

← Older revision		Revision as of 14:45, 19 December 2016
Line 3:		Line 3:
	[[Metadata]] field.		[[Metadata]] field.

−	Deprecated. This is a lingering part of EPrints 2 and should not be used.	+	Was marked as 'Deprecated. This is a lingering part of EPrints 2 and should not be used' but has continued to be used through 3.3.x versions and as the basis of new Identifier types e.g. ORCID.
		+	Useful in search as a 'match full value' rather than partial match of e.g. type 'text'