Compound field - Revision history

Drn@ecs.soton.ac.uk: Reinstate link to API page even though a redirect

2024-07-09T09:49:04Z

Reinstate link to API page even though a redirect

2024-07-09T09:40:38Z

Removed link to API page (just a redirect to this)

2023-04-11T20:41:16Z

‎Additional Properties

2023-04-11T14:43:56Z

‎Additional Properties

2023-04-09T09:40:59Z

2023-04-09T09:37:06Z

2023-04-09T08:53:37Z

‎Properties: Improved descriptions

2023-04-09T08:48:17Z

‎Database

2023-04-09T08:47:36Z

‎Database: URLs are now LONGTEXT not VARCHAR(255)

2023-04-09T08:43:13Z

‎Description

← Older revision		Revision as of 09:49, 9 July 2024
Line 40:		Line 40:

	<tt>eprintid</tt> is the ID of the eprint to which the field applies. <tt>pos</tt> contains the position of the entry (starting at 0). The remaining field uses the appropriate field type for the sub-field (in this case <code>LONGTEXT</code> for the [[Url field\|URL]] and <code>VARCHAR(255)</code> for the type).		<tt>eprintid</tt> is the ID of the eprint to which the field applies. <tt>pos</tt> contains the position of the entry (starting at 0). The remaining field uses the appropriate field type for the sub-field (in this case <code>LONGTEXT</code> for the [[Url field\|URL]] and <code>VARCHAR(255)</code> for the type).
		+
		+	== API ==
		+	See [[API:EPrints/MetaField/Compound\|API page]].

	== Examples ==		== Examples ==

← Older revision		Revision as of 09:40, 9 July 2024
Line 40:		Line 40:

	<tt>eprintid</tt> is the ID of the eprint to which the field applies. <tt>pos</tt> contains the position of the entry (starting at 0). The remaining field uses the appropriate field type for the sub-field (in this case <code>LONGTEXT</code> for the [[Url field\|URL]] and <code>VARCHAR(255)</code> for the type).		<tt>eprintid</tt> is the ID of the eprint to which the field applies. <tt>pos</tt> contains the position of the entry (starting at 0). The remaining field uses the appropriate field type for the sub-field (in this case <code>LONGTEXT</code> for the [[Url field\|URL]] and <code>VARCHAR(255)</code> for the type).
−
−	~~== API ==~~
−	~~See [[API:EPrints/MetaField/Compound\|API page]].~~

	== Examples ==		== Examples ==

@@ Line 17: / Line 17: @@
 | '''fields_cache''' || n/a || YES || A cache of the sub-fields. || Although this is required it is generated from <code>fields</code> so does not to be included in the field definition.
 |-
-| '''show_in_fieldlist''' || <tt>0</tt> || NO || Whether field should be included in data object's field list. || Different default (0 rather than 1) as individual sub-fields are already shown in field list.
+| '''show_in_fieldlist''' || <tt>0</tt> || NO || Whether field should be included in data object's field list. || Different to parent default (<tt>1</tt>), as individual sub-fields are already shown in field list.
 |}

@@ Line 11: / Line 11: @@
 == Additional Properties ==
 {| border="1" cellpadding="3" cellspacing="0"
-| name || default || description
+! Name !! Default Value !! Required !! Description !! Notes
 |-
-| '''fields''' || n/a || '''This property is always required.'''
+| '''fields''' || n/a || YES || The sub-fields for this compound field. ||
 |-
-| '''fields_cache''' || n/a || ''This property is always required but is generated from <code>fields</code>.''
+| '''fields_cache''' || n/a || YES || A cache of the sub-fields. || Although this is required it is generated from <code>fields</code> so does not to be included in the field definition.
 |-
-| '''show_in_fieldlist''' || 0 || ''This is set to 0 rather than 1 as individual sub-fields are already shown in field list.''
+| '''show_in_fieldlist''' || <tt>0</tt> || NO || Whether field should be included in data object's field list. || Different default (0 rather than 1) as individual sub-fields are already shown in field list.
 |}

@@ Line 9: / Line 9: @@
 ** [[Compound field]]
-== Properties ==
+== Additional Properties ==
 {| border="1" cellpadding="3" cellspacing="0"
 | name || default || description

@@ Line 21: / Line 21: @@
 == Required Phrases ==
-Additional phrases are typically required for the field name of the sub-fields in the form:
+In addition to the [[Metadata#Required_Phrases|standard metadata field phrases]] other phrases that are typically required for the field name of the sub-fields in the form:
    datasetid + "_fieldname_" + fieldname + "_" + subfieldname
 Individual fieldhelp phrases are not required the help for sub-fields should be included in the fieldhelp for the main field.
@@ Line 45: / Line 45: @@
 == Examples ==
-Most basic example:
+Most basic example.
+  {
       name => 'match',

@@ Line 26: / Line 26: @@
 == Database ==
-Each sub-field within a compound field has its own table named <code><dataset>_<fieldname>_<subfieldname><code>. For example, the related URL for an EPrint (<tt>related_url</tt>) has a URL and a type, so would have tables named <tt>eprint_related_url_url</tt> and <tt>eprint_related_url_type</tt>.
+Each sub-field within a compound field has its own table named <code><dataset>_<fieldname>_<subfieldname></code>. For example, the related URL for an EPrint (<tt>related_url</tt>) has a URL and a type, so would have tables named <tt>eprint_related_url_url</tt> and <tt>eprint_related_url_type</tt>.
 The tables in this instance have the following structure:
@@ Line 33: / Line 33: @@
     pos INT(11)
     related_url_url LONGTEXT
-−
   eprint_related_url_type:
     eprintid INT(11)

@@ Line 3: / Line 3: @@
 == Description ==
-A field that contains multiple sub-fields such as used for Creators so both a name and ID can be captured.
+This field that contains multiple sub-fields such as used for creators so both a name and ID can be captured.
 == Inheritance ==