Difference between revisions of "Name field"
(→Additional Properties) |
m (→Additional Properties) |
||
Line 20: | Line 20: | ||
|- | |- | ||
| '''family_first''' || <tt>0</tt> || NO || Determines the input order: when <tt>1</tt> then the first asks the family name, and then the given name. || The default is set in <tt>cfg.d/field_property_defaults.pl</tt>. | | '''family_first''' || <tt>0</tt> || NO || Determines the input order: when <tt>1</tt> then the first asks the family name, and then the given name. || The default is set in <tt>cfg.d/field_property_defaults.pl</tt>. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
} | } | ||
Revision as of 16:25, 15 April 2023
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
Contents
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
Additional Properties
As for Text fields except for:
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.
} Required PhrasesNo additional phrases beyond those required for Text fields. DatabaseName fields are stored in the database as fieldname_family VARCHAR(64) fieldname_given VARCHAR(64) fieldname_lineage VARCHAR(10) fieldname_honourific VARCHAR(10) APISee API page. ExamplesMost 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, } |