⧼vector-jumptocontent⧽

Multipart field

From EPrints Documentation
Revision as of 23:43, 10 April 2023 by Drn@ecs.soton.ac.uk (talk | contribs) (Added multipart metadata field type)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Description

This field is similar to a Compound field except...

Inheritance

Additional Properties

name default description
fields n/a This property is always required.
fields_cache n/a This property is always required but is generated from fields.
fields_index {} ...

Required Phrases

In addition tothe standard metadata field phrasestype. 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 page.

Examples

Most basic example.

{
    name => 'email',
    type => 'multipart',
    fields => [
        {
            sub_name => 'subject'
            type => 'text'
        },
        {
            sub_name => 'body'
            type => 'longtext'
        },
}