Name field - Revision history

Drn@ecs.soton.ac.uk at 08:04, 16 April 2023

2023-04-16T08:04:24Z

← Older revision		Revision as of 08:04, 16 April 2023
Line 13:		Line 13:

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

	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
Line 36:		Line 36:

	== Required Phrases ==		== Required Phrases ==
	No additional phrases beyond those required for [[~~Text~~ field#Required_Phrases\|~~Text~~ fields]].		No additional phrases beyond those required for [[Multipart field#Required_Phrases\|Multipart fields]].

	== Database ==		== Database ==

Drn@ecs.soton.ac.uk at 20:34, 15 April 2023

2023-04-15T20:34:16Z

← Older revision		Revision as of 20:34, 15 April 2023
Line 14:		Line 14:
	== Additional Properties ==		== Additional Properties ==
	As for [[Text field#Additional Properties\|Text fields]] except for:		As for [[Text field#Additional Properties\|Text fields]] except for:


	~~== Additional Properties ==~~
	~~As for [[Text field#Additional Properties\|Text fields]] except for:~~


	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"

Drn@ecs.soton.ac.uk at 20:04, 15 April 2023

2023-04-15T20:04:26Z

← Older revision		Revision as of 20:04, 15 April 2023
Line 31:		Line 31:
	\| '''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>.		\| '''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_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>.		\| '''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_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_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_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>).		\| '''text_index''' \|\| <tt>1</tt> \|\| NO \|\| Whether the text for these fields should be indexed. \|\| Different from [[Metadata]] default (<tt>0</tt>).

Drn@ecs.soton.ac.uk: /* Inheritance */

2023-04-15T16:28:05Z

Inheritance

← Older revision		Revision as of 16:28, 15 April 2023
Line 9:		Line 9:
	== Inheritance ==		== Inheritance ==
	* [[Metadata]]		* [[Metadata]]
	** [[~~Text~~ field]]		** [[Multipart field]]
	*** [[Name field]]		*** [[Name field]]

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-15T16:26:54Z

Additional Properties

@@ Line 11: / Line 11: @@
 ** [[Text field]]
 *** [[Name field]]
 == Additional Properties ==
@@ Line 20: / Line 24: @@
 |-
 | '''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>.
+|-
 == Required Phrases ==

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-15T16:25:45Z

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>.
+}

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-15T16:24:19Z

Additional Properties

← Older revision		Revision as of 16:24, 15 April 2023
Line 34:		Line 34:
	\|-		\|-
	\| '''text_index''' \|\| <tt>1</tt> \|\| NO \|\| Whether the text for these fields should be indexed. \|\| Different from [[Metadata]] default (<tt>0</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 ==		== Required Phrases ==

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-15T16:23:52Z

Additional Properties

← Older revision		Revision as of 16:23, 15 April 2023
Line 25:		Line 25:
	\| '''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>.		\| '''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>.		\| '''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_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>.		\| '''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>.
Line 35:		Line 35:
	\| '''text_index''' \|\| <tt>1</tt> \|\| NO \|\| Whether the text for these fields should be indexed. \|\| Different from [[Metadata]] default (<tt>0</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 ==		== Required Phrases ==

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-15T16:19:11Z

Additional Properties

← Older revision		Revision as of 16:19, 15 April 2023
Line 25:		Line 25:
	\| '''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>.		\| '''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>{		\| '''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>.
	honourific=>8,
	given=>20,
	family=>20,
	lineage=>8
	}</tt> \|\| 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_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>.		\| '''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>.

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-15T16:17:16Z

Additional Properties

← Older revision		Revision as of 16:17, 15 April 2023
Line 14:		Line 14:
	== Additional Properties ==		== Additional Properties ==
	As for [[Text field#Additional Properties\|Text fields]] except for:		As for [[Text field#Additional Properties\|Text fields]] except for:


	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	~~\| name \|\| default \|\| description~~		! Name !! Default Value !! Required !! Description !! Notes
	\|-		\|-
	\| '''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.		\| '''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''' \|\| n/a \|\| ~~'''This property is taken from~~ the ~~repository configuration~~.~~''' For input: if 1 do not prompt for the title (~~Dr, Prof, Esq)		\| '''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''' \|\| n/a \|\| ~~'''This property is taken from~~ the ~~repository configuration.''' For input: if 1 do not prompt for~~ lineage (Jr, Sr, III, IV)		\| '''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''' \|\| 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		\| '''input_name_cols''' \|\| <tt>{
			honourific=>8,
			given=>20,
			family=>20,
			lineage=>8
			}</tt> \|\| 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_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"		\| '''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>.
	\|}		\|-
			\| '''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_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).
			\|-
			\| '''text_index''' \|\| <tt>1</tt> \|\| NO \|\| Whether the text for these fields should be indexed. \|\| Different from [[Metadata]] default (<tt>0</tt>).
			\|-
			}

	== Required Phrases ==		== Required Phrases ==