Editing Name field

{{fieldtypes}}


== 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]]
** [[Multipart field]]
*** [[Name field]]

== Additional Properties ==
As for [[Multipart field#Additional Properties|Multipart fields]] except for:

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

== Required Phrases ==
No additional phrases beyond those required for [[Multipart field#Required_Phrases|Multipart 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:EPrints/MetaField/Longtext|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,
 }