Keywords field

From EPrints Documentation
Jump to: navigation, search

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 - 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 => ';',
}