Keywords field - Revision history

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

2023-04-15T15:16:06Z

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

2023-04-12T08:01:29Z

‎Additional Properties

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

2023-04-12T08:01:04Z

‎Additional Properties

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

2023-04-12T07:38:59Z

‎Inheritance

Drn@ecs.soton.ac.uk at 22:23, 9 April 2023

2023-04-09T22:23:19Z

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

2023-03-23T11:31:55Z

‎Examples

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

2023-03-23T11:31:45Z

‎Examples

Drn@ecs.soton.ac.uk: Added examples. Improved other sections unhide ToC.

2023-03-23T11:31:28Z

Added examples. Improved other sections unhide ToC.

Drn@ecs.soton.ac.uk: Added keywords field

2020-06-14T11:31:45Z

Added keywords field

New page

{{fieldtypes}}
__NOTOC__
== Inheritance ==

* [[Metadata]]
** [[Text field]]
*** [[Longtext field]]
**** [[Keywords field]]

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

== Properties ==

As for [[Longtext field]]s with the following difference...

{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
|-
| '''separator''' || , || '''Can be overridden in the field definition.'''
|}

== Required Phrases ==

@@ Line 25: / Line 25: @@
 |-
 | '''separator''' || <tt>,</tt> || NO || How to separate listed keywords. ||
 |}

@@ Line 24: / Line 24: @@
 | '''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.
+| '''separator''' || <tt>,</tt> || NO || How to separate listed keywords. ||
 |-

@@ Line 11: / Line 11: @@
 == Additional Properties ==
-As for [[Longtext field#Additional_Properties|Longtext fields]] with the following difference...
+As for [[Id field#Additional_Properties|Id fields]] except for
 {| border="1" cellpadding="3" cellspacing="0"
-| name || default || description
+! Name !! Default Value !! Required !! Description !! Notes
 |-
-| '''separator''' || , || '''Can be overridden in the field definition.'''
+| '''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>.
 |}

@@ Line 11: / Line 11: @@
 **** [[Keywords field]]
-== Properties ==
+== Additional Properties ==
-As for [[Longtext field]]s with the following difference...
+As for [[Longtext field#Additional_Properties|Longtext fields]] with the following difference...
 {| border="1" cellpadding="3" cellspacing="0"
@@ Line 21: / Line 21: @@
 == Required Phrases ==
-No additional phrases.
+No additional phrases beyond those required for [[Longtext field#Required_Phrases|Longtext fields]].
 == Database ==

@@ Line 37: / Line 37: @@
     type => 'keywords',
+  }
-Use a semi-colon (<tt>;</tt> as a separator.
+Use a semi-colon (<tt>;</tt>) as a separator.
+  {
     name => 'terms',

@@ Line 7: / Line 7: @@
 == Inheritance ==
 * [[Metadata]]
-** [[Text field]]
+** [[Id field]]
-*** [[Longtext field]]
+*** [[Keywords field]]
 == Additional Properties ==

← Older revision		Revision as of 11:31, 23 March 2023
Line 33:		Line 33:
	== Examples ==		== Examples ==
	Most basic example.		Most basic example.
−	{	+	{
−	name => 'keywords',	+	name => 'keywords',
−	type => 'keywords',	+	type => 'keywords',
−	}	+	}
	Use a semi-colon (<tt>;</tt> as a separator.		Use a semi-colon (<tt>;</tt> as a separator.
−	{	+	{
−	name => 'terms',	+	name => 'terms',
−	type => 'keywords',	+	type => 'keywords',
−	separator => ';',	+	separator => ';',
−	}	+	}