Multipart field - Revision history

Drn@ecs.soton.ac.uk: Re-instated this field type as it is the super class of Name field.

2023-04-15T16:38:17Z

Re-instated this field type as it is the super class of Name field.

← Older revision		Revision as of 16:38, 15 April 2023
Line 2:		Line 2:


	~~{{Deprecated\|The Multipart~~ field ~~type~~ is ~~far inferior~~ to a [[Compound field]] ~~type~~ that ~~should~~ be used ~~instead~~.\|metadata field type}}		== Description ==
			This field is similar to a [[Compound field]] but only intended for single sets of values (i.e. <tt>multiple => 0</tt>). So that it can be used to build complex fields like the [[Name field]].

			== Inheritance ==
			* [[Metadata]]
			*** [[Multipart field]]

			== Additional Properties ==
			{\| border="1" cellpadding="3" cellspacing="0"
			! Name !! Default Value !! Required !! Description !! Notes
			\|-
			\| '''fields''' \|\| n/a \|\| YES \|\| The sub-fields of the main field \|\|
			\|-
			\| '''fields_cache''' \|\| n/a \|\| NO \|\| A cache of the sub-fields \|\| This property is generated from <code>fields</code>.
			\|-
			\| '''fields_index''' \|\| <tt>{}</tt> \|\| NO \|\| Index of <tt>sub_name</tt> to field object \|\| This property is generated from <code>fields</code>.
			\|}

			== Required Phrases ==
			In addition tothe [[Metadata#Required_Phrases\|standard metadata field phrases]]<code>type</code>. The sub-field names 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.

			== Database ==
			Multipart fields are stored in the database as multiple fields, whose types are determined in the sub-field configuration.

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

			== Examples ==
			Most basic example.
			{
			name => 'email',
			type => 'multipart',
			fields => [
			{
			sub_name => 'subject'
			type => 'text'
			},
			{
			sub_name => 'body'
			type => 'longtext'
			},
			}

Drn@ecs.soton.ac.uk: Used modified deprecated template

2023-04-11T09:21:54Z

Used modified deprecated template

← Older revision		Revision as of 09:21, 11 April 2023
Line 2:		Line 2:


	{{Deprecated\|~~This metadata~~ field type is far inferior to a [[Compound field]] that should be used instead.}}		{{Deprecated\|The Multipart field type is far inferior to a [[Compound field]] type that should be used instead.\|metadata field type}}

Drn@ecs.soton.ac.uk: Replaced content with "{{fieldtypes}} {{Deprecated|This metadata field type is far inferior to a Compound field that should be used instead.}}"

2023-04-11T09:16:39Z

Replaced content with "{{fieldtypes}} {{Deprecated|This metadata field type is far inferior to a Compound field that should be used instead.}}"

← Older revision		Revision as of 09:16, 11 April 2023
Line 2:		Line 2:


	~~== Description ==~~		{{Deprecated\|This metadata field type is far inferior to a [[Compound field]] that should be used instead.}}
	This field is ~~similar~~ to a [[Compound field]] ~~except...~~

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

	~~== Additional Properties ==~~
	~~{\| border="1" cellpadding="3" cellspacing="0"~~
	~~\| name \|\| default \|\| description~~
	\|-
	~~\| '''fields''' \|\| n/a \|\| '''This property is always required.'''~~
	\|-
	~~\| '''fields_cache''' \|\| n/a \|\| ''This property is always required but is generated from <code>fields</code>.''~~
	\|-
	~~\| '''fields_index''' \|\| {} \|\| ...~~
	\|}

	~~== Required Phrases ==~~
	~~In addition tothe [[Metadata#Required_Phrases\|standard metadata field phrases]]<code>type</code>. The sub-field names 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~~.

	~~== Database ==~~
	~~Multipart fields are stored in the database as multiple fields, whose types are determined in the sub-field configuration.~~

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

	~~== Examples ==~~
	~~Most basic example.~~
	{
	~~name => 'email',~~
	~~type => 'multipart',~~
	~~fields => [~~
	{
	~~sub_name => 'subject'~~
	~~type => 'text'~~
	},
	{
	~~sub_name => 'body'~~
	~~type => 'longtext'~~
	},
	}

Drn@ecs.soton.ac.uk: Added multipart metadata field type

2023-04-10T23:43:16Z

Added multipart metadata field type

New page

{{fieldtypes}}

== Description ==
This field is similar to a [[Compound field]] except...

== Inheritance ==
* [[Metadata]]
*** [[Multipart field]]

== Additional Properties ==
{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
|-
| '''fields''' || n/a || '''This property is always required.'''
|-
| '''fields_cache''' || n/a || ''This property is always required but is generated from <code>fields</code>.''
|-
| '''fields_index''' || {} || ...
|}

== Required Phrases ==
In addition tothe [[Metadata#Required_Phrases|standard metadata field phrases]]<code>type</code>. The sub-field names 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.

== Database ==
Multipart fields are stored in the database as multiple fields, whose types are determined in the sub-field configuration.

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

== Examples ==
Most basic example.
{
name => 'email',
type => 'multipart',
fields => [
{
sub_name => 'subject'
type => 'text'
},
{
sub_name => 'body'
type => 'longtext'
},
}