Editing Keywords field

{{fieldtypes}}


== Description ==
Stores a list of keywords as a <tt>longtext</tt> field but allows searching for exact matches on individual keyword phrases separated by a user-specifiable separator.

== Inheritance ==
* [[Metadata]]
** [[Id field]]
*** [[Keywords field]]

== Additional Properties ==
As for [[Id field#Additional_Properties|Id fields]] except for

{| border="1" cellpadding="3" cellspacing="0"
! Name !! Default Value !! Required !! Description !! Notes
|-
| '''match''' || <tt>EQ</tt> || NO || How to match against search criteria.  || Different from [[Id field]] (<tt>EX</tt>).  Could be set to <tt>SET</tt>.
|-
| '''input_rows''' || <tt>10</tt> || NO || How many rows for the field in the input form. || The default value for this property is taken from <tt>cfg.d/field_property_defaults.pl</tt>.
|-
| '''maxlength''' || <tt>65535</tt> || NO || Limit the maximum length of text that can be input. || Different from [[Metadata]] default (<tt>255</tt>). Maximum length could be as much as <tt>4294967295</tt> (over 4 billion).
|-
| '''sql_index''' || <tt>0</tt> || NO || Whether field should be index for quicker lookup by the database. || Different from [[Metadata]] default (<tt>1</tt>).
|-
| '''separator''' || <tt>,</tt> || NO || How to separate listed keywords. ||
|}

== Required Phrases ==
No additional phrases beyond those required for [[Longtext field#Required_Phrases|Longtext fields]].

== Database ==
Keywords fields are stored in the database as

 fieldname LONGTEXT

== API ==
See [[API:EPrints/MetaField/Keywords|API page]].

== Examples ==
Most basic example.
 {
   name => 'keywords',
   type => 'keywords',
 }
Use a semi-colon (<tt>;</tt>) as a separator.
 {
   name => 'terms',
   type => 'keywords',
   separator => ';',
 }