Difference between revisions of "Keywords field"

From EPrints Documentation
Jump to: navigation, search
m (Examples)
m
Line 11: Line 11:
 
**** [[Keywords field]]
 
**** [[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"
 
{| border="1" cellpadding="3" cellspacing="0"
Line 21: Line 21:
  
 
== Required Phrases ==
 
== Required Phrases ==
No additional phrases.
+
No additional phrases beyond those required for [[Longtext field#Required_Phrases|Longtext fields]].
  
 
== Database ==
 
== Database ==

Revision as of 22:23, 9 April 2023

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid


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.

Inheritance

Additional Properties

As for Longtext fields with the following difference...

name default description
separator , Can be overridden in the field definition.

Required Phrases

No additional phrases beyond those required for Longtext fields.

Database

Keywords fields are stored in the database as

fieldname LONGTEXT

API

See API page.

Examples

Most basic example.

{
  name => 'keywords',
  type => 'keywords',
}

Use a semi-colon (;) as a separator.

{
  name => 'terms',
  type => 'keywords',
  separator => ';',
}