Name field

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

---

Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid

Description

This field can store the individual parts of a person's name. Including family name(s) (a.k.a. surname) given name(s) (or initials), honorific (e.g. Dr, Prof, etc.) and lineage (e.g. Jr, Sr, III, etc.)

The configuration for this field provides various customisations that determine which and what order these sub-fields can be entered and/or rendered.

Inheritance

• Metadata
  • Text field
    • Name field

Additional Properties

As for Text fields except for:

name	default	description
family_first	n/a	This property is taken from the repository configuration. Determines the input order: when 1 then the first asks the family name, and then the given name. The default is set in cfg.d/field_property_defaults.pl.
hide_honourific	n/a	This property is taken from the repository configuration. For input: if 1 do not prompt for the title (Dr, Prof, Esq)
hide_lineage	n/a	This property is taken from the repository configuration. For input: if 1 do not prompt for lineage (Jr, Sr, III, IV)
input_name_cols	n/a	This property is taken from the repository configuration. It is a hash of four fields, see the format in cfg.d/field_property_defaults.pl
render_order	fg	Output: f is for family, g is for given. The fg format is rendered as "Davis Jr, Dr Sammy" if both lineage and honourific is present; the gf order results in "Dr Sammy Davis Jr"

Required Phrases

No additional phrases beyond those required for Text fields.

Database

Name fields are stored in the database as

fieldname_family VARCHAR(64)
fieldname_given VARCHAR(64)
fieldname_lineage VARCHAR(10)
fieldname_honourific VARCHAR(10)

API

See API page.

Examples

Most basic example.

{
    name => 'name',
    type => 'name',
}

Display given name before family name.

{
    name => 'name',
    type => 'name',
    render_order => 'gf',
}

Hide the honorific and lineage fields from entry and make family name the first field to be entered.

{
    name => 'name',
    type => 'name',
    hide_honourific => 1,
    hide_lineage => 1,
    family_first => 1,
} 

Use as a sub-field (in a multiple field).

{
    name => 'creators',
    type => 'compound',
    multiple => 1,
    fields => [
        {
            sub_name => 'name',
            type => 'name',
            hide_honourific => 1,
            hide_lineage => 1,
            family_first => 1,
        },
        {
            sub_name => 'id',
            type => 'text',
            input_cols => 20,
            allow_null => 1,
            export_as_xml => 0,
        }
    ],
    input_boxes => 4,
}