Set field - Revision history

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

2023-05-10T15:48:46Z

‎Additional Properties

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

2023-05-10T15:48:30Z

‎Additional Properties

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

2023-04-16T10:13:23Z

‎Additional Properties

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

2023-04-16T10:07:49Z

‎Additional Properties

Drn@ecs.soton.ac.uk: /* Inheritance */ Updated to include Text and Id

2023-04-16T08:11:31Z

‎Inheritance: Updated to include Text and Id

Drn@ecs.soton.ac.uk: Switched to additional properties

2023-04-11T08:53:59Z

Switched to additional properties

Drn@ecs.soton.ac.uk: /* Required Phrases */

2023-04-09T22:57:51Z

‎Required Phrases

Drn@ecs.soton.ac.uk: Added ToC. Added API and Examples sections. Reorganised/completed other sections.

2023-04-08T23:06:59Z

Added ToC. Added API and Examples sections. Reorganised/completed other sections.

Moj at 15:24, 11 January 2007

2007-01-11T15:24:14Z

Moj at 14:16, 11 January 2007

2007-01-11T14:16:01Z

@@ Line 41: / Line 41: @@
 | '''render_max_search_values''' || <tt>5</tt> || NO || Maximum number of options displayed in search description title of search results. ||
 |-
-| '''render_option'' || <tt>undef</tt> || NO || How to render individual options. || If defined must be a function that generates output to be rendered for a single option.  If not <tt>datasetid + "_fieldopt_" + fieldname + "_" + optionname</tt> phrase will be used.
+| '''render_option''' || <tt>undef</tt> || NO || How to render individual options. || If defined must be a function that generates output to be rendered for a single option.  If not <tt>datasetid + "_fieldopt_" + fieldname + "_" + optionname</tt> phrase will be used.
 |-
 | '''search_input_style''' || <tt>checkbox</tt> || NO || How to present options in search form. || Either checkboxes by default or select box if any other value set.

@@ Line 21: / Line 21: @@
 ! Name !! Default Value !! Required !! Description !! Notes
 |-
-| '''form_input_style''' || <tt>select</tt> || NO || How to present options  in the input form. || Only applicable when <tt>input_style => 'short'</tt>.  Any value other than <tt>checkbox</tt> will display as <tt>select</tt> box rather than individual checkboxes.
+| '''form_input_style''' || <tt>select</tt> || NO || How to present options  in the input form. || Only applicable when <tt>input_style => 'short'</tt>.  Any value other than <tt>checkbox</tt> will display as <tt>select</tt> box rather than individual checkboxes.  <tt>checkbox</tt> should only be used if <tt>multiple => 1</tt>
 |-
 | '''input_ordered''' || <tt>0</tt> || NO || If multiple values should they be submitted in a specific order || Different from [[Metadata]] default. Only applicable if <tt>multiple => 1</tt>.  Not normally useful for Set fields as ordering better determined by ordering of <tt>options</tt>.

@@ Line 27: / Line 27: @@
 | '''input_rows''' || <tt>10</tt> || NO || Number of rows (i.e. options) to display in select box for input form . || The default value for this property is taken from <tt>cfg.d/field_property_defaults.pl</tt>. Only applicable if <tt>input_style => 'short'</tt>.
 |-
-| '''input_style''' || <tt>short</tt> || NO || How field is displayed in input form. || Can be one of <tt>short</tt>, <tt>medium</tt> or <tt>tt>long</tt>.
+| '''input_style''' || <tt>short</tt> || NO || How field is displayed in input form. || Can be one of <tt>short</tt>, <tt>medium</tt> or <tt>long</tt>.
 |-
 | '''input_tags''' || <tt>undef</tt> || NO || Use alternative tags for options in input form. || If defined must be a function that generates an array of tags. If not defined, tags will be the same as options.  Useful if you want to sub-divide sections of options.

@@ Line 16: / Line 16: @@
 == Additional Properties ==
 {| border="1" cellpadding="3" cellspacing="0"
-| name || default || description
+! Name !! Default Value !! Required !! Description !! Notes
 |-
-| '''input_ordered''' || 0 || ...
+| '''form_input_style''' || <tt>select</tt> || NO || How to present options  in the input form. || Only applicable when <tt>input_style => 'short'</tt>.  Any value other than <tt>checkbox</tt> will display as <tt>select</tt> box rather than individual checkboxes.
 |-
-| '''input_rows''' || n/a || '''This property is taken from the repository configuration.'''
+| '''input_ordered''' || <tt>0</tt> || NO || If multiple values should they be submitted in a specific order || Different from [[Metadata]] default. Only applicable if <tt>multiple => 1</tt>.  Not normally useful for Set fields as ordering better determined by ordering of <tt>options</tt>.
 |-
-| '''input_style''' || short || ...
+| '''input_rows''' || <tt>10</tt> || NO || Number of rows (i.e. options) to display in select box for input form . || The default value for this property is taken from <tt>cfg.d/field_property_defaults.pl</tt>. Only applicable if <tt>input_style => 'short'</tt>.
 |-
-| '''input_tags''' || undef || ...
+| '''input_style''' || <tt>short</tt> || NO || How field is displayed in input form. || Can be one of <tt>short</tt>, <tt>medium</tt> or <tt>tt>long</tt>.
 |-
-| '''options''' || n/a || '''This property is always required.'''
+| '''input_tags''' || <tt>undef</tt> || NO || Use alternative tags for options in input form. || If defined must be a function that generates an array of tags. If not defined, tags will be the same as options.  Useful if you want to sub-divide sections of options.
 |-
-| '''render_option''' || undef || ...
+| '''match''' || <tt>EQ</tt> || NO || How to match values in search results. || Different from [[Text field]] default (<tt>IN</tt>). Treat the search value as a single string rather than a whitespace-separated list of words.
 |-
-| '''search_input_style''' || checkbox || ...
+| '''merge''' || <tt>ANY</tt> || NO || Initial search form setting for whether to match on all or any values (i.e. options). || Different from [[Metadata]] default (<tt>ALL</tt>).
 |-
 |}

@@ Line 11: / Line 11: @@
 == Inheritance ==
 * [[Metadata]]
-** [[Set field]]
+** [[Id field]]
 == Additional Properties ==

@@ Line 35: / Line 35: @@
 == Required Phrases ==
-If <code>input_style => 'short'</code> or <code>input_style => 'medium'</code> then the only extra phrases required are the name label for each of the options in the form:
+In addition to the [[Metadata#Required_Phrases|standard metadata field phrases]], if <code>input_style => 'short'</code> or <code>input_style => 'medium'</code> then the only extra phrases required are the name label for each of the options in the form:
   datasetid + "_fieldopt_" + fieldname + "_" + optionname
 E.g. <tt>eprint_fieldopt_ispublished_unpub</tt>

@@ Line 1: / Line 1: @@
 {{fieldtypes}}
-__NOTOC__
 == Inheritance ==
 * [[Metadata]]
 ** [[Set field]]
 == Properties ==
 {| border="1" cellpadding="3" cellspacing="0"
 | name || default || description
@@ Line 31: / Line 35: @@
 == Required Phrases ==
 == Database ==
-Set fields are stored in the database as
+== API ==
-  fieldname VARCHAR(255)
+== Examples ==

← Older revision		Revision as of 14:16, 11 January 2007
Line 32:		Line 32:

	== Required Phrases ==		== Required Phrases ==
		+
		+	== Database ==
		+
		+	Set fields are stored in the database as
		+
		+	fieldname VARCHAR(255)