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:

}

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,
}

Name	Default Value	Required	Description	Notes
family_first	0	NO	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	0	NO	Whether the honorific (e.g. Dr, Prof, Esq) sub-field should be displayed in the input form.	The default is set in cfg.d/field_property_defaults.pl.
hide_lineage	1	NO	Whether the lineage (e.g. Jr, Sr, III, IV) sub-field should be displayed in the input form.	The default is set in cfg.d/field_property_defaults.pl.
input_name_cols	{ honourific=>8, given=>20, family=>20, lineage=>8 } || The widths of the text sub-fields in the input form. || The default is set in cfg.d/field_property_defaults.pl.
render_order	fg	NO	The order the given and family names should appear when rendered.	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.
render_limit	undef	NO	Whether to limit and to how many names (e.g. creators) in a citation.	Only applicable if limit_names_shown is set as render_value for parent field (e.g. creators).
render_dynamic	undef	NO	Whether names (e.g. creators) beyond render_limit can be unhidden in a citation.	Only applicable if limit_names_shown is set as render_value for parent field (e.g. creators).
text_index	1	NO	Whether the text for these fields should be indexed.	Different from Metadata default (0).